External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-28 08:35:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add note about numeric domain names to manpage

Browse Source 
Clarify that domains with numeric names can only be identified by
their domain id.
(cherry picked from commit 13c69cd0b4)
This commit is contained in:
Dave Allan 2012-10-01 14:01:36 -04:00 committed by Cole Robinson
parent 2a85eaee82
commit 72ad93f00d
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
tools/virsh.pod
View File

@ -26,12 +26,16 @@ The basic structure of most virsh usage is:
virsh [OPTION]... <command> <domain> [ARG]...
Where I<command> is one of the commands listed below, I<domain> is the numeric
domain id, or the domain name, or the domain UUID and I<ARGS> are command
specific options. There are a few exceptions to this rule in the cases where
the command in question acts on all domains, the entire machine, or directly
on the xen hypervisor. Those exceptions will be clear for each of those
commands.
Where I<command> is one of the commands listed below; I<domain> is the
numeric domain id, or the domain name, or the domain UUID; and I<ARGS>
are command specific options. There are a few exceptions to this rule
in the cases where the command in question acts on all domains, the
entire machine, or directly on the xen hypervisor. Those exceptions
will be clear for each of those commands. Note: it is permissible to
give numeric names to domains, however, doing so will result in a
domain that can only be identified by domain id. In other words, if a
numeric value is supplied it will be interpreted as a domain id, not
as a name.
The B<virsh> program can be used either to run one I<COMMAND> by giving the
command and its arguments on the shell command line, or a I<COMMAND_STRING>