mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-12-22 13:45:38 +00:00
* docs/formatdomain.html docs/formatdomain.html.in docs/libvirt-api.xml
docs/libvirt-refs.xml docs/html/libvirt-libvirt.html src/libvirt.c: fixed somedocs and API entry point descriptions as suggested by Charles Duffy and regenerated the API descriptions. Daniel
This commit is contained in:
Daniel Veillard
parent
9ec9991c5d
commit
eba65e1c6d
@ -1,3 +1,10 @@
|
||||
Fri Aug 1 08:40:48 CEST 2008 Daniel Veillard <veillard@redhat.com>
|
||||
|
||||
* docs/formatdomain.html docs/formatdomain.html.in docs/libvirt-api.xml
|
||||
docs/libvirt-refs.xml docs/html/libvirt-libvirt.html src/libvirt.c:
|
||||
fixed somedocs and API entry point descriptions as suggested by
|
||||
Charles Duffy and regenerated the API descriptions.
|
||||
|
||||
Fri Aug 1 08:22:08 CEST 2008 Daniel Veillard <veillard@redhat.com>
|
||||
|
||||
* src/qemu_driver.c: apply patch from Charles Duffy fixing erro
|
||||
|
||||
@ -689,11 +689,11 @@ The content of this structure is not made public by the API.
|
||||
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div></div>
|
||||
<hr/>
|
||||
<div class="refsect2" lang="en"><h3><a name="virDomainCreateLinux"/>virDomainCreateLinux ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainCreateLinux (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/> const char * xmlDesc, <br/> unsigned int flags)<br/>
|
||||
</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</p>
|
||||
</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted (see virDomainDefineXML() to define persistent domains).</p>
|
||||
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an optional set of virDomainFlags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div></div>
|
||||
<hr/>
|
||||
<div class="refsect2" lang="en"><h3><a name="virDomainDefineXML"/>virDomainDefineXML ()</h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br/> const char * xml)<br/>
|
||||
</pre><p>define a domain, but does not start it</p>
|
||||
</pre><p>Define a domain, but does not start it. This definition is persistent, until explicitly undefined with virDomainUndefine().</p>
|
||||
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the domain, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the domain otherwise</td></tr></tbody></table></div></div>
|
||||
<hr/>
|
||||
<div class="refsect2" lang="en"><h3><a name="virDomainDestroy"/>virDomainDestroy ()</h3><pre class="programlisting">int virDomainDestroy (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
|
||||
@ -841,7 +841,7 @@ The content of this structure is not made public by the API.
|
||||
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div></div>
|
||||
<hr/>
|
||||
<div class="refsect2" lang="en"><h3><a name="virDomainUndefine"/>virDomainUndefine ()</h3><pre class="programlisting">int virDomainUndefine (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br/>
|
||||
</pre><p>undefine a domain but does not stop it if it is running</p>
|
||||
</pre><p>Undefine a domain but does not stop it if it is running</p>
|
||||
<div class="variablelist"><table border="0"><col align="left"/><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div></div>
|
||||
<hr/>
|
||||
<div class="refsect2" lang="en"><h3><a name="virGetVersion"/>virGetVersion ()</h3><pre class="programlisting">int virGetVersion (unsigned long * libVer, <br/> const char * type, <br/> unsigned long * typeVer)<br/>
|
||||
|
||||
@ -649,8 +649,10 @@
|
||||
<dl><dt><code>graphics</code></dt><dd>The <code>graphics</code> element has a mandatory <code>type</code>
|
||||
attribute which takes the value "sdl" or "vnc". The former displays
|
||||
a window on the host desktop, while the latter activates a VNC server.
|
||||
If the latter is used the <code>port</code> attributes specifies the
|
||||
TCP port number (with -1 indicating that it should be auto-allocated).
|
||||
If the latter is used the <code>port</code> attribute specifies the TCP
|
||||
port number (with -1 as legacy syntax indicating that it should be
|
||||
auto-allocated). The <code>autoport</code> attribute is the new
|
||||
preferred syntax for indicating autoallocation of the TCP port to use.
|
||||
The <code>listen</code> attribute is an IP address for the server to
|
||||
listen on. The <code>password</code> attribute provides a VNC password
|
||||
in clear text.</dd></dl>
|
||||
|
||||
@ -584,8 +584,10 @@
|
||||
<dd>The <code>graphics</code> element has a mandatory <code>type</code>
|
||||
attribute which takes the value "sdl" or "vnc". The former displays
|
||||
a window on the host desktop, while the latter activates a VNC server.
|
||||
If the latter is used the <code>port</code> attributes specifies the
|
||||
TCP port number (with -1 indicating that it should be auto-allocated).
|
||||
If the latter is used the <code>port</code> attribute specifies the TCP
|
||||
port number (with -1 as legacy syntax indicating that it should be
|
||||
auto-allocated). The <code>autoport</code> attribute is the new
|
||||
preferred syntax for indicating autoallocation of the TCP port to use.
|
||||
The <code>listen</code> attribute is an IP address for the server to
|
||||
listen on. The <code>password</code> attribute provides a VNC password
|
||||
in clear text.</dd>
|
||||
|
||||
@ -286,8 +286,8 @@ char * <a href="#virStorageVolGetXMLDesc">virStorageVolGetXMLDesc</a> (<a href=
|
||||
</pre><p>This function returns block device (disk) stats for block devices attached to the domain. The path parameter is the name of the block device. Get this by calling <a href="libvirt-libvirt.html#virDomainGetXMLDesc">virDomainGetXMLDesc</a> and finding the <target dev='...'> attribute within //domain/devices/disk. (For example, "xvda"). Domains may have more than one block device. To get stats for each you should make multiple calls to this function. Individual fields within the stats structure may be returned as -1, which indicates that the hypervisor does not support that particular statistic.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>dom</tt></i>:</span></td><td>pointer to the domain object</td></tr><tr><td><span class="term"><i><tt>path</tt></i>:</span></td><td>path to the block device</td></tr><tr><td><span class="term"><i><tt>stats</tt></i>:</span></td><td>block device stats (returned)</td></tr><tr><td><span class="term"><i><tt>size</tt></i>:</span></td><td>size of stats structure</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success or -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainCoreDump" id="virDomainCoreDump"><code>virDomainCoreDump</code></a></h3><pre class="programlisting">int virDomainCoreDump (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * to, <br /> int flags)<br />
|
||||
</pre><p>This method will dump the core of a domain on a given file for analysis. Note that for remote Xen Daemon the file path will be interpreted in the remote host.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>to</tt></i>:</span></td><td>path for the core file</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>extra flags, currently unused</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainCreate" id="virDomainCreate"><code>virDomainCreate</code></a></h3><pre class="programlisting">int virDomainCreate (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
|
||||
</pre><p>launch a defined domain. If the call succeed the domain moves from the defined to the running domains pools.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virDomainCreateLinux" id="virDomainCreateLinux"><code>virDomainCreateLinux</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainCreateLinux (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc, <br /> unsigned int flags)<br />
|
||||
</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an optional set of virDomainFlags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virDomainDefineXML" id="virDomainDefineXML"><code>virDomainDefineXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)<br />
|
||||
</pre><p>define a domain, but does not start it</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the domain, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the domain otherwise</td></tr></tbody></table></div><h3><a name="virDomainDestroy" id="virDomainDestroy"><code>virDomainDestroy</code></a></h3><pre class="programlisting">int virDomainDestroy (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
|
||||
</pre><p>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted (see virDomainDefineXML() to define persistent domains).</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xmlDesc</tt></i>:</span></td><td>string containing an XML description of the domain</td></tr><tr><td><span class="term"><i><tt>flags</tt></i>:</span></td><td>an optional set of virDomainFlags</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>a new domain object or NULL in case of failure</td></tr></tbody></table></div><h3><a name="virDomainDefineXML" id="virDomainDefineXML"><code>virDomainDefineXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> virDomainDefineXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xml)<br />
|
||||
</pre><p>Define a domain, but does not start it. This definition is persistent, until explicitly undefined with virDomainUndefine().</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>conn</tt></i>:</span></td><td>pointer to the hypervisor connection</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>the XML description for the domain, preferably in UTF-8</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>NULL in case of error, a pointer to the domain otherwise</td></tr></tbody></table></div><h3><a name="virDomainDestroy" id="virDomainDestroy"><code>virDomainDestroy</code></a></h3><pre class="programlisting">int virDomainDestroy (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
|
||||
</pre><p>Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated <a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> object. This function may require privileged access</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainDetachDevice" id="virDomainDetachDevice"><code>virDomainDetachDevice</code></a></h3><pre class="programlisting">int virDomainDetachDevice (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> const char * xml)<br />
|
||||
</pre><p>Destroy a virtual device attachment to backend.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object</td></tr><tr><td><span class="term"><i><tt>xml</tt></i>:</span></td><td>pointer to XML description of one device</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainFree" id="virDomainFree"><code>virDomainFree</code></a></h3><pre class="programlisting">int virDomainFree (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
|
||||
</pre><p>Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainGetAutostart" id="virDomainGetAutostart"><code>virDomainGetAutostart</code></a></h3><pre class="programlisting">int virDomainGetAutostart (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain, <br /> int * autostart)<br />
|
||||
@ -324,7 +324,7 @@ char * <a href="#virStorageVolGetXMLDesc">virStorageVolGetXMLDesc</a> (<a href=
|
||||
</pre><p>Dynamically change the number of virtual CPUs used by the domain. Note that this call may fail if the underlying virtualization hypervisor does not support it or if growing the number is arbitrary limited. This function requires privileged access to the hypervisor.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to domain object, or NULL for Domain0</td></tr><tr><td><span class="term"><i><tt>nvcpus</tt></i>:</span></td><td>the new number of virtual CPUs for this domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainShutdown" id="virDomainShutdown"><code>virDomainShutdown</code></a></h3><pre class="programlisting">int virDomainShutdown (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
|
||||
</pre><p>Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ?</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainSuspend" id="virDomainSuspend"><code>virDomainSuspend</code></a></h3><pre class="programlisting">int virDomainSuspend (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
|
||||
</pre><p>Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain. This function may requires privileged access.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>a domain object</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success and -1 in case of failure.</td></tr></tbody></table></div><h3><a name="virDomainUndefine" id="virDomainUndefine"><code>virDomainUndefine</code></a></h3><pre class="programlisting">int virDomainUndefine (<a href="libvirt-libvirt.html#virDomainPtr">virDomainPtr</a> domain)<br />
|
||||
</pre><p>undefine a domain but does not stop it if it is running</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virGetVersion" id="virGetVersion"><code>virGetVersion</code></a></h3><pre class="programlisting">int virGetVersion (unsigned long * libVer, <br /> const char * type, <br /> unsigned long * typeVer)<br />
|
||||
</pre><p>Undefine a domain but does not stop it if it is running</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>domain</tt></i>:</span></td><td>pointer to a defined domain</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virGetVersion" id="virGetVersion"><code>virGetVersion</code></a></h3><pre class="programlisting">int virGetVersion (unsigned long * libVer, <br /> const char * type, <br /> unsigned long * typeVer)<br />
|
||||
</pre><p>Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not available, an error code will be returned and @typeVer will be 0.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>libVer</tt></i>:</span></td><td>return value for the library version (OUT)</td></tr><tr><td><span class="term"><i><tt>type</tt></i>:</span></td><td>the type of connection/driver looked at</td></tr><tr><td><span class="term"><i><tt>typeVer</tt></i>:</span></td><td>return value for the version of the hypervisor (OUT)</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>-1 in case of failure, 0 otherwise, and values for @libVer and @typeVer have the format major * 1,000,000 + minor * 1,000 + release.</td></tr></tbody></table></div><h3><a name="virInitialize" id="virInitialize"><code>virInitialize</code></a></h3><pre class="programlisting">int virInitialize (void)<br />
|
||||
</pre><p>Initialize the library. It's better to call this routine at startup in multithreaded applications to avoid potential race when initializing the library.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNetworkCreate" id="virNetworkCreate"><code>virNetworkCreate</code></a></h3><pre class="programlisting">int virNetworkCreate (<a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> network)<br />
|
||||
</pre><p>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</p><div class="variablelist"><table border="0"><col align="left" /><tbody><tr><td><span class="term"><i><tt>network</tt></i>:</span></td><td>pointer to a defined network</td></tr><tr><td><span class="term"><i><tt>Returns</tt></i>:</span></td><td>0 in case of success, -1 in case of error</td></tr></tbody></table></div><h3><a name="virNetworkCreateXML" id="virNetworkCreateXML"><code>virNetworkCreateXML</code></a></h3><pre class="programlisting"><a href="libvirt-libvirt.html#virNetworkPtr">virNetworkPtr</a> virNetworkCreateXML (<a href="libvirt-libvirt.html#virConnectPtr">virConnectPtr</a> conn, <br /> const char * xmlDesc)<br />
|
||||
|
||||
@ -854,14 +854,14 @@ see note above'/>
|
||||
<arg name='domain' type='virDomainPtr' info='pointer to a defined domain'/>
|
||||
</function>
|
||||
<function name='virDomainCreateLinux' file='libvirt' module='libvirt'>
|
||||
<info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor.</info>
|
||||
<info>Launch a new Linux guest domain, based on an XML description similar to the one returned by virDomainGetXMLDesc() This function may requires privileged access to the hypervisor. The domain is not persistent, so its definition will disappear when it is destroyed, or if the host is restarted (see virDomainDefineXML() to define persistent domains).</info>
|
||||
<return type='virDomainPtr' info='a new domain object or NULL in case of failure'/>
|
||||
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
||||
<arg name='xmlDesc' type='const char *' info='string containing an XML description of the domain'/>
|
||||
<arg name='flags' type='unsigned int' info='an optional set of virDomainFlags'/>
|
||||
</function>
|
||||
<function name='virDomainDefineXML' file='libvirt' module='libvirt'>
|
||||
<info>define a domain, but does not start it</info>
|
||||
<info>Define a domain, but does not start it. This definition is persistent, until explicitly undefined with virDomainUndefine().</info>
|
||||
<return type='virDomainPtr' info='NULL in case of error, a pointer to the domain otherwise'/>
|
||||
<arg name='conn' type='virConnectPtr' info='pointer to the hypervisor connection'/>
|
||||
<arg name='xml' type='const char *' info='the XML description for the domain, preferably in UTF-8'/>
|
||||
@ -1088,7 +1088,7 @@ see note above'/>
|
||||
<arg name='domain' type='virDomainPtr' info='a domain object'/>
|
||||
</function>
|
||||
<function name='virDomainUndefine' file='libvirt' module='libvirt'>
|
||||
<info>undefine a domain but does not stop it if it is running</info>
|
||||
<info>Undefine a domain but does not stop it if it is running</info>
|
||||
<return type='int' info='0 in case of success, -1 in case of error'/>
|
||||
<arg name='domain' type='virDomainPtr' info='pointer to a defined domain'/>
|
||||
</function>
|
||||
|
||||
@ -1420,6 +1420,7 @@
|
||||
<ref name='virDefaultErrorFunc'/>
|
||||
</word>
|
||||
<word name='Define'>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
<ref name='virNetworkDefineXML'/>
|
||||
<ref name='virStoragePoolDefineXML'/>
|
||||
</word>
|
||||
@ -1813,6 +1814,7 @@
|
||||
<ref name='virDomainLookupByID'/>
|
||||
</word>
|
||||
<word name='Undefine'>
|
||||
<ref name='virDomainUndefine'/>
|
||||
<ref name='virNetworkUndefine'/>
|
||||
<ref name='virStoragePoolUndefine'/>
|
||||
</word>
|
||||
@ -2610,7 +2612,7 @@
|
||||
<ref name='virSetErrorFunc'/>
|
||||
</word>
|
||||
<word name='define'>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
</word>
|
||||
<word name='defined'>
|
||||
<ref name='virConnectListDefinedDomains'/>
|
||||
@ -2624,6 +2626,8 @@
|
||||
<ref name='virConnectGetCapabilities'/>
|
||||
</word>
|
||||
<word name='definition'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
<ref name='virStoragePoolCreateXML'/>
|
||||
</word>
|
||||
<word name='defresult'>
|
||||
@ -2656,6 +2660,7 @@
|
||||
<ref name='virDomainMigrate'/>
|
||||
</word>
|
||||
<word name='destroyed'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virStoragePoolCreateXML'/>
|
||||
<ref name='virStoragePoolDestroy'/>
|
||||
</word>
|
||||
@ -2687,6 +2692,7 @@
|
||||
<ref name='virDomainMigrate'/>
|
||||
</word>
|
||||
<word name='disappear'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virStoragePoolCreateXML'/>
|
||||
</word>
|
||||
<word name='disk'>
|
||||
@ -2733,6 +2739,7 @@
|
||||
<ref name='virConnectNumOfDomains'/>
|
||||
<ref name='virConnectOpenReadOnly'/>
|
||||
<ref name='virDomainCreate'/>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainLookupByID'/>
|
||||
<ref name='virDomainMigrate'/>
|
||||
</word>
|
||||
@ -2818,6 +2825,7 @@
|
||||
<ref name='_virNodeInfo'/>
|
||||
</word>
|
||||
<word name='explicitly'>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
<ref name='virStoragePoolDefineXML'/>
|
||||
</word>
|
||||
<word name='extra'>
|
||||
@ -3162,6 +3170,7 @@
|
||||
<word name='host'>
|
||||
<ref name='VIR_NODEINFO_MAXCPUS'/>
|
||||
<ref name='virDomainCoreDump'/>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainGetAutostart'/>
|
||||
<ref name='virDomainMigrate'/>
|
||||
<ref name='virDomainSetAutostart'/>
|
||||
@ -3329,6 +3338,7 @@
|
||||
<ref name='virDomainGetVcpus'/>
|
||||
</word>
|
||||
<word name='its'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainGetName'/>
|
||||
<ref name='virDomainLookupByName'/>
|
||||
<ref name='virDomainLookupByUUID'/>
|
||||
@ -4012,6 +4022,8 @@
|
||||
<ref name='virDomainBlockPeek'/>
|
||||
</word>
|
||||
<word name='persistent'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
<ref name='virStoragePoolCreateXML'/>
|
||||
<ref name='virStoragePoolDefineXML'/>
|
||||
<ref name='virStoragePoolDestroy'/>
|
||||
@ -4274,6 +4286,7 @@
|
||||
<ref name='virDomainReboot'/>
|
||||
</word>
|
||||
<word name='restarted'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainResume'/>
|
||||
<ref name='virStoragePoolCreateXML'/>
|
||||
<ref name='virStoragePoolDestroy'/>
|
||||
@ -4398,6 +4411,7 @@
|
||||
</word>
|
||||
<word name='see'>
|
||||
<ref name='_virError'/>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainGetUUIDString'/>
|
||||
<ref name='virDomainMemoryPeek'/>
|
||||
<ref name='virDomainMigrate'/>
|
||||
@ -4806,10 +4820,8 @@
|
||||
</chunk>
|
||||
<chunk name='chunk8'>
|
||||
<letter name='u'>
|
||||
<word name='undefine'>
|
||||
<ref name='virDomainUndefine'/>
|
||||
</word>
|
||||
<word name='undefined'>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
<ref name='virStoragePoolDefineXML'/>
|
||||
</word>
|
||||
<word name='underlying'>
|
||||
@ -4844,6 +4856,7 @@
|
||||
<ref name='virNodeGetCellsFreeMemory'/>
|
||||
</word>
|
||||
<word name='until'>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
<ref name='virStoragePoolDefineXML'/>
|
||||
</word>
|
||||
<word name='unused'>
|
||||
@ -5002,6 +5015,9 @@
|
||||
<word name='virDomainCreateLinux'>
|
||||
<ref name='virDomainGetXMLDesc'/>
|
||||
</word>
|
||||
<word name='virDomainDefineXML'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
</word>
|
||||
<word name='virDomainFlags'>
|
||||
<ref name='_virDomainInfo'/>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
@ -5049,6 +5065,9 @@
|
||||
<word name='virDomainSave'>
|
||||
<ref name='virDomainRestore'/>
|
||||
</word>
|
||||
<word name='virDomainUndefine'>
|
||||
<ref name='virDomainDefineXML'/>
|
||||
</word>
|
||||
<word name='virDomainXMLFlags'>
|
||||
<ref name='virDomainGetXMLDesc'/>
|
||||
<ref name='virStoragePoolGetXMLDesc'/>
|
||||
@ -5141,6 +5160,8 @@
|
||||
<ref name='virStorageVolCreateXML'/>
|
||||
</word>
|
||||
</letter>
|
||||
</chunk>
|
||||
<chunk name='chunk9'>
|
||||
<letter name='w'>
|
||||
<word name='want'>
|
||||
<ref name='virDomainMemoryPeek'/>
|
||||
@ -5161,6 +5182,7 @@
|
||||
<ref name='virStorageVolGetKey'/>
|
||||
</word>
|
||||
<word name='when'>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainGetAutostart'/>
|
||||
<ref name='virDomainSetAutostart'/>
|
||||
<ref name='virErrorFunc'/>
|
||||
@ -5222,6 +5244,7 @@
|
||||
<ref name='virConnectOpenAuth'/>
|
||||
<ref name='virCopyLastError'/>
|
||||
<ref name='virDomainCoreDump'/>
|
||||
<ref name='virDomainCreateLinux'/>
|
||||
<ref name='virDomainGetMaxVcpus'/>
|
||||
<ref name='virDomainGetName'/>
|
||||
<ref name='virDomainGetSchedulerParameters'/>
|
||||
@ -5283,8 +5306,6 @@
|
||||
<ref name='virConnectGetType'/>
|
||||
</word>
|
||||
</letter>
|
||||
</chunk>
|
||||
<chunk name='chunk9'>
|
||||
<letter name='x'>
|
||||
<word name='xen'>
|
||||
<ref name='virConnectOpen'/>
|
||||
@ -5327,8 +5348,8 @@
|
||||
<chunk name='chunk5' start='m' end='o'/>
|
||||
<chunk name='chunk6' start='p' end='r'/>
|
||||
<chunk name='chunk7' start='s' end='t'/>
|
||||
<chunk name='chunk8' start='u' end='w'/>
|
||||
<chunk name='chunk9' start='x' end='z'/>
|
||||
<chunk name='chunk8' start='u' end='v'/>
|
||||
<chunk name='chunk9' start='w' end='z'/>
|
||||
</chunks>
|
||||
</index>
|
||||
</apirefs>
|
||||
|
||||
@ -1217,6 +1217,9 @@ virDomainGetConnect (virDomainPtr dom)
|
||||
* Launch a new Linux guest domain, based on an XML description similar
|
||||
* to the one returned by virDomainGetXMLDesc()
|
||||
* This function may requires privileged access to the hypervisor.
|
||||
* The domain is not persistent, so its definition will disappear when it
|
||||
* is destroyed, or if the host is restarted (see virDomainDefineXML() to
|
||||
* define persistent domains).
|
||||
*
|
||||
* Returns a new domain object or NULL in case of failure
|
||||
*/
|
||||
@ -2778,7 +2781,9 @@ virDomainMemoryPeek (virDomainPtr dom,
|
||||
* @conn: pointer to the hypervisor connection
|
||||
* @xml: the XML description for the domain, preferably in UTF-8
|
||||
*
|
||||
* define a domain, but does not start it
|
||||
* Define a domain, but does not start it.
|
||||
* This definition is persistent, until explicitly undefined with
|
||||
* virDomainUndefine().
|
||||
*
|
||||
* Returns NULL in case of error, a pointer to the domain otherwise
|
||||
*/
|
||||
@ -2810,7 +2815,7 @@ virDomainDefineXML(virConnectPtr conn, const char *xml) {
|
||||
* virDomainUndefine:
|
||||
* @domain: pointer to a defined domain
|
||||
*
|
||||
* undefine a domain but does not stop it if it is running
|
||||
* Undefine a domain but does not stop it if it is running
|
||||
*
|
||||
* Returns 0 in case of success, -1 in case of error
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user