commit 82e8bf90026f70f3b977768f0ba3c8a25c1d31a1
Author: W. David Ashley <w.david.ashley(a)gmail.com>
Date: Thu Aug 20 14:08:38 2015 -0500
Various chapters
- added information for flags parameters
- ficed a few spelling errors
en-US/Guest_Domains.xml | 52 +++++++++++++++++++++++++++++++++++++++--
en-US/Network_Interfaces.xml | 4 ++-
en-US/Storage_Pools.xml | 40 ++++++++++++++++++++++++++++++++
3 files changed, 92 insertions(+), 4 deletions(-)
---
diff --git a/en-US/Guest_Domains.xml b/en-US/Guest_Domains.xml
index 230ef36..859fdca 100644
--- a/en-US/Guest_Domains.xml
+++ b/en-US/Guest_Domains.xml
@@ -176,7 +176,28 @@
upon an error. The <literal>list</literal> can be empty when no
persistent domains
exist.
</para>
-
+ <para>
+ The <literal>listAllDomains</literal> method takes a single
parameter which is a flag specifying
+ a filter for the domains to be listed. If a value of
<code>0</code> is specified then all
+ domains will be listed. Otherwise any or all of the following constants can
be added together
+ to create a filter for the domains to be listed.
+ </para>
+ <simplelist>
+ <member>VIR_CONNECT_LIST_DOMAINS_ACTIVE</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_INACTIVE</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_PERSISTENT</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_TRANSIENT</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_RUNNING</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_PAUSED</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_SHUTOFF</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_OTHER</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_MANAGEDSAVE</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_NO_MANAGEDSAVE</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_AUTOSTART</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_NO_AUTOSTART</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_HAS_SNAPSHOT</member>
+ <member>VIR_CONNECT_LIST_DOMAINS_NO_SNAPSHO</member>
+ </simplelist>
<example>
<title>Fetching all domain objects</title>
<programlisting language="Python"><xi:include
href="extras/Domains-Example-6.py" parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -729,10 +750,26 @@
</para>
<para>
The second parameter of the <literal>migrate</literal> method
specifies a set of flags that control how the
- migration takes place over the connection. If npo flags are needed then
the parameter should
+ migration takes place over the connection. If no flags are needed then
the parameter should
be set to zero.
</para>
<para>
+ Flags may be one of more of the following:
+ </para>
+ <simplelist>
+ <member>VIR_MIGRATE_LIVE</member>
+ <member>VIR_MIGRATE_PEER2PEER</member>
+ <member>VIR_MIGRATE_TUNNELLED</member>
+ <member>VIR_MIGRATE_PERSIST_DEST</member>
+ <member>VIR_MIGRATE_UNDEFINE_SOURCE</member>
+ <member>VIR_MIGRATE_PAUSED</member>
+ <member>VIR_MIGRATE_NON_SHARED_DISK</member>
+ <member>VIR_MIGRATE_NON_SHARED_INC</member>
+ <member>VIR_MIGRATE_CHANGE_PROTECTION</member>
+ <member>VIR_MIGRATE_UNSAFE</member>
+ <member>VIR_MIGRATE_OFFLINE</member>
+ </simplelist>
+ <para>
The third parameter of the <literal>migrate</literal> method
specifies a new name for the domain on the target
of the migration. Not all hypervisors support this operation. If no
rename of the domain is
required then the parameter shoule be set to
<literal>None</literal>.
@@ -978,12 +1015,21 @@
<title>Device configuration</title>
<para>
- Configuration information for a guest domain can be obtained by using the
<literal>XMLSesc</literal>
+ Configuration information for a guest domain can be obtained by using the
<literal>XMLDesc</literal>
method. This method returns the current description of a domain as an XML
data stream.
This stream can then be parsed to obtain detailed information about the
doamin and all the
parts that make up the domain.
</para>
<para>
+ The flags parameter may contain any number of the following constants:
+ </para>
+ <simplelist>
+ <member>VIR_DOMAIN_XML_SECURE</member>
+ <member>VIR_DOMAIN_XML_INACTIVE</member>
+ <member>VIR_DOMAIN_XML_UPDATE_CPU</member>
+ <member>VIR_DOMAIN_XML_MIGRATABLE</member>
+ </simplelist>
+ <para>
The following example shows how to obtain some basic information about the
domain.
</para>
<example>
diff --git a/en-US/Network_Interfaces.xml b/en-US/Network_Interfaces.xml
index d4b8652..beb1c1c 100644
--- a/en-US/Network_Interfaces.xml
+++ b/en-US/Network_Interfaces.xml
@@ -197,7 +197,9 @@
This can be used as a handle to perform further actions on the new
interface,
for example making it active with <literal>create</literal>.
</para>
-
+ <para>
+ Currently the flags parameter should always be
<code>0</code>.
+ </para>
<example id="Example-Defining_a_new_interface">
<title>Defining a new interface</title>
<programlisting language="Python"><xi:include
href="extras/NetworkInterface-Example-11.py" parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
diff --git a/en-US/Storage_Pools.xml b/en-US/Storage_Pools.xml
index bcd085c..c128c9d 100644
--- a/en-US/Storage_Pools.xml
+++ b/en-US/Storage_Pools.xml
@@ -88,6 +88,29 @@
A list of storage pool objects can be obtained using the
<literal>listAllStoragePools</literal> method of the
<literal>virConnect</literal> class.
</para>
+ <para>
+ The flags parameter can be one or more of the following constants:
+ </para>
+ <simplelist>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_ACTIVE</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_PERSISTENT</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_TRANSIENT</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_AUTOSTART</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_NO_AUTOSTART</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_DIR</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_FS</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_NETFS</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_LOGICAL</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_DISK</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_ISCSI</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_SCSI</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_MPATH</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_RBD</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_SHEEPDOG</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_GLUSTER</member>
+ <member>VIR_CONNECT_LIST_STORAGE_POOLS_ZFS</member>
+ </simplelist>
<example>
<title>Get the list of storage pools</title>
<programlisting language="Python"><xi:include
href="extras/StoragePools-Example-1.py" parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -122,6 +145,12 @@
and will remain on the file system after it is released.
</para>
<para>
+ The flags parameter can be one or more of the following constants:
+ </para>
+ <simplelist>
+ <member>VIR_STORAGE_XML_INACTIVE</member>
+ </simplelist>
+ <para>
The following example shows how to get the XML description of a storage
pool.
</para>
<example>
@@ -156,6 +185,10 @@
The sources for a storage pool's sources can be discovered by examining
the pool's XML
description. An example program follows that prints out a pools source
description attributes.
</para>
+ <para>
+ Currently the flags parameter for the
<literal>storagePoolCreateXML</literal> method
+ should always be <code>0</code>.
+ </para>
<example>
<title>Discover a storage pool's sources</title>
<programlisting language="Python"><xi:include
href="extras/StoragePools-Example-5.py" parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
@@ -216,6 +249,13 @@
and attributes of the storage volume are specified in the XML passed to the
<literal>createXML</literal> method.
</para>
+ <para>
+ The flags parameter can be one or more of the following constants:
+ </para>
+ <simplelist>
+ <member>VIR_STORAGE_VOL_CREATE_PREALLOC_METADATA</member>
+
<member>VIR_STORAGE_VOL_CREATE_REFLINKVIR_CONNECT_LIST_STORAGE_POOLS_INACTIVE</member>
+ </simplelist>
<example>
<title>Create a storage volume</title>
<programlisting language="Python"><xi:include
href="extras/StoragePools-Example-9.py" parse="text"
xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>