1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.28 $ -->
<refentry xml:id="function.libvirt-storagevolume-create-xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>libvirt_storagevolume_create_xml</refname>
<refpurpose>Create a new storage volume based on XML input</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>libvirt_storagevolume_create_xml</methodname>
<methodparam ><type>resource</type><parameter>storagepool resource</parameter></methodparam>
<methodparam ><type>string</type><parameter>xml</parameter></methodparam>
</methodsynopsis>
<para>
This function returns string containing volume information in XML format
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>storagepool resource</parameter></term>
<listitem>
<para>
Connection resource of the storagepool
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>xml</parameter></term>
<listitem>
<para>
XML information to base the new volume on
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<!-- See also &return.success; -->
<para>
Volume resource of the newly created volume. &false; on failure
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>libvirt_storagevolume_create_xmlc</function> example</title>
<para>
Create a new volume in a storagepool
</para>
<programlisting role="php">
<![CDATA[
<?php
$conn=libvirt_connect($uri,true);
$pool=libvirt_storagepools_lookup_by_name($conn,'default');
$xml = "<volume>
<name>volume2</name>
<key>b10fa7e2-5e48-4c97-a7a0-42ca197d400c</key>
<capacity unit='M'>100</capacity>
</volume>";
$volumeNew=libvirt_storagevolume_create_xml($pool,$xml);
var_dump($volumeNew);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
resource(3) of type (Libvirt volume)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>libvirt_storagevolume_lookup_by_name</function></member>
<member><function>libvirt_storagevolume_get_info</function></member>
<member><function>libvirt_storagevolume_get_xml_desc</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|