[libvirt] [PATCH] virsh man page - domain-id consistency
Jan Tomko
jtomko at redhat.com
Wed Jul 18 16:03:19 UTC 2012
Using 'domain-id' to represent domain name, domain id or uuid,
as introduced in the DOMAIN COMMANDS section.
---
tools/virsh.pod | 86 +++++++++++++++++++++++++++---------------------------
1 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 4bddf15..ed1efde 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -580,11 +580,11 @@ If I<--graceful> is specified, don't resort to extreme measures
(e.g. SIGKILL) when the guest doesn't stop after a reasonable timeout;
return an error instead.
-=item B<domblkstat> I<domain> I<block-device> [I<--human>]
+=item B<domblkstat> I<domain-id> I<block-device> [I<--human>]
Get device block stats for a running domain. A I<block-device> corresponds
to a unique target name (<target dev='name'/>) or source file (<source
-file='name'/>) for one of the disk devices attached to I<domain> (see
+file='name'/>) for one of the disk devices attached to I<domain-id> (see
also B<domblklist> for listing these names).
Use I<--human> for a more human readable output.
@@ -605,11 +605,11 @@ B<Explanation of fields> (fields appear in the folowing order):
flush_total_times - total time flush operations took (ns)
<-- other fields provided by hypervisor -->
-=item B<domifstat> I<domain> I<interface-device>
+=item B<domifstat> I<domain-id> I<interface-device>
Get network interface stats for a running domain.
-=item B<domif-setlink> I<domain> I<interface-device> I<state> [I<--config>]
+=item B<domif-setlink> I<domain-id> I<interface-device> I<state> [I<--config>]
Modify link state of the domain's virtual interface. Possible values for
state are "up" and "down. If I<--config> is specified, only the persistent
@@ -617,7 +617,7 @@ configuration of the domain is modified, for compatibility purposes,
I<--persistent> is alias of I<--config>.
I<interface-device> can be the interface's target name or the MAC address.
-=item B<domif-getlink> I<domain> I<interface-device> [I<--config>]
+=item B<domif-getlink> I<domain-id> I<interface-device> [I<--config>]
Query link state of the domain's virtual interface. If I<--config>
is specified, query the persistent configuration, for compatibility
@@ -625,7 +625,7 @@ purposes, I<--persistent> is alias of I<--config>.
I<interface-device> can be the interface's target name or the MAC address.
-=item B<domiftune> I<domain> I<interface-device>
+=item B<domiftune> I<domain-id> I<interface-device>
[[I<--config>] [I<--live>] | [I<--current>]]
[I<--inbound average,peak,burst>]
[I<--outbound average,peak,burst>]
@@ -646,7 +646,7 @@ Both I<--live> and I<--current> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.
-=item B<dommemstat> I<domain>
+=item B<dommemstat> I<domain-id>
Get memory stats for a running domain.
@@ -657,17 +657,17 @@ B<domstate> command says that a domain was paused due to I/O error.
The B<domblkerror> command lists all block devices in error state and
the error seen on each of them.
-=item B<domblkinfo> I<domain> I<block-device>
+=item B<domblkinfo> I<domain-id> I<block-device>
Get block device size info for a domain. A I<block-device> corresponds
to a unique target name (<target dev='name'/>) or source file (<source
-file='name'/>) for one of the disk devices attached to I<domain> (see
+file='name'/>) for one of the disk devices attached to I<domain-id> (see
also B<domblklist> for listing these names).
-=item B<domblklist> I<domain> [I<--inactive>] [I<--details>]
+=item B<domblklist> I<domain-id> [I<--inactive>] [I<--details>]
Print a table showing the brief information of all block devices
-associated with I<domain>. If I<--inactive> is specified, query the
+associated with I<domain-id>. If I<--inactive> is specified, query the
block devices that will be used on the next boot, rather than those
currently in use by a running domain. If I<--details> is specified,
disk type and device value will also be printed. Other contexts
@@ -675,16 +675,16 @@ that require a block device name (such as I<domblkinfo> or
I<snapshot-create> for disk snapshots) will accept either target
or unique source names printed by this command.
-=item B<domiflist> I<domain> [I<--inactive>]
+=item B<domiflist> I<domain-id> [I<--inactive>]
Print a table showing the brief information of all virtual interfaces
-associated with I<domain>. If I<--inactive> is specified, query the
+associated with I<domain-id>. If I<--inactive> is specified, query the
virtual interfaces that will be used on the next boot, rather than those
currently in use by a running domain. Other contexts that require a MAC
address of virtual interface (such as I<detach-interface> or
I<domif-setlink>) will accept the MAC address printed by this command.
-=item B<blockcopy> I<domain> I<path> I<dest> [I<bandwidth>] [I<--shallow>]
+=item B<blockcopy> I<domain-id> I<path> I<dest> [I<bandwidth>] [I<--shallow>]
[I<--reuse-external>] [I<--raw>] [I<--wait> [I<--verbose]
[{I<--pivot> | I<--finish>}] [I<--timeout> B<seconds>] [I<--async>]]
@@ -725,7 +725,7 @@ is done cleaning up.
I<path> specifies fully-qualified path of the disk.
I<bandwidth> specifies copying bandwidth limit in Mbps.
-=item B<blockpull> I<domain> I<path> [I<bandwidth>] [I<base>]
+=item B<blockpull> I<domain-id> I<path> [I<bandwidth>] [I<base>]
[I<--wait> [I<--verbose>] [I<--timeout> B<seconds>] [I<--async]]
Populate a disk from its backing image chain. By default, this command
@@ -748,19 +748,19 @@ longer until the job is done cleaning up.
I<path> specifies fully-qualified path of the disk; it corresponds
to a unique target name (<target dev='name'/>) or source file (<source
-file='name'/>) for one of the disk devices attached to I<domain> (see
+file='name'/>) for one of the disk devices attached to I<domain-id> (see
also B<domblklist> for listing these names).
I<bandwidth> specifies copying bandwidth limit in Mbps.
-=item B<blkdeviotune> I<domain> I<device>
+=item B<blkdeviotune> I<domain-id> I<device>
[[I<--config>] [I<--live>] | [I<--current>]]
[[I<total-bytes-sec>] | [I<read-bytes-sec>] [I<write-bytes-sec>]]
[[I<total-iops-sec>] | [I<read-iops-sec>] [I<write-iops-sec>]]
-Set or query the block disk io parameters for a block device of I<domain>.
+Set or query the block disk io parameters for a block device of I<domain-id>.
I<device> specifies a unique target name (<target dev='name'/>) or source
file (<source file='name'/>) for one of the disk devices attached to
-I<domain> (see also B<domblklist> for listing these names).
+I<domain-id> (see also B<domblklist> for listing these names).
If no limit is specified, it will query current I/O limits setting.
Otherwise, alter the limits with these flags:
@@ -786,7 +786,7 @@ Both I<--live> and I<--current> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.
-=item B<blockjob> I<domain> I<path> { [I<--abort>] [I<--async>] [I<--pivot>] |
+=item B<blockjob> I<domain-id> I<path> { [I<--abort>] [I<--async>] [I<--pivot>] |
[I<--info>] | [I<bandwidth>] }
Manage active block operations. There are three modes: I<--info>,
@@ -795,7 +795,7 @@ or I<--pivot> implies I<--abort>.
I<path> specifies fully-qualified path of the disk; it corresponds
to a unique target name (<target dev='name'/>) or source file (<source
-file='name'/>) for one of the disk devices attached to I<domain> (see
+file='name'/>) for one of the disk devices attached to I<domain-id> (see
also B<domblklist> for listing these names).
If I<--abort> is specified, the active job on the specified disk will
@@ -807,12 +807,12 @@ If I<--info> is specified, the active job information on the specified
disk will be printed.
I<bandwidth> can be used to set bandwidth limit for the active job.
-=item B<blockresize> I<domain> I<path> I<size>
+=item B<blockresize> I<domain-id> I<path> I<size>
Resize a block device of domain while the domain is running, I<path>
specifies the absolute path of the block device; it corresponds
to a unique target name (<target dev='name'/>) or source file (<source
-file='name'/>) for one of the disk devices attached to I<domain> (see
+file='name'/>) for one of the disk devices attached to I<domain-id> (see
also B<domblklist> for listing these names).
I<size> is a scaled integer (see B<NOTES> above) which defaults to KiB
@@ -838,11 +838,11 @@ Convert a domain name or id to domain UUID
Convert a domain name (or UUID) to a domain id
-=item B<domjobabort> I<domain-id-or-uuid>
+=item B<domjobabort> I<domain-id>
Abort the currently running domain job.
-=item B<domjobinfo> I<domain-id-or-uuid>
+=item B<domjobinfo> I<domain-id>
Returns information about jobs running on a domain.
@@ -959,7 +959,7 @@ Provide the maximum number of virtual CPUs supported for a guest VM on
this connection. If provided, the I<type> parameter must be a valid
type attribute for the <domain> element of XML.
-=item B<cpu-stats> I<domain> [I<--total>] [I<start>] [I<count>]
+=item B<cpu-stats> I<domain-id> [I<--total>] [I<start>] [I<count>]
Provide cpu statistics information of a domain. The domain should
be running. Default it shows stats for all CPUs, and a total. Use
@@ -1045,7 +1045,7 @@ migrated to another host.
Get the maximum migration bandwidth (in Mbps) for a domain.
-=item B<numatune> I<domain> [I<--mode> B<mode>] [I<--nodeset> B<nodeset>]
+=item B<numatune> I<domain-id> [I<--mode> B<mode>] [I<--nodeset> B<nodeset>]
[[I<--config>] [I<--live>] | [I<--current>]]
Set or get a domain's numa parameters, corresponding to the <numatune>
@@ -1470,7 +1470,7 @@ By default the hypervisor will try to pick a suitable shutdown
method. To specify an alternative method, the I<--mode> parameter
can specify C<acpi> or C<agent>.
-=item B<start> I<domain-name> [I<--console>] [I<--paused>] [I<--autodestroy>]
+=item B<start> I<domain-name-or-uuid> [I<--console>] [I<--paused>] [I<--autodestroy>]
[I<--bypass-cache>] [I<--force-boot>]
Start a (previously defined) inactive domain, either from the last
@@ -2424,11 +2424,11 @@ used to represent properties of snapshots.
=over 4
-=item B<snapshot-create> I<domain> [I<xmlfile>] {[I<--redefine> [I<--current>]]
+=item B<snapshot-create> I<domain-id> [I<xmlfile>] {[I<--redefine> [I<--current>]]
| [I<--no-metadata>] [I<--halt>] [I<--disk-only>] [I<--reuse-external>]
[I<--quiesce>] [I<--atomic>]}
-Create a snapshot for domain I<domain> with the properties specified in
+Create a snapshot for domain I<domain-id> with the properties specified in
I<xmlfile>. Normally, the only properties settable for a domain snapshot
are the <name> and <description> elements, as well as <disks> if
I<--disk-only> is given; the rest of the fields are
@@ -2484,12 +2484,12 @@ a persistent domain. However, for transient domains, snapshot
metadata is silently lost when the domain quits running (whether
by command such as B<destroy> or by internal guest action).
-=item B<snapshot-create-as> I<domain> {[I<--print-xml>]
+=item B<snapshot-create-as> I<domain-id> {[I<--print-xml>]
| [I<--no-metadata>] [I<--halt>] [I<--reuse-external>]} [I<name>]
[I<description>] [I<--disk-only> [I<--quiesce>] [I<--atomic>]
[[I<--diskspec>] B<diskspec>]...]
-Create a snapshot for domain I<domain> with the given <name> and
+Create a snapshot for domain I<domain-id> with the given <name> and
<description>; if either value is omitted, libvirt will choose a
value. If I<--print-xml> is specified, then XML appropriate for
I<snapshot-create> is output, rather than actually creating a snapshot.
@@ -2503,7 +2503,7 @@ arguments to add <disk> elements to the xml. Each <diskspec> is in the
form B<disk[,snapshot=type][,driver=type][,file=name]>. To include a
literal comma in B<disk> or in B<file=name>, escape it with a second
comma. A literal I<--diskspec> must preceed each B<diskspec> unless
-all three of I<domain>, I<name>, and I<description> are also present.
+all three of I<domain-id>, I<name>, and I<description> are also present.
For example, a diskspec of "vda,snapshot=external,file=/path/to,,new"
results in the following XML:
<disk name='vda' snapshot='external'>
@@ -2532,7 +2532,7 @@ this. If this flag is not specified, then some hypervisors may fail
after partially performing the action, and B<dumpxml> must be used to
see whether any partial changes occurred.
-=item B<snapshot-current> I<domain> {[I<--name>] | [I<--security-info>]
+=item B<snapshot-current> I<domain-id> {[I<--name>] | [I<--security-info>]
| [I<snapshotname>]}
Without I<snapshotname>, this will output the snapshot XML for the domain's
@@ -2544,7 +2544,7 @@ the XML.
With I<snapshotname>, this is a request to make the existing named
snapshot become the current snapshot, without reverting the domain.
-=item B<snapshot-edit> I<domain> [I<snapshotname>] [I<--current>]
+=item B<snapshot-edit> I<domain-id> [I<snapshotname>] [I<--current>]
{[I<--rename>] | [I<--clone>]}
Edit the XML configuration file for I<snapshotname> of a domain. If
@@ -2572,12 +2572,12 @@ a snapshot name must be done with care, since the contents of some
snapshots, such as internal snapshots within a single qcow2 file, are
accessible only from the original name.
-=item B<snapshot-info> I<domain> {I<snapshot> | I<--current>}
+=item B<snapshot-info> I<domain-id> {I<snapshot> | I<--current>}
Output basic information about a named <snapshot>, or the current snapshot
with I<--current>.
-=item B<snapshot-list> I<domain> [{I<--parent> | I<--roots> | I<--tree>}]
+=item B<snapshot-list> I<domain-id> [{I<--parent> | I<--roots> | I<--tree>}]
[{[I<--from>] B<snapshot> | I<--current>} [I<--descendants>]]
[I<--metadata>] [I<--no-metadata>] [I<--leaves>] [I<--no-leaves>]
@@ -2613,18 +2613,18 @@ a transient domain. Likewise, if I<--no-metadata> is specified,
the list will be filtered to just snapshots that exist without
the need for libvirt metadata.
-=item B<snapshot-dumpxml> I<domain> I<snapshot> [I<--security-info>]
+=item B<snapshot-dumpxml> I<domain-id> I<snapshot> [I<--security-info>]
Output the snapshot XML for the domain's snapshot named I<snapshot>.
Using I<--security-info> will also include security sensitive information.
Use B<snapshot-current> to easily access the XML of the current snapshot.
-=item B<snapshot-parent> I<domain> {I<snapshot> | I<--current>}
+=item B<snapshot-parent> I<domain-id> {I<snapshot> | I<--current>}
Output the name of the parent snapshot, if any, for the given
I<snapshot>, or for the current snapshot with I<--current>.
-=item B<snapshot-revert> I<domain> {I<snapshot> | I<--current>}
+=item B<snapshot-revert> I<domain-id> {I<snapshot> | I<--current>}
[{I<--running> | I<--paused>}] [I<--force>]
Revert the given domain to the snapshot specified by I<snapshot>, or to
@@ -2658,7 +2658,7 @@ snapshot that uses a provably incompatible configuration, as well as
with an inactive snapshot that is combined with the I<--start> or
I<--pause> flag.
-=item B<snapshot-delete> I<domain> {I<snapshot> | I<--current>} [I<--metadata>]
+=item B<snapshot-delete> I<domain-id> {I<snapshot> | I<--current>} [I<--metadata>]
[{I<--children> | I<--children-only>}]
Delete the snapshot for the domain named I<snapshot>, or the current
@@ -2761,9 +2761,9 @@ attaching to an externally launched QEMU process. There may be
issues with the guest ABI changing upon migration, and hotunplug
may not work.
-=item B<qemu-monitor-command> I<domain> [I<--hmp>] I<command>...
+=item B<qemu-monitor-command> I<domain-id> [I<--hmp>] I<command>...
-Send an arbitrary monitor command I<command> to domain I<domain> through the
+Send an arbitrary monitor command I<command> to domain I<domain-id> through the
qemu monitor. The results of the command will be printed on stdout. If
I<--hmp> is passed, the command is considered to be a human monitor command
and libvirt will automatically convert it into QMP if needed. In that case
--
1.7.8.6
More information about the libvir-list
mailing list