File: function.libvirt-storagevolume-get-xml-desc.html

package info (click to toggle)
libvirt-php 0.5.2~30-g64dca6f-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,460 kB
  • ctags: 5,538
  • sloc: cpp: 11,159; ansic: 8,250; xml: 3,999; php: 1,604; sh: 580; makefile: 189; perl: 97
file content (129 lines) | stat: -rw-r--r-- 6,873 bytes parent folder | download 
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
126
127
128
129
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Get storagevolume information in XML format</title>
 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-storagevolume-get-info.html">libvirt_storagevolume_get_info</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.libvirt-storagevolume-lookup-by-name.html">libvirt_storagevolume_lookup_by_name</a></div>
 <div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.libvirt-storagevolume-get-xml-desc" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">libvirt_storagevolume_get_xml_desc</h1>
  <p class="verinfo">(php-libvirt 0.4)</p><p class="refpurpose"><span class="refname">libvirt_storagevolume_get_xml_desc</span> &mdash; <span class="dc-title">Get storagevolume information in XML format</span></p>

 </div>

 <a name="function.libvirt-storagevolume-get-xml-desc.description"></a><div class="refsect1 description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">array</span> <span class="methodname"><b>libvirt_storagevolume_get_xml_desc</b></span>
    ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$volume resource</tt></span>
   )</div>

  <p class="para rdfs-comment">
   This function returns string containing volume information in XML format
  </p>
 </div>


 <a name="function.libvirt-storagevolume-get-xml-desc.parameters"></a><div class="refsect1 parameters">
  <h3 class="title">Parameters</h3>
 <p class="para">
   </p><dl>

    <dt class="varlistentry">

     <span class="term"><i><tt class="parameter">volume resource</tt></i>
</span>

     </dt><dd class="listitem">

      <p class="para">
       Connection resource of volume
      </p>
     </dd>

    
   </dl>
<p>
  </p>
 </div>


 <a name="function.libvirt-storagevolume-get-xml-desc.returnvalues"></a><div class="refsect1 returnvalues">
  <h3 class="title">Return Values</h3>
  
  <p class="para">
    String with volume information in XML format. <b><tt class="constant">FALSE</tt></b> on failure
  </p>
 </div>


 

 <a name="function.libvirt-storagevolume-get-xml-desc.examples"></a><div class="refsect1 examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   </p><div class="example">
    <p><b>Example #1 <b>libvirt_storagevolume_get_xml_desc()</b> example</b></p>
    <div class="example-contents para"><p>
     String with volume information in XML format
    </p></div>
    <div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;$conn</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$uri</span><span style="color: #007700">,</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$pool</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_storagepools_lookup_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">,</span><span style="color: #DD0000">'default'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$volume</span><span style="color: #007700">=</span><span style="color: #0000BB">libvirt_storagevolume_lookup_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$pool</span><span style="color: #007700">,</span><span style="color: #DD0000">'volume1'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$volumeXML</span><span style="color: #007700">=</span><span style="color: #0000BB">libtvirt_storagevolume_get_xml_desc</span><span style="color: #007700">(</span><span style="color: #0000BB">$volume</span><span style="color: #007700">);<br /><br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$volumeXML</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents para"><p>The above example will output 
something similar to:</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
string(451) &quot;&lt;volume&gt;
  &lt;name&gt;volume1&lt;/name&gt;
  &lt;key&gt;mQ3tpH-dAjE-IdHi-iafe-QElg-X2r7-Pv59e6&lt;/key&gt;
  &lt;source&gt;
    &lt;device path=&#039;/dev/sdb&#039;&gt;
      &lt;extent start=&#039;27971813376&#039; end=&#039;30119297024&#039;/&gt;
    &lt;/device&gt;
  &lt;/source&gt;
  &lt;capacity&gt;2147483648&lt;/capacity&gt;
  &lt;allocation&gt;2147483648&lt;/allocation&gt;
  &lt;target&gt;
    &lt;path&gt;/dev/data/volume1&lt;/path&gt;
    &lt;permissions&gt;
      &lt;mode&gt;0660&lt;/mode&gt;
      &lt;owner&gt;0&lt;/owner&gt;
      &lt;group&gt;6&lt;/group&gt;
    &lt;/permissions&gt;
  &lt;/target&gt;
&lt;/volume&gt;
</pre></div>
    </div>
   </div><p>
  </p>
 </div>


 <a name="function.libvirt-storagevolume-get-xml-desc.seealso"></a><div class="refsect1 seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   </p><ul class="simplelist">
    <li class="member"><a href="function.libvirt-storagevolume-lookup-by-name.html" class="function" rel="rdfs-seeAlso">libvirt_storagevolume_lookup_by_name()</a> - Lookup volume resource by name</li>
    <li class="member"><a href="function.libvirt-storagevolume-get-info.html" class="function" rel="rdfs-seeAlso">libvirt_storagevolume_get_info()</a> - Get storagevolume information</li>
    <li class="member"><a href="function.libvirt-storagevolume-create-xml.html" class="function" rel="rdfs-seeAlso">libvirt_storagevolume_create_xml()</a> - Create a new storage volume based on XML input</li>
   </ul><p>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-storagevolume-get-info.html">libvirt_storagevolume_get_info</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.libvirt-storagevolume-lookup-by-name.html">libvirt_storagevolume_lookup_by_name</a></div>
 <div class="up"><a href="ref.libvirt.html">Libvirt Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>