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
|
<!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>Provide an XML description of the domain</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.libvirt-domain-get-uuid.html">libvirt_domain_get_uuid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-interface-stats.html">libvirt_domain_interface_stats</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-domain-get-xml-desc" class="refentry">
<div class="refnamediv">
<h1 class="refname">libvirt_domain_get_xml_desc</h1>
<p class="verinfo">(php-libvirt 0.1)</p><p class="refpurpose"><span class="refname">libvirt_domain_get_xml_desc</span> — <span class="dc-title">Provide an XML description of the domain</span></p>
</div>
<a name="function.libvirt-domain-get-xml-desc.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><b>libvirt_domain_get_xml_desc</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$domain</tt></span>
[, <span class="methodparam"><span class="type">integer</span> <tt class="parameter">$flags</tt><span class="initializer">= 0</span></span>
] )</div>
<p class="para rdfs-comment">
Provide an XML description of the domain. The description may be reused later to relaunch the domain with <a href="function.libvirt-domain-create-xml.html" class="function">libvirt_domain_create_xml()</a> or defined with <a href="function.libvirt-domain-define-xml.html" class="function">libvirt_domain_define_xml()</a>.
</p>
</div>
<a name="function.libvirt-domain-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">domain</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Domain resource of domain to get XML description.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">flags</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Logical OR of any of these flags:
</p><ul class="simplelist">
<li class="member"><b><tt class="constant">VIR_DOMAIN_XML_SECURE</tt></b> - dump security sensitive information too</li>
<li class="member"><b><tt class="constant">VIR_DOMAIN_XML_INACTIVE</tt></b> - dump inactive domain information</li>
</ul><p>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.libvirt-domain-get-xml-desc.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
String with XML description of domain. For more details see <a href="http://www.libvirt.org/formatdomain.html" class="link external">» http://www.libvirt.org/formatdomain.html</a>.
</p>
</div>
<a name="function.libvirt-domain-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-domain-create-xml.html" class="function" rel="rdfs-seeAlso">libvirt_domain_create_xml()</a> - Launch a new guest domain, based on an XML description</li>
<li class="member"><a href="function.libvirt-domain-define-xml.html" class="function" rel="rdfs-seeAlso">libvirt_domain_define_xml()</a> - Define a domain, but does not start it.</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-domain-get-uuid.html">libvirt_domain_get_uuid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.libvirt-domain-interface-stats.html">libvirt_domain_interface_stats</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>
|
