2007-06-21 07:39:51 +00:00
|
|
|
=head1 NAME
|
|
|
|
|
|
|
|
virsh - management user interface
|
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
2010-10-12 07:14:01 +00:00
|
|
|
B<virsh> [I<OPTION>]... [I<COMMAND_STRING>]
|
|
|
|
|
|
|
|
B<virsh> [I<OPTION>]... I<COMMAND> [I<ARG>]...
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
|
|
|
The B<virsh> program is the main interface for managing virsh guest
|
|
|
|
domains. The program can be used to create, pause, and shutdown
|
2010-03-12 16:25:37 +00:00
|
|
|
domains. It can also be used to list current domains. Libvirt is a C
|
|
|
|
toolkit to interact with the virtualization capabilities of recent
|
|
|
|
versions of Linux (and other OSes). It is free software available
|
|
|
|
under the GNU Lesser General Public License. Virtualization of the
|
|
|
|
Linux Operating System means the ability to run multiple instances of
|
|
|
|
Operating Systems concurrently on a single hardware system where the
|
|
|
|
basic resources are driven by a Linux instance. The library aims at
|
2014-06-18 09:19:12 +00:00
|
|
|
providing a long term stable C API. It currently supports Xen, QEMU,
|
Remove the Open Nebula driver
The Open Nebula driver has been unmaintained since it was first
introduced. The only commits have been for tree-wide cleanups.
It also has a major design flaw, in that it only knows about guests
that it has created itself, which makes it of very limited use.
Discussions wrt evolution of the VMWare ESX driver, concluded that
it should limit itself to single-node ESX operation and not try to
manage the multi-node architecture of VirtualCenter. Open Nebula
is a cluster like Virtual Center, not a single node system, so
the same reasoning applies.
The DeltaCloud project includes an Open Nebula driver and is a much
better fit architecturally, since it is explicitly targetting the
distributed multihost cluster scenario.
Thus this patch deletes the libvirt Open Nebula driver with the
recommendation that people use DeltaCloud for managing it instead.
* configure.ac: Remove probe for xmlrpc & --with-one arg
* daemon/Makefile.am, daemon/libvirtd.c, src/Makefile.am: Remove
ONE driver build
* src/opennebula/one_client.c, src/opennebula/one_client.h,
src/opennebula/one_conf.c, src/opennebula/one_conf.h,
src/opennebula/one_driver.c, src/opennebula/one_driver.c: Delete
files
* autobuild.sh, libvirt.spec.in, mingw32-libvirt.spec.in: Remove
build rules for Open Nebula
* docs/drivers.html.in, docs/sitemap.html.in: Remove reference
to OpenNebula
* docs/drvone.html.in: Delete file
2011-03-22 16:12:34 +00:00
|
|
|
KVM, LXC, OpenVZ, VirtualBox and VMware ESX.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
The basic structure of most virsh usage is:
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
virsh [OPTION]... <command> <domain> [ARG]...
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-10-01 18:01:36 +00:00
|
|
|
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.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2010-10-12 07:14:01 +00:00
|
|
|
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>
|
|
|
|
which is a single shell argument consisting of multiple I<COMMAND> actions
|
|
|
|
and their arguments joined with whitespace, and separated by semicolons
|
|
|
|
between commands. Within I<COMMAND_STRING>, virsh understands the
|
|
|
|
same single, double, and backslash escapes as the shell, although you must
|
|
|
|
add another layer of shell escaping in creating the single shell argument.
|
|
|
|
If no command is given in the command line, B<virsh> will then start a minimal
|
|
|
|
interpreter waiting for your commands, and the B<quit> command will then exit
|
2007-06-21 15:00:17 +00:00
|
|
|
the program.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2010-10-12 20:49:28 +00:00
|
|
|
The B<virsh> program understands the following I<OPTIONS>.
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item B<-c>, B<--connect> I<URI>
|
|
|
|
|
|
|
|
Connect to the specified I<URI>, as if by the B<connect> command,
|
|
|
|
instead of the default connection.
|
|
|
|
|
|
|
|
=item B<-d>, B<--debug> I<LEVEL>
|
|
|
|
|
|
|
|
Enable debug messages at integer I<LEVEL> and above. I<LEVEL> can
|
2011-08-26 09:02:10 +00:00
|
|
|
range from 0 to 4 (default). See the documentation of B<VIRSH_DEBUG>
|
2012-03-22 02:07:51 +00:00
|
|
|
environment variable below for the description of each I<LEVEL>.
|
2010-10-12 20:49:28 +00:00
|
|
|
|
2014-03-06 15:53:53 +00:00
|
|
|
=item B<-e>, B<--escape> I<string>
|
|
|
|
|
|
|
|
Set alternative escape sequence for I<console> command. By default,
|
|
|
|
telnet's B<^]> is used. Allowed characters when using hat notation are:
|
|
|
|
alphabetic character, @, [, ], \, ^, _.
|
|
|
|
|
|
|
|
=item B<-h>, B<--help>
|
|
|
|
|
|
|
|
Ignore all other arguments, and behave as if the B<help> command were
|
|
|
|
given instead.
|
|
|
|
|
2014-03-06 16:20:11 +00:00
|
|
|
=item B<-k>, B<--keepalive-interval> I<INTERVAL>
|
|
|
|
|
|
|
|
Set an I<INTERVAL> (in seconds) for sending keepalive messages to
|
|
|
|
check whether connection to the server is still alive. Setting the
|
|
|
|
interval to 0 disables client keepalive mechanism.
|
|
|
|
|
|
|
|
=item B<-K>, B<--keepalive-count> I<COUNT>
|
|
|
|
|
|
|
|
Set a number of times keepalive message can be sent without getting an
|
|
|
|
answer from the server without marking the connection dead. There is
|
|
|
|
no effect to this setting in case the I<INTERVAL> is set to 0.
|
|
|
|
|
2010-10-12 20:49:28 +00:00
|
|
|
=item B<-l>, B<--log> I<FILE>
|
|
|
|
|
|
|
|
Output logging details to I<FILE>.
|
|
|
|
|
|
|
|
=item B<-q>, B<--quiet>
|
|
|
|
|
|
|
|
Avoid extra informational messages.
|
|
|
|
|
|
|
|
=item B<-r>, B<--readonly>
|
|
|
|
|
|
|
|
Make the initial connection read-only, as if by the I<--readonly>
|
|
|
|
option of the B<connect> command.
|
|
|
|
|
|
|
|
=item B<-t>, B<--timing>
|
|
|
|
|
|
|
|
Output elapsed time information for each command.
|
|
|
|
|
2014-03-06 15:53:53 +00:00
|
|
|
=item B<-v>, B<--version[=short]>
|
2011-11-22 16:08:05 +00:00
|
|
|
|
2014-03-06 15:53:53 +00:00
|
|
|
Ignore all other arguments, and prints the version of the libvirt library
|
|
|
|
virsh is coming from
|
|
|
|
|
|
|
|
=item B<-V>, B<--version=long>
|
|
|
|
|
|
|
|
Ignore all other arguments, and prints the version of the libvirt library
|
|
|
|
virsh is coming from and which options and driver are compiled in.
|
2011-11-22 16:08:05 +00:00
|
|
|
|
2010-10-12 20:49:28 +00:00
|
|
|
=back
|
|
|
|
|
2007-06-21 07:39:51 +00:00
|
|
|
=head1 NOTES
|
|
|
|
|
2010-03-12 16:25:37 +00:00
|
|
|
Most B<virsh> operations rely upon the libvirt library being able to
|
|
|
|
connect to an already running libvirtd service. This can usually be
|
|
|
|
done using the command B<service libvirtd start>.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-08-14 07:02:18 +00:00
|
|
|
Most B<virsh> commands require root privileges to run due to the
|
2007-06-21 07:39:51 +00:00
|
|
|
communications channels used to talk to the hypervisor. Running as
|
|
|
|
non root will return an error.
|
|
|
|
|
2009-11-18 10:53:41 +00:00
|
|
|
Most B<virsh> commands act synchronously, except maybe shutdown,
|
2010-04-12 12:22:02 +00:00
|
|
|
setvcpus and setmem. In those cases the fact that the B<virsh>
|
2009-11-18 10:53:41 +00:00
|
|
|
program returned, may not mean the action is complete and you
|
|
|
|
must poll periodically to detect that the guest completed the
|
|
|
|
operation.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-03-02 18:01:15 +00:00
|
|
|
B<virsh> strives for backward compatibility. Although the B<help>
|
|
|
|
command only lists the preferred usage of a command, if an older
|
|
|
|
version of B<virsh> supported an alternate spelling of a command or
|
|
|
|
option (such as I<--tunnelled> instead of I<--tunneled>), then
|
|
|
|
scripts using that older spelling will continue to work.
|
|
|
|
|
2012-03-08 01:10:30 +00:00
|
|
|
Several B<virsh> commands take an optionally scaled integer; if no
|
|
|
|
scale is provided, then the default is listed in the command (for
|
|
|
|
historical reasons, some commands default to bytes, while other
|
|
|
|
commands default to kibibytes). The following case-insensitive
|
2012-10-11 16:31:20 +00:00
|
|
|
suffixes can be used to select a specific scale:
|
2012-03-08 01:10:30 +00:00
|
|
|
b, byte byte 1
|
|
|
|
KB kilobyte 1,000
|
|
|
|
k, KiB kibibyte 1,024
|
|
|
|
MB megabyte 1,000,000
|
|
|
|
M, MiB mebibyte 1,048,576
|
|
|
|
GB gigabyte 1,000,000,000
|
|
|
|
G, GiB gibibyte 1,073,741,824
|
|
|
|
TB terabyte 1,000,000,000,000
|
|
|
|
T, TiB tebibyte 1,099,511,627,776
|
|
|
|
PB petabyte 1,000,000,000,000,000
|
|
|
|
P, PiB pebibyte 1,125,899,906,842,624
|
|
|
|
EB exabyte 1,000,000,000,000,000,000
|
|
|
|
E, EiB exbibyte 1,152,921,504,606,846,976
|
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=head1 GENERIC COMMANDS
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
The following commands are generic i.e. not specific to a domain.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<help> [I<command-or-group>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2010-12-02 12:49:38 +00:00
|
|
|
This lists each of the virsh commands. When used without options, all
|
|
|
|
commands are listed, one per line, grouped into related categories,
|
|
|
|
displaying the keyword for each group.
|
|
|
|
|
|
|
|
To display only commands for a specific group, give the keyword for that
|
|
|
|
group as an option. For example:
|
|
|
|
|
|
|
|
virsh # help host
|
|
|
|
|
|
|
|
Host and Hypervisor (help keyword 'host'):
|
|
|
|
capabilities capabilities
|
2013-09-23 09:46:03 +00:00
|
|
|
cpu-models show the CPU models for an architecture
|
2010-12-02 12:49:38 +00:00
|
|
|
connect (re)connect to hypervisor
|
|
|
|
freecell NUMA free memory
|
|
|
|
hostname print the hypervisor hostname
|
2011-05-05 16:32:07 +00:00
|
|
|
qemu-attach Attach to existing QEMU process
|
|
|
|
qemu-monitor-command QEMU Monitor Command
|
2012-08-23 03:29:27 +00:00
|
|
|
qemu-agent-command QEMU Guest Agent Command
|
2011-02-07 22:13:48 +00:00
|
|
|
sysinfo print the hypervisor sysinfo
|
2010-12-02 12:49:38 +00:00
|
|
|
uri print the hypervisor canonical URI
|
|
|
|
|
|
|
|
To display detailed information for a specific command, give its name as the
|
|
|
|
option instead. For example:
|
|
|
|
|
|
|
|
virsh # help list
|
|
|
|
NAME
|
|
|
|
list - list domains
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
list [--inactive] [--all]
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
Returns list of domains.
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
--inactive list inactive domains
|
|
|
|
--all list inactive & active domains
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2010-03-30 20:50:35 +00:00
|
|
|
=item B<quit>, B<exit>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
quit this interactive terminal
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2014-06-18 09:16:33 +00:00
|
|
|
=item B<version> [I<--daemon>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-02-05 19:27:37 +00:00
|
|
|
Will print out the major version info about what this built from.
|
2014-06-18 09:16:33 +00:00
|
|
|
If I<--daemon> is specified then the version of the libvirt daemon
|
|
|
|
is included in the output.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=over 4
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-02-05 19:27:37 +00:00
|
|
|
B<Example>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2014-06-18 09:16:33 +00:00
|
|
|
$ virsh version
|
|
|
|
Compiled against library: libvirt 1.2.3
|
|
|
|
Using library: libvirt 1.2.3
|
|
|
|
Using API: QEMU 1.2.3
|
|
|
|
Running hypervisor: QEMU 2.0.50
|
|
|
|
|
|
|
|
$ virsh version --daemon
|
|
|
|
Compiled against library: libvirt 1.2.3
|
|
|
|
Using library: libvirt 1.2.3
|
|
|
|
Using API: QEMU 1.2.3
|
|
|
|
Running hypervisor: QEMU 2.0.50
|
|
|
|
Running against daemon: 1.2.6
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=back
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<cd> [I<directory>]
|
2009-07-16 14:40:08 +00:00
|
|
|
|
|
|
|
Will change current directory to I<directory>. The default directory
|
|
|
|
for the B<cd> command is the home directory or, if there is no I<HOME>
|
|
|
|
variable in the environment, the root directory.
|
|
|
|
|
|
|
|
This command is only available in interactive mode.
|
|
|
|
|
|
|
|
=item B<pwd>
|
|
|
|
|
|
|
|
Will print the current directory.
|
|
|
|
|
2013-12-16 12:37:12 +00:00
|
|
|
=item B<connect> [I<URI>] [I<--readonly>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
(Re)-Connect to the hypervisor. When the shell is first started, this
|
|
|
|
is automatically run with the I<URI> parameter requested by the C<-c>
|
|
|
|
option on the command line. The I<URI> parameter specifies how to
|
|
|
|
connect to the hypervisor. The documentation page at
|
|
|
|
L<http://libvirt.org/uri.html> list the values supported, but the most
|
|
|
|
common are:
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=over 4
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:46:04 +00:00
|
|
|
=item xen:///
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2013-12-16 12:37:12 +00:00
|
|
|
this is used to connect to the local Xen hypervisor
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=item qemu:///system
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2014-06-18 09:19:12 +00:00
|
|
|
connect locally as root to the daemon supervising QEMU and KVM domains
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=item qemu:///session
|
|
|
|
|
2014-06-18 09:19:12 +00:00
|
|
|
connect locally as a normal user to his own set of QEMU and KVM domains
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2010-01-17 23:48:39 +00:00
|
|
|
=item lxc:///
|
|
|
|
|
|
|
|
connect to a local linux container
|
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=back
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2014-08-11 20:02:13 +00:00
|
|
|
To find the currently used URI, check the I<uri> command documented below.
|
|
|
|
|
2012-03-22 02:07:51 +00:00
|
|
|
For remote access see the documentation page at
|
|
|
|
L<http://libvirt.org/uri.html> on how to make URIs.
|
2007-06-21 15:00:17 +00:00
|
|
|
The I<--readonly> option allows for read-only connection
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-04-15 15:20:43 +00:00
|
|
|
=item B<uri>
|
|
|
|
|
|
|
|
Prints the hypervisor canonical URI, can be useful in shell mode.
|
|
|
|
|
|
|
|
=item B<hostname>
|
|
|
|
|
|
|
|
Print the hypervisor hostname.
|
|
|
|
|
2011-02-07 22:13:48 +00:00
|
|
|
=item B<sysinfo>
|
|
|
|
|
|
|
|
Print the XML representation of the hypervisor sysinfo, if available.
|
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=item B<nodeinfo>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
Returns basic information about the node, like number and type of CPU,
|
2011-06-02 08:56:43 +00:00
|
|
|
and size of the physical memory. The output corresponds to virNodeInfo
|
|
|
|
structure. Specifically, the "CPU socket(s)" field means number of CPU
|
2015-07-10 09:05:07 +00:00
|
|
|
sockets per NUMA cell. The information libvirt displays is dependent
|
|
|
|
upon what each architecture may provide.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2014-06-05 11:16:00 +00:00
|
|
|
=item B<nodecpumap> [I<--pretty>]
|
2012-10-16 14:05:13 +00:00
|
|
|
|
|
|
|
Displays the node's total number of CPUs, the number of online CPUs
|
|
|
|
and the list of online CPUs.
|
|
|
|
|
2014-06-05 11:16:00 +00:00
|
|
|
With I<--pretty> the online CPUs are printed as a range instead of a list.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<nodecpustats> [I<cpu>] [I<--percent>]
|
2011-06-07 01:02:13 +00:00
|
|
|
|
|
|
|
Returns cpu stats of the node.
|
|
|
|
If I<cpu> is specified, this will prints specified cpu statistics only.
|
|
|
|
If I<--percent> is specified, this will prints percentage of each kind of cpu
|
|
|
|
statistics during 1 second.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<nodememstats> [I<cell>]
|
2011-06-07 01:09:15 +00:00
|
|
|
|
|
|
|
Returns memory stats of the node.
|
|
|
|
If I<cell> is specified, this will prints specified cell statistics only.
|
|
|
|
|
2012-10-25 08:14:38 +00:00
|
|
|
=item B<nodesuspend> [I<target>] [I<duration>]
|
2011-11-28 21:42:44 +00:00
|
|
|
|
2014-01-22 06:55:34 +00:00
|
|
|
Puts the node (host machine) into a system-wide sleep state and schedule
|
|
|
|
the node's Real-Time-Clock interrupt to resume the node after the time
|
|
|
|
duration specified by I<duration> is out.
|
|
|
|
I<target> specifies the state to which the host will be suspended to, it
|
|
|
|
can be "mem" (suspend to RAM), "disk" (suspend to disk), or "hybrid"
|
|
|
|
(suspend to both RAM and disk). I<duration> specifies the time duration
|
|
|
|
in seconds for which the host has to be suspended, it should be at least
|
|
|
|
60 seconds.
|
2011-11-28 21:42:44 +00:00
|
|
|
|
2012-09-14 14:42:18 +00:00
|
|
|
=item B<node-memory-tune> [I<shm-pages-to-scan>] [I<shm-sleep-millisecs>]
|
2014-02-04 08:47:32 +00:00
|
|
|
[I<shm-merge-across-nodes>]
|
2012-09-14 14:42:18 +00:00
|
|
|
|
|
|
|
Allows you to display or set the node memory parameters.
|
|
|
|
I<shm-pages-to-scan> can be used to set the number of pages to scan
|
|
|
|
before the shared memory service goes to sleep; I<shm-sleep-millisecs>
|
|
|
|
can be used to set the number of millisecs the shared memory service should
|
2012-10-12 08:25:42 +00:00
|
|
|
sleep before next scan; I<shm-merge-across-nodes> specifies if pages from
|
|
|
|
different numa nodes can be merged. When set to 0, only pages which physically
|
|
|
|
reside in the memory area of same NUMA node can be merged. When set to 1,
|
|
|
|
pages from all nodes can be merged. Default to 1.
|
2012-09-14 14:42:18 +00:00
|
|
|
|
2014-01-22 06:55:35 +00:00
|
|
|
B<Note>: Currently the "shared memory service" only means KSM (Kernel Samepage
|
|
|
|
Merging).
|
|
|
|
|
2008-02-05 19:27:37 +00:00
|
|
|
=item B<capabilities>
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Print an XML document describing the capabilities of the hypervisor
|
|
|
|
we are currently connected to. This includes a section on the host
|
|
|
|
capabilities in terms of CPU and features, and a set of description
|
|
|
|
for each kind of guest which can be virtualized. For a more complete
|
2007-06-21 15:57:49 +00:00
|
|
|
description see:
|
2009-08-11 14:37:33 +00:00
|
|
|
L<http://libvirt.org/formatcaps.html>
|
2008-03-14 11:08:03 +00:00
|
|
|
The XML also show the NUMA topology information if available.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2014-06-25 15:56:20 +00:00
|
|
|
=item B<domcapabilities> [I<virttype>] [I<emulatorbin>]
|
|
|
|
[I<arch>] [I<machine>]
|
|
|
|
|
|
|
|
Print an XML document describing the domain capabilities for the
|
|
|
|
hypervisor we are connected to using information either sourced from an
|
|
|
|
existing domain or taken from the B<virsh capabilities> output. This may
|
|
|
|
be useful if you intend to create a new domain and are curious if for
|
|
|
|
instance it could make use of VFIO by creating a domain for the
|
|
|
|
hypervisor with a specific emulator and architecture.
|
|
|
|
|
|
|
|
Each hypervisor will have different requirements regarding which options
|
|
|
|
are required and which are optional. A hypervisor can support providing
|
|
|
|
a default value for any of the options.
|
|
|
|
|
|
|
|
The I<virttype> option specifies the virtualization type used. The value
|
|
|
|
to be used is either from the 'type' attribute of the <domain/> top
|
|
|
|
level element from the domain XML or the 'type' attribute found within
|
|
|
|
each <guest/> element from the B<virsh capabilities> output. The
|
|
|
|
I<emulatorbin> option specifies the path to the emulator. The value to
|
|
|
|
be used is either the <emulator> element in the domain XML or the
|
|
|
|
B<virsh capabilities> output. The I<arch> option specifies the
|
|
|
|
architecture to be used for the domain. The value to be used is either
|
|
|
|
the "arch" attribute from the domain's XML <os/> element and <type/>
|
|
|
|
subelement or the "name" attribute of an <arch/> element from the
|
|
|
|
B<virsh capabililites> output. The I<machine> specifies the machine type
|
|
|
|
for the emulator. The value to be used is either the "machine" attribute
|
|
|
|
from the domain's XML <os/> element and <type/> subelement or one from a
|
|
|
|
list of machines from the B<virsh capabilities> output for a specific
|
|
|
|
architecture and domain type.
|
|
|
|
|
|
|
|
For the qemu hypervisor, a I<virttype> of either 'qemu' or 'kvm' must be
|
|
|
|
supplied along with either the I<emulatorbin> or I<arch> in order to
|
|
|
|
generate output for the default I<machine>. Supplying a I<machine>
|
|
|
|
value will generate output for the specific machine.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<inject-nmi> I<domain>
|
2011-07-12 09:40:16 +00:00
|
|
|
|
|
|
|
Inject NMI to the guest.
|
|
|
|
|
2012-06-19 13:18:16 +00:00
|
|
|
=item B<list> [I<--inactive> | I<--all>]
|
|
|
|
[I<--managed-save>] [I<--title>]
|
|
|
|
{ [I<--table>] | I<--name> | I<--uuid> }
|
|
|
|
[I<--persistent>] [I<--transient>]
|
|
|
|
[I<--with-managed-save>] [I<--without-managed-save>]
|
|
|
|
[I<--autostart>] [I<--no-autostart>]
|
|
|
|
[I<--with-snapshot>] [I<--without-snapshot>]
|
|
|
|
[I<--state-running>] [I<--state-paused>]
|
|
|
|
[I<--state-shutoff>] [I<--state-other>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-07-26 03:20:49 +00:00
|
|
|
Prints information about existing domains. If no options are
|
2010-05-30 03:28:42 +00:00
|
|
|
specified it prints out information about running domains.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
An example format for the list is as follows:
|
|
|
|
|
|
|
|
B<virsh> list
|
2012-06-19 13:18:16 +00:00
|
|
|
Id Name State
|
|
|
|
----------------------------------------------------
|
|
|
|
0 Domain-0 running
|
|
|
|
2 fedora paused
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-02-05 19:27:37 +00:00
|
|
|
Name is the name of the domain. ID the domain numeric id.
|
2008-09-25 12:40:01 +00:00
|
|
|
State is the run state (see below).
|
2007-09-28 14:28:12 +00:00
|
|
|
|
2007-06-21 07:39:51 +00:00
|
|
|
B<STATES>
|
|
|
|
|
2012-03-14 15:26:53 +00:00
|
|
|
The State field lists 8 states for a domain, and which ones the
|
2008-09-25 12:40:01 +00:00
|
|
|
current domain is in.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=over 4
|
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
=item B<running>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
The domain is currently running on a CPU
|
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
=item B<idle>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
The domain is idle, and not running or runnable. This can be caused
|
2007-06-21 07:39:51 +00:00
|
|
|
because the domain is waiting on IO (a traditional wait state) or has
|
|
|
|
gone to sleep because there was nothing else for it to do.
|
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
=item B<paused>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
The domain has been paused, usually occurring through the administrator
|
2008-09-25 12:40:01 +00:00
|
|
|
running B<virsh suspend>. When in a paused state the domain will still
|
2007-06-21 07:39:51 +00:00
|
|
|
consume allocated resources like memory, but will not be eligible for
|
2008-09-25 12:40:01 +00:00
|
|
|
scheduling by the hypervisor.
|
2011-05-10 08:26:05 +00:00
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
=item B<shutdown>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
The domain is in the process of shutting down, i.e. the guest operating system
|
2008-02-05 19:27:37 +00:00
|
|
|
has been notified and should be in the process of stopping its operations
|
2007-06-21 15:00:17 +00:00
|
|
|
gracefully.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2010-05-30 03:28:42 +00:00
|
|
|
=item B<shut off>
|
|
|
|
|
|
|
|
The domain is not running. Usually this indicates the domain has been
|
|
|
|
shut down completely, or has not been started.
|
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
=item B<crashed>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
The domain has crashed, which is always a violent ending. Usually
|
|
|
|
this state can only occur if the domain has been configured not to
|
2008-09-25 12:40:01 +00:00
|
|
|
restart on crash.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
=item B<dying>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
The domain is in process of dying, but hasn't completely shutdown or
|
|
|
|
crashed.
|
|
|
|
|
2012-03-14 15:26:53 +00:00
|
|
|
=item B<pmsuspended>
|
|
|
|
|
|
|
|
The domain has been suspended by guest power management, e.g. entered
|
|
|
|
into s3 state.
|
|
|
|
|
2007-06-21 07:39:51 +00:00
|
|
|
=back
|
|
|
|
|
2012-06-19 13:18:16 +00:00
|
|
|
Normally only active domains are listed. To list inactive domains specify
|
|
|
|
I<--inactive> or I<--all> to list both active and inactive domains.
|
|
|
|
|
2012-09-17 08:57:41 +00:00
|
|
|
To further filter the list of domains you may specify one or more of filtering
|
|
|
|
flags supported by the B<list> command. These flags are grouped by function.
|
|
|
|
Specifying one or more flags from a group enables the filter group. Note that
|
|
|
|
some combinations of flags may yield no results. Supported filtering flags and
|
|
|
|
groups:
|
2012-06-19 13:18:16 +00:00
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item B<Persistence>
|
|
|
|
|
|
|
|
Flag I<--persistent> is used to include persistent domains in the returned
|
|
|
|
list. To include transient domains specify I<--transient>.
|
|
|
|
|
|
|
|
=item B<Existence of managed save image>
|
|
|
|
|
|
|
|
To list domains having a managed save image specify flag
|
|
|
|
I<--with-managed-save>. For domains that don't have a managed save image
|
|
|
|
specify I<--without-managed-save>.
|
|
|
|
|
|
|
|
=item B<Domain state>
|
|
|
|
|
|
|
|
The following filter flags select a domain by its state:
|
|
|
|
I<--state-running> for running domains, I<--state-paused> for paused domains,
|
|
|
|
I<--state-shutoff> for turned off domains and I<--state-other> for all
|
|
|
|
other states as a fallback.
|
|
|
|
|
|
|
|
=item B<Autostarting domains>
|
|
|
|
|
|
|
|
To list autostarting domains use the flag I<--autostart>. To list domains with
|
|
|
|
this feature disabled use I<--no-autostart>.
|
|
|
|
|
|
|
|
=item B<Snapshot existence>
|
|
|
|
|
|
|
|
Domains that have snapshot images can be listed using flag I<--with-snapshot>,
|
|
|
|
domains without a snapshot I<--without-snapshot>.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
When talking to older servers, this command is forced to use a series of API
|
|
|
|
calls with an inherent race, where a domain might not be listed or might appear
|
|
|
|
more than once if it changed state between calls while the list was being
|
|
|
|
collected. Newer servers do not have this problem.
|
|
|
|
|
|
|
|
If I<--managed-save> is specified, then domains that have managed save state
|
|
|
|
(only possible if they are in the B<shut off> state, so you need to specify
|
|
|
|
I<--inactive> or I<--all> to actually list them) will instead show as B<saved>
|
|
|
|
in the listing. This flag is usable only with the default I<--table> output.
|
|
|
|
Note that this flag does not filter the list of domains.
|
2012-02-21 14:02:23 +00:00
|
|
|
|
|
|
|
If I<--name> is specified, domain names are printed instead of the table
|
|
|
|
formatted one per line. If I<--uuid> is specified domain's UUID's are printed
|
|
|
|
instead of names. Flag I<--table> specifies that the legacy table-formatted
|
|
|
|
output should be used. This is the default. All of these are mutually
|
|
|
|
exclusive.
|
|
|
|
|
2012-04-19 08:33:05 +00:00
|
|
|
If I<--title> is specified, then the short domain description (title) is
|
|
|
|
printed in an extra column. This flag is usable only with the default
|
2012-02-21 14:02:23 +00:00
|
|
|
I<--table> output.
|
2012-02-01 13:03:51 +00:00
|
|
|
|
2012-04-19 08:33:05 +00:00
|
|
|
Example:
|
|
|
|
|
2012-02-21 14:05:49 +00:00
|
|
|
B<virsh> list --title
|
2012-06-19 13:18:16 +00:00
|
|
|
Id Name State Title
|
|
|
|
--------------------------------------------------------------------------
|
|
|
|
0 Domain-0 running Mailserver 1
|
|
|
|
2 fedora paused
|
2012-02-01 13:03:51 +00:00
|
|
|
|
2012-03-22 20:49:07 +00:00
|
|
|
=item B<freecell> [{ [I<--cellno>] B<cellno> | I<--all> }]
|
|
|
|
|
|
|
|
Prints the available amount of memory on the machine or within a NUMA
|
|
|
|
cell. The freecell command can provide one of three different
|
|
|
|
displays of available memory on the machine depending on the options
|
|
|
|
specified. With no options, it displays the total free memory on the
|
|
|
|
machine. With the --all option, it displays the free memory in each
|
|
|
|
cell and the total free memory on the machine. Finally, with a
|
|
|
|
numeric argument or with --cellno plus a cell number it will display
|
|
|
|
the free memory for the specified cell only.
|
2008-09-25 12:40:01 +00:00
|
|
|
|
2014-06-09 15:56:43 +00:00
|
|
|
=item B<freepages> [{ [I<--cellno>] I<cellno> [I<--pagesize>] I<pagesize> |
|
|
|
|
I<--all> }]
|
|
|
|
|
|
|
|
Prints the available amount of pages within a NUMA cell. I<cellno> refers
|
|
|
|
to the NUMA cell you're interested in. I<pagesize> is a scaled integer (see
|
|
|
|
B<NOTES> above). Alternatively, if I<--all> is used, info on each possible
|
|
|
|
combination of NUMA cell and page size is printed out.
|
|
|
|
|
2014-09-17 13:53:42 +00:00
|
|
|
=item B<allocpages> [I<--pagesize>] I<pagesize> [I<--pagecount>] I<pagecount>
|
|
|
|
[[I<--cellno>] I<cellno>] [I<--add>] [I<--all>]
|
|
|
|
|
|
|
|
Change the size of pages pool of I<pagesize> on the host. If
|
|
|
|
I<--add> is specified, then I<pagecount> pages are added into the
|
|
|
|
pool. However, if I<--add> wasn't specified, then the
|
|
|
|
I<pagecount> is taken as the new absolute size of the pool (this
|
|
|
|
may be used to free some pages and size the pool down). The
|
|
|
|
I<cellno> modifier can be used to narrow the modification down to
|
|
|
|
a single host NUMA cell. On the other end of spectrum lies
|
|
|
|
I<--all> which executes the modification on all NUMA cells.
|
|
|
|
|
2015-02-05 14:30:50 +00:00
|
|
|
=item B<cpu-baseline> I<FILE> [I<--features>] [I<--migratable>]
|
2010-02-17 13:52:07 +00:00
|
|
|
|
|
|
|
Compute baseline CPU which will be supported by all host CPUs given in <file>.
|
|
|
|
The list of host CPUs is built by extracting all <cpu> elements from the
|
|
|
|
<file>. Thus, the <file> can contain either a set of <cpu> elements separated
|
|
|
|
by new lines or even a set of complete <capabilities> elements printed by
|
2013-08-02 19:08:19 +00:00
|
|
|
B<capabilities> command. If I<--features> is specified then the
|
|
|
|
resulting XML description will explicitly include all features that make
|
|
|
|
up the CPU, without this option features that are part of the CPU model
|
2015-02-05 14:30:50 +00:00
|
|
|
will not be listed in the XML description. If I<--migratable> is specified,
|
|
|
|
features that block migration will not be included in the resulting CPU.
|
2010-02-17 13:52:07 +00:00
|
|
|
|
2014-05-28 13:12:59 +00:00
|
|
|
=item B<cpu-compare> I<FILE> [I<--error>]
|
2010-01-20 14:16:29 +00:00
|
|
|
|
|
|
|
Compare CPU definition from XML <file> with host CPU. The XML <file> may
|
|
|
|
contain either host or guest CPU definition. The host CPU definition is the
|
|
|
|
<cpu> element and its contents as printed by B<capabilities> command. The
|
|
|
|
guest CPU definition is the <cpu> element and its contents from domain XML
|
|
|
|
definition. For more information on guest CPU definition see:
|
2014-05-28 13:12:59 +00:00
|
|
|
L<http://libvirt.org/formatdomain.html#elementsCPU>. If I<--error> is
|
|
|
|
specified, the command will return an error when the given CPU is
|
|
|
|
incompatible with host CPU and a message providing more details about the
|
|
|
|
incompatibility will be printed out.
|
2010-01-20 14:16:29 +00:00
|
|
|
|
2015-02-18 13:53:32 +00:00
|
|
|
=item B<cpu-models> I<arch>
|
|
|
|
|
|
|
|
Print the list of CPU models known for the specified architecture.
|
|
|
|
|
2011-12-25 17:20:03 +00:00
|
|
|
=item B<echo> [I<--shell>] [I<--xml>] [I<arg>...]
|
|
|
|
|
|
|
|
Echo back each I<arg>, separated by space. If I<--shell> is
|
|
|
|
specified, then the output will be single-quoted where needed, so that
|
|
|
|
it is suitable for reuse in a shell context. If I<--xml> is
|
|
|
|
specified, then the output will be escaped for use in XML.
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=back
|
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
=head1 DOMAIN COMMANDS
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
The following commands manipulate domains directly, as stated
|
2012-07-25 11:17:03 +00:00
|
|
|
previously most commands take domain as the first parameter. The
|
|
|
|
I<domain> can be specified as a short integer, a name or a full UUID.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=over 4
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<autostart> [I<--disable>] I<domain>
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Configure a domain to be automatically started at boot.
|
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
The option I<--disable> disables autostarting.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<console> I<domain> [I<devname>] [I<--safe>] [I<--force>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2010-07-27 09:40:30 +00:00
|
|
|
Connect the virtual serial console for the guest. The optional
|
|
|
|
I<devname> parameter refers to the device alias of an alternate
|
|
|
|
console, serial or parallel device configured for the guest.
|
|
|
|
If omitted, the primary console will be opened.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2011-10-12 10:59:15 +00:00
|
|
|
If the flag I<--safe> is specified, the connection is only attempted
|
|
|
|
if the driver supports safe console handling. This flag specifies that
|
|
|
|
the server has to ensure exclusive access to console devices. Optionally
|
|
|
|
the I<--force> flag may be specified, requesting to disconnect any existing
|
|
|
|
sessions, such as in a case of a broken connection.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<create> I<FILE> [I<--console>] [I<--paused>] [I<--autodestroy>]
|
2013-07-11 15:32:14 +00:00
|
|
|
[I<--pass-fds N,M,...>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
Create a domain from an XML <file>. An easy way to create the XML
|
|
|
|
<file> is to use the B<dumpxml> command to obtain the definition of a
|
2010-06-08 19:43:01 +00:00
|
|
|
pre-existing guest. The domain will be paused if the I<--paused> option
|
|
|
|
is used and supported by the driver; otherwise it will be running.
|
|
|
|
If I<--console> is requested, attach to the console after creation.
|
2011-06-23 10:41:57 +00:00
|
|
|
If I<--autodestroy> is requested, then the guest will be automatically
|
|
|
|
destroyed when virsh closes its connection to libvirt, or otherwise
|
|
|
|
exits.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2013-07-11 15:32:14 +00:00
|
|
|
If I<--pass-fds> is specified, the argument is a comma separated list
|
|
|
|
of open file descriptors which should be pass on into the guest. The
|
2013-11-30 06:33:17 +00:00
|
|
|
file descriptors will be re-numbered in the guest, starting from 3. This
|
2013-07-11 15:32:14 +00:00
|
|
|
is only supported with container based virtualization.
|
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
B<Example>
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
virsh dumpxml <domain> > domain.xml
|
2010-11-17 14:15:12 +00:00
|
|
|
vi domain.xml (or make changes with your other text editor)
|
2012-11-07 20:35:55 +00:00
|
|
|
virsh create domain.xml
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
=item B<define> I<FILE>
|
|
|
|
|
2010-06-08 00:18:01 +00:00
|
|
|
Define a domain from an XML <file>. The domain definition is registered
|
2011-12-12 21:28:31 +00:00
|
|
|
but not started. If domain is already running, the changes will take
|
|
|
|
effect on the next boot.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<desc> I<domain> [[I<--live>] [I<--config>] |
|
2012-06-19 09:05:31 +00:00
|
|
|
[I<--current>]] [I<--title>] [I<--edit>] [I<--new-desc>
|
|
|
|
New description or title message]
|
2012-02-01 13:03:51 +00:00
|
|
|
|
|
|
|
Show or modify description and title of a domain. These values are user
|
|
|
|
fields that allow to store arbitrary textual data to allow easy
|
|
|
|
identification of domains. Title should be short, although it's not enforced.
|
2014-08-18 14:47:13 +00:00
|
|
|
(See also B<metadata> that works with XML based domain metadata.)
|
2012-02-01 13:03:51 +00:00
|
|
|
|
|
|
|
Flags I<--live> or I<--config> select whether this command works on live
|
2012-02-08 10:31:10 +00:00
|
|
|
or persistent definitions of the domain. If both I<--live> and I<--config>
|
|
|
|
are specified, the I<--config> option takes precedence on getting the current
|
|
|
|
description and both live configuration and config are updated while setting
|
2012-02-28 07:41:37 +00:00
|
|
|
the description. I<--current> is exclusive and implied if none of these was
|
|
|
|
specified.
|
2012-02-01 13:03:51 +00:00
|
|
|
|
|
|
|
Flag I<--edit> specifies that an editor with the contents of current
|
|
|
|
description or title should be opened and the contents saved back afterwards.
|
|
|
|
|
|
|
|
Flag I<--title> selects operation on the title field instead of description.
|
|
|
|
|
2012-06-19 09:05:31 +00:00
|
|
|
If neither of I<--edit> and I<--new-desc> are specified the note or description
|
2012-02-01 13:03:51 +00:00
|
|
|
is displayed instead of being modified.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<destroy> I<domain> [I<--graceful>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
Immediately terminate the domain I<domain>. This doesn't give the domain
|
2010-04-12 12:22:02 +00:00
|
|
|
OS any chance to react, and it's the equivalent of ripping the power
|
2007-06-21 15:00:17 +00:00
|
|
|
cord out on a physical machine. In most cases you will want to use
|
2011-07-06 21:42:47 +00:00
|
|
|
the B<shutdown> command instead. However, this does not delete any
|
|
|
|
storage volumes used by the guest, and if the domain is persistent, it
|
|
|
|
can be restarted later.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
If I<domain> is transient, then the metadata of any snapshots will
|
2011-08-12 02:24:19 +00:00
|
|
|
be lost once the guest stops running, but the snapshot contents still
|
|
|
|
exist, and a new domain with the same name and UUID can restore the
|
|
|
|
snapshot metadata with B<snapshot-create>.
|
|
|
|
|
2012-02-03 19:14:36 +00:00
|
|
|
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.
|
|
|
|
|
2014-02-14 17:49:04 +00:00
|
|
|
=item B<domblkstat> I<domain> [I<block-device>] [I<--human>]
|
2008-04-15 15:20:43 +00:00
|
|
|
|
snapshot: also support disks by path
I got confused when 'virsh domblkinfo dom disk' required the
path to a disk (which can be ambiguous, since a single file
can back multiple disks), rather than the unambiguous target
device name that I was using in disk snapshots. So, in true
developer fashion, I went for the best of both worlds - all
interfaces that operate on a disk (aka block) now accept
either the target name or the unambiguous path to the backing
file used by the disk.
* src/conf/domain_conf.h (virDomainDiskIndexByName): Add
parameter.
(virDomainDiskPathByName): New prototype.
* src/libvirt_private.syms (domain_conf.h): Export it.
* src/conf/domain_conf.c (virDomainDiskIndexByName): Also allow
searching by path, and decide whether ambiguity is okay.
(virDomainDiskPathByName): New function.
(virDomainDiskRemoveByName, virDomainSnapshotAlignDisks): Update
callers.
* src/qemu/qemu_driver.c (qemudDomainBlockPeek)
(qemuDomainAttachDeviceConfig, qemuDomainUpdateDeviceConfig)
(qemuDomainGetBlockInfo, qemuDiskPathToAlias): Likewise.
* src/qemu/qemu_process.c (qemuProcessFindDomainDiskByPath):
Likewise.
* src/libxl/libxl_driver.c (libxlDomainAttachDeviceDiskLive)
(libxlDomainDetachDeviceDiskLive, libxlDomainAttachDeviceConfig)
(libxlDomainUpdateDeviceConfig): Likewise.
* src/uml/uml_driver.c (umlDomainBlockPeek): Likewise.
* src/xen/xend_internal.c (xenDaemonDomainBlockPeek): Likewise.
* docs/formatsnapshot.html.in: Update documentation.
* tools/virsh.pod (domblkstat, domblkinfo): Likewise.
* docs/schemas/domaincommon.rng (diskTarget): Tighten pattern on
disk targets.
* docs/schemas/domainsnapshot.rng (disksnapshot): Update to match.
* tests/domainsnapshotxml2xmlin/disk_snapshot.xml: Update test.
2011-08-20 02:38:36 +00:00
|
|
|
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
|
2011-08-20 13:04:24 +00:00
|
|
|
file='name'/>) for one of the disk devices attached to I<domain> (see
|
2015-03-10 15:52:08 +00:00
|
|
|
also B<domblklist> for listing these names). On a lxc or qemu domain,
|
|
|
|
omitting the I<block-device> yields device block stats summarily for the
|
|
|
|
entire domain.
|
2008-04-15 15:20:43 +00:00
|
|
|
|
2011-09-19 12:23:12 +00:00
|
|
|
Use I<--human> for a more human readable output.
|
|
|
|
|
|
|
|
Availability of these fields depends on hypervisor. Unsupported fields are
|
|
|
|
missing from the output. Other fields may appear if communicating with a newer
|
|
|
|
version of libvirtd.
|
|
|
|
|
2012-10-11 16:31:20 +00:00
|
|
|
B<Explanation of fields> (fields appear in the following order):
|
2011-09-19 12:23:12 +00:00
|
|
|
rd_req - count of read operations
|
|
|
|
rd_bytes - count of read bytes
|
|
|
|
wr_req - count of write operations
|
|
|
|
wr_bytes - count of written bytes
|
|
|
|
errs - error count
|
|
|
|
flush_operations - count of flush operations
|
|
|
|
rd_total_times - total time read operations took (ns)
|
|
|
|
wr_total_times - total time write operations took (ns)
|
|
|
|
flush_total_times - total time flush operations took (ns)
|
|
|
|
<-- other fields provided by hypervisor -->
|
|
|
|
|
2015-01-25 18:38:49 +00:00
|
|
|
|
|
|
|
=item B<domifaddr> I<domain> [I<interface>] [I<--full>]
|
|
|
|
[I<--source lease|agent>]
|
|
|
|
|
|
|
|
Get a list of interfaces of a running domain along with their IP and MAC
|
|
|
|
addresses, or limited output just for one interface if I<interface> is
|
|
|
|
specified. Note that I<interface> can be driver dependent, it can be the name
|
|
|
|
within guest OS or the name you would see in domain XML. Moreover, the whole
|
|
|
|
command may require a guest agent to be configured for the queried domain under
|
|
|
|
some drivers, notably qemu. If I<--full> is specified, the interface name is
|
|
|
|
always displayed when the interface has multiple addresses or alias, otherwise
|
|
|
|
it only displays the interface name for the first address, and "-" for the
|
|
|
|
others. The I<--source> argument specifies what data source to use for the
|
|
|
|
addresses, currently one of 'lease' to read DHCP leases, or 'agent' to query
|
|
|
|
the guest OS via an agent. If unspecified, 'lease' is the default.
|
|
|
|
|
2008-04-15 15:20:43 +00:00
|
|
|
=item B<domifstat> I<domain> I<interface-device>
|
|
|
|
|
|
|
|
Get network interface stats for a running domain.
|
|
|
|
|
virsh: Use option alias for outmoded "--persistent"
Since VIR_DOMAIN_AFFECT_{LIVE,CONFIG,CURRENT} was created,
all new virsh commands use "--config" to represents the
persistent changing. This patch add "--config" option
for the old commands which still use "--persistent",
and "--persistent" is now alias of "--config".
tools/virsh.c: (use "--config", and "--persistent" is
alias of "--config" now).
cmdDomIfSetLink, cmdDomIfGetLink, cmdAttachDevice,
cmdDetachDevice, cmdUpdateDevice, cmdAttachInterface,
cmdDetachInterface, cmdAttachDisk, cmdDetachDisk
toos/virsh.pod: Update docs of the changed commands, and
add some missed docs for "--config" (detach-interface,
detach-disk, and detach-device).
2012-03-08 11:38:57 +00:00
|
|
|
=item B<domif-setlink> I<domain> I<interface-device> I<state> [I<--config>]
|
2011-09-06 08:31:59 +00:00
|
|
|
|
|
|
|
Modify link state of the domain's virtual interface. Possible values for
|
2015-02-25 08:34:27 +00:00
|
|
|
state are "up" and "down". If I<--config> is specified, only the persistent
|
virsh: Use option alias for outmoded "--persistent"
Since VIR_DOMAIN_AFFECT_{LIVE,CONFIG,CURRENT} was created,
all new virsh commands use "--config" to represents the
persistent changing. This patch add "--config" option
for the old commands which still use "--persistent",
and "--persistent" is now alias of "--config".
tools/virsh.c: (use "--config", and "--persistent" is
alias of "--config" now).
cmdDomIfSetLink, cmdDomIfGetLink, cmdAttachDevice,
cmdDetachDevice, cmdUpdateDevice, cmdAttachInterface,
cmdDetachInterface, cmdAttachDisk, cmdDetachDisk
toos/virsh.pod: Update docs of the changed commands, and
add some missed docs for "--config" (detach-interface,
detach-disk, and detach-device).
2012-03-08 11:38:57 +00:00
|
|
|
configuration of the domain is modified, for compatibility purposes,
|
|
|
|
I<--persistent> is alias of I<--config>.
|
2012-01-20 06:30:47 +00:00
|
|
|
I<interface-device> can be the interface's target name or the MAC address.
|
2011-09-06 08:31:59 +00:00
|
|
|
|
virsh: Use option alias for outmoded "--persistent"
Since VIR_DOMAIN_AFFECT_{LIVE,CONFIG,CURRENT} was created,
all new virsh commands use "--config" to represents the
persistent changing. This patch add "--config" option
for the old commands which still use "--persistent",
and "--persistent" is now alias of "--config".
tools/virsh.c: (use "--config", and "--persistent" is
alias of "--config" now).
cmdDomIfSetLink, cmdDomIfGetLink, cmdAttachDevice,
cmdDetachDevice, cmdUpdateDevice, cmdAttachInterface,
cmdDetachInterface, cmdAttachDisk, cmdDetachDisk
toos/virsh.pod: Update docs of the changed commands, and
add some missed docs for "--config" (detach-interface,
detach-disk, and detach-device).
2012-03-08 11:38:57 +00:00
|
|
|
=item B<domif-getlink> I<domain> 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
|
|
|
|
purposes, I<--persistent> is alias of I<--config>.
|
2011-09-06 08:31:59 +00:00
|
|
|
|
2012-01-20 06:30:47 +00:00
|
|
|
I<interface-device> can be the interface's target name or the MAC address.
|
2011-09-06 08:31:59 +00:00
|
|
|
|
2011-12-29 07:33:21 +00:00
|
|
|
=item B<domiftune> I<domain> I<interface-device>
|
|
|
|
[[I<--config>] [I<--live>] | [I<--current>]]
|
2015-08-01 07:48:04 +00:00
|
|
|
[I<--inbound average,peak,burst,floor>]
|
2011-12-29 07:33:21 +00:00
|
|
|
[I<--outbound average,peak,burst>]
|
|
|
|
|
|
|
|
Set or query the domain's network interface's bandwidth parameters.
|
|
|
|
I<interface-device> can be the interface's target name (<target dev='name'/>),
|
|
|
|
or the MAC address.
|
|
|
|
|
|
|
|
If no I<--inbound> or I<--outbound> is specified, this command will
|
|
|
|
query and show the bandwidth settings. Otherwise, it will set the
|
2015-08-01 07:48:04 +00:00
|
|
|
inbound or outbound bandwidth. I<average,peak,burst,floor> is the same as
|
|
|
|
in command I<attach-interface>. Values for I<average>, I<peak> and I<floor>
|
|
|
|
are expressed in kilobytes per second, while I<burst> is expressed in kilobytes
|
|
|
|
in a single burst at I<peak> speed as described in the Network XML
|
2014-02-12 20:33:02 +00:00
|
|
|
documentation at L<http://libvirt.org/formatnetwork.html#elementQoS>.
|
2011-12-29 07:33:21 +00:00
|
|
|
|
2014-03-18 09:50:02 +00:00
|
|
|
To clear inbound or outbound settings, use I<--inbound> or I<--outbound>
|
2014-03-19 10:25:03 +00:00
|
|
|
respectfully with average value of zero.
|
2014-03-18 09:50:02 +00:00
|
|
|
|
2011-12-29 07:33:21 +00:00
|
|
|
If I<--live> is specified, affect a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
2014-10-14 07:41:24 +00:00
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
2011-12-29 07:33:21 +00:00
|
|
|
exclusive. If no flag is specified, behavior is different depending
|
|
|
|
on hypervisor.
|
|
|
|
|
2013-07-08 17:19:43 +00:00
|
|
|
=item B<dommemstat> I<domain> [I<--period> B<seconds>]
|
|
|
|
[[I<--config>] [I<--live>] | [I<--current>]]
|
2009-12-21 14:24:56 +00:00
|
|
|
|
|
|
|
Get memory stats for a running domain.
|
|
|
|
|
2013-07-08 17:19:43 +00:00
|
|
|
Depending on the hypervisor a variety of statistics can be returned
|
|
|
|
|
|
|
|
For QEMU/KVM with a memory balloon, setting the optional I<--period> to a
|
|
|
|
value larger than 0 in seconds will allow the balloon driver to return
|
|
|
|
additional statistics which will be displayed by subsequent B<dommemstat>
|
|
|
|
commands. Setting the I<--period> to 0 will stop the balloon driver collection,
|
|
|
|
but does not clear the statistics in the balloon driver. Requires at least
|
|
|
|
QEMU/KVM 1.5 to be running on the host.
|
|
|
|
|
|
|
|
The I<--live>, I<--config>, and I<--current> flags are only valid when using
|
|
|
|
the I<--period> option in order to set the collection period for the balloon
|
|
|
|
driver. If I<--live> is specified, only the running guest collection period
|
|
|
|
is affected. If I<--config> is specified, affect the next boot of a persistent
|
|
|
|
guest. If I<--current> is specified, affect the current guest state.
|
|
|
|
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. If no flag is specified, behavior is different depending
|
|
|
|
on the guest state.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<domblkerror> I<domain>
|
2012-01-18 16:46:00 +00:00
|
|
|
|
|
|
|
Show errors on block devices. This command usually comes handy when
|
|
|
|
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.
|
|
|
|
|
2010-04-27 19:31:58 +00:00
|
|
|
=item B<domblkinfo> I<domain> I<block-device>
|
|
|
|
|
snapshot: also support disks by path
I got confused when 'virsh domblkinfo dom disk' required the
path to a disk (which can be ambiguous, since a single file
can back multiple disks), rather than the unambiguous target
device name that I was using in disk snapshots. So, in true
developer fashion, I went for the best of both worlds - all
interfaces that operate on a disk (aka block) now accept
either the target name or the unambiguous path to the backing
file used by the disk.
* src/conf/domain_conf.h (virDomainDiskIndexByName): Add
parameter.
(virDomainDiskPathByName): New prototype.
* src/libvirt_private.syms (domain_conf.h): Export it.
* src/conf/domain_conf.c (virDomainDiskIndexByName): Also allow
searching by path, and decide whether ambiguity is okay.
(virDomainDiskPathByName): New function.
(virDomainDiskRemoveByName, virDomainSnapshotAlignDisks): Update
callers.
* src/qemu/qemu_driver.c (qemudDomainBlockPeek)
(qemuDomainAttachDeviceConfig, qemuDomainUpdateDeviceConfig)
(qemuDomainGetBlockInfo, qemuDiskPathToAlias): Likewise.
* src/qemu/qemu_process.c (qemuProcessFindDomainDiskByPath):
Likewise.
* src/libxl/libxl_driver.c (libxlDomainAttachDeviceDiskLive)
(libxlDomainDetachDeviceDiskLive, libxlDomainAttachDeviceConfig)
(libxlDomainUpdateDeviceConfig): Likewise.
* src/uml/uml_driver.c (umlDomainBlockPeek): Likewise.
* src/xen/xend_internal.c (xenDaemonDomainBlockPeek): Likewise.
* docs/formatsnapshot.html.in: Update documentation.
* tools/virsh.pod (domblkstat, domblkinfo): Likewise.
* docs/schemas/domaincommon.rng (diskTarget): Tighten pattern on
disk targets.
* docs/schemas/domainsnapshot.rng (disksnapshot): Update to match.
* tests/domainsnapshotxml2xmlin/disk_snapshot.xml: Update test.
2011-08-20 02:38:36 +00:00
|
|
|
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
|
2011-08-20 13:04:24 +00:00
|
|
|
file='name'/>) for one of the disk devices attached to I<domain> (see
|
|
|
|
also B<domblklist> for listing these names).
|
|
|
|
|
2012-01-13 10:03:12 +00:00
|
|
|
=item B<domblklist> I<domain> [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
|
|
|
|
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
|
|
|
|
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.
|
2010-04-27 19:31:58 +00:00
|
|
|
|
getstats: add new flag for block backing chain
This patch introduces access to allocation information about
a backing chain of a live domain. While querying storage
volumes for read-only disks could provide some of the details,
we do NOT want to read() a file while qemu is writing it.
Also, there is one case where we have to rely on qemu: when
doing a block commit into a backing file, where that file is
stored in qcow2 format on a host block device, we want to know
the current highest write offset into that image, in order to
know if the disk must be resized larger. qemu-img does not
(currently) show this information, and none of the earlier
block APIs were extensible enough to expose it. But
virDomainListGetStats is perfect for the job!
We don't need a new group of statistics, as the existing block
group is sufficient. On the other hand, as existing libvirt
releases already report 1:1 mapping of block.count to <disk>
devices, changing the array size could confuse older clients;
and even with newer clients, the time and memory taken to
report additional statistics is not always necessary (backing
files are generally read-only except for block-commit, so while
read statistics may change, sizing statistics will not). So
the choice here is to add a new flag that only newer callers
will pass, when they are prepared for the additional information.
This patch introduces the new API, but it will take more
patches to get it implemented for qemu.
* include/libvirt/libvirt-domain.h
(VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING): New flag.
* src/libvirt-domain.c (virConnectGetAllDomainStats): Document it,
and add a new field when it is in use.
* tools/virsh-domain-monitor.c (cmdDomstats): Use new flag.
* tools/virsh.pod (domstats): Document it.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-11-25 15:46:49 +00:00
|
|
|
=item B<domstats> [I<--raw>] [I<--enforce>] [I<--backing>] [I<--state>]
|
2014-09-15 08:48:10 +00:00
|
|
|
[I<--cpu-total>] [I<--balloon>] [I<--vcpu>] [I<--interface>] [I<--block>]
|
2014-08-26 13:55:14 +00:00
|
|
|
[[I<--list-active>] [I<--list-inactive>] [I<--list-persistent>]
|
|
|
|
[I<--list-transient>] [I<--list-running>] [I<--list-paused>]
|
|
|
|
[I<--list-shutoff>] [I<--list-other>]] | [I<domain> ...]
|
|
|
|
|
|
|
|
Get statistics for multiple or all domains. Without any argument this
|
|
|
|
command prints all available statistics for all domains.
|
|
|
|
|
|
|
|
The list of domains to gather stats for can be either limited by listing
|
|
|
|
the domains as a space separated list, or by specifying one of the
|
|
|
|
filtering flags I<--list-*>. (The approaches can't be combined.)
|
|
|
|
|
|
|
|
By default some of the returned fields may be converted to more
|
|
|
|
human friendly values by a set of pretty-printers. To suppress this
|
|
|
|
behavior use the I<--raw> flag.
|
|
|
|
|
|
|
|
The individual statistics groups are selectable via specific flags. By
|
|
|
|
default all supported statistics groups are returned. Supported
|
2014-09-15 08:48:10 +00:00
|
|
|
statistics groups flags are: I<--state>, I<--cpu-total>, I<--balloon>,
|
|
|
|
I<--vcpu>, I<--interface>, I<--block>.
|
2014-08-26 13:55:14 +00:00
|
|
|
|
2014-09-15 15:32:42 +00:00
|
|
|
When selecting the I<--state> group the following fields are returned:
|
|
|
|
"state.state" - state of the VM, returned as number from virDomainState enum,
|
2014-11-24 20:58:20 +00:00
|
|
|
"state.reason" - reason for entering given state, returned as int from
|
2014-09-15 15:32:42 +00:00
|
|
|
virDomain*Reason enum corresponding to given state.
|
|
|
|
|
|
|
|
I<--cpu-total> returns:
|
|
|
|
"cpu.time" - total cpu time spent for this domain in nanoseconds,
|
|
|
|
"cpu.user" - user cpu time spent in nanoseconds,
|
|
|
|
"cpu.system" - system cpu time spent in nanoseconds
|
|
|
|
|
|
|
|
I<--balloon> returns:
|
|
|
|
"balloon.current" - the memory in kiB currently used,
|
|
|
|
"balloon.maximum" - the maximum memory in kiB allowed
|
|
|
|
|
|
|
|
I<--vcpu> returns:
|
|
|
|
"vcpu.current" - current number of online virtual CPUs,
|
|
|
|
"vcpu.maximum" - maximum number of online virtual CPUs,
|
|
|
|
"vcpu.<num>.state" - state of the virtual CPU <num>, as number
|
|
|
|
from virVcpuState enum,
|
|
|
|
"vcpu.<num>.time" - virtual cpu time spent by virtual CPU <num>
|
|
|
|
|
|
|
|
I<--interface> returns:
|
|
|
|
"net.count" - number of network interfaces on this domain,
|
|
|
|
"net.<num>.name" - name of the interface <num>,
|
|
|
|
"net.<num>.rx.bytes" - number of bytes received,
|
|
|
|
"net.<num>.rx.pkts" - number of packets received,
|
|
|
|
"net.<num>.rx.errs" - number of receive errors,
|
|
|
|
"net.<num>.rx.drop" - number of receive packets dropped,
|
|
|
|
"net.<num>.tx.bytes" - number of bytes transmitted,
|
|
|
|
"net.<num>.tx.pkts" - number of packets transmitted,
|
|
|
|
"net.<num>.tx.errs" - number of transmission errors,
|
2014-11-24 20:58:20 +00:00
|
|
|
"net.<num>.tx.drop" - number of transmit packets dropped
|
2014-09-15 15:32:42 +00:00
|
|
|
|
getstats: add new flag for block backing chain
This patch introduces access to allocation information about
a backing chain of a live domain. While querying storage
volumes for read-only disks could provide some of the details,
we do NOT want to read() a file while qemu is writing it.
Also, there is one case where we have to rely on qemu: when
doing a block commit into a backing file, where that file is
stored in qcow2 format on a host block device, we want to know
the current highest write offset into that image, in order to
know if the disk must be resized larger. qemu-img does not
(currently) show this information, and none of the earlier
block APIs were extensible enough to expose it. But
virDomainListGetStats is perfect for the job!
We don't need a new group of statistics, as the existing block
group is sufficient. On the other hand, as existing libvirt
releases already report 1:1 mapping of block.count to <disk>
devices, changing the array size could confuse older clients;
and even with newer clients, the time and memory taken to
report additional statistics is not always necessary (backing
files are generally read-only except for block-commit, so while
read statistics may change, sizing statistics will not). So
the choice here is to add a new flag that only newer callers
will pass, when they are prepared for the additional information.
This patch introduces the new API, but it will take more
patches to get it implemented for qemu.
* include/libvirt/libvirt-domain.h
(VIR_CONNECT_GET_ALL_DOMAINS_STATS_BACKING): New flag.
* src/libvirt-domain.c (virConnectGetAllDomainStats): Document it,
and add a new field when it is in use.
* tools/virsh-domain-monitor.c (cmdDomstats): Use new flag.
* tools/virsh.pod (domstats): Document it.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-11-25 15:46:49 +00:00
|
|
|
I<--block> returns information about disks associated with each
|
|
|
|
domain. Using the I<--backing> flag extends this information to
|
|
|
|
cover all resources in the backing chain, rather than the default
|
|
|
|
of limiting information to the active layer for each guest disk.
|
|
|
|
Information listed includes:
|
|
|
|
"block.count" - number of block devices being listed,
|
|
|
|
"block.<num>.name" - name of the target of the block device <num> (the
|
|
|
|
same name for multiple entries if I<--backing> is present),
|
|
|
|
"block.<num>.backingIndex" - when I<--backing> is present, matches up
|
|
|
|
with the <backingStore> index listed in domain XML for backing files,
|
2014-11-25 00:12:30 +00:00
|
|
|
"block.<num>.path" - file source of block device <num>, if it is a
|
|
|
|
local file or block device,
|
2014-09-15 15:32:42 +00:00
|
|
|
"block.<num>.rd.reqs" - number of read requests,
|
|
|
|
"block.<num>.rd.bytes" - number of read bytes,
|
|
|
|
"block.<num>.rd.times" - total time (ns) spent on reads,
|
|
|
|
"block.<num>.wr.reqs" - number of write requests,
|
|
|
|
"block.<num>.wr.bytes" - number of written bytes,
|
|
|
|
"block.<num>.wr.times" - total time (ns) spent on writes,
|
|
|
|
"block.<num>.fl.reqs" - total flush requests,
|
|
|
|
"block.<num>.fl.times" - total time (ns) spent on cache flushing,
|
|
|
|
"block.<num>.errors" - Xen only: the 'oo_req' value,
|
2014-11-24 20:58:20 +00:00
|
|
|
"block.<num>.allocation" - offset of highest written sector in bytes,
|
|
|
|
"block.<num>.capacity" - logical size of source file in bytes,
|
|
|
|
"block.<num>.physical" - physical size of source file in bytes
|
2014-09-15 15:32:42 +00:00
|
|
|
|
2014-08-26 13:55:14 +00:00
|
|
|
Selecting a specific statistics groups doesn't guarantee that the
|
|
|
|
daemon supports the selected group of stats. Flag I<--enforce>
|
|
|
|
forces the command to fail if the daemon doesn't support the
|
|
|
|
selected group.
|
|
|
|
|
2012-01-11 12:45:31 +00:00
|
|
|
=item B<domiflist> I<domain> [I<--inactive>]
|
|
|
|
|
|
|
|
Print a table showing the brief information of all virtual interfaces
|
|
|
|
associated with I<domain>. 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.
|
|
|
|
|
2012-09-17 20:56:01 +00:00
|
|
|
=item B<blockcommit> I<domain> I<path> [I<bandwidth>]
|
2014-05-13 15:59:32 +00:00
|
|
|
[I<base>] [I<--shallow>] [I<top>] [I<--delete>] [I<--keep-relative>]
|
2014-05-21 04:11:29 +00:00
|
|
|
[I<--wait> [I<--async>] [I<--verbose>]] [I<--timeout> B<seconds>]
|
|
|
|
[I<--active>] [{I<--pivot> | I<--keep-overlay>}]
|
2012-09-17 20:56:01 +00:00
|
|
|
|
|
|
|
Reduce the length of a backing image chain, by committing changes at the
|
|
|
|
top of the chain (snapshot or delta files) into backing images. By
|
|
|
|
default, this command attempts to flatten the entire chain. If I<base>
|
|
|
|
and/or I<top> are specified as files within the backing chain, then the
|
|
|
|
operation is constrained to committing just that portion of the chain;
|
|
|
|
I<--shallow> can be used instead of I<base> to specify the immediate
|
|
|
|
backing file of the resulting top image to be committed. The files
|
|
|
|
being committed are rendered invalid, possibly as soon as the operation
|
2014-05-21 04:11:29 +00:00
|
|
|
starts; using the I<--delete> flag will attempt to remove these invalidated
|
2014-05-13 15:59:32 +00:00
|
|
|
files at the successful completion of the commit operation. When the
|
|
|
|
I<--keep-relative> flag is used, the backing file paths will be kept relative.
|
2014-05-21 04:11:29 +00:00
|
|
|
|
|
|
|
When I<top> is omitted or specified as the active image, it is also
|
|
|
|
possible to specify I<--active> to trigger a two-phase active commit. In
|
|
|
|
the first phase, I<top> is copied into I<base> and the job can only be
|
|
|
|
canceled, with top still containing data not yet in base. In the second
|
|
|
|
phase, I<top> and I<base> remain identical until a call to B<blockjob>
|
|
|
|
with the I<--abort> flag (keeping top as the active image that tracks
|
|
|
|
changes from that point in time) or the I<--pivot> flag (making base
|
|
|
|
the new active image and invalidating top).
|
2012-09-17 20:56:01 +00:00
|
|
|
|
|
|
|
By default, this command returns as soon as possible, and data for
|
|
|
|
the entire disk is committed in the background; the progress of the
|
|
|
|
operation can be checked with B<blockjob>. However, if I<--wait> is
|
2014-05-21 04:11:29 +00:00
|
|
|
specified, then this command will block until the operation completes
|
|
|
|
(or for I<--active>, enters the second phase), or until the operation
|
|
|
|
is canceled because the optional I<timeout> in seconds elapses
|
2012-09-17 20:56:01 +00:00
|
|
|
or SIGINT is sent (usually with C<Ctrl-C>). Using I<--verbose> along
|
2013-09-19 13:08:29 +00:00
|
|
|
with I<--wait> will produce periodic status updates. If job cancellation
|
|
|
|
is triggered, I<--async> will return control to the user as fast as
|
|
|
|
possible, otherwise the command may continue to block a little while
|
2014-05-21 04:11:29 +00:00
|
|
|
longer until the job is done cleaning up. Using I<--pivot> is shorthand
|
|
|
|
for combining I<--active> I<--wait> with an automatic B<blockjob>
|
|
|
|
I<--pivot>; and using I<--keep-overlay> is shorthand for combining
|
|
|
|
I<--active> I<--wait> with an automatic B<blockjob> I<--abort>.
|
2012-09-17 20:56:01 +00:00
|
|
|
|
|
|
|
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
|
|
|
|
also B<domblklist> for listing these names).
|
|
|
|
I<bandwidth> specifies copying bandwidth limit in MiB/s, although for
|
2014-07-15 12:35:50 +00:00
|
|
|
qemu, it may be non-zero only for an online domain. Specifying a negative
|
|
|
|
value is interpreted as an unsigned long long value or essentially
|
|
|
|
unlimited. The hypervisor can choose whether to reject the value or
|
|
|
|
convert it to the maximum value allowed.
|
2012-09-17 20:56:01 +00:00
|
|
|
|
blockcopy: expose new API in virsh
Expose the new power of virDomainBlockCopy through virsh (well,
all but the finer-grained bandwidth, as that is its own can of
worms for a later patch). Continue to use the older API where
possible, for maximum compatibility.
The command now requires either --dest (with optional --format
and --blockdev), to directly describe the file destination, or
--xml, to name a file that contains an XML description such as:
<disk type='network'>
<driver type='raw'/>
<source protocol='gluster' name='vol1/img'>
<host name='red'/>
</source>
</disk>
[well, it may be a while before the qemu driver is actually patched
to act on that particular xml beyond just parsing it, but the virsh
interface won't need changing at that time]
Non-zero option parameters are converted into virTypedParameters,
and if anything requires the new API, the command can synthesize
appropriate XML even if the --dest option was used instead of --xml.
The existing --raw flag remains for back-compat, but the preferred
spelling is now --format=raw, since the new API now allows us
to specify all formats rather than just a boolean raw to suppress
probing.
I hope I did justice in describing the effects of granularity and
buf-size on how they get passed through to qemu.
* tools/virsh-domain.c (cmdBlockCopy): Add new options --xml,
--granularity, --buf-size, --format. Make --raw an alias for
--format=raw. Call new API if new parameters are in use.
* tools/virsh.pod (blockcopy): Document new options.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-29 21:47:28 +00:00
|
|
|
=item B<blockcopy> I<domain> I<path> { I<dest> [I<format>] [I<--blockdev>]
|
2015-06-15 12:08:05 +00:00
|
|
|
| I<--xml> B<file> } [I<--shallow>] [I<--reuse-external>] [I<bandwidth>]
|
blockcopy: expose new API in virsh
Expose the new power of virDomainBlockCopy through virsh (well,
all but the finer-grained bandwidth, as that is its own can of
worms for a later patch). Continue to use the older API where
possible, for maximum compatibility.
The command now requires either --dest (with optional --format
and --blockdev), to directly describe the file destination, or
--xml, to name a file that contains an XML description such as:
<disk type='network'>
<driver type='raw'/>
<source protocol='gluster' name='vol1/img'>
<host name='red'/>
</source>
</disk>
[well, it may be a while before the qemu driver is actually patched
to act on that particular xml beyond just parsing it, but the virsh
interface won't need changing at that time]
Non-zero option parameters are converted into virTypedParameters,
and if anything requires the new API, the command can synthesize
appropriate XML even if the --dest option was used instead of --xml.
The existing --raw flag remains for back-compat, but the preferred
spelling is now --format=raw, since the new API now allows us
to specify all formats rather than just a boolean raw to suppress
probing.
I hope I did justice in describing the effects of granularity and
buf-size on how they get passed through to qemu.
* tools/virsh-domain.c (cmdBlockCopy): Add new options --xml,
--granularity, --buf-size, --format. Make --raw an alias for
--format=raw. Call new API if new parameters are in use.
* tools/virsh.pod (blockcopy): Document new options.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-29 21:47:28 +00:00
|
|
|
[I<--wait> [I<--async>] [I<--verbose>]] [{I<--pivot> | I<--finish>}]
|
|
|
|
[I<--timeout> B<seconds>] [I<granularity>] [I<buf-size>]
|
|
|
|
|
|
|
|
Copy a disk backing image chain to a destination. Either I<dest> as
|
2015-06-15 12:08:05 +00:00
|
|
|
the destination file name, or I<--xml> with the name of an XML file containing
|
blockcopy: expose new API in virsh
Expose the new power of virDomainBlockCopy through virsh (well,
all but the finer-grained bandwidth, as that is its own can of
worms for a later patch). Continue to use the older API where
possible, for maximum compatibility.
The command now requires either --dest (with optional --format
and --blockdev), to directly describe the file destination, or
--xml, to name a file that contains an XML description such as:
<disk type='network'>
<driver type='raw'/>
<source protocol='gluster' name='vol1/img'>
<host name='red'/>
</source>
</disk>
[well, it may be a while before the qemu driver is actually patched
to act on that particular xml beyond just parsing it, but the virsh
interface won't need changing at that time]
Non-zero option parameters are converted into virTypedParameters,
and if anything requires the new API, the command can synthesize
appropriate XML even if the --dest option was used instead of --xml.
The existing --raw flag remains for back-compat, but the preferred
spelling is now --format=raw, since the new API now allows us
to specify all formats rather than just a boolean raw to suppress
probing.
I hope I did justice in describing the effects of granularity and
buf-size on how they get passed through to qemu.
* tools/virsh-domain.c (cmdBlockCopy): Add new options --xml,
--granularity, --buf-size, --format. Make --raw an alias for
--format=raw. Call new API if new parameters are in use.
* tools/virsh.pod (blockcopy): Document new options.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-29 21:47:28 +00:00
|
|
|
a top-level <disk> element describing the destination, must be present.
|
|
|
|
Additionally, if I<dest> is given, I<format> should be specified to declare
|
|
|
|
the format of the destination (if I<format> is omitted, then libvirt
|
|
|
|
will reuse the format of the source, or with I<--reuse-external> will
|
|
|
|
be forced to probe the destination format, which could be a potential
|
|
|
|
security hole). The command supports I<--raw> as a boolean flag synonym for
|
|
|
|
I<--format=raw>. When using I<dest>, the destination is treated as a regular
|
|
|
|
file unless I<--blockdev> is used to signal that it is a block device. By
|
|
|
|
default, this command flattens the entire chain; but if I<--shallow> is
|
|
|
|
specified, the copy shares the backing chain.
|
|
|
|
|
|
|
|
If I<--reuse-external> is specified, then the destination must exist and have
|
2014-07-07 12:38:10 +00:00
|
|
|
sufficient space to hold the copy. If I<--shallow> is used in
|
|
|
|
conjunction with I<--reuse-external> then the pre-created image must have
|
|
|
|
guest visible contents identical to guest visible contents of the backing
|
|
|
|
file of the original image. This may be used to modify the backing file
|
|
|
|
names on the destination.
|
2012-04-12 20:31:52 +00:00
|
|
|
|
|
|
|
By default, the copy job runs in the background, and consists of two
|
|
|
|
phases. Initially, the job must copy all data from the source, and
|
|
|
|
during this phase, the job can only be canceled to revert back to the
|
|
|
|
source disk, with no guarantees about the destination. After this phase
|
|
|
|
completes, both the source and the destination remain mirrored until a
|
|
|
|
call to B<blockjob> with the I<--abort> and I<--pivot> flags pivots over
|
|
|
|
to the copy, or a call without I<--pivot> leaves the destination as a
|
|
|
|
faithful copy of that point in time. However, if I<--wait> is specified,
|
|
|
|
then this command will block until the mirroring phase begins, or cancel
|
|
|
|
the operation if the optional I<timeout> in seconds elapses or SIGINT is
|
|
|
|
sent (usually with C<Ctrl-C>). Using I<--verbose> along with I<--wait>
|
2014-06-11 15:36:49 +00:00
|
|
|
will produce periodic status updates. Using I<--pivot> (similar to
|
|
|
|
B<blockjob> I<--pivot>) or I<--finish> (similar to B<blockjob> I<--abort>)
|
|
|
|
implies I<--wait>, and will additionally end the job cleanly rather than
|
|
|
|
leaving things in the mirroring phase. If job cancellation is triggered
|
|
|
|
by timeout or by I<--finish>, I<--async> will return control to the user
|
|
|
|
as fast as possible, otherwise the command may continue to block a little
|
|
|
|
while longer until the job has actually cancelled.
|
2012-04-12 20:31:52 +00:00
|
|
|
|
|
|
|
I<path> specifies fully-qualified path of the disk.
|
2014-07-15 12:35:50 +00:00
|
|
|
I<bandwidth> specifies copying bandwidth limit in MiB/s. Specifying a negative
|
blockcopy: expose new API in virsh
Expose the new power of virDomainBlockCopy through virsh (well,
all but the finer-grained bandwidth, as that is its own can of
worms for a later patch). Continue to use the older API where
possible, for maximum compatibility.
The command now requires either --dest (with optional --format
and --blockdev), to directly describe the file destination, or
--xml, to name a file that contains an XML description such as:
<disk type='network'>
<driver type='raw'/>
<source protocol='gluster' name='vol1/img'>
<host name='red'/>
</source>
</disk>
[well, it may be a while before the qemu driver is actually patched
to act on that particular xml beyond just parsing it, but the virsh
interface won't need changing at that time]
Non-zero option parameters are converted into virTypedParameters,
and if anything requires the new API, the command can synthesize
appropriate XML even if the --dest option was used instead of --xml.
The existing --raw flag remains for back-compat, but the preferred
spelling is now --format=raw, since the new API now allows us
to specify all formats rather than just a boolean raw to suppress
probing.
I hope I did justice in describing the effects of granularity and
buf-size on how they get passed through to qemu.
* tools/virsh-domain.c (cmdBlockCopy): Add new options --xml,
--granularity, --buf-size, --format. Make --raw an alias for
--format=raw. Call new API if new parameters are in use.
* tools/virsh.pod (blockcopy): Document new options.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-29 21:47:28 +00:00
|
|
|
value is interpreted as an unsigned long long value that might be essentially
|
|
|
|
unlimited, but more likely would overflow; it is safer to use 0 for that
|
|
|
|
purpose. Specifying I<granularity> allows fine-tuning of the granularity that
|
|
|
|
will be copied when a dirty region is detected; larger values trigger less
|
|
|
|
I/O overhead but may end up copying more data overall (the default value is
|
2015-03-27 09:56:30 +00:00
|
|
|
usually correct); hypervisors may restrict this to be a power of two or fall
|
|
|
|
within a certain range. Specifying I<buf-size> will control how much data can
|
|
|
|
be simultaneously in-flight during the copy; larger values use more memory but
|
|
|
|
may allow faster completion (the default value is usually correct).
|
2012-04-12 20:31:52 +00:00
|
|
|
|
2012-02-18 16:55:45 +00:00
|
|
|
=item B<blockpull> I<domain> I<path> [I<bandwidth>] [I<base>]
|
2012-10-26 10:25:14 +00:00
|
|
|
[I<--wait> [I<--verbose>] [I<--timeout> B<seconds>] [I<--async>]]
|
2014-05-16 13:40:06 +00:00
|
|
|
[I<--keep-relative>]
|
2012-02-18 16:55:45 +00:00
|
|
|
|
|
|
|
Populate a disk from its backing image chain. By default, this command
|
|
|
|
flattens the entire chain; but if I<base> is specified, containing the
|
|
|
|
name of one of the backing files in the chain, then that file becomes
|
|
|
|
the new backing file and only the intermediate portion of the chain is
|
|
|
|
pulled. Once all requested data from the backing image chain has been
|
|
|
|
pulled, the disk no longer depends on that portion of the backing chain.
|
2012-04-12 19:12:21 +00:00
|
|
|
|
|
|
|
By default, this command returns as soon as possible, and data for
|
|
|
|
the entire disk is pulled in the background; the progress of the
|
|
|
|
operation can be checked with B<blockjob>. However, if I<--wait> is
|
|
|
|
specified, then this command will block until the operation completes,
|
|
|
|
or cancel the operation if the optional I<timeout> in seconds elapses
|
|
|
|
or SIGINT is sent (usually with C<Ctrl-C>). Using I<--verbose> along
|
|
|
|
with I<--wait> will produce periodic status updates. If job cancellation
|
|
|
|
is triggered, I<--async> will return control to the user as fast as
|
|
|
|
possible, otherwise the command may continue to block a little while
|
|
|
|
longer until the job is done cleaning up.
|
2011-07-27 02:48:28 +00:00
|
|
|
|
2014-05-16 13:40:06 +00:00
|
|
|
Using the I<--keep-relative> flag will keep the backing chain names
|
|
|
|
relative.
|
|
|
|
|
blockjob: add API for async virDomainBlockJobAbort
Block job cancellation can take a while. Now that upstream qemu 1.1
has asynchronous block cancellation, we want to expose that to the user.
Therefore, the following updates are made to the virDomainBlockJob API:
A new block job event type VIR_DOMAIN_BLOCK_JOB_CANCELED is managed by
libvirt. Regardless of the flags used with virDomainBlockJobAbort, this
event will be raised: 1. when using synchronous block_job_cancel (the
event will be synthesized by libvirt), and 2. whenever it is received
from qemu (via asynchronous block-job-cancel). Note that the event
may be detected by libvirt even before the virDomainBlockJobAbort
completes (always true when it is synthesized, but also possible if
cancellation was fast).
A new extension flag VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC is added to the
virDomainBlockJobAbort API. When enabled, this function will allow
(but not require) asynchronous operation (ie, it returns as soon as
possible, which might be before the job has actually been canceled).
When the API is used in this mode, it is the responsibility of the
caller to wait for a VIR_DOMAIN_BLOCK_JOB_CANCELED event or poll via
the virDomainGetBlockJobInfo API to check the cancellation status.
This patch also exposes the new flag through virsh, and makes virsh
slightly easier to use (--async implies --abort, and lack of any options
implies --info), although it leaves the qemu implementation for later
patches.
Signed-off-by: Adam Litke <agl@us.ibm.com>
Cc: Stefan Hajnoczi <stefanha@gmail.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2012-01-13 20:51:23 +00:00
|
|
|
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
|
|
|
|
also B<domblklist> for listing these names).
|
2014-07-15 12:35:50 +00:00
|
|
|
I<bandwidth> specifies copying bandwidth limit in MiB/s. Specifying a negative
|
|
|
|
value is interpreted as an unsigned long long value or essentially
|
|
|
|
unlimited. The hypervisor can choose whether to reject the value or
|
|
|
|
convert it to the maximum value allowed.
|
2011-07-27 02:48:28 +00:00
|
|
|
|
2011-11-15 09:02:47 +00:00
|
|
|
=item B<blkdeviotune> I<domain> I<device>
|
|
|
|
[[I<--config>] [I<--live>] | [I<--current>]]
|
2012-03-02 18:18:00 +00:00
|
|
|
[[I<total-bytes-sec>] | [I<read-bytes-sec>] [I<write-bytes-sec>]]
|
|
|
|
[[I<total-iops-sec>] | [I<read-iops-sec>] [I<write-iops-sec>]]
|
2014-10-29 12:16:05 +00:00
|
|
|
[[I<total-bytes-sec-max>] | [I<read-bytes-sec-max>] [I<write-bytes-sec-max>]]
|
|
|
|
[[I<total-iops-sec-max>] | [I<read-iops-sec-max>] [I<write-iops-sec-max>]]
|
|
|
|
[I<size-iops-sec>]
|
2011-11-15 09:02:47 +00:00
|
|
|
|
|
|
|
Set or query the block disk io parameters for a block device of I<domain>.
|
|
|
|
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).
|
|
|
|
|
|
|
|
If no limit is specified, it will query current I/O limits setting.
|
|
|
|
Otherwise, alter the limits with these flags:
|
2012-03-02 18:18:00 +00:00
|
|
|
I<--total-bytes-sec> specifies total throughput limit in bytes per second.
|
|
|
|
I<--read-bytes-sec> specifies read throughput limit in bytes per second.
|
|
|
|
I<--write-bytes-sec> specifies write throughput limit in bytes per second.
|
|
|
|
I<--total-iops-sec> specifies total I/O operations limit per second.
|
|
|
|
I<--read-iops-sec> specifies read I/O operations limit per second.
|
|
|
|
I<--write-iops-sec> specifies write I/O operations limit per second.
|
2014-10-29 12:16:05 +00:00
|
|
|
I<--total-bytes-sec-max> specifies maximum total throughput limit in bytes per second.
|
|
|
|
I<--read-bytes-sec-max> specifies maximum read throughput limit in bytes per second.
|
|
|
|
I<--write-bytes-sec-max> specifies maximum write throughput limit in bytes per second.
|
|
|
|
I<--total-iops-sec-max> specifies maximum total I/O operations limit per second.
|
|
|
|
I<--read-iops-sec-max> specifies maximum read I/O operations limit per second.
|
|
|
|
I<--write-iops-sec-max> specifies maximum write I/O operations limit per second.
|
|
|
|
I<--size-iops-sec> specifies size I/O operations limit per second.
|
2012-03-02 18:18:00 +00:00
|
|
|
|
|
|
|
Older versions of virsh only accepted these options with underscore
|
|
|
|
instead of dash, as in I<--total_bytes_sec>.
|
2011-11-15 09:02:47 +00:00
|
|
|
|
2012-02-10 21:53:49 +00:00
|
|
|
Bytes and iops values are independent, but setting only one value (such
|
2012-03-02 18:18:00 +00:00
|
|
|
as --read-bytes-sec) resets the other two in that category to unlimited.
|
2012-02-10 21:53:49 +00:00
|
|
|
An explicit 0 also clears any limit. A non-zero value for a given total
|
2011-11-15 09:02:47 +00:00
|
|
|
cannot be mixed with non-zero values for read or write.
|
|
|
|
|
|
|
|
If I<--live> is specified, affect a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
2015-01-29 07:33:51 +00:00
|
|
|
When setting the disk io parameters both I<--live> and I<--config> flags may be
|
|
|
|
given, but I<--current> is exclusive. For querying only one of I<--live>,
|
|
|
|
I<--config> or I<--current> can be specified. If no flag is specified, behavior
|
|
|
|
is different depending on hypervisor.
|
2011-11-15 09:02:47 +00:00
|
|
|
|
2012-04-12 20:31:52 +00:00
|
|
|
=item B<blockjob> I<domain> I<path> { [I<--abort>] [I<--async>] [I<--pivot>] |
|
2014-08-28 23:39:25 +00:00
|
|
|
[I<--info>] [I<--raw>] [I<--bytes>] | [I<bandwidth>] }
|
2011-07-27 02:48:28 +00:00
|
|
|
|
blockjob: add new --raw flag to virsh blockjob
The current output of 'blockjob [--info]' is a single line
designed for human consumption; it's not very nice for machine
parsing. Furthermore, I have plans to modify the line in
response to the new flag for controlling bandwidth units.
Solve that by adding a --raw parameter, which outputs
information closer to the C struct.
$ virsh blockjob testvm1 vda --raw
type=Block Copy
bandwidth=1
cur=197120
end=197120
The information is indented, because I'd like for a later patch
to add a mode that iterates over all the vm's disks with status
for each; in that mode, each block name would be listed unindented
before information (if any) about that block.
Now that we have a raw mode, we can guarantee that it won't change
format over time. Any app that cares about parsing the output can
try --raw, and if it fails, know that it was talking to an older
virsh and fall back to parsing the human-readable format which had
not changed until now; meanwhile, when not using --raw, we have
freed future virsh to change the output to whatever makes sense.
My first change to human mode: this command now guarantees a line
is printed on successful use of the API, even when the API did
not find a current block job (consistent with the rest of virsh).
Bonus: https://bugzilla.redhat.com/show_bug.cgi?id=1135441
complained that this message was confusing:
$ virsh blockjob test1 hda --async --bandwidth 10
error: conflict between --abort, --info, and --bandwidth modes
even though the man page already documents that --async implies
abort mode, all because '--abort' wasn't present in the command
line. Since I'm adding another case where options are tied
to or imply a mode, I changed that error to:
error: conflict between abort, info, and bandwidth modes
* tools/virsh-domain.c (cmdBlockJob): Add --raw parameter; tweak
error wording.
* tools/virsh.pod (blockjob): Document it.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-28 23:23:49 +00:00
|
|
|
Manage active block operations. There are three mutually-exclusive modes:
|
|
|
|
I<--info>, I<bandwidth>, and I<--abort>. I<--async> and I<--pivot> imply
|
|
|
|
abort mode; I<--raw> implies info mode; and if no mode was given, I<--info>
|
|
|
|
mode is assumed.
|
blockjob: add API for async virDomainBlockJobAbort
Block job cancellation can take a while. Now that upstream qemu 1.1
has asynchronous block cancellation, we want to expose that to the user.
Therefore, the following updates are made to the virDomainBlockJob API:
A new block job event type VIR_DOMAIN_BLOCK_JOB_CANCELED is managed by
libvirt. Regardless of the flags used with virDomainBlockJobAbort, this
event will be raised: 1. when using synchronous block_job_cancel (the
event will be synthesized by libvirt), and 2. whenever it is received
from qemu (via asynchronous block-job-cancel). Note that the event
may be detected by libvirt even before the virDomainBlockJobAbort
completes (always true when it is synthesized, but also possible if
cancellation was fast).
A new extension flag VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC is added to the
virDomainBlockJobAbort API. When enabled, this function will allow
(but not require) asynchronous operation (ie, it returns as soon as
possible, which might be before the job has actually been canceled).
When the API is used in this mode, it is the responsibility of the
caller to wait for a VIR_DOMAIN_BLOCK_JOB_CANCELED event or poll via
the virDomainGetBlockJobInfo API to check the cancellation status.
This patch also exposes the new flag through virsh, and makes virsh
slightly easier to use (--async implies --abort, and lack of any options
implies --info), although it leaves the qemu implementation for later
patches.
Signed-off-by: Adam Litke <agl@us.ibm.com>
Cc: Stefan Hajnoczi <stefanha@gmail.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2012-01-13 20:51:23 +00:00
|
|
|
|
|
|
|
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
|
|
|
|
also B<domblklist> for listing these names).
|
2011-07-27 02:48:28 +00:00
|
|
|
|
blockjob: add new --raw flag to virsh blockjob
The current output of 'blockjob [--info]' is a single line
designed for human consumption; it's not very nice for machine
parsing. Furthermore, I have plans to modify the line in
response to the new flag for controlling bandwidth units.
Solve that by adding a --raw parameter, which outputs
information closer to the C struct.
$ virsh blockjob testvm1 vda --raw
type=Block Copy
bandwidth=1
cur=197120
end=197120
The information is indented, because I'd like for a later patch
to add a mode that iterates over all the vm's disks with status
for each; in that mode, each block name would be listed unindented
before information (if any) about that block.
Now that we have a raw mode, we can guarantee that it won't change
format over time. Any app that cares about parsing the output can
try --raw, and if it fails, know that it was talking to an older
virsh and fall back to parsing the human-readable format which had
not changed until now; meanwhile, when not using --raw, we have
freed future virsh to change the output to whatever makes sense.
My first change to human mode: this command now guarantees a line
is printed on successful use of the API, even when the API did
not find a current block job (consistent with the rest of virsh).
Bonus: https://bugzilla.redhat.com/show_bug.cgi?id=1135441
complained that this message was confusing:
$ virsh blockjob test1 hda --async --bandwidth 10
error: conflict between --abort, --info, and --bandwidth modes
even though the man page already documents that --async implies
abort mode, all because '--abort' wasn't present in the command
line. Since I'm adding another case where options are tied
to or imply a mode, I changed that error to:
error: conflict between abort, info, and bandwidth modes
* tools/virsh-domain.c (cmdBlockJob): Add --raw parameter; tweak
error wording.
* tools/virsh.pod (blockjob): Document it.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-28 23:23:49 +00:00
|
|
|
In I<--abort> mode, the active job on the specified disk will
|
blockjob: add API for async virDomainBlockJobAbort
Block job cancellation can take a while. Now that upstream qemu 1.1
has asynchronous block cancellation, we want to expose that to the user.
Therefore, the following updates are made to the virDomainBlockJob API:
A new block job event type VIR_DOMAIN_BLOCK_JOB_CANCELED is managed by
libvirt. Regardless of the flags used with virDomainBlockJobAbort, this
event will be raised: 1. when using synchronous block_job_cancel (the
event will be synthesized by libvirt), and 2. whenever it is received
from qemu (via asynchronous block-job-cancel). Note that the event
may be detected by libvirt even before the virDomainBlockJobAbort
completes (always true when it is synthesized, but also possible if
cancellation was fast).
A new extension flag VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC is added to the
virDomainBlockJobAbort API. When enabled, this function will allow
(but not require) asynchronous operation (ie, it returns as soon as
possible, which might be before the job has actually been canceled).
When the API is used in this mode, it is the responsibility of the
caller to wait for a VIR_DOMAIN_BLOCK_JOB_CANCELED event or poll via
the virDomainGetBlockJobInfo API to check the cancellation status.
This patch also exposes the new flag through virsh, and makes virsh
slightly easier to use (--async implies --abort, and lack of any options
implies --info), although it leaves the qemu implementation for later
patches.
Signed-off-by: Adam Litke <agl@us.ibm.com>
Cc: Stefan Hajnoczi <stefanha@gmail.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2012-01-13 20:51:23 +00:00
|
|
|
be aborted. If I<--async> is also specified, this command will return
|
2013-11-30 06:33:17 +00:00
|
|
|
immediately, rather than waiting for the cancellation to complete. If
|
2014-05-21 04:11:29 +00:00
|
|
|
I<--pivot> is specified, this requests that an active copy or active
|
|
|
|
commit job be pivoted over to the new image.
|
blockjob: add new --raw flag to virsh blockjob
The current output of 'blockjob [--info]' is a single line
designed for human consumption; it's not very nice for machine
parsing. Furthermore, I have plans to modify the line in
response to the new flag for controlling bandwidth units.
Solve that by adding a --raw parameter, which outputs
information closer to the C struct.
$ virsh blockjob testvm1 vda --raw
type=Block Copy
bandwidth=1
cur=197120
end=197120
The information is indented, because I'd like for a later patch
to add a mode that iterates over all the vm's disks with status
for each; in that mode, each block name would be listed unindented
before information (if any) about that block.
Now that we have a raw mode, we can guarantee that it won't change
format over time. Any app that cares about parsing the output can
try --raw, and if it fails, know that it was talking to an older
virsh and fall back to parsing the human-readable format which had
not changed until now; meanwhile, when not using --raw, we have
freed future virsh to change the output to whatever makes sense.
My first change to human mode: this command now guarantees a line
is printed on successful use of the API, even when the API did
not find a current block job (consistent with the rest of virsh).
Bonus: https://bugzilla.redhat.com/show_bug.cgi?id=1135441
complained that this message was confusing:
$ virsh blockjob test1 hda --async --bandwidth 10
error: conflict between --abort, --info, and --bandwidth modes
even though the man page already documents that --async implies
abort mode, all because '--abort' wasn't present in the command
line. Since I'm adding another case where options are tied
to or imply a mode, I changed that error to:
error: conflict between abort, info, and bandwidth modes
* tools/virsh-domain.c (cmdBlockJob): Add --raw parameter; tweak
error wording.
* tools/virsh.pod (blockjob): Document it.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-28 23:23:49 +00:00
|
|
|
|
|
|
|
In I<--info> mode, the active job information on the specified
|
|
|
|
disk will be printed. By default, the output is a single human-readable
|
|
|
|
summary line; this format may change in future versions. Adding
|
2014-08-28 23:39:25 +00:00
|
|
|
I<--raw> lists each field of the struct, in a stable format. If the
|
|
|
|
I<--bytes> flag is set, then the command errors out if the server could
|
|
|
|
not supply bytes/s resolution; when omitting the flag, raw output is
|
|
|
|
listed in MiB/s and human-readable output automatically selects the
|
|
|
|
best resolution supported by the server.
|
blockjob: add new --raw flag to virsh blockjob
The current output of 'blockjob [--info]' is a single line
designed for human consumption; it's not very nice for machine
parsing. Furthermore, I have plans to modify the line in
response to the new flag for controlling bandwidth units.
Solve that by adding a --raw parameter, which outputs
information closer to the C struct.
$ virsh blockjob testvm1 vda --raw
type=Block Copy
bandwidth=1
cur=197120
end=197120
The information is indented, because I'd like for a later patch
to add a mode that iterates over all the vm's disks with status
for each; in that mode, each block name would be listed unindented
before information (if any) about that block.
Now that we have a raw mode, we can guarantee that it won't change
format over time. Any app that cares about parsing the output can
try --raw, and if it fails, know that it was talking to an older
virsh and fall back to parsing the human-readable format which had
not changed until now; meanwhile, when not using --raw, we have
freed future virsh to change the output to whatever makes sense.
My first change to human mode: this command now guarantees a line
is printed on successful use of the API, even when the API did
not find a current block job (consistent with the rest of virsh).
Bonus: https://bugzilla.redhat.com/show_bug.cgi?id=1135441
complained that this message was confusing:
$ virsh blockjob test1 hda --async --bandwidth 10
error: conflict between --abort, --info, and --bandwidth modes
even though the man page already documents that --async implies
abort mode, all because '--abort' wasn't present in the command
line. Since I'm adding another case where options are tied
to or imply a mode, I changed that error to:
error: conflict between abort, info, and bandwidth modes
* tools/virsh-domain.c (cmdBlockJob): Add --raw parameter; tweak
error wording.
* tools/virsh.pod (blockjob): Document it.
Signed-off-by: Eric Blake <eblake@redhat.com>
2014-08-28 23:23:49 +00:00
|
|
|
|
2011-07-27 02:48:28 +00:00
|
|
|
I<bandwidth> can be used to set bandwidth limit for the active job.
|
2014-07-15 12:35:50 +00:00
|
|
|
Specifying a negative value is interpreted as an unsigned long long
|
|
|
|
value or essentially unlimited. The hypervisor can choose whether to
|
|
|
|
reject the value or convert it to the maximum value allowed.
|
2011-07-27 02:48:28 +00:00
|
|
|
|
2012-03-08 01:10:30 +00:00
|
|
|
=item B<blockresize> I<domain> I<path> I<size>
|
2011-11-29 07:37:09 +00:00
|
|
|
|
2012-03-08 01:10:30 +00:00
|
|
|
Resize a block device of domain while the domain is running, I<path>
|
blockjob: add API for async virDomainBlockJobAbort
Block job cancellation can take a while. Now that upstream qemu 1.1
has asynchronous block cancellation, we want to expose that to the user.
Therefore, the following updates are made to the virDomainBlockJob API:
A new block job event type VIR_DOMAIN_BLOCK_JOB_CANCELED is managed by
libvirt. Regardless of the flags used with virDomainBlockJobAbort, this
event will be raised: 1. when using synchronous block_job_cancel (the
event will be synthesized by libvirt), and 2. whenever it is received
from qemu (via asynchronous block-job-cancel). Note that the event
may be detected by libvirt even before the virDomainBlockJobAbort
completes (always true when it is synthesized, but also possible if
cancellation was fast).
A new extension flag VIR_DOMAIN_BLOCK_JOB_ABORT_ASYNC is added to the
virDomainBlockJobAbort API. When enabled, this function will allow
(but not require) asynchronous operation (ie, it returns as soon as
possible, which might be before the job has actually been canceled).
When the API is used in this mode, it is the responsibility of the
caller to wait for a VIR_DOMAIN_BLOCK_JOB_CANCELED event or poll via
the virDomainGetBlockJobInfo API to check the cancellation status.
This patch also exposes the new flag through virsh, and makes virsh
slightly easier to use (--async implies --abort, and lack of any options
implies --info), although it leaves the qemu implementation for later
patches.
Signed-off-by: Adam Litke <agl@us.ibm.com>
Cc: Stefan Hajnoczi <stefanha@gmail.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2012-01-13 20:51:23 +00:00
|
|
|
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
|
|
|
|
also B<domblklist> for listing these names).
|
|
|
|
|
|
|
|
I<size> is a scaled integer (see B<NOTES> above) which defaults to KiB
|
|
|
|
(blocks of 1024 bytes) if there is no suffix. You must use a suffix of
|
|
|
|
"B" to get bytes (note that for historical reasons, this differs from
|
|
|
|
B<vol-resize> which defaults to bytes without a suffix).
|
2011-11-29 07:37:09 +00:00
|
|
|
|
2014-11-21 10:10:21 +00:00
|
|
|
=item B<domdisplay> I<domain> [I<--include-password>] [[I<--type>] B<type>]
|
2012-06-24 21:14:54 +00:00
|
|
|
|
|
|
|
Output a URI which can be used to connect to the graphical display of the
|
2014-11-21 10:10:21 +00:00
|
|
|
domain via VNC, SPICE or RDP. The particular graphical display type can
|
|
|
|
be selected using the B<type> parameter (e.g. "vnc", "spice", "rdp"). If
|
|
|
|
I<--include-password> is specified, the SPICE channel password will be
|
|
|
|
included in the URI.
|
2012-06-24 21:14:54 +00:00
|
|
|
|
2014-11-22 01:27:52 +00:00
|
|
|
=item B<domfsinfo> I<domain>
|
|
|
|
|
|
|
|
Show a list of mounted filesystems within the running domain. The list contains
|
|
|
|
mountpoints, names of a mounted device in the guest, filesystem types, and
|
|
|
|
unique target names used in the domain XML (<target dev='name'/>).
|
|
|
|
|
|
|
|
Note that this command requires a guest agent configured and running in the
|
|
|
|
domain's guest OS.
|
|
|
|
|
2014-05-02 00:06:13 +00:00
|
|
|
=item B<domfsfreeze> I<domain> [[I<--mountpoint>] B<mountpoint>...]
|
|
|
|
|
|
|
|
Freeze mounted filesystems within a running domain to prepare for consistent
|
|
|
|
snapshots.
|
|
|
|
|
|
|
|
The I<--mountpoint> option takes a parameter B<mountpoint>, which is a
|
|
|
|
mount point path of the filesystem to be frozen. This option can occur
|
|
|
|
multiple times. If this is not specified, every mounted filesystem is frozen.
|
|
|
|
|
|
|
|
Note: B<snapshot-create> command has a I<--quiesce> option to freeze
|
|
|
|
and thaw the filesystems automatically to keep snapshots consistent.
|
|
|
|
B<domfsfreeze> command is only needed when a user wants to utilize the
|
|
|
|
native snapshot features of storage devices not supported by libvirt.
|
|
|
|
|
|
|
|
=item B<domfsthaw> I<domain> [[I<--mountpoint>] B<mountpoint>...]
|
|
|
|
|
|
|
|
Thaw mounted filesystems within a running domain, which have been frozen by
|
|
|
|
domfsfreeze command.
|
|
|
|
|
|
|
|
The I<--mountpoint> option takes a parameter B<mountpoint>, which is a
|
|
|
|
mount point path of the filesystem to be thawed. This option can occur
|
|
|
|
multiple times. If this is not specified, every mounted filesystem is thawed.
|
|
|
|
|
2012-11-20 17:23:20 +00:00
|
|
|
=item B<domfstrim> I<domain> [I<--minimum> B<bytes>]
|
|
|
|
[I<--mountpoint mountPoint>]
|
|
|
|
|
|
|
|
Issue a fstrim command on all mounted filesystems within a running
|
|
|
|
domain. It discards blocks which are not in use by the filesystem.
|
|
|
|
If I<--minimum> B<bytes> is specified, it tells guest kernel length
|
|
|
|
of contiguous free range. Smaller than this may be ignored (this is
|
|
|
|
a hint and the guest may not respect it). By increasing this value,
|
|
|
|
the fstrim operation will complete more quickly for filesystems
|
|
|
|
with badly fragmented free space, although not all blocks will
|
|
|
|
be discarded. The default value is zero, meaning "discard
|
|
|
|
every free block". Moreover, a if user wants to trim only one mount
|
|
|
|
point, it can be specified via optional I<--mountpoint> parameter.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<domhostname> I<domain>
|
2012-07-10 10:45:30 +00:00
|
|
|
|
|
|
|
Returns the hostname of a domain, if the hypervisor makes it available.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<dominfo> I<domain>
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Returns basic information about the domain.
|
|
|
|
|
|
|
|
=item B<domuuid> I<domain-name-or-id>
|
|
|
|
|
|
|
|
Convert a domain name or id to domain UUID
|
|
|
|
|
2008-04-15 15:20:43 +00:00
|
|
|
=item B<domid> I<domain-name-or-uuid>
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2008-04-15 15:20:43 +00:00
|
|
|
Convert a domain name (or UUID) to a domain id
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<domjobabort> I<domain>
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Abort the currently running domain job.
|
|
|
|
|
2014-08-22 12:29:41 +00:00
|
|
|
=item B<domjobinfo> I<domain> [I<--completed>]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2014-08-22 12:29:41 +00:00
|
|
|
Returns information about jobs running on a domain. I<--completed> tells
|
|
|
|
virsh to return information about a recently finished job. Statistics of
|
|
|
|
a completed job are automatically destroyed once read or when libvirtd
|
2014-08-28 14:37:38 +00:00
|
|
|
is restarted. Note that time information returned for completed
|
|
|
|
migrations may be completely irrelevant unless both source and
|
|
|
|
destination hosts have synchronized time (i.e., NTP daemon is running
|
|
|
|
on both of them).
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2008-04-15 15:20:43 +00:00
|
|
|
=item B<domname> I<domain-id-or-uuid>
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2008-04-15 15:20:43 +00:00
|
|
|
Convert a domain Id (or UUID) to domain name
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2015-08-10 19:59:15 +00:00
|
|
|
=item B<domrename> I<domain> I<new-name>
|
|
|
|
|
|
|
|
Rename a domain. This command changes current domain name to the new name
|
|
|
|
specified in the second argument.
|
|
|
|
|
|
|
|
B<Note>: Domain must be inactive and without snapshots.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<domstate> I<domain> [I<--reason>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2011-04-29 08:20:49 +00:00
|
|
|
Returns state about a domain. I<--reason> tells virsh to also print
|
|
|
|
reason for the state.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<domcontrol> I<domain>
|
2011-05-31 16:21:58 +00:00
|
|
|
|
|
|
|
Returns state of an interface to VMM used to control a domain. For
|
|
|
|
states other than "ok" or "error" the command also prints number of
|
|
|
|
seconds elapsed since the control interface entered its current state.
|
|
|
|
|
2014-04-02 16:50:12 +00:00
|
|
|
=item B<domtime> I<domain> { [I<--now>] [I<--pretty>] [I<--sync>]
|
|
|
|
[I<--time> B<time>] }
|
|
|
|
|
|
|
|
Gets or sets the domain's system time. When run without any arguments
|
|
|
|
(but I<domain>), the current domain's system time is printed out. The
|
|
|
|
I<--pretty> modifier can be used to print the time in more human
|
|
|
|
readable form.
|
|
|
|
|
|
|
|
When I<--time> B<time> is specified, the domain's time is
|
|
|
|
not gotten but set instead. The I<--now> modifier acts like if it was
|
|
|
|
an alias for I<--time> B<$now>, which means it sets the time that is
|
|
|
|
currently on the host virsh is running at. In both cases (setting and
|
|
|
|
getting), time is in seconds relative to Epoch of 1970-01-01 in UTC.
|
|
|
|
The I<--sync> modifies the set behavior a bit: The time passed is
|
|
|
|
ignored, but the time to set is read from domain's RTC instead. Please
|
|
|
|
note, that some hypervisors may require a guest agent to be configured
|
|
|
|
in order to get or set the guest time.
|
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
=item B<domxml-from-native> I<format> I<config>
|
|
|
|
|
|
|
|
Convert the file I<config> in the native guest configuration format
|
2011-12-20 10:59:01 +00:00
|
|
|
named by I<format> to a domain XML format. For QEMU/KVM hypervisor,
|
|
|
|
the I<format> argument must be B<qemu-argv>. For Xen hypervisor, the
|
2014-12-16 04:30:06 +00:00
|
|
|
I<format> argument may be B<xen-xm>, B<xen-xl>, or B<xen-sxpr>. For
|
|
|
|
LXC hypervisor, the I<format> argument must be B<lxc-tools>.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
=item B<domxml-to-native> I<format> I<xml>
|
|
|
|
|
|
|
|
Convert the file I<xml> in domain XML format to the native guest
|
2011-12-20 10:59:01 +00:00
|
|
|
configuration format named by I<format>. For QEMU/KVM hypervisor,
|
|
|
|
the I<format> argument must be B<qemu-argv>. For Xen hypervisor, the
|
2014-12-16 04:30:06 +00:00
|
|
|
I<format> argument may be B<xen-xm>, B<xen-xl>, or B<xen-sxpr>. For
|
|
|
|
LXC hypervisor, the I<format> argument must be B<lxc-tools>.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<dump> I<domain> I<corefilepath> [I<--bypass-cache>]
|
2012-06-12 03:07:04 +00:00
|
|
|
{ [I<--live>] | [I<--crash>] | [I<--reset>] } [I<--verbose>] [I<--memory-only>]
|
2014-03-23 03:51:15 +00:00
|
|
|
[I<--format> I<string>]
|
2008-04-15 15:20:43 +00:00
|
|
|
|
|
|
|
Dumps the core of a domain to a file for analysis.
|
2011-07-09 03:09:16 +00:00
|
|
|
If I<--live> is specified, the domain continues to run until the core
|
|
|
|
dump is complete, rather than pausing up front.
|
|
|
|
If I<--crash> is specified, the domain is halted with a crashed status,
|
|
|
|
rather than merely left in a paused state.
|
2011-09-26 12:39:16 +00:00
|
|
|
If I<--reset> is specified, the domain is reset after successful dump.
|
|
|
|
Note, these three switches are mutually exclusive.
|
2011-07-09 03:09:16 +00:00
|
|
|
If I<--bypass-cache> is specified, the save will avoid the file system
|
|
|
|
cache, although this may slow down the operation.
|
2012-06-12 03:07:04 +00:00
|
|
|
If I<--memory-only> is specified, the file is elf file, and will only
|
|
|
|
include domain's memory and cpu common register value. It is very
|
|
|
|
useful if the domain uses host devices directly.
|
2014-03-23 03:51:15 +00:00
|
|
|
I<--format> I<string> is used to specify the format of 'memory-only'
|
|
|
|
dump, and I<string> can be one of them: elf, kdump-zlib(kdump-compressed
|
|
|
|
format with zlib-compressed), kdump-lzo(kdump-compressed format with
|
|
|
|
lzo-compressed), kdump-snappy(kdump-compressed format with snappy-compressed).
|
2008-04-15 15:20:43 +00:00
|
|
|
|
2011-09-26 12:55:22 +00:00
|
|
|
The progress may be monitored using B<domjobinfo> virsh command and canceled
|
2011-12-20 13:56:33 +00:00
|
|
|
with B<domjobabort> command (sent by another virsh instance). Another option
|
|
|
|
is to send SIGINT (usually with C<Ctrl-C>) to the virsh process running
|
|
|
|
B<dump> command. I<--verbose> displays the progress of dump.
|
2011-09-26 12:55:22 +00:00
|
|
|
|
2011-09-16 10:04:40 +00:00
|
|
|
NOTE: Some hypervisors may require the user to manually ensure proper
|
|
|
|
permissions on file and path specified by argument I<corefilepath>.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<dumpxml> I<domain> [I<--inactive>] [I<--security-info>]
|
2012-10-08 09:58:05 +00:00
|
|
|
[I<--update-cpu>] [I<--migratable>]
|
2010-04-06 13:51:41 +00:00
|
|
|
|
|
|
|
Output the domain information as an XML dump to stdout, this format can be used
|
|
|
|
by the B<create> command. Additional options affecting the XML dump may be
|
|
|
|
used. I<--inactive> tells virsh to dump domain configuration that will be used
|
|
|
|
on next start of the domain as opposed to the current domain configuration.
|
2011-08-16 19:34:22 +00:00
|
|
|
Using I<--security-info> will also include security sensitive information
|
2010-04-06 13:51:41 +00:00
|
|
|
in the XML dump. I<--update-cpu> updates domain CPU requirements according to
|
2012-10-08 09:58:05 +00:00
|
|
|
host CPU. With I<--migratable> one can request an XML that is suitable for
|
|
|
|
migrations, i.e., compatible with older libvirt releases and possibly amended
|
|
|
|
with internal run-time options. This option may automatically enable other
|
|
|
|
options (I<--update-cpu>, I<--security-info>, ...) as necessary.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<edit> I<domain>
|
2008-08-01 14:30:41 +00:00
|
|
|
|
2011-12-12 21:28:31 +00:00
|
|
|
Edit the XML configuration file for a domain, which will affect the
|
|
|
|
next boot of the guest.
|
2008-08-01 14:30:41 +00:00
|
|
|
|
|
|
|
This is equivalent to:
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2011-12-12 21:28:31 +00:00
|
|
|
virsh dumpxml --inactive --security-info domain > domain.xml
|
2010-11-17 14:15:12 +00:00
|
|
|
vi domain.xml (or make changes with your other text editor)
|
2008-08-01 14:30:41 +00:00
|
|
|
virsh define domain.xml
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2008-08-01 14:30:41 +00:00
|
|
|
except that it does some error checking.
|
|
|
|
|
2010-03-12 16:33:22 +00:00
|
|
|
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
|
|
|
|
variables, and defaults to C<vi>.
|
2008-08-01 14:30:41 +00:00
|
|
|
|
2014-02-24 23:57:06 +00:00
|
|
|
=item B<event> {[I<domain>] { I<event> | I<--all> } [I<--loop>]
|
|
|
|
[I<--timeout> I<seconds>] | I<--list>}
|
2014-02-14 23:59:35 +00:00
|
|
|
|
|
|
|
Wait for a class of domain events to occur, and print appropriate details
|
|
|
|
of events as they happen. The events can optionally be filtered by
|
|
|
|
I<domain>. Using I<--list> as the only argument will provide a list
|
|
|
|
of possible I<event> values known by this client, although the connection
|
2014-02-24 23:57:06 +00:00
|
|
|
might not allow registering for all these events. It is also possible
|
|
|
|
to use I<--all> instead of I<event> to register for all possible event
|
|
|
|
types at once.
|
2014-02-14 23:59:35 +00:00
|
|
|
|
|
|
|
By default, this command is one-shot, and returns success once an event
|
|
|
|
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
|
|
|
|
If I<--timeout> is specified, the command gives up waiting for events
|
|
|
|
after I<seconds> have elapsed. With I<--loop>, the command prints all
|
|
|
|
events until a timeout or interrupt key.
|
|
|
|
|
2015-03-25 16:15:04 +00:00
|
|
|
=item B<iothreadinfo> I<domain> [[I<--live>] [I<--config>] | [I<--current>]]
|
2015-02-11 20:29:22 +00:00
|
|
|
|
|
|
|
Display basic domain IOThreads information including the IOThread ID and
|
|
|
|
the CPU Affinity for each IOThread.
|
|
|
|
|
|
|
|
If I<--live> is specified, get the IOThreads data from the running guest. If
|
|
|
|
the guest is not running, an error is returned.
|
|
|
|
If I<--config> is specified, get the IOThreads data from the next boot of
|
|
|
|
a persistent guest.
|
|
|
|
If I<--current> is specified or I<--live> and I<--config> are not specified,
|
|
|
|
then get the IOThread data based on the current guest state.
|
|
|
|
|
2015-03-06 00:08:04 +00:00
|
|
|
=item B<iothreadpin> I<domain> I<iothread> I<cpulist>
|
|
|
|
[[I<--live>] [I<--config>] | [I<--current>]]
|
|
|
|
|
|
|
|
Change the pinning of a domain IOThread to host physical CPUs. In order
|
2015-03-25 16:15:04 +00:00
|
|
|
to retrieve a list of all IOThreads, use B<iothreadinfo>. To pin an
|
2015-03-06 00:08:04 +00:00
|
|
|
I<iothread> specify the I<cpulist> desired for the IOThread ID as listed
|
2015-03-25 16:15:04 +00:00
|
|
|
in the B<iothreadinfo> output.
|
2015-03-06 00:08:04 +00:00
|
|
|
|
|
|
|
I<cpulist> is a list of physical CPU numbers. Its syntax is a comma
|
|
|
|
separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can
|
|
|
|
also be allowed. The '-' denotes the range and the '^' denotes exclusive.
|
|
|
|
If you want to reset iothreadpin setting, that is, to pin an I<iothread>
|
|
|
|
to all physical cpus, simply specify 'r' as a I<cpulist>.
|
|
|
|
|
|
|
|
If I<--live> is specified, affect a running guest. If the guest is not running,
|
|
|
|
an error is returned.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified or I<--live> and I<--config> are not specified,
|
|
|
|
affect the current guest state.
|
|
|
|
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
|
|
|
|
but I<--current> is exclusive.
|
|
|
|
If no flag is specified, behavior is different depending on hypervisor.
|
|
|
|
|
|
|
|
B<Note>: The expression is sequentially evaluated, so "0-15,^8" is
|
|
|
|
identical to "9-14,0-7,15" but not identical to "^8,0-15".
|
|
|
|
|
2015-03-18 13:01:50 +00:00
|
|
|
=item B<iothreadadd> I<domain> I<iothread_id>
|
|
|
|
[[I<--config>] [I<--live>] | [I<--current>]]
|
|
|
|
|
|
|
|
Add a new IOThread to the domain using the specified I<iothread_id>.
|
|
|
|
If the I<iothread_id> already exists, the command will fail. The
|
|
|
|
I<iothread_id> must be greater than zero.
|
|
|
|
|
|
|
|
If I<--live> is specified, affect a running guest. If the guest is not
|
|
|
|
running an error is returned.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified or I<--live> and I<--config> are not specified,
|
|
|
|
affect the current guest state.
|
|
|
|
|
|
|
|
=item B<iothreaddel> I<domain> I<iothread_id>
|
|
|
|
[[I<--config>] [I<--live>] | [I<--current>]]
|
|
|
|
|
|
|
|
Delete an IOThread from the domain using the specified I<iothread_id>.
|
|
|
|
If an IOThread is currently assigned to a disk resource such as via the
|
|
|
|
B<attach-disk> command, then the attempt to remove the IOThread will fail.
|
|
|
|
If the I<iothread_id> does not exist an error will occur.
|
|
|
|
|
|
|
|
If I<--live> is specified, affect a running guest. If the guest is not
|
|
|
|
running an error is returned.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified or I<--live> and I<--config> are not specified,
|
|
|
|
affect the current guest state.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<managedsave> I<domain> [I<--bypass-cache>]
|
2011-12-20 14:50:52 +00:00
|
|
|
[{I<--running> | I<--paused>}] [I<--verbose>]
|
2010-04-01 16:05:38 +00:00
|
|
|
|
2011-07-06 21:42:47 +00:00
|
|
|
Save and destroy (stop) a running domain, so it can be restarted from the same
|
2010-10-29 00:50:15 +00:00
|
|
|
state at a later time. When the virsh B<start> command is next run for
|
|
|
|
the domain, it will automatically be started from this saved state.
|
2011-07-09 03:09:16 +00:00
|
|
|
If I<--bypass-cache> is specified, the save will avoid the file system
|
|
|
|
cache, although this may slow down the operation.
|
2010-04-01 16:05:38 +00:00
|
|
|
|
2011-09-26 12:55:22 +00:00
|
|
|
The progress may be monitored using B<domjobinfo> virsh command and canceled
|
2011-12-20 14:50:52 +00:00
|
|
|
with B<domjobabort> command (sent by another virsh instance). Another option
|
|
|
|
is to send SIGINT (usually with C<Ctrl-C>) to the virsh process running
|
|
|
|
B<managedsave> command. I<--verbose> displays the progress of save.
|
2011-09-26 12:55:22 +00:00
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
Normally, starting a managed save will decide between running or paused
|
|
|
|
based on the state the domain was in when the save was done; passing
|
|
|
|
either the I<--running> or I<--paused> flag will allow overriding which
|
|
|
|
state the B<start> should use.
|
|
|
|
|
2011-07-19 06:24:57 +00:00
|
|
|
The B<dominfo> command can be used to query whether a domain currently
|
|
|
|
has any managed save image.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<managedsave-remove> I<domain>
|
2010-06-22 13:50:17 +00:00
|
|
|
|
2010-10-29 00:50:15 +00:00
|
|
|
Remove the B<managedsave> state file for a domain, if it exists. This
|
|
|
|
ensures the domain will do a full boot the next time it is started.
|
2010-06-22 13:50:17 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<maxvcpus> [I<type>]
|
2010-09-29 21:20:23 +00:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2012-03-02 02:54:24 +00:00
|
|
|
=item B<cpu-stats> I<domain> [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
|
|
|
|
I<--total> for only the total stats, I<start> for only the per-cpu
|
|
|
|
stats of the CPUs from I<start>, I<count> for only I<count> CPUs'
|
|
|
|
stats.
|
|
|
|
|
2014-08-15 15:08:29 +00:00
|
|
|
=item B<metadata> I<domain> [[I<--live>] [I<--config>] | [I<--current>]]
|
|
|
|
[I<--edit>] [I<uri>] [I<key>] [I<set>] [I<--remove>]
|
|
|
|
|
|
|
|
Show or modify custom XML metadata of a domain. The metadata is a user
|
|
|
|
defined XML that allows to store arbitrary XML data in the domain definition.
|
|
|
|
Multiple separate custom metadata pieces can be stored in the domain XML.
|
|
|
|
The pieces are identified by a private XML namespace provided via the
|
2014-08-18 14:47:13 +00:00
|
|
|
I<uri> argument. (See also B<desc> that works with textual metadata of
|
|
|
|
a domain.)
|
2014-08-15 15:08:29 +00:00
|
|
|
|
|
|
|
Flags I<--live> or I<--config> select whether this command works on live
|
|
|
|
or persistent definitions of the domain. If both I<--live> and I<--config>
|
|
|
|
are specified, the I<--config> option takes precedence on getting the current
|
|
|
|
description and both live configuration and config are updated while setting
|
|
|
|
the description. I<--current> is exclusive and implied if none of these was
|
|
|
|
specified.
|
|
|
|
|
|
|
|
Flag I<--remove> specifies that the metadata element specified by the I<uri>
|
|
|
|
argument should be removed rather than updated.
|
|
|
|
|
|
|
|
Flag I<--edit> specifies that an editor with the metadata identified by the
|
|
|
|
I<uri> argument should be opened and the contents saved back afterwards.
|
|
|
|
Otherwise the new contents can be provided via the I<set> argument.
|
|
|
|
|
|
|
|
When setting metadata via I<--edit> or I<set> the I<key> argument must be
|
|
|
|
specified and is used to prefix the custom elements to bind them
|
|
|
|
to the private namespace.
|
|
|
|
|
|
|
|
If neither of I<--edit> and I<set> are specified the XML metadata corresponding
|
|
|
|
to the I<uri> namespace is displayed instead of being modified.
|
|
|
|
|
2012-11-21 08:28:49 +00:00
|
|
|
=item B<migrate> [I<--live>] [I<--offline>] [I<--direct>] [I<--p2p> [I<--tunnelled>]]
|
2011-07-14 17:36:21 +00:00
|
|
|
[I<--persistent>] [I<--undefinesource>] [I<--suspend>] [I<--copy-storage-all>]
|
2012-02-21 12:19:46 +00:00
|
|
|
[I<--copy-storage-inc>] [I<--change-protection>] [I<--unsafe>] [I<--verbose>]
|
2014-08-19 12:56:11 +00:00
|
|
|
[I<--compressed>] [I<--abort-on-error>] [I<--auto-converge>]
|
2013-10-08 11:49:25 +00:00
|
|
|
I<domain> I<desturi> [I<migrateuri>] [I<graphicsuri>] [I<listen-address>]
|
|
|
|
[I<dname>] [I<--timeout> B<seconds>] [I<--xml> B<file>]
|
2015-06-15 22:42:11 +00:00
|
|
|
[I<--migrate-disks> B<disk-list>]
|
2010-11-18 08:21:05 +00:00
|
|
|
|
2012-11-21 08:28:49 +00:00
|
|
|
Migrate domain to another host. Add I<--live> for live migration; <--p2p>
|
2010-11-18 08:21:05 +00:00
|
|
|
for peer-2-peer migration; I<--direct> for direct migration; or I<--tunnelled>
|
2012-11-21 08:28:49 +00:00
|
|
|
for tunnelled migration. I<--offline> migrates domain definition without
|
|
|
|
starting the domain on destination and without stopping it on source host.
|
|
|
|
Offline migration may be used with inactive domains and it must be used with
|
|
|
|
I<--persistent> option. I<--persistent> leaves the domain persistent on
|
2010-11-18 08:21:05 +00:00
|
|
|
destination host, I<--undefinesource> undefines the domain on the source host,
|
|
|
|
and I<--suspend> leaves the domain paused on the destination host.
|
|
|
|
I<--copy-storage-all> indicates migration with non-shared storage with full
|
|
|
|
disk copy, I<--copy-storage-inc> indicates migration with non-shared storage
|
|
|
|
with incremental copy (same base image shared between source and destination).
|
2011-09-26 13:09:08 +00:00
|
|
|
In both cases the disk images have to exist on destination host, the
|
|
|
|
I<--copy-storage-...> options only tell libvirt to transfer data from the
|
|
|
|
images on source host to the images found at the same place on the destination
|
2015-06-15 22:42:11 +00:00
|
|
|
host. By default only non-shared non-readonly images are transferred. Use
|
|
|
|
I<--migrate-disks> to explicitly specify a list of disk targets to
|
|
|
|
transfer via the comma separated B<disk-list> argument. I<--change-protection>
|
|
|
|
enforces that no incompatible configuration changes will be made to the domain
|
|
|
|
while the migration is underway; this flag is implicitly enabled when supported
|
|
|
|
by the hypervisor, but can be explicitly used to reject the migration if the
|
|
|
|
hypervisor lacks change protection support. I<--verbose> displays the progress
|
|
|
|
of migration. I<--compressed> activates compression of memory pages that have
|
|
|
|
to be transferred repeatedly during live migration. I<--abort-on-error> cancels
|
|
|
|
the migration if a soft error (for example I/O error) happens during the
|
|
|
|
migration. I<--auto-converge> forces convergence during live migration.
|
2010-11-18 08:21:05 +00:00
|
|
|
|
2012-07-12 13:27:18 +00:00
|
|
|
B<Note>: Individual hypervisors usually do not support all possible types of
|
|
|
|
migration. For example, QEMU does not support direct migration.
|
|
|
|
|
2012-02-21 12:19:46 +00:00
|
|
|
In some cases libvirt may refuse to migrate the domain because doing so may
|
|
|
|
lead to potential problems such as data corruption, and thus the migration is
|
|
|
|
considered unsafe. For QEMU domain, this may happen if the domain uses disks
|
|
|
|
without explicitly setting cache mode to "none". Migrating such domains is
|
|
|
|
unsafe unless the disk images are stored on coherent clustered filesystem,
|
|
|
|
such as GFS2 or GPFS. If you are sure the migration is safe or you just do not
|
|
|
|
care, use I<--unsafe> to force the migration.
|
|
|
|
|
2010-11-18 08:21:05 +00:00
|
|
|
I<dname> is used for renaming the domain to new name during migration, which
|
2011-07-19 20:24:29 +00:00
|
|
|
also usually can be omitted. Likewise, I<--xml> B<file> is usually
|
|
|
|
omitted, but can be used to supply an alternative XML file for use on
|
|
|
|
the destination to supply a larger set of changes to any host-specific
|
|
|
|
portions of the domain XML, such as accounting for naming differences
|
|
|
|
between source and destination in accessing underlying storage.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--timeout> B<seconds> forces guest to suspend when live migration exceeds
|
|
|
|
that many seconds, and
|
2011-01-25 10:14:45 +00:00
|
|
|
then the migration will complete offline. It can only be used with I<--live>.
|
|
|
|
|
2011-09-26 12:55:22 +00:00
|
|
|
Running migration can be canceled by interrupting virsh (usually using
|
|
|
|
C<Ctrl-C>) or by B<domjobabort> command sent from another virsh instance.
|
|
|
|
|
2014-06-09 09:49:22 +00:00
|
|
|
The I<desturi> and I<migrateuri> parameters can be used to control which
|
|
|
|
destination the migration uses. I<desturi> is important for managed
|
|
|
|
migration, but unused for direct migration; I<migrateuri> is required
|
|
|
|
for direct migration, but can usually be automatically determined for
|
|
|
|
managed migration.
|
|
|
|
|
2011-01-12 06:12:39 +00:00
|
|
|
B<Note>: The I<desturi> parameter for normal migration and peer2peer migration
|
|
|
|
has different semantics:
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item * normal migration: the I<desturi> is an address of the target host as
|
|
|
|
seen from the client machine.
|
|
|
|
|
|
|
|
=item * peer2peer migration: the I<desturi> is an address of the target host as
|
|
|
|
seen from the source machine.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
2013-02-11 06:22:00 +00:00
|
|
|
When I<migrateuri> is not specified, libvirt will automatically determine the
|
2014-06-09 09:49:22 +00:00
|
|
|
hypervisor specific URI. Some hypervisors, including QEMU, have an optional
|
|
|
|
"migration_host" configuration parameter (useful when the host has multiple
|
|
|
|
network interfaces). If this is unspecified, libvirt determines a name
|
|
|
|
by looking up the target host's configured hostname.
|
|
|
|
|
2013-02-11 06:22:00 +00:00
|
|
|
There are a few scenarios where specifying I<migrateuri> may help:
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item * The configured hostname is incorrect, or DNS is broken. If a host has a
|
|
|
|
hostname which will not resolve to match one of its public IP addresses, then
|
|
|
|
libvirt will generate an incorrect URI. In this case I<migrateuri> should be
|
|
|
|
explicitly specified, using an IP address, or a correct hostname.
|
|
|
|
|
2013-11-30 06:33:17 +00:00
|
|
|
=item * The host has multiple network interfaces. If a host has multiple network
|
2013-02-11 06:22:00 +00:00
|
|
|
interfaces, it might be desirable for the migration data stream to be sent over
|
|
|
|
a specific interface for either security or performance reasons. In this case
|
|
|
|
I<migrateuri> should be explicitly specified, using an IP address associated
|
|
|
|
with the network to be used.
|
|
|
|
|
|
|
|
=item * The firewall restricts what ports are available. When libvirt generates
|
|
|
|
a migration URI, it will pick a port number using hypervisor specific rules.
|
|
|
|
Some hypervisors only require a single port to be open in the firewalls, while
|
|
|
|
others require a whole range of port numbers. In the latter case I<migrateuri>
|
|
|
|
might be specified to choose a specific port number outside the default range in
|
|
|
|
order to comply with local firewall policies.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
2014-06-09 09:49:22 +00:00
|
|
|
See L<http://libvirt.org/migration.html#uris> for more details on
|
|
|
|
migration URIs.
|
|
|
|
|
2013-06-18 07:46:49 +00:00
|
|
|
Optional I<graphicsuri> overrides connection parameters used for automatically
|
|
|
|
reconnecting a graphical clients at the end of migration. If omitted, libvirt
|
|
|
|
will compute the parameters based on target host IP address. In case the
|
|
|
|
client does not have a direct access to the network virtualization hosts are
|
|
|
|
connected to and needs to connect through a proxy, I<graphicsuri> may be used
|
|
|
|
to specify the address the client should connect to. The URI is formed as
|
|
|
|
follows:
|
|
|
|
|
|
|
|
protocol://hostname[:port]/[?parameters]
|
|
|
|
|
|
|
|
where protocol is either "spice" or "vnc" and parameters is a list of protocol
|
|
|
|
specific parameters separated by '&'. Currently recognized parameters are
|
|
|
|
"tlsPort" and "tlsSubject". For example,
|
|
|
|
|
|
|
|
spice://target.host.com:1234/?tlsPort=4567
|
|
|
|
|
2013-10-08 11:49:25 +00:00
|
|
|
Optional I<listen-address> sets the listen address that hypervisor on the
|
|
|
|
destination side should bind to for incoming migration. Both IPv4 and IPv6
|
|
|
|
addresses are accepted as well as hostnames (the resolving is done on
|
|
|
|
destination). Some hypervisors do not support this feature and will return an
|
|
|
|
error if this parameter is used.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<migrate-setmaxdowntime> I<domain> I<downtime>
|
2010-03-17 16:18:36 +00:00
|
|
|
|
|
|
|
Set maximum tolerable downtime for a domain which is being live-migrated to
|
|
|
|
another host. The I<downtime> is a number of milliseconds the guest is allowed
|
|
|
|
to be down at the end of live migration.
|
|
|
|
|
2013-02-18 20:14:49 +00:00
|
|
|
=item B<migrate-compcache> I<domain> [I<--size> B<bytes>]
|
|
|
|
|
|
|
|
Sets and/or gets size of the cache (in bytes) used for compressing repeatedly
|
|
|
|
transferred memory pages during live migration. When called without I<size>,
|
|
|
|
the command just prints current size of the compression cache. When I<size>
|
|
|
|
is specified, the hypervisor is asked to change compression cache to I<size>
|
|
|
|
bytes and then the current size is printed (the result may differ from the
|
|
|
|
requested size due to rounding done by the hypervisor). The I<size> option
|
|
|
|
is supposed to be used while the domain is being live-migrated as a reaction
|
|
|
|
to migration progress and increasing number of compression cache misses
|
|
|
|
obtained from domjobinfo.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<migrate-setspeed> I<domain> I<bandwidth>
|
2011-06-08 02:40:57 +00:00
|
|
|
|
2013-04-09 14:15:07 +00:00
|
|
|
Set the maximum migration bandwidth (in MiB/s) for a domain which is being
|
2014-07-15 12:35:50 +00:00
|
|
|
migrated to another host. I<bandwidth> is interpreted as an unsigned long
|
|
|
|
long value. Specifying a negative value results in an essentially unlimited
|
|
|
|
value being provided to the hypervisor. The hypervisor can choose whether to
|
|
|
|
reject the value or convert it to the maximum value allowed.
|
2011-06-08 02:40:57 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<migrate-getspeed> I<domain>
|
2011-08-26 18:10:24 +00:00
|
|
|
|
2013-04-09 14:15:07 +00:00
|
|
|
Get the maximum migration bandwidth (in MiB/s) for a domain.
|
2011-08-26 18:10:24 +00:00
|
|
|
|
2011-12-20 08:35:03 +00:00
|
|
|
=item B<numatune> I<domain> [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>
|
|
|
|
element of domain XML. Without flags, the current settings are
|
|
|
|
displayed.
|
|
|
|
|
2014-07-09 07:53:14 +00:00
|
|
|
I<mode> can be one of `strict', `interleave' and `preferred' or any
|
|
|
|
valid number from the virDomainNumatuneMemMode enum in case the daemon
|
|
|
|
supports it. For a running domain, the mode can't be changed, and the
|
|
|
|
nodeset can be changed only if the domain was started with a mode of
|
|
|
|
`strict'.
|
2011-12-20 08:35:03 +00:00
|
|
|
|
|
|
|
I<nodeset> is a list of numa nodes used by the host for running the domain.
|
|
|
|
Its syntax is a comma separated list, with '-' for ranges and '^' for
|
|
|
|
excluding a node.
|
|
|
|
|
|
|
|
If I<--live> is specified, set scheduler information of a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
|
|
|
|
2012-11-30 15:30:05 +00:00
|
|
|
=item B<reboot> I<domain> [I<--mode MODE-LIST>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-11-16 15:23:17 +00:00
|
|
|
Reboot a domain. This acts just as if the domain had the B<reboot>
|
|
|
|
command run from the console. The command returns as soon as it has
|
|
|
|
executed the reboot action, which may be significantly before the
|
|
|
|
domain actually reboots.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
The exact behavior of a domain when it reboots is set by the
|
|
|
|
I<on_reboot> parameter in the domain's XML definition.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-10-05 17:31:57 +00:00
|
|
|
By default the hypervisor will try to pick a suitable shutdown
|
|
|
|
method. To specify an alternative method, the I<--mode> parameter
|
2012-11-30 15:30:05 +00:00
|
|
|
can specify a comma separated list which includes C<acpi>, C<agent>,
|
2014-05-01 17:42:54 +00:00
|
|
|
C<initctl>, C<signal> and C<paravirt>. The order in which drivers will
|
|
|
|
try each mode is undefined, and not related to the order specified to virsh.
|
2012-11-30 15:30:05 +00:00
|
|
|
For strict control over ordering, use a single mode at a time and
|
|
|
|
repeat the command.
|
2011-10-05 17:31:57 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<reset> I<domain>
|
2011-09-29 08:57:12 +00:00
|
|
|
|
|
|
|
Reset a domain immediately without any guest shutdown. B<reset>
|
|
|
|
emulates the power reset button on a machine, where all guest
|
|
|
|
hardware sees the RST line set and reinitializes internal state.
|
|
|
|
|
|
|
|
B<Note>: Reset without any guest OS shutdown risks data loss.
|
|
|
|
|
2011-07-19 20:24:29 +00:00
|
|
|
=item B<restore> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
|
2011-08-27 14:16:04 +00:00
|
|
|
[{I<--running> | I<--paused>}]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-04-07 15:01:18 +00:00
|
|
|
Restores a domain from a B<virsh save> state file. See I<save> for more info.
|
2011-04-07 08:58:26 +00:00
|
|
|
|
2011-07-09 03:09:16 +00:00
|
|
|
If I<--bypass-cache> is specified, the restore will avoid the file system
|
|
|
|
cache, although this may slow down the operation.
|
|
|
|
|
2011-07-19 20:24:29 +00:00
|
|
|
I<--xml> B<file> is usually omitted, but can be used to supply an
|
|
|
|
alternative XML file for use on the restored guest with changes only
|
|
|
|
in the host-specific portions of the domain XML. For example, it can
|
|
|
|
be used to account for file naming differences in underlying storage
|
|
|
|
due to disk snapshots taken after the guest was saved.
|
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
Normally, restoring a saved image will use the state recorded in the
|
|
|
|
save image to decide between running or paused; passing either the
|
|
|
|
I<--running> or I<--paused> flag will allow overriding which state the
|
|
|
|
domain should be started in.
|
|
|
|
|
2011-04-07 08:58:26 +00:00
|
|
|
B<Note>: To avoid corrupting file system contents within the domain, you
|
2011-04-07 15:01:18 +00:00
|
|
|
should not reuse the saved state file for a second B<restore> unless you
|
|
|
|
have also reverted all storage volumes back to the same contents as when
|
|
|
|
the state file was created.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<save> I<domain> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
|
2011-12-20 14:35:15 +00:00
|
|
|
[{I<--running> | I<--paused>}] [I<--verbose>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-06-15 20:24:53 +00:00
|
|
|
Saves a running domain (RAM, but not disk state) to a state file so that
|
|
|
|
it can be restored
|
2007-06-21 07:39:51 +00:00
|
|
|
later. Once saved, the domain will no longer be running on the
|
|
|
|
system, thus the memory allocated for the domain will be free for
|
|
|
|
other domains to use. B<virsh restore> restores from this state file.
|
2011-07-09 03:09:16 +00:00
|
|
|
If I<--bypass-cache> is specified, the save will avoid the file system
|
|
|
|
cache, although this may slow down the operation.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-09-26 12:55:22 +00:00
|
|
|
The progress may be monitored using B<domjobinfo> virsh command and canceled
|
2011-12-20 14:35:15 +00:00
|
|
|
with B<domjobabort> command (sent by another virsh instance). Another option
|
|
|
|
is to send SIGINT (usually with C<Ctrl-C>) to the virsh process running
|
|
|
|
B<save> command. I<--verbose> displays the progress of save.
|
2011-09-26 12:55:22 +00:00
|
|
|
|
2007-06-21 07:39:51 +00:00
|
|
|
This is roughly equivalent to doing a hibernate on a running computer,
|
|
|
|
with all the same limitations. Open network connections may be
|
|
|
|
severed upon restore, as TCP timeouts may have expired.
|
|
|
|
|
2011-07-19 20:24:29 +00:00
|
|
|
I<--xml> B<file> is usually omitted, but can be used to supply an
|
|
|
|
alternative XML file for use on the restored guest with changes only
|
|
|
|
in the host-specific portions of the domain XML. For example, it can
|
|
|
|
be used to account for file naming differences that are planned to
|
|
|
|
be made via disk snapshots of underlying storage after the guest is saved.
|
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
Normally, restoring a saved image will decide between running or paused
|
|
|
|
based on the state the domain was in when the save was done; passing
|
|
|
|
either the I<--running> or I<--paused> flag will allow overriding which
|
|
|
|
state the B<restore> should use.
|
|
|
|
|
2011-06-15 20:24:53 +00:00
|
|
|
Domain saved state files assume that disk images will be unchanged
|
|
|
|
between the creation and restore point. For a more complete system
|
|
|
|
restore point, where the disk state is saved alongside the memory
|
|
|
|
state, see the B<snapshot> family of commands.
|
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
=item B<save-image-define> I<file> I<xml> [{I<--running> | I<--paused>}]
|
2011-07-20 16:23:57 +00:00
|
|
|
|
|
|
|
Update the domain XML that will be used when I<file> is later
|
|
|
|
used in the B<restore> command. The I<xml> argument must be a file
|
|
|
|
name containing the alternative XML, with changes only in the
|
|
|
|
host-specific portions of the domain XML. For example, it can
|
|
|
|
be used to account for file naming differences resulting from creating
|
|
|
|
disk snapshots of underlying storage after the guest was saved.
|
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
The save image records whether the domain should be restored to a
|
|
|
|
running or paused state. Normally, this command does not alter the
|
|
|
|
recorded state; passing either the I<--running> or I<--paused> flag
|
|
|
|
will allow overriding which state the B<restore> should use.
|
|
|
|
|
2011-07-20 16:23:57 +00:00
|
|
|
=item B<save-image-dumpxml> I<file> [I<--security-info>]
|
|
|
|
|
|
|
|
Extract the domain XML that was in effect at the time the saved state
|
|
|
|
file I<file> was created with the B<save> command. Using
|
|
|
|
I<--security-info> will also include security sensitive information.
|
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
=item B<save-image-edit> I<file> [{I<--running> | I<--paused>}]
|
2011-07-20 16:23:57 +00:00
|
|
|
|
|
|
|
Edit the XML configuration associated with a saved state file I<file>
|
|
|
|
created by the B<save> command.
|
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
The save image records whether the domain should be restored to a
|
|
|
|
running or paused state. Normally, this command does not alter the
|
|
|
|
recorded state; passing either the I<--running> or I<--paused> flag
|
|
|
|
will allow overriding which state the B<restore> should use.
|
|
|
|
|
2011-07-20 16:23:57 +00:00
|
|
|
This is equivalent to:
|
|
|
|
|
|
|
|
virsh save-image-dumpxml state-file > state-file.xml
|
|
|
|
vi state-file.xml (or make changes with your other text editor)
|
|
|
|
virsh save-image-define state-file state-file-xml
|
|
|
|
|
|
|
|
except that it does some error checking.
|
|
|
|
|
|
|
|
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
|
|
|
|
variables, and defaults to C<vi>.
|
|
|
|
|
2013-03-15 13:42:42 +00:00
|
|
|
=item B<schedinfo> I<domain> [[I<--config>] [I<--live>] | [I<--current>]]
|
|
|
|
[[I<--set>] B<parameter=value>]...
|
2008-10-08 16:28:48 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<schedinfo> [I<--weight> B<number>] [I<--cap> B<number>]
|
2012-07-25 11:17:03 +00:00
|
|
|
I<domain>
|
2008-04-15 15:20:43 +00:00
|
|
|
|
2011-05-17 06:20:03 +00:00
|
|
|
Allows you to show (and set) the domain scheduler parameters. The parameters
|
|
|
|
available for each hypervisor are:
|
2010-01-17 23:48:39 +00:00
|
|
|
|
2014-08-18 08:29:33 +00:00
|
|
|
LXC (posix scheduler) : cpu_shares, vcpu_period, vcpu_quota
|
2011-08-19 08:53:22 +00:00
|
|
|
|
2012-08-21 09:18:43 +00:00
|
|
|
QEMU/KVM (posix scheduler): cpu_shares, vcpu_period, vcpu_quota,
|
|
|
|
emulator_period, emulator_quota
|
2010-01-17 23:48:39 +00:00
|
|
|
|
|
|
|
Xen (credit scheduler): weight, cap
|
|
|
|
|
|
|
|
ESX (allocation scheduler): reservation, limit, shares
|
|
|
|
|
2011-05-17 06:20:03 +00:00
|
|
|
If I<--live> is specified, set scheduler information of a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
|
|
|
|
2011-02-01 08:46:17 +00:00
|
|
|
B<Note>: The cpu_shares parameter has a valid value range of 0-262144; Negative
|
|
|
|
values are wrapped to positive, and larger values are capped at the maximum.
|
2011-09-28 01:59:43 +00:00
|
|
|
Therefore, -1 is a useful shorthand for 262144. On the Linux kernel, the
|
|
|
|
values 0 and 1 are automatically converted to a minimal value of 2.
|
2008-10-08 16:28:48 +00:00
|
|
|
|
|
|
|
B<Note>: The weight and cap parameters are defined only for the
|
|
|
|
XEN_CREDIT scheduler and are now I<DEPRECATED>.
|
2008-04-15 15:20:43 +00:00
|
|
|
|
2012-08-21 09:18:43 +00:00
|
|
|
B<Note>: The vcpu_period/emulator_period parameters have a valid value range
|
|
|
|
of 1000-1000000 or 0, and the vcpu_quota/emulator_quota parameters have a
|
|
|
|
valid value range of 1000-18446744073709551 or less than 0. The value 0 for
|
|
|
|
either parameter is the same as not specifying that parameter.
|
2011-08-19 08:53:22 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<screenshot> I<domain> [I<imagefilepath>] [I<--screen> B<screenID>]
|
2011-05-12 16:29:12 +00:00
|
|
|
|
|
|
|
Takes a screenshot of a current domain console and stores it into a file.
|
|
|
|
Optionally, if hypervisor supports more displays for a domain, I<screenID>
|
|
|
|
allows to specify which screen will be captured. It is the sequential number
|
|
|
|
of screen. In case of multiple graphics cards, heads are enumerated before
|
|
|
|
devices, e.g. having two graphics cards, both with four heads, screen ID 5
|
|
|
|
addresses the second head on the second card.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<send-key> I<domain> [I<--codeset> B<codeset>]
|
2011-12-25 17:08:11 +00:00
|
|
|
[I<--holdtime> B<holdtime>] I<keycode>...
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
Parse the I<keycode> sequence as keystrokes to send to I<domain>.
|
2011-12-25 17:08:11 +00:00
|
|
|
Each I<keycode> can either be a numeric value or a symbolic name from
|
|
|
|
the corresponding codeset. If I<--holdtime> is given, each keystroke
|
|
|
|
will be held for that many milliseconds. The default codeset is
|
|
|
|
B<linux>, but use of the I<--codeset> option allows other codesets to
|
|
|
|
be chosen.
|
|
|
|
|
2012-10-20 23:55:24 +00:00
|
|
|
If multiple keycodes are specified, they are all sent simultaneously
|
|
|
|
to the guest, and they may be received in random order. If you need
|
|
|
|
distinct keypresses, you must use multiple send-key invocations.
|
|
|
|
|
2011-12-25 17:08:11 +00:00
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item B<linux>
|
|
|
|
|
|
|
|
The numeric values are those defined by the Linux generic input
|
|
|
|
event subsystem. The symbolic names match the corresponding
|
|
|
|
Linux key constant macro names.
|
|
|
|
|
|
|
|
=item B<xt>
|
|
|
|
|
|
|
|
The numeric values are those defined by the original XT keyboard
|
|
|
|
controller. No symbolic names are provided
|
|
|
|
|
|
|
|
=item B<atset1>
|
|
|
|
|
|
|
|
The numeric values are those defined by the AT keyboard controller,
|
|
|
|
set 1 (aka XT compatible set). Extended keycoes from B<atset1>
|
|
|
|
may differ from extended keycodes in the B<xt> codeset. No symbolic
|
|
|
|
names are provided
|
|
|
|
|
|
|
|
=item B<atset2>
|
|
|
|
|
|
|
|
The numeric values are those defined by the AT keyboard controller,
|
|
|
|
set 2. No symbolic names are provided
|
|
|
|
|
|
|
|
=item B<atset3>
|
|
|
|
|
|
|
|
The numeric values are those defined by the AT keyboard controller,
|
|
|
|
set 3 (aka PS/2 compatible set). No symbolic names are provided
|
|
|
|
|
|
|
|
=item B<os_x>
|
|
|
|
|
|
|
|
The numeric values are those defined by the OS-X keyboard input
|
|
|
|
subsystem. The symbolic names match the corresponding OS-X key
|
|
|
|
constant macro names
|
|
|
|
|
|
|
|
=item B<xt_kbd>
|
|
|
|
|
|
|
|
The numeric values are those defined by the Linux KBD device.
|
|
|
|
These are a variant on the original XT codeset, but often with
|
|
|
|
different encoding for extended keycodes. No symbolic names are
|
|
|
|
provided.
|
|
|
|
|
|
|
|
=item B<win32>
|
|
|
|
|
|
|
|
The numeric values are those defined by the Win32 keyboard input
|
|
|
|
subsystem. The symbolic names match the corresponding Win32 key
|
|
|
|
constant macro names
|
|
|
|
|
|
|
|
=item B<usb>
|
|
|
|
|
|
|
|
The numeric values are those defined by the USB HID specification
|
|
|
|
for keyboard input. No symbolic names are provided
|
|
|
|
|
|
|
|
=item B<rfb>
|
|
|
|
|
|
|
|
The numeric values are those defined by the RFB extension for sending
|
|
|
|
raw keycodes. These are a variant on the XT codeset, but extended
|
|
|
|
keycodes have the low bit of the second byte set, instead of the high
|
|
|
|
bit of the first byte. No symbolic names are provided.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
B<Examples>
|
2012-10-20 23:55:24 +00:00
|
|
|
# send three strokes 'k', 'e', 'y', using xt codeset. these
|
|
|
|
# are all pressed simultaneously and may be received by the guest
|
|
|
|
# in random order
|
2011-12-25 17:08:11 +00:00
|
|
|
virsh send-key dom --codeset xt 37 18 21
|
2012-10-20 23:55:24 +00:00
|
|
|
|
2011-12-25 17:08:11 +00:00
|
|
|
# send one stroke 'right-ctrl+C'
|
|
|
|
virsh send-key dom KEY_RIGHTCTRL KEY_C
|
2012-10-20 23:55:24 +00:00
|
|
|
|
2011-12-25 17:08:11 +00:00
|
|
|
# send a tab, held for 1 second
|
|
|
|
virsh send-key --holdtime 1000 0xf
|
|
|
|
|
2011-11-15 16:01:11 +00:00
|
|
|
=item B<send-process-signal> I<domain-id> I<pid> I<signame>
|
|
|
|
|
|
|
|
Send a signal I<signame> to the process identified by I<pid> running in
|
|
|
|
the virtual domain I<domain-id>. The I<pid> is a process ID in the virtual
|
|
|
|
domain namespace.
|
|
|
|
|
|
|
|
The I<signame> argument may be either an integer signal constant number,
|
|
|
|
or one of the symbolic names:
|
|
|
|
|
|
|
|
"nop", "hup", "int", "quit", "ill",
|
|
|
|
"trap", "abrt", "bus", "fpe", "kill",
|
|
|
|
"usr1", "segv", "usr2", "pipe", "alrm",
|
|
|
|
"term", "stkflt", "chld", "cont", "stop",
|
|
|
|
"tstp", "ttin", "ttou", "urg", "xcpu",
|
|
|
|
"xfsz", "vtalrm", "prof", "winch", "poll",
|
|
|
|
"pwr", "sys", "rt0", "rt1", "rt2", "rt3",
|
|
|
|
"rt4", "rt5", "rt6", "rt7", "rt8", "rt9",
|
|
|
|
"rt10", "rt11", "rt12", "rt13", "rt14", "rt15",
|
|
|
|
"rt16", "rt17", "rt18", "rt19", "rt20", "rt21",
|
|
|
|
"rt22", "rt23", "rt24", "rt25", "rt26", "rt27",
|
|
|
|
"rt28", "rt29", "rt30", "rt31", "rt32"
|
|
|
|
|
|
|
|
The symbol name may optionally be prefixed with 'sig' or 'sig_' and
|
|
|
|
may be in uppercase or lowercase.
|
|
|
|
|
|
|
|
B<Examples>
|
|
|
|
virsh send-process-signal myguest 1 15
|
|
|
|
virsh send-process-signal myguest 1 term
|
|
|
|
virsh send-process-signal myguest 1 sigterm
|
|
|
|
virsh send-process-signal myguest 1 SIG_HUP
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<setmem> I<domain> B<size> [[I<--config>] [I<--live>] |
|
2011-07-14 17:36:21 +00:00
|
|
|
[I<--current>]]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2011-03-02 08:13:39 +00:00
|
|
|
Change the memory allocation for a guest domain.
|
|
|
|
If I<--live> is specified, perform a memory balloon of a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
2011-03-23 05:49:28 +00:00
|
|
|
If I<--current> is specified, affect the current guest state.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. If no flag is specified, behavior is different depending
|
|
|
|
on hypervisor.
|
2011-01-13 20:45:37 +00:00
|
|
|
|
2012-03-06 00:06:57 +00:00
|
|
|
I<size> is a scaled integer (see B<NOTES> above); it defaults to kibibytes
|
|
|
|
(blocks of 1024 bytes) unless you provide a suffix (and the older option
|
|
|
|
name I<--kilobytes> is available as a deprecated synonym) . Libvirt rounds
|
|
|
|
up to the nearest kibibyte. Some hypervisors require a larger granularity
|
|
|
|
than KiB, and requests that are not an even multiple will be rounded up.
|
|
|
|
For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes).
|
2011-01-13 20:45:37 +00:00
|
|
|
|
|
|
|
For Xen, you can only adjust the memory of a running domain if the domain is
|
|
|
|
paravirtualized or running the PV balloon driver.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2015-02-26 23:31:06 +00:00
|
|
|
For LXC, the value being set is the cgroups value for limit_in_bytes or the
|
|
|
|
maximum amount of user memory (including file cache). When viewing memory
|
|
|
|
inside the container, this is the /proc/meminfo "MemTotal" value. When viewing
|
|
|
|
the value from the host, use the B<virsh memtune> command. In order to view
|
|
|
|
the current memory in use and the maximum value allowed to set memory, use
|
|
|
|
the B<virsh dominfo> command.
|
|
|
|
|
2015-05-18 10:37:38 +00:00
|
|
|
=item B<set-user-password> I<domain> I<user> I<password> [I<--encrypted>]
|
|
|
|
|
|
|
|
Set the password for the I<user> account in the guest domain.
|
|
|
|
|
|
|
|
If I<--encrypted> is specified, the password is assumed to be already
|
|
|
|
encrypted by the method required by the guest OS.
|
|
|
|
|
|
|
|
For QEMU/KVM, this requires the guest agent to be configured
|
|
|
|
and running.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<setmaxmem> I<domain> B<size> [[I<--config>] [I<--live>] |
|
2011-07-14 17:36:21 +00:00
|
|
|
[I<--current>]]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2011-04-08 05:08:52 +00:00
|
|
|
Change the maximum memory allocation limit for a guest domain.
|
|
|
|
If I<--live> is specified, affect a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
2011-11-29 11:45:18 +00:00
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
2011-04-08 05:08:52 +00:00
|
|
|
exclusive. If no flag is specified, behavior is different depending
|
|
|
|
on hypervisor.
|
2011-01-27 16:29:26 +00:00
|
|
|
|
2013-03-22 10:05:36 +00:00
|
|
|
Some hypervisors such as QEMU/KVM don't support live changes (especially
|
2015-02-17 15:53:25 +00:00
|
|
|
increasing) of the maximum memory limit. Even persistent configuration changes
|
|
|
|
might not be performed with some hypervisors/configuration (e.g. on NUMA enabled
|
|
|
|
domains on QEMU). For complex configuration changes use command B<edit>
|
|
|
|
instead).
|
2011-01-27 16:29:26 +00:00
|
|
|
|
2012-03-06 00:06:57 +00:00
|
|
|
I<size> is a scaled integer (see B<NOTES> above); it defaults to kibibytes
|
|
|
|
(blocks of 1024 bytes) unless you provide a suffix (and the older option
|
|
|
|
name I<--kilobytes> is available as a deprecated synonym) . Libvirt rounds
|
|
|
|
up to the nearest kibibyte. Some hypervisors require a larger granularity
|
|
|
|
than KiB, and requests that are not an even multiple will be rounded up.
|
|
|
|
For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes).
|
2011-01-27 16:29:26 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<memtune> I<domain> [I<--hard-limit> B<size>]
|
2012-03-06 00:06:57 +00:00
|
|
|
[I<--soft-limit> B<size>] [I<--swap-hard-limit> B<size>]
|
|
|
|
[I<--min-guarantee> B<size>] [[I<--config>] [I<--live>] | [I<--current>]]
|
2010-10-19 15:39:51 +00:00
|
|
|
|
|
|
|
Allows you to display or set the domain memory parameters. Without
|
|
|
|
flags, the current settings are displayed; with a flag, the
|
|
|
|
appropriate limit is adjusted if supported by the hypervisor. LXC and
|
2011-03-31 09:48:17 +00:00
|
|
|
QEMU/KVM support I<--hard-limit>, I<--soft-limit>, and I<--swap-hard-limit>.
|
2012-03-06 00:06:57 +00:00
|
|
|
I<--min-guarantee> is supported only by ESX hypervisor. Each of these
|
|
|
|
limits are scaled integers (see B<NOTES> above), with a default of
|
2012-07-24 08:50:29 +00:00
|
|
|
kibibytes (blocks of 1024 bytes) if no suffix is present. Libvirt rounds
|
|
|
|
up to the nearest kibibyte. Some hypervisors require a larger granularity
|
|
|
|
than KiB, and requests that are not an even multiple will be rounded up.
|
|
|
|
For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes).
|
2011-03-31 09:48:17 +00:00
|
|
|
|
2011-05-27 07:35:11 +00:00
|
|
|
If I<--live> is specified, affect a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
2011-11-29 11:45:18 +00:00
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
2011-05-27 07:35:11 +00:00
|
|
|
exclusive. If no flag is specified, behavior is different depending
|
|
|
|
on hypervisor.
|
|
|
|
|
2011-03-31 09:48:17 +00:00
|
|
|
For QEMU/KVM, the parameters are applied to the QEMU process as a whole.
|
|
|
|
Thus, when counting them, one needs to add up guest RAM, guest video RAM, and
|
|
|
|
some memory overhead of QEMU itself. The last piece is hard to determine so
|
|
|
|
one needs guess and try.
|
|
|
|
|
2015-02-26 23:31:06 +00:00
|
|
|
For LXC, the displayed hard_limit value is the current memory setting
|
|
|
|
from the XML or the results from a B<virsh setmem> command.
|
|
|
|
|
2011-03-31 09:48:17 +00:00
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item I<--hard-limit>
|
|
|
|
|
2012-03-06 00:06:57 +00:00
|
|
|
The maximum memory the guest can use.
|
2011-03-31 09:48:17 +00:00
|
|
|
|
|
|
|
=item I<--soft-limit>
|
|
|
|
|
2012-03-06 00:06:57 +00:00
|
|
|
The memory limit to enforce during memory contention.
|
2011-03-31 09:48:17 +00:00
|
|
|
|
|
|
|
=item I<--swap-hard-limit>
|
|
|
|
|
2012-03-06 00:06:57 +00:00
|
|
|
The maximum memory plus swap the guest can use. This has to be more
|
|
|
|
than hard-limit value provided.
|
2011-03-31 09:48:17 +00:00
|
|
|
|
|
|
|
=item I<--min-guarantee>
|
|
|
|
|
2012-03-06 00:06:57 +00:00
|
|
|
The guaranteed minimum memory allocation for the guest.
|
2011-03-31 09:48:17 +00:00
|
|
|
|
|
|
|
=back
|
2010-10-19 12:27:12 +00:00
|
|
|
|
2011-09-22 10:14:18 +00:00
|
|
|
Specifying -1 as a value for these limits is interpreted as unlimited.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<blkiotune> I<domain> [I<--weight> B<weight>]
|
virsh: add setting throttle blkio cgroup option to blkiotune
With this patch, user can setup the throttle blkio cgorup
for domain through the virsh cmd, such as:
virsh blkiotune domain1 --device-read-bytes-sec /dev/sda1,1000000,/dev/sda2,2000000
--device-write-bytes-sec /dev/sda1,1000000 --device-read-iops-sec /dev/sda1,10000
--device-write-iops-sec /dev/sda1,10000,/dev/sda2,0
This patch also add manpage for these new options.
Signed-off-by: Guan Qiang <hzguanqiang@corp.netease.com>
Signed-off-by: Gao feng <gaofeng@cn.fujitsu.com>
2013-12-11 08:29:51 +00:00
|
|
|
[I<--device-weights> B<device-weights>]
|
|
|
|
[I<--device-read-iops-sec> B<device-read-iops-sec>]
|
|
|
|
[I<--device-write-iops-sec> B<device-write-iops-sec>]
|
|
|
|
[I<--device-read-bytes-sec> B<device-read-bytes-sec>]
|
|
|
|
[I<--device-write-bytes-sec> B<device-write-bytes-sec>]
|
|
|
|
[[I<--config>] [I<--live>] | [I<--current>]]
|
2011-02-22 05:33:24 +00:00
|
|
|
|
|
|
|
Display or set the blkio parameters. QEMU/KVM supports I<--weight>.
|
2013-10-11 13:41:22 +00:00
|
|
|
I<--weight> is in range [100, 1000]. After kernel 2.6.39, the value
|
|
|
|
could be in the range [10, 1000].
|
2011-02-22 05:33:24 +00:00
|
|
|
|
2011-11-08 11:00:33 +00:00
|
|
|
B<device-weights> is a single string listing one or more device/weight
|
|
|
|
pairs, in the format of /path/to/device,weight,/path/to/device,weight.
|
2013-10-11 13:41:22 +00:00
|
|
|
Each weight is in the range [100, 1000], [10, 1000] after kernel 2.6.39,
|
|
|
|
or the value 0 to remove that device from per-device listings.
|
|
|
|
Only the devices listed in the string are modified;
|
|
|
|
any existing per-device weights for other devices remain unchanged.
|
2011-11-08 11:00:33 +00:00
|
|
|
|
virsh: add setting throttle blkio cgroup option to blkiotune
With this patch, user can setup the throttle blkio cgorup
for domain through the virsh cmd, such as:
virsh blkiotune domain1 --device-read-bytes-sec /dev/sda1,1000000,/dev/sda2,2000000
--device-write-bytes-sec /dev/sda1,1000000 --device-read-iops-sec /dev/sda1,10000
--device-write-iops-sec /dev/sda1,10000,/dev/sda2,0
This patch also add manpage for these new options.
Signed-off-by: Guan Qiang <hzguanqiang@corp.netease.com>
Signed-off-by: Gao feng <gaofeng@cn.fujitsu.com>
2013-12-11 08:29:51 +00:00
|
|
|
B<device-read-iops-sec> is a single string listing one or more device/read_iops_sec
|
|
|
|
pairs, int the format of /path/to/device,read_iops_sec,/path/to/device,read_iops_sec.
|
|
|
|
Each read_iops_sec is a number which type is unsigned int, value 0 to remove that
|
|
|
|
device from per-decice listing.
|
|
|
|
Only the devices listed in the string are modified;
|
|
|
|
any existing per-device read_iops_sec for other devices remain unchanged.
|
|
|
|
|
|
|
|
B<device-write-iops-sec> is a single string listing one or more device/write_iops_sec
|
|
|
|
pairs, int the format of /path/to/device,write_iops_sec,/path/to/device,write_iops_sec.
|
|
|
|
Each write_iops_sec is a number which type is unsigned int, value 0 to remove that
|
|
|
|
device from per-decice listing.
|
|
|
|
Only the devices listed in the string are modified;
|
|
|
|
any existing per-device write_iops_sec for other devices remain unchanged.
|
|
|
|
|
|
|
|
B<device-read-bytes-sec> is a single string listing one or more device/read_bytes_sec
|
|
|
|
pairs, int the format of /path/to/device,read_bytes_sec,/path/to/device,read_bytes_sec.
|
|
|
|
Each read_bytes_sec is a number which type is unsigned long long, value 0 to remove
|
|
|
|
that device from per-decice listing.
|
|
|
|
Only the devices listed in the string are modified;
|
|
|
|
any existing per-device read_bytes_sec for other devices remain unchanged.
|
|
|
|
|
|
|
|
B<device-write-bytes-sec> is a single string listing one or more device/write_bytes_sec
|
|
|
|
pairs, int the format of /path/to/device,write_bytes_sec,/path/to/device,write_bytes_sec.
|
|
|
|
Each write_bytes_sec is a number which type is unsigned long long, value 0 to remove
|
|
|
|
that device from per-decice listing.
|
|
|
|
Only the devices listed in the string are modified;
|
|
|
|
any existing per-device write_bytes_sec for other devices remain unchanged.
|
|
|
|
|
2011-06-07 06:03:07 +00:00
|
|
|
If I<--live> is specified, affect a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
2011-11-29 11:45:18 +00:00
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
2011-06-07 06:03:07 +00:00
|
|
|
exclusive. If no flag is specified, behavior is different depending
|
|
|
|
on hypervisor.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<setvcpus> I<domain> I<count> [I<--maximum>] [[I<--config>]
|
2013-06-07 15:12:47 +00:00
|
|
|
[I<--live>] | [I<--current>]] [I<--guest>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2011-01-13 20:45:37 +00:00
|
|
|
Change the number of virtual CPUs active in a guest domain. By default,
|
|
|
|
this command works on active guest domains. To change the settings for an
|
|
|
|
inactive guest domain, use the I<--config> flag.
|
|
|
|
|
|
|
|
The I<count> value may be limited by host, hypervisor, or a limit coming
|
|
|
|
from the original description of the guest domain. For Xen, you can only
|
|
|
|
adjust the virtual CPUs of a running domain if the domain is paravirtualized.
|
|
|
|
|
|
|
|
If the I<--config> flag is specified, the change is made to the stored XML
|
|
|
|
configuration for the guest domain, and will only take effect when the guest
|
|
|
|
domain is next started.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2011-01-13 20:45:37 +00:00
|
|
|
If I<--live> is specified, the guest domain must be active, and the change
|
|
|
|
takes place immediately. Both the I<--config> and I<--live> flags may be
|
2014-04-23 11:01:24 +00:00
|
|
|
specified together if supported by the hypervisor. If this command is run
|
|
|
|
before the guest has finished booting, the guest may fail to process
|
|
|
|
the change.
|
2008-01-25 12:03:05 +00:00
|
|
|
|
2011-07-15 07:02:00 +00:00
|
|
|
If I<--current> is specified, affect the current guest state.
|
|
|
|
|
|
|
|
When no flags are given, the I<--live>
|
2011-01-13 20:45:37 +00:00
|
|
|
flag is assumed and the guest domain must be active. In this situation it
|
|
|
|
is up to the hypervisor whether the I<--config> flag is also assumed, and
|
|
|
|
therefore whether the XML configuration is adjusted to make the change
|
|
|
|
persistent.
|
2010-09-29 21:20:23 +00:00
|
|
|
|
2013-06-07 15:12:47 +00:00
|
|
|
If I<--guest> is specified, then the count of cpus is modified in the guest
|
|
|
|
instead of the hypervisor. This flag is usable only for live domains
|
|
|
|
and may require guest agent to be configured in the guest.
|
2013-04-12 12:30:41 +00:00
|
|
|
|
2011-01-13 20:45:37 +00:00
|
|
|
The I<--maximum> flag controls the maximum number of virtual cpus that can
|
|
|
|
be hot-plugged the next time the domain is booted. As such, it must only be
|
2015-03-20 14:39:03 +00:00
|
|
|
used with the I<--config> flag, and not with the I<--live> or the I<--current>
|
|
|
|
flag.
|
2010-09-29 21:20:23 +00:00
|
|
|
|
2012-11-30 15:30:05 +00:00
|
|
|
=item B<shutdown> I<domain> [I<--mode MODE-LIST>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
|
|
|
Gracefully shuts down a domain. This coordinates with the domain OS
|
2007-08-14 07:02:18 +00:00
|
|
|
to perform graceful shutdown, so there is no guarantee that it will
|
2007-06-21 07:39:51 +00:00
|
|
|
succeed, and may take a variable length of time depending on what
|
2008-02-05 19:27:37 +00:00
|
|
|
services must be shutdown in the domain.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
The exact behavior of a domain when it shuts down is set by the
|
|
|
|
I<on_shutdown> parameter in the domain's XML definition.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
If I<domain> is transient, then the metadata of any snapshots will
|
2011-08-12 02:24:19 +00:00
|
|
|
be lost once the guest stops running, but the snapshot contents still
|
|
|
|
exist, and a new domain with the same name and UUID can restore the
|
|
|
|
snapshot metadata with B<snapshot-create>.
|
|
|
|
|
2011-10-05 17:31:57 +00:00
|
|
|
By default the hypervisor will try to pick a suitable shutdown
|
|
|
|
method. To specify an alternative method, the I<--mode> parameter
|
2012-11-30 15:30:05 +00:00
|
|
|
can specify a comma separated list which includes C<acpi>, C<agent>,
|
2014-05-01 17:42:54 +00:00
|
|
|
C<initctl>, C<signal> and C<paravirt>. The order in which drivers will
|
|
|
|
try each mode is undefined, and not related to the order specified to virsh.
|
2012-11-30 15:30:05 +00:00
|
|
|
For strict control over ordering, use a single mode at a time and
|
|
|
|
repeat the command.
|
2011-10-05 17:31:57 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<start> I<domain-name-or-uuid> [I<--console>] [I<--paused>]
|
2013-07-11 15:32:14 +00:00
|
|
|
[I<--autodestroy>] [I<--bypass-cache>] [I<--force-boot>] [I<--pass-fds N,M,...>]
|
2008-04-15 15:20:43 +00:00
|
|
|
|
2010-10-29 00:50:15 +00:00
|
|
|
Start a (previously defined) inactive domain, either from the last
|
|
|
|
B<managedsave> state, or via a fresh boot if no managedsave state is
|
|
|
|
present. The domain will be paused if the I<--paused> option is
|
|
|
|
used and supported by the driver; otherwise it will be running.
|
2010-06-10 16:18:02 +00:00
|
|
|
If I<--console> is requested, attach to the console after creation.
|
2011-06-23 10:41:57 +00:00
|
|
|
If I<--autodestroy> is requested, then the guest will be automatically
|
|
|
|
destroyed when virsh closes its connection to libvirt, or otherwise
|
2011-07-09 03:09:16 +00:00
|
|
|
exits. If I<--bypass-cache> is specified, and managedsave state exists,
|
|
|
|
the restore will avoid the file system cache, although this may slow
|
2011-08-27 23:07:18 +00:00
|
|
|
down the operation. If I<--force-boot> is specified, then any
|
|
|
|
managedsave state is discarded and a fresh boot occurs.
|
2008-04-15 15:20:43 +00:00
|
|
|
|
2013-07-11 15:32:14 +00:00
|
|
|
If I<--pass-fds> is specified, the argument is a comma separated list
|
|
|
|
of open file descriptors which should be pass on into the guest. The
|
|
|
|
file descriptors will be re-numered in the guest, starting from 3. This
|
|
|
|
is only supported with container based virtualization.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<suspend> I<domain>
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Suspend a running domain. It is kept in memory but won't be scheduled
|
|
|
|
anymore.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<resume> I<domain>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
Moves a domain out of the suspended state. This will allow a previously
|
2008-01-29 17:43:28 +00:00
|
|
|
suspended domain to now be eligible for scheduling by the underlying
|
2007-06-21 15:00:17 +00:00
|
|
|
hypervisor.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<dompmsuspend> I<domain> I<target> [I<--duration>]
|
2012-01-26 19:20:49 +00:00
|
|
|
|
|
|
|
Suspend a running domain into one of these states (possible I<target>
|
|
|
|
values):
|
2013-11-30 06:33:17 +00:00
|
|
|
mem equivalent of S3 ACPI state
|
|
|
|
disk equivalent of S4 ACPI state
|
2012-01-26 19:20:49 +00:00
|
|
|
hybrid RAM is saved to disk but not powered off
|
|
|
|
|
2012-06-21 15:59:27 +00:00
|
|
|
The I<--duration> argument specifies number of seconds before the domain is
|
|
|
|
woken up after it was suspended (see also B<dompmwakeup>). Default is 0 for
|
|
|
|
unlimited suspend time. (This feature isn't currently supported by any
|
|
|
|
hypervisor driver and 0 should be used.).
|
|
|
|
|
|
|
|
Note that this command requires a guest agent configured and running in the
|
|
|
|
domain's guest OS.
|
|
|
|
|
2013-05-31 16:00:48 +00:00
|
|
|
Beware that at least for QEMU, the domain's process will be terminated when
|
|
|
|
target disk is used and a new process will be launched when libvirt is asked
|
|
|
|
to wake up the domain. As a result of this, any runtime changes, such as
|
|
|
|
device hotplug or memory settings, are lost unless such changes were made
|
|
|
|
with I<--config> flag.
|
|
|
|
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<dompmwakeup> I<domain>
|
2012-02-10 12:07:24 +00:00
|
|
|
|
2012-09-04 10:01:41 +00:00
|
|
|
Wakeup a domain from pmsuspended state (either suspended by dompmsuspend or
|
|
|
|
from the guest itself). Injects a wakeup into the guest that is in pmsuspended
|
|
|
|
state, rather than waiting for the previously requested duration (if any) to
|
|
|
|
elapse. This operation doesn't not necessarily fail if the domain is running.
|
2012-02-10 12:07:24 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<ttyconsole> I<domain>
|
2007-07-26 08:41:16 +00:00
|
|
|
|
|
|
|
Output the device used for the TTY console of the domain. If the information
|
2007-08-14 07:02:18 +00:00
|
|
|
is not available the processes will provide an exit code of 1.
|
2007-07-26 08:41:16 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<undefine> I<domain> [I<--managed-save>] [I<--snapshots-metadata>]
|
2014-09-11 11:17:11 +00:00
|
|
|
[I<--nvram>] [ {I<--storage> B<volumes> | I<--remove-all-storage>} I<--wipe-storage>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2011-07-20 03:12:46 +00:00
|
|
|
Undefine a domain. If the domain is running, this converts it to a
|
|
|
|
transient domain, without stopping it. If the domain is inactive,
|
|
|
|
the domain configuration is removed.
|
|
|
|
|
2011-08-12 02:24:19 +00:00
|
|
|
The I<--managed-save> flag guarantees that any managed save image (see
|
2011-07-20 03:12:46 +00:00
|
|
|
the B<managedsave> command) is also cleaned up. Without the flag, attempts
|
|
|
|
to undefine a domain with a managed save image will fail.
|
|
|
|
|
2011-08-12 02:24:19 +00:00
|
|
|
The I<--snapshots-metadata> flag guarantees that any snapshots (see the
|
|
|
|
B<snapshot-list> command) are also cleaned up when undefining an inactive
|
|
|
|
domain. Without the flag, attempts to undefine an inactive domain with
|
|
|
|
snapshot metadata will fail. If the domain is active, this flag is
|
|
|
|
ignored.
|
|
|
|
|
2014-09-11 11:17:11 +00:00
|
|
|
The I<--nvram> flag ensures no nvram (/domain/os/nvram/) file is
|
|
|
|
left behind. If the domain has an nvram file and the flag is
|
|
|
|
omitted, the undefine will fail.
|
|
|
|
|
2011-09-08 12:48:47 +00:00
|
|
|
The I<--storage> flag takes a parameter B<volumes>, which is a comma separated
|
|
|
|
list of volume target names or source paths of storage volumes to be removed
|
|
|
|
along with the undefined domain. Volumes can be undefined and thus removed only
|
|
|
|
on inactive domains. Volume deletion is only attempted after the domain is
|
|
|
|
undefined; if not all of the requested volumes could be deleted, the
|
|
|
|
error message indicates what still remains behind. If a volume path is not
|
|
|
|
found in the domain definition, it's treated as if the volume was successfully
|
2013-12-18 13:52:58 +00:00
|
|
|
deleted. Only volumes managed by libvirt in storage pools can be removed this
|
|
|
|
way.
|
2011-09-08 12:48:47 +00:00
|
|
|
(See B<domblklist> for list of target names associated to a domain).
|
|
|
|
Example: --storage vda,/path/to/storage.img
|
|
|
|
|
|
|
|
The I<--remove-all-storage> flag specifies that all of the domain's storage
|
|
|
|
volumes should be deleted.
|
|
|
|
|
|
|
|
The flag I<--wipe-storage> specifies that the storage volumes should be
|
|
|
|
wiped before removal.
|
|
|
|
|
2011-07-20 03:12:46 +00:00
|
|
|
NOTE: For an inactive domain, the domain name or UUID must be used as the
|
2012-07-25 11:17:03 +00:00
|
|
|
I<domain>.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<vcpucount> I<domain> [{I<--maximum> | I<--active>}
|
2013-06-07 15:12:47 +00:00
|
|
|
{I<--config> | I<--live> | I<--current>}] [I<--guest>]
|
2010-09-29 21:20:23 +00:00
|
|
|
|
|
|
|
Print information about the virtual cpu counts of the given
|
2012-07-25 11:17:03 +00:00
|
|
|
I<domain>. If no flags are specified, all possible counts are
|
2010-09-29 21:20:23 +00:00
|
|
|
listed in a table; otherwise, the output is limited to just the
|
2011-07-18 22:01:48 +00:00
|
|
|
numeric value requested. For historical reasons, the table
|
|
|
|
lists the label "current" on the rows that can be queried in isolation
|
|
|
|
via the I<--active> flag, rather than relating to the I<--current> flag.
|
2010-09-29 21:20:23 +00:00
|
|
|
|
|
|
|
I<--maximum> requests information on the maximum cap of vcpus that a
|
2011-07-18 22:01:48 +00:00
|
|
|
domain can add via B<setvcpus>, while I<--active> shows the current
|
2010-09-29 21:20:23 +00:00
|
|
|
usage; these two flags cannot both be specified. I<--config>
|
2011-07-18 22:01:48 +00:00
|
|
|
requires a persistent domain and requests information regarding the next
|
|
|
|
time the domain will be booted, I<--live> requires a running domain and
|
|
|
|
lists current values, and I<--current> queries according to the current
|
|
|
|
state of the domain (corresponding to I<--live> if running, or
|
|
|
|
I<--config> if inactive); these three flags are mutually exclusive.
|
2013-04-12 12:30:41 +00:00
|
|
|
|
2013-06-07 15:12:47 +00:00
|
|
|
If I<--guest> is specified, then the count of cpus is reported from
|
|
|
|
the perspective of the guest. This flag is usable only for live domains
|
|
|
|
and may require guest agent to be configured in the guest.
|
2010-09-29 21:20:23 +00:00
|
|
|
|
2014-06-05 11:16:00 +00:00
|
|
|
=item B<vcpuinfo> I<domain> [I<--pretty>]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-06-21 15:00:17 +00:00
|
|
|
Returns basic information about the domain virtual CPUs, like the number of
|
|
|
|
vCPUs, the running time, the affinity to physical processors.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2014-06-05 11:16:00 +00:00
|
|
|
With I<--pretty>, cpu affinities are shown as ranges.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<vcpupin> I<domain> [I<vcpu>] [I<cpulist>] [[I<--live>]
|
2011-07-14 17:36:21 +00:00
|
|
|
[I<--config>] | [I<--current>]]
|
2007-06-21 07:39:51 +00:00
|
|
|
|
vcpupin: add query option to virsh vcpupin command
This patch teaches "virsh vcpupin" command to query if no list
is given. Its feature is to show CPU affinity information in more
reader-friendly way.
# virsh vcpupin VM --config
VCPU: CPU Affinity
----------------------------------
0: 1-6,9-20
1: 10
2: 5,9-11,15-20
3: 1,3,5,7,9,11,13,15
When cpulist is omitted, vcpu number is optional. When vcpu number is
provided, information of only specified vcpu is displayed.
Signed-off-by: Taku Izumi <izumi.taku@jp.fujitsu.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2011-06-24 09:02:28 +00:00
|
|
|
Query or change the pinning of domain VCPUs to host physical CPUs. To
|
|
|
|
pin a single I<vcpu>, specify I<cpulist>; otherwise, you can query one
|
|
|
|
I<vcpu> or omit I<vcpu> to list all at once.
|
|
|
|
|
|
|
|
I<cpulist> is a list of physical CPU numbers. Its syntax is a comma
|
vcpupin: improve vcpupin definition of virsh vcpupin
When using vcpupin command, we have to speficy comma-separated list as cpulist,
but this is tedious in case the number of phsycal cpus is large.
This patch improves this by introducing special markup "-" and "^" which are
similar to XML schema of "cpuset" attribute.
The example:
# virsh vcpupin Guest 0 0-15,^8
is identical to
# virsh vcpupin Guest 0 0,1,2,3,4,5,6,7,9,10,11,12,13,14,15
NOTE: The expression is sequentially evaluated, so "0-15,^8" is not identical
to "^8,0-15".
Signed-off-by: Taku Izumi <izumi.taku@jp.fujitsu.com>
2011-06-10 06:38:55 +00:00
|
|
|
separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can
|
|
|
|
also be allowed. The '-' denotes the range and the '^' denotes exclusive.
|
2015-05-25 12:19:50 +00:00
|
|
|
For pinning the I<vcpu> to all physical cpus specify 'r' as a I<cpulist>.
|
2011-06-13 15:51:04 +00:00
|
|
|
If I<--live> is specified, affect a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
vcpupin: add query option to virsh vcpupin command
This patch teaches "virsh vcpupin" command to query if no list
is given. Its feature is to show CPU affinity information in more
reader-friendly way.
# virsh vcpupin VM --config
VCPU: CPU Affinity
----------------------------------
0: 1-6,9-20
1: 10
2: 5,9-11,15-20
3: 1,3,5,7,9,11,13,15
When cpulist is omitted, vcpu number is optional. When vcpu number is
provided, information of only specified vcpu is displayed.
Signed-off-by: Taku Izumi <izumi.taku@jp.fujitsu.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2011-06-24 09:02:28 +00:00
|
|
|
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
|
|
|
|
but I<--current> is exclusive.
|
2011-06-13 15:51:04 +00:00
|
|
|
If no flag is specified, behavior is different depending on hypervisor.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
vcpupin: add query option to virsh vcpupin command
This patch teaches "virsh vcpupin" command to query if no list
is given. Its feature is to show CPU affinity information in more
reader-friendly way.
# virsh vcpupin VM --config
VCPU: CPU Affinity
----------------------------------
0: 1-6,9-20
1: 10
2: 5,9-11,15-20
3: 1,3,5,7,9,11,13,15
When cpulist is omitted, vcpu number is optional. When vcpu number is
provided, information of only specified vcpu is displayed.
Signed-off-by: Taku Izumi <izumi.taku@jp.fujitsu.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
2011-06-24 09:02:28 +00:00
|
|
|
B<Note>: The expression is sequentially evaluated, so "0-15,^8" is
|
|
|
|
identical to "9-14,0-7,15" but not identical to "^8,0-15".
|
vcpupin: improve vcpupin definition of virsh vcpupin
When using vcpupin command, we have to speficy comma-separated list as cpulist,
but this is tedious in case the number of phsycal cpus is large.
This patch improves this by introducing special markup "-" and "^" which are
similar to XML schema of "cpuset" attribute.
The example:
# virsh vcpupin Guest 0 0-15,^8
is identical to
# virsh vcpupin Guest 0 0,1,2,3,4,5,6,7,9,10,11,12,13,14,15
NOTE: The expression is sequentially evaluated, so "0-15,^8" is not identical
to "^8,0-15".
Signed-off-by: Taku Izumi <izumi.taku@jp.fujitsu.com>
2011-06-10 06:38:55 +00:00
|
|
|
|
2012-08-21 09:18:40 +00:00
|
|
|
=item B<emulatorpin> I<domain> [I<cpulist>] [[I<--live>] [I<--config>]
|
|
|
|
| [I<--current>]]
|
|
|
|
|
|
|
|
Query or change the pinning of domain's emulator threads to host physical
|
|
|
|
CPUs.
|
|
|
|
|
|
|
|
See B<vcpupin> for I<cpulist>.
|
|
|
|
|
|
|
|
If I<--live> is specified, affect a running guest.
|
|
|
|
If I<--config> is specified, affect the next boot of a persistent guest.
|
|
|
|
If I<--current> is specified, affect the current guest state.
|
|
|
|
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
|
|
|
|
but I<--current> is exclusive.
|
|
|
|
If no flag is specified, behavior is different depending on hypervisor.
|
|
|
|
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<vncdisplay> I<domain>
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2007-07-26 08:41:16 +00:00
|
|
|
Output the IP address and port number for the VNC display. If the information
|
2007-08-14 07:02:18 +00:00
|
|
|
is not available the processes will provide an exit code of 1.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=back
|
|
|
|
|
|
|
|
=head1 DEVICE COMMANDS
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
The following commands manipulate devices associated to domains.
|
2012-07-25 11:17:03 +00:00
|
|
|
The I<domain> can be specified as a short integer, a name or a full UUID.
|
2007-06-21 15:00:17 +00:00
|
|
|
To better understand the values allowed as options for the command
|
2009-08-11 14:37:33 +00:00
|
|
|
reading the documentation at L<http://libvirt.org/formatdomain.html> on the
|
2007-06-21 15:00:17 +00:00
|
|
|
format of the device sections to get the most accurate set of accepted values.
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=over 4
|
|
|
|
|
2013-05-28 09:07:33 +00:00
|
|
|
=item B<attach-device> I<domain> I<FILE>
|
|
|
|
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2012-03-22 02:07:51 +00:00
|
|
|
Attach a device to the domain, using a device definition in an XML
|
|
|
|
file using a device definition element such as <disk> or <interface>
|
|
|
|
as the top-level element. See the documentation at
|
|
|
|
L<http://libvirt.org/formatdomain.html#elementsDevices> to learn about
|
|
|
|
libvirt XML format for a device. If I<--config> is specified the
|
|
|
|
command alters the persistent domain configuration with the device
|
2013-05-28 09:07:33 +00:00
|
|
|
attach taking effect the next time libvirt starts the domain.
|
2012-03-22 02:07:51 +00:00
|
|
|
For cdrom and floppy devices, this command only replaces the media
|
|
|
|
within an existing device; consider using B<update-device> for this
|
|
|
|
usage. For passthrough host devices, see also B<nodedev-detach>,
|
2015-03-20 09:25:13 +00:00
|
|
|
needed if the PCI device does not use managed mode.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2013-05-28 09:07:33 +00:00
|
|
|
If I<--live> is specified, affect a running domain.
|
|
|
|
If I<--config> is specified, affect the next startup of a persistent domain.
|
|
|
|
If I<--current> is specified, affect the current domain state.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. When no flag is specified legacy API is used whose behavior depends
|
|
|
|
on the hypervisor driver.
|
|
|
|
|
|
|
|
For compatibility purposes, I<--persistent> behaves like I<--config> for
|
|
|
|
an offline domain, and like I<--live> I<--config> for a running domain.
|
|
|
|
|
2013-04-11 14:27:23 +00:00
|
|
|
B<Note>: using of partial device definition XML files may lead to unexpected
|
|
|
|
results as some fields may be autogenerated and thus match devices other than
|
|
|
|
expected.
|
|
|
|
|
2014-07-01 10:02:03 +00:00
|
|
|
=item B<attach-disk> I<domain> I<source> I<target> [[[I<--live>] [I<--config>]
|
|
|
|
| [I<--current>]] | [I<--persistent>]] [I<--targetbus bus>] [I<--driver
|
2014-09-02 15:20:41 +00:00
|
|
|
driver>] [I<--subdriver subdriver>] [I<--iothread iothread>]
|
|
|
|
[I<--cache cache>] [I<--type type>]
|
2014-07-01 10:02:03 +00:00
|
|
|
[I<--mode mode>] [I<--sourcetype sourcetype>] [I<--serial serial>] [I<--wwn
|
|
|
|
wwn>] [I<--rawio>] [I<--address address>] [I<--multifunction>] [I<--print-xml>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Attach a new disk device to the domain.
|
2012-06-18 11:14:49 +00:00
|
|
|
I<source> is path for the files and devices. I<target> controls the bus or
|
|
|
|
device under which the disk is exposed to the guest OS. It indicates the
|
2014-07-01 10:02:03 +00:00
|
|
|
"logical" device name; the optional I<targetbus> attribute specifies the type
|
|
|
|
of disk device to emulate; possible values are driver specific, with typical
|
|
|
|
values being I<ide>, I<scsi>, I<virtio>, I<xen>, I<usb>, I<sata>, or I<sd>, if
|
|
|
|
omitted, the bus type is inferred from the style of the device name (e.g. a
|
|
|
|
device named 'sda' will typically be exported using a SCSI bus). I<driver> can
|
|
|
|
be I<file>, I<tap> or I<phy> for the Xen
|
2012-06-18 11:14:49 +00:00
|
|
|
hypervisor depending on the kind of access; or I<qemu> for the QEMU emulator.
|
2012-08-30 15:51:35 +00:00
|
|
|
Further details to the driver can be passed using I<subdriver>. For Xen
|
|
|
|
I<subdriver> can be I<aio>, while for QEMU subdriver should match the format
|
|
|
|
of the disk source, such as I<raw> or I<qcow2>. Hypervisor default will be
|
|
|
|
used if I<subdriver> is not specified. However, the default may not be
|
|
|
|
correct, esp. for QEMU as for security reasons it is configured not to detect
|
|
|
|
disk formats. I<type> can indicate I<lun>, I<cdrom> or I<floppy> as
|
|
|
|
alternative to the disk default, although this use only replaces the media
|
|
|
|
within the existing virtual cdrom or floppy device; consider using
|
|
|
|
B<update-device> for this usage instead.
|
2007-06-21 15:00:17 +00:00
|
|
|
I<mode> can specify the two specific mode I<readonly> or I<shareable>.
|
2010-11-18 07:50:02 +00:00
|
|
|
I<sourcetype> can indicate the type of source (block|file)
|
2011-09-22 19:33:47 +00:00
|
|
|
I<cache> can be one of "default", "none", "writethrough", "writeback",
|
|
|
|
"directsync" or "unsafe".
|
2014-09-02 15:20:41 +00:00
|
|
|
I<iothread> is the number within the range of domain IOThreads to which
|
|
|
|
this disk may be attached (QEMU only).
|
2013-06-04 03:27:04 +00:00
|
|
|
I<serial> is the serial of disk device. I<wwn> is the wwn of disk device.
|
2012-02-03 04:33:13 +00:00
|
|
|
I<rawio> indicates the disk needs rawio capability.
|
2011-07-15 07:06:53 +00:00
|
|
|
I<address> is the address of disk device in the form of pci:domain.bus.slot.function,
|
2015-02-04 14:00:08 +00:00
|
|
|
scsi:controller.bus.unit, ide:controller.bus.unit or ccw:cssid.ssid.devno.
|
|
|
|
Virtio-ccw devices must have their cssid set to 0xfe.
|
2011-12-13 06:12:32 +00:00
|
|
|
I<multifunction> indicates specified pci address is a multifunction pci device
|
|
|
|
address.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2013-01-25 12:21:23 +00:00
|
|
|
If I<--print-xml> is specified, then the XML of the disk that would be attached
|
|
|
|
is printed instead.
|
|
|
|
|
2013-05-28 09:07:33 +00:00
|
|
|
If I<--live> is specified, affect a running domain.
|
|
|
|
If I<--config> is specified, affect the next startup of a persistent domain.
|
|
|
|
If I<--current> is specified, affect the current domain state.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. When no flag is specified legacy API is used whose behavior depends
|
|
|
|
on the hypervisor driver.
|
|
|
|
|
|
|
|
For compatibility purposes, I<--persistent> behaves like I<--config> for
|
|
|
|
an offline domain, and like I<--live> I<--config> for a running domain.
|
2013-10-24 07:15:56 +00:00
|
|
|
Likewise, I<--shareable> is an alias for I<--mode shareable>.
|
2013-05-28 09:07:33 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<attach-interface> I<domain> I<type> I<source>
|
2013-05-28 09:07:33 +00:00
|
|
|
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
|
2011-07-14 17:36:21 +00:00
|
|
|
[I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>]
|
2015-08-01 07:48:04 +00:00
|
|
|
[I<--inbound average,peak,burst,floor>] [I<--outbound average,peak,burst>]
|
2015-11-11 14:01:37 +00:00
|
|
|
[I<--managed>] [I<--print-xml>]
|
|
|
|
|
|
|
|
Attach a new network interface to the domain.
|
|
|
|
|
|
|
|
B<type> can be one of the:
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
I<network> to indicate connection via a libvirt virtual network,
|
|
|
|
|
|
|
|
I<bridge> to indicate connection via a bridge device on the host,
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2015-02-09 15:17:51 +00:00
|
|
|
I<direct> to indicate connection directly to one of the host's network
|
2015-11-11 14:01:37 +00:00
|
|
|
interfaces or bridges,
|
|
|
|
|
2015-10-21 10:59:41 +00:00
|
|
|
I<hostdev> to indicate connection using a passthrough of PCI device
|
|
|
|
on the host.
|
|
|
|
|
2015-11-11 14:01:37 +00:00
|
|
|
=back
|
|
|
|
|
|
|
|
B<source> indicates the source of the connection. The source depends
|
|
|
|
on the type of the interface:
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
I<network> name of the virtual network,
|
|
|
|
|
|
|
|
I<bridge> the name of the bridge device,
|
|
|
|
|
|
|
|
I<direct> the name of the host's interface or bridge,
|
|
|
|
|
2015-10-21 10:59:41 +00:00
|
|
|
I<hostdev> the PCI address of the host's interface formatted
|
|
|
|
as domain:bus:slot.function.
|
|
|
|
|
2015-11-11 14:01:37 +00:00
|
|
|
=back
|
|
|
|
|
|
|
|
B<--target> is used to specify the tap/macvtap device to be used to
|
|
|
|
connect the domain to the source. Names starting with 'vnet' are
|
|
|
|
considered as auto-generated and are blanked out/regenerated each
|
|
|
|
time the interface is attached.
|
|
|
|
|
|
|
|
B<--mac> specifies the MAC address of the network interface; if a MAC
|
2014-08-07 14:50:21 +00:00
|
|
|
address is not given, a new address will be automatically generated
|
|
|
|
(and stored in the persistent configuration if "--config" is given on
|
2015-11-11 14:01:37 +00:00
|
|
|
the command line).
|
|
|
|
|
|
|
|
B<--script> is used to specify a path to a custom script to be called
|
|
|
|
while attaching to a bridge - this will be called instead of the default
|
|
|
|
script not in addition to it. This is valid only for interfaces of
|
|
|
|
I<bridge> type and only for Xen domains.
|
|
|
|
|
|
|
|
B<--model> specifies the network device model to be presented to the
|
|
|
|
domain.
|
|
|
|
|
|
|
|
B<--inbound> and B<--outbound> control the bandwidth of the
|
|
|
|
interface. At least one from the I<average>, I<floor> pair must be
|
|
|
|
specified. The other two I<peak> and I<burst> are optional, so
|
2015-08-01 07:48:04 +00:00
|
|
|
"average,peak", "average,,burst", "average,,,floor", "average" and
|
2015-11-11 14:01:37 +00:00
|
|
|
",,,floor" are also legal. Values for I<average>, I<floor> and I<peak>
|
2015-08-01 07:48:04 +00:00
|
|
|
are expressed in kilobytes per second, while I<burst> is expressed in
|
|
|
|
kilobytes in a single burst at I<peak> speed as described in the
|
|
|
|
Network XML documentation at
|
2014-08-07 14:50:21 +00:00
|
|
|
L<http://libvirt.org/formatnetwork.html#elementQoS>.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2015-10-21 10:59:41 +00:00
|
|
|
B<--managed> is usable only for I<hostdev> type and tells libvirt
|
|
|
|
that the interface should be managed, which means detached and reattached
|
|
|
|
from/to the host by libvirt.
|
|
|
|
|
2015-11-11 14:01:37 +00:00
|
|
|
If B<--print-xml> is specified, then the XML of the interface that would be
|
2015-09-07 10:13:47 +00:00
|
|
|
attached is printed instead.
|
|
|
|
|
2015-11-11 14:01:37 +00:00
|
|
|
If B<--live> is specified, affect a running domain.
|
|
|
|
If B<--config> is specified, affect the next startup of a persistent domain.
|
|
|
|
If B<--current> is specified, affect the current domain state.
|
|
|
|
Both B<--live> and B<--config> flags may be given, but B<--current> is
|
|
|
|
exclusive. When no flag is specified legacy API is used whose behavior
|
|
|
|
depends on the hypervisor driver.
|
2013-05-28 09:07:33 +00:00
|
|
|
|
2015-11-11 14:01:37 +00:00
|
|
|
For compatibility purposes, B<--persistent> behaves like B<--config> for
|
|
|
|
an offline domain, and like B<--live> B<--config> for a running domain.
|
2013-05-28 09:07:33 +00:00
|
|
|
|
2011-09-28 03:58:29 +00:00
|
|
|
B<Note>: the optional target value is the name of a device to be created
|
2015-11-11 14:01:37 +00:00
|
|
|
as the back-end on the node. If not provided a device named "vnetN" or "vifN"
|
2011-09-28 03:58:29 +00:00
|
|
|
will be created automatically.
|
|
|
|
|
2013-03-21 15:26:23 +00:00
|
|
|
=item B<detach-device> I<domain> I<FILE>
|
|
|
|
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Detach a device from the domain, takes the same kind of XML descriptions
|
|
|
|
as command B<attach-device>.
|
2011-10-14 22:59:16 +00:00
|
|
|
For passthrough host devices, see also B<nodedev-reattach>, needed if
|
|
|
|
the device does not use managed mode.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2015-02-20 11:25:42 +00:00
|
|
|
B<Note>: The supplied XML description of the device should be as specific
|
|
|
|
as its definition in the domain XML. The set of attributes used
|
|
|
|
to match the device are internal to the drivers. Using a partial definition,
|
|
|
|
or attempting to detach a device that is not present in the domain XML,
|
|
|
|
but shares some specific attributes with one that is present,
|
|
|
|
may lead to unexpected results.
|
2013-04-11 14:27:23 +00:00
|
|
|
|
2013-03-21 15:26:23 +00:00
|
|
|
If I<--live> is specified, affect a running domain.
|
|
|
|
If I<--config> is specified, affect the next startup of a persistent domain.
|
|
|
|
If I<--current> is specified, affect the current domain state.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. When no flag is specified legacy API is used whose behavior depends
|
|
|
|
on the hypervisor driver.
|
|
|
|
|
|
|
|
For compatibility purposes, I<--persistent> behaves like I<--config> for
|
|
|
|
an offline domain, and like I<--live> I<--config> for a running domain.
|
|
|
|
|
|
|
|
Note that older versions of virsh used I<--config> as an alias for
|
|
|
|
I<--persistent>.
|
|
|
|
|
2013-03-21 15:29:10 +00:00
|
|
|
=item B<detach-disk> I<domain> I<target>
|
|
|
|
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Detach a disk device from a domain. The I<target> is the device as seen
|
|
|
|
from the domain.
|
2013-03-21 15:29:10 +00:00
|
|
|
|
|
|
|
If I<--live> is specified, affect a running domain.
|
|
|
|
If I<--config> is specified, affect the next startup of a persistent domain.
|
|
|
|
If I<--current> is specified, affect the current domain state.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. When no flag is specified legacy API is used whose behavior depends
|
|
|
|
on the hypervisor driver.
|
|
|
|
|
|
|
|
For compatibility purposes, I<--persistent> behaves like I<--config> for
|
|
|
|
an offline domain, and like I<--live> I<--config> for a running domain.
|
|
|
|
|
|
|
|
Note that older versions of virsh used I<--config> as an alias for
|
|
|
|
I<--persistent>.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2013-03-21 14:03:42 +00:00
|
|
|
=item B<detach-interface> I<domain> I<type> [I<--mac mac>]
|
|
|
|
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2007-08-14 07:02:18 +00:00
|
|
|
Detach a network interface from a domain.
|
2012-02-28 07:41:37 +00:00
|
|
|
I<type> can be either I<network> to indicate a physical network device or
|
|
|
|
I<bridge> to indicate a bridge to a device. It is recommended to use the
|
|
|
|
I<mac> option to distinguish between the interfaces if more than one are
|
|
|
|
present on the domain.
|
2013-03-21 14:03:42 +00:00
|
|
|
|
|
|
|
If I<--live> is specified, affect a running domain.
|
|
|
|
If I<--config> is specified, affect the next startup of a persistent domain.
|
|
|
|
If I<--current> is specified, affect the current domain state.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. When no flag is specified legacy API is used whose behavior depends
|
|
|
|
on the hypervisor driver.
|
|
|
|
|
|
|
|
For compatibility purposes, I<--persistent> behaves like I<--config> for
|
|
|
|
an offline domain, and like I<--live> I<--config> for a running domain.
|
|
|
|
|
|
|
|
Note that older versions of virsh used I<--config> as an alias for
|
|
|
|
I<--persistent>.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2013-03-15 16:11:28 +00:00
|
|
|
=item B<update-device> I<domain> I<file> [I<--force>]
|
|
|
|
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
|
2010-12-22 16:01:53 +00:00
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
Update the characteristics of a device associated with I<domain>,
|
2013-03-15 16:11:28 +00:00
|
|
|
based on the device definition in an XML I<file>. The I<--force> option
|
|
|
|
can be used to force device update, e.g., to eject a CD-ROM even if it is
|
|
|
|
locked/mounted in the domain. See the documentation at
|
2012-03-22 02:07:51 +00:00
|
|
|
L<http://libvirt.org/formatdomain.html#elementsDevices> to learn about
|
|
|
|
libvirt XML format for a device.
|
2010-06-09 15:12:56 +00:00
|
|
|
|
2013-03-15 16:11:28 +00:00
|
|
|
If I<--live> is specified, affect a running domain.
|
|
|
|
If I<--config> is specified, affect the next startup of a persistent domain.
|
|
|
|
If I<--current> is specified, affect the current domain state.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. Not specifying any flag is the same as specifying I<--current>.
|
|
|
|
|
|
|
|
For compatibility purposes, I<--persistent> behaves like I<--config> for
|
|
|
|
an offline domain, and like I<--live> I<--config> for a running domain.
|
|
|
|
|
|
|
|
Note that older versions of virsh used I<--config> as an alias for
|
|
|
|
I<--persistent>.
|
|
|
|
|
2013-04-11 14:27:23 +00:00
|
|
|
B<Note>: using of partial device definition XML files may lead to unexpected
|
|
|
|
results as some fields may be autogenerated and thus match devices other than
|
|
|
|
expected.
|
|
|
|
|
2012-07-25 11:17:03 +00:00
|
|
|
=item B<change-media> I<domain> I<path> [I<--eject>] [I<--insert>]
|
2012-02-28 07:36:38 +00:00
|
|
|
[I<--update>] [I<source>] [I<--force>] [[I<--live>] [I<--config>] | [I<--current>]]
|
2015-03-12 15:41:21 +00:00
|
|
|
[I<--print-xml>] [I<--block>]
|
2012-02-28 07:36:38 +00:00
|
|
|
|
|
|
|
Change media of CDROM or floppy drive. I<path> can be the fully-qualified path
|
|
|
|
or the unique target name (<target dev='hdc'>) of the disk device. I<source>
|
2015-03-12 15:41:21 +00:00
|
|
|
specifies the path of the media to be inserted or updated. Flag I<--block>
|
|
|
|
allows to set the backing type in case a block device is used as media for the
|
|
|
|
CDROM or floppy drive instead of a file.
|
2012-02-28 07:36:38 +00:00
|
|
|
|
|
|
|
I<--eject> indicates the media will be ejected.
|
|
|
|
I<--insert> indicates the media will be inserted. I<source> must be specified.
|
|
|
|
If the device has source (e.g. <source file='media'>), and I<source> is not
|
|
|
|
specified, I<--update> is equal to I<--eject>. If the device has no source,
|
|
|
|
and I<source> is specified, I<--update> is equal to I<--insert>. If the device
|
|
|
|
has source, and I<source> is specified, I<--update> behaves like combination
|
|
|
|
of I<--eject> and I<--insert>.
|
|
|
|
If none of I<--eject>, I<--insert>, and I<--update> is specified, I<--update>
|
|
|
|
is used by default.
|
|
|
|
The I<--force> option can be used to force media changing.
|
|
|
|
If I<--live> is specified, alter live configuration of running guest.
|
|
|
|
If I<--config> is specified, alter persistent configuration, effect observed
|
|
|
|
on next boot.
|
|
|
|
I<--current> can be either or both of I<live> and I<config>, depends on
|
|
|
|
the hypervisor's implementation.
|
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. If no flag is specified, behavior is different depending
|
|
|
|
on hypervisor.
|
2015-03-12 15:04:00 +00:00
|
|
|
If I<--print-xml> is specified, the XML that would be used to change media is
|
|
|
|
printed instead of changing the media.
|
2012-02-28 07:36:38 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=back
|
|
|
|
|
2011-09-23 23:26:24 +00:00
|
|
|
=head1 NODEDEV COMMANDS
|
|
|
|
|
|
|
|
The following commands manipulate host devices that are intended to be
|
|
|
|
passed through to guest domains via <hostdev> elements in a domain's
|
|
|
|
<devices> section. A node device key is generally specified by the bus
|
|
|
|
name followed by its address, using underscores between all components,
|
|
|
|
such as pci_0000_00_02_1, usb_1_5_3, or net_eth1_00_27_13_6a_fe_00.
|
|
|
|
The B<nodedev-list> gives the full list of host devices that are known
|
|
|
|
to libvirt, although this includes devices that cannot be assigned to
|
|
|
|
a guest (for example, attempting to detach the PCI device that controls
|
|
|
|
the host's hard disk controller where the guest's disk images live could
|
|
|
|
cause the host system to lock up or reboot).
|
|
|
|
|
|
|
|
For more information on node device definition see:
|
|
|
|
L<http://libvirt.org/formatnode.html>.
|
|
|
|
|
|
|
|
Passthrough devices cannot be simultaneously used by the host and its
|
2011-10-14 22:59:16 +00:00
|
|
|
guest domains, nor by multiple active guests at once. If the
|
2015-03-20 09:25:13 +00:00
|
|
|
<hostdev> description of a PCI device includes the attribute B<managed='yes'>,
|
|
|
|
and the hypervisor driver supports it, then the device is in managed mode, and
|
2011-10-14 22:59:16 +00:00
|
|
|
attempts to use that passthrough device in an active guest will
|
2012-03-02 19:01:06 +00:00
|
|
|
automatically behave as if B<nodedev-detach> (guest start, device
|
2011-10-14 22:59:16 +00:00
|
|
|
hot-plug) and B<nodedev-reattach> (guest stop, device hot-unplug) were
|
2015-03-20 09:25:13 +00:00
|
|
|
called at the right points. If a PCI device is not marked as managed,
|
|
|
|
then it must manually be detached before guests can use it, and manually
|
|
|
|
reattached to be returned to the host. Also, if a device is manually detached,
|
2011-10-14 22:59:16 +00:00
|
|
|
then the host does not regain control of the device without a matching
|
|
|
|
reattach, even if the guests use the device in managed mode.
|
2011-09-23 23:26:24 +00:00
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item B<nodedev-create> I<FILE>
|
|
|
|
|
|
|
|
Create a device on the host node that can then be assigned to virtual
|
|
|
|
machines. Normally, libvirt is able to automatically determine which
|
|
|
|
host nodes are available for use, but this allows registration of
|
|
|
|
host hardware that libvirt did not automatically detect. I<file>
|
|
|
|
contains xml for a top-level <device> description of a node device.
|
|
|
|
|
2013-02-04 14:16:44 +00:00
|
|
|
=item B<nodedev-destroy> I<device>
|
2011-09-23 23:26:24 +00:00
|
|
|
|
2013-02-04 14:16:44 +00:00
|
|
|
Destroy (stop) a device on the host. I<device> can be either device
|
2013-11-22 12:55:25 +00:00
|
|
|
name or wwn pair in "wwnn,wwpn" format (only works for vHBA currently).
|
|
|
|
Note that this makes libvirt quit managing a host device, and may even
|
|
|
|
make that device unusable by the rest of the physical host until a reboot.
|
2011-09-23 23:26:24 +00:00
|
|
|
|
2013-07-12 09:32:51 +00:00
|
|
|
=item B<nodedev-detach> I<nodedev> [I<--driver backend_driver>]
|
2011-09-23 23:26:24 +00:00
|
|
|
|
|
|
|
Detach I<nodedev> from the host, so that it can safely be used by
|
|
|
|
guests via <hostdev> passthrough. This is reversed with
|
2011-10-14 22:59:16 +00:00
|
|
|
B<nodedev-reattach>, and is done automatically for managed devices.
|
2012-03-02 19:01:06 +00:00
|
|
|
For compatibility purposes, this command can also be spelled
|
|
|
|
B<nodedev-dettach>.
|
2011-09-23 23:26:24 +00:00
|
|
|
|
2013-07-12 09:32:51 +00:00
|
|
|
Different backend drivers expect the device to be bound to different
|
|
|
|
dummy devices. For example, QEMU's "kvm" backend driver (the default)
|
|
|
|
expects the device to be bound to pci-stub, but its "vfio" backend
|
|
|
|
driver expects the device to be bound to vfio-pci. The I<--driver>
|
|
|
|
parameter can be used to specify the desired backend driver.
|
|
|
|
|
2013-02-04 14:16:44 +00:00
|
|
|
=item B<nodedev-dumpxml> I<device>
|
2011-09-23 23:26:24 +00:00
|
|
|
|
|
|
|
Dump a <device> XML representation for the given node device, including
|
|
|
|
such information as the device name, which bus owns the device, the
|
|
|
|
vendor and product id, and any capabilities of the device usable by
|
2013-02-04 14:16:44 +00:00
|
|
|
libvirt (such as whether device reset is supported). I<device> can
|
|
|
|
be either device name or wwn pair in "wwnn,wwpn" format (only works
|
|
|
|
for HBA).
|
2011-09-23 23:26:24 +00:00
|
|
|
|
|
|
|
=item B<nodedev-list> I<cap> I<--tree>
|
|
|
|
|
|
|
|
List all of the devices available on the node that are known by libvirt.
|
2012-09-17 03:32:53 +00:00
|
|
|
I<cap> is used to filter the list by capability types, the types must be
|
|
|
|
separated by comma, e.g. --cap pci,scsi, valid capability types include
|
|
|
|
'system', 'pci', 'usb_device', 'usb', 'net', 'scsi_host', 'scsi_target',
|
2013-06-03 10:05:35 +00:00
|
|
|
'scsi', 'storage', 'fc_host', 'vports', 'scsi_generic'. If I<--tree> is
|
|
|
|
used, the output is formatted in a tree representing parents of each node.
|
|
|
|
I<cap> and I<--tree> are mutually exclusive.
|
2013-01-07 17:05:28 +00:00
|
|
|
|
2011-09-23 23:26:24 +00:00
|
|
|
=item B<nodedev-reattach> I<nodedev>
|
|
|
|
|
|
|
|
Declare that I<nodedev> is no longer in use by any guests, and that
|
2011-10-14 22:59:16 +00:00
|
|
|
the host can resume normal use of the device. This is done
|
2015-03-20 09:25:13 +00:00
|
|
|
automatically for PCI devices in managed mode and USB devices, but
|
|
|
|
must be done explicitly to match any explicit B<nodedev-detach>.
|
2011-09-23 23:26:24 +00:00
|
|
|
|
|
|
|
=item B<nodedev-reset> I<nodedev>
|
|
|
|
|
|
|
|
Trigger a device reset for I<nodedev>, useful prior to transferring
|
|
|
|
a node device between guest passthrough or the host. Libvirt will
|
|
|
|
often do this action implicitly when required, but this command
|
|
|
|
allows an explicit reset when needed.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=head1 VIRTUAL NETWORK COMMANDS
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
The following commands manipulate networks. Libvirt has the capability to
|
|
|
|
define virtual networks which can then be used by domains and linked to
|
2008-03-14 11:08:03 +00:00
|
|
|
actual network devices. For more detailed information about this feature
|
2011-05-31 19:45:50 +00:00
|
|
|
see the documentation at L<http://libvirt.org/formatnetwork.html> . Many
|
|
|
|
of the commands for virtual networks are similar to the ones used for domains,
|
2007-06-21 15:00:17 +00:00
|
|
|
but the way to name a virtual network is either by its name or UUID.
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=over 4
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<net-autostart> I<network> [I<--disable>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Configure a virtual network to be automatically started at boot.
|
|
|
|
The I<--disable> option disable autostarting.
|
|
|
|
|
|
|
|
=item B<net-create> I<file>
|
|
|
|
|
2013-03-16 17:36:32 +00:00
|
|
|
Create a transient (temporary) virtual network from an
|
|
|
|
XML I<file> and instantiate (start) the network.
|
|
|
|
See the documentation at L<http://libvirt.org/formatnetwork.html>
|
|
|
|
to get a description of the XML network format used by libvirt.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
=item B<net-define> I<file>
|
|
|
|
|
2015-02-25 15:01:09 +00:00
|
|
|
Define an inactive persistent virtual network or modify an existing persistent
|
|
|
|
one from the XML I<file>.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
=item B<net-destroy> I<network>
|
|
|
|
|
2013-03-16 17:36:32 +00:00
|
|
|
Destroy (stop) a given transient or persistent virtual network
|
|
|
|
specified by its name or UUID. This takes effect immediately.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2011-12-14 10:50:40 +00:00
|
|
|
=item B<net-dumpxml> I<network> [I<--inactive>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Output the virtual network information as an XML dump to stdout.
|
2011-12-14 10:50:40 +00:00
|
|
|
If I<--inactive> is specified, then physical functions are not
|
|
|
|
expanded into their associated virtual functions.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
2008-08-01 14:30:41 +00:00
|
|
|
=item B<net-edit> I<network>
|
|
|
|
|
|
|
|
Edit the XML configuration file for a network.
|
|
|
|
|
|
|
|
This is equivalent to:
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2012-06-04 18:45:16 +00:00
|
|
|
virsh net-dumpxml --inactive network > network.xml
|
2010-11-17 14:15:12 +00:00
|
|
|
vi network.xml (or make changes with your other text editor)
|
2010-04-05 23:21:02 +00:00
|
|
|
virsh net-define network.xml
|
|
|
|
|
2008-08-01 14:30:41 +00:00
|
|
|
except that it does some error checking.
|
|
|
|
|
2010-03-12 16:33:22 +00:00
|
|
|
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
|
|
|
|
variables, and defaults to C<vi>.
|
2008-08-01 14:30:41 +00:00
|
|
|
|
2014-02-15 00:19:32 +00:00
|
|
|
=item B<net-event> {[I<network>] I<event> [I<--loop>] [I<--timeout>
|
|
|
|
I<seconds>] | I<--list>}
|
|
|
|
|
|
|
|
Wait for a class of network events to occur, and print appropriate details
|
|
|
|
of events as they happen. The events can optionally be filtered by
|
|
|
|
I<network>. Using I<--list> as the only argument will provide a list
|
|
|
|
of possible I<event> values known by this client, although the connection
|
|
|
|
might not allow registering for all these events.
|
|
|
|
|
|
|
|
By default, this command is one-shot, and returns success once an event
|
|
|
|
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
|
|
|
|
If I<--timeout> is specified, the command gives up waiting for events
|
|
|
|
after I<seconds> have elapsed. With I<--loop>, the command prints all
|
|
|
|
events until a timeout or interrupt key.
|
|
|
|
|
2010-11-16 07:48:47 +00:00
|
|
|
=item B<net-info> I<network>
|
|
|
|
|
|
|
|
Returns basic information about the I<network> object.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<net-list> [I<--inactive> | I<--all>]
|
2015-06-08 14:13:28 +00:00
|
|
|
{ [I<--table>] | I<--name> | I<--uuid> }
|
2012-09-04 15:55:20 +00:00
|
|
|
[I<--persistent>] [<--transient>]
|
|
|
|
[I<--autostart>] [<--no-autostart>]
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
Returns the list of active networks, if I<--all> is specified this will also
|
|
|
|
include defined but inactive networks, if I<--inactive> is specified only the
|
2012-09-04 15:55:20 +00:00
|
|
|
inactive ones will be listed. You may also want to filter the returned networks
|
2013-04-03 09:37:41 +00:00
|
|
|
by I<--persistent> to list the persistent ones, I<--transient> to list the
|
2012-09-04 15:55:20 +00:00
|
|
|
transient ones, I<--autostart> to list the ones with autostart enabled, and
|
|
|
|
I<--no-autostart> to list the ones with autostart disabled.
|
|
|
|
|
2015-06-08 14:13:28 +00:00
|
|
|
If I<--name> is specified, network names are printed instead of the table
|
|
|
|
formatted one per line. If I<--uuid> is specified network's UUID's are printed
|
|
|
|
instead of names. Flag I<--table> specifies that the legacy table-formatted
|
|
|
|
output should be used. This is the default. All of these are mutually
|
|
|
|
exclusive.
|
|
|
|
|
2012-09-04 15:55:20 +00:00
|
|
|
NOTE: When talking to older servers, this command is forced to use a series of
|
|
|
|
API calls with an inherent race, where a pool might not be listed or might appear
|
|
|
|
more than once if it changed state between calls while the list was being
|
|
|
|
collected. Newer servers do not have this problem.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
=item B<net-name> I<network-UUID>
|
|
|
|
|
|
|
|
Convert a network UUID to network name.
|
|
|
|
|
|
|
|
=item B<net-start> I<network>
|
|
|
|
|
|
|
|
Start a (previously defined) inactive network.
|
|
|
|
|
|
|
|
=item B<net-undefine> I<network>
|
|
|
|
|
2014-08-19 02:59:51 +00:00
|
|
|
Undefine the configuration for a persistent network. If the network is active,
|
|
|
|
make it transient.
|
2007-06-21 15:00:17 +00:00
|
|
|
|
|
|
|
=item B<net-uuid> I<network-name>
|
|
|
|
|
|
|
|
Convert a network name to network UUID.
|
|
|
|
|
virsh: new net-update command
This command uses the new virNetworkUpdate() API to modify an existing
network definition, and optionally have those modifications take
effect immediately without restarting the network.
An example usage:
virsh net-update mynet add-last ip-dhcp-host \
"<host mac='00:11:22:33:44:55' ip='192.168.122.45'/>" \
--live --config
If you like, you can instead put the xml into a file, and call like
this:
virsh net-update mynet add ip-dhcp-host /tmp/myxml.xml
--live --config
virsh will autodetect whether the argument is itself an xml element,
or if it's a file, by looking at the first character - the first
character of an xml element is always "<", and the first character of
a file is almost always *not* "<" (in the rare case that it is, the
user could specify "./<filename...").
A --parent-index option is also available (to give the index within a
list of parent objects, e.g. the index of the parent <ip> element when
updating ip-dhcp-host elements), but is optional and at least for now
will probably be used rarely.
--live, --config, and --current options - if you specify --live, only
the live state of the network will be updated. If you also specify
--config, then the persistent configuration will also be updated;
these two commands can be given separately, or both together. If you
don't specify either (you can optionally specify "--current" for the
same effect), then the "current" config will be updated (i.e. if the
network is active, then only its live config is affected, but if the
network is inactive, only the persistent config is affected).
2012-09-19 11:38:43 +00:00
|
|
|
=item B<net-update> I<network> I<command> I<section> I<xml>
|
|
|
|
[I<--parent-index> I<index>] [[I<--live>] [I<--config>] | [I<--current>]]
|
|
|
|
|
|
|
|
Update the given section of an existing network definition, with the
|
|
|
|
changes optionally taking effect immediately, without needing to
|
|
|
|
destroy and re-start the network.
|
|
|
|
|
|
|
|
I<command> is one of "add-first", "add-last", "add" (a synonym for
|
|
|
|
add-last), "delete", or "modify".
|
|
|
|
|
2013-01-14 23:46:30 +00:00
|
|
|
I<section> is one of "bridge", "domain", "ip", "ip-dhcp-host",
|
virsh: new net-update command
This command uses the new virNetworkUpdate() API to modify an existing
network definition, and optionally have those modifications take
effect immediately without restarting the network.
An example usage:
virsh net-update mynet add-last ip-dhcp-host \
"<host mac='00:11:22:33:44:55' ip='192.168.122.45'/>" \
--live --config
If you like, you can instead put the xml into a file, and call like
this:
virsh net-update mynet add ip-dhcp-host /tmp/myxml.xml
--live --config
virsh will autodetect whether the argument is itself an xml element,
or if it's a file, by looking at the first character - the first
character of an xml element is always "<", and the first character of
a file is almost always *not* "<" (in the rare case that it is, the
user could specify "./<filename...").
A --parent-index option is also available (to give the index within a
list of parent objects, e.g. the index of the parent <ip> element when
updating ip-dhcp-host elements), but is optional and at least for now
will probably be used rarely.
--live, --config, and --current options - if you specify --live, only
the live state of the network will be updated. If you also specify
--config, then the persistent configuration will also be updated;
these two commands can be given separately, or both together. If you
don't specify either (you can optionally specify "--current" for the
same effect), then the "current" config will be updated (i.e. if the
network is active, then only its live config is affected, but if the
network is inactive, only the persistent config is affected).
2012-09-19 11:38:43 +00:00
|
|
|
"ip-dhcp-range", "forward", "forward-interface", "forward-pf",
|
|
|
|
"portgroup", "dns-host", "dns-txt", or "dns-srv", each section being
|
|
|
|
named by a concatenation of the xml element hierarchy leading to the
|
|
|
|
element being changed. For example, "ip-dhcp-host" will change a
|
|
|
|
<host> element that is contained inside a <dhcp> element inside an
|
|
|
|
<ip> element of the network.
|
|
|
|
|
|
|
|
I<xml> is either the text of a complete xml element of the type being
|
|
|
|
changed (e.g. "<host mac="00:11:22:33:44:55' ip='1.2.3.4'/>", or the
|
|
|
|
name of a file that contains a complete xml element. Disambiguation is
|
|
|
|
done by looking at the first character of the provided text - if the
|
|
|
|
first character is "<", it is xml text, if the first character is not
|
|
|
|
"<", it is the name of a file that contains the xml text to be used.
|
|
|
|
|
|
|
|
The I<--parent-index> option is used to specify which of several
|
|
|
|
parent elements the requested element is in (0-based). For example, a
|
|
|
|
dhcp <host> element could be in any one of multiple <ip> elements in
|
|
|
|
the network; if a parent-index isn't provided, the "most appropriate"
|
|
|
|
<ip> element will be selected (usually the only one that already has a
|
|
|
|
<dhcp> element), but if I<--parent-index> is given, that particular
|
|
|
|
instance of <ip> will get the modification.
|
|
|
|
|
2012-11-01 14:51:28 +00:00
|
|
|
If I<--live> is specified, affect a running network.
|
|
|
|
If I<--config> is specified, affect the next startup of a persistent network.
|
|
|
|
If I<--current> is specified, affect the current network state.
|
virsh: new net-update command
This command uses the new virNetworkUpdate() API to modify an existing
network definition, and optionally have those modifications take
effect immediately without restarting the network.
An example usage:
virsh net-update mynet add-last ip-dhcp-host \
"<host mac='00:11:22:33:44:55' ip='192.168.122.45'/>" \
--live --config
If you like, you can instead put the xml into a file, and call like
this:
virsh net-update mynet add ip-dhcp-host /tmp/myxml.xml
--live --config
virsh will autodetect whether the argument is itself an xml element,
or if it's a file, by looking at the first character - the first
character of an xml element is always "<", and the first character of
a file is almost always *not* "<" (in the rare case that it is, the
user could specify "./<filename...").
A --parent-index option is also available (to give the index within a
list of parent objects, e.g. the index of the parent <ip> element when
updating ip-dhcp-host elements), but is optional and at least for now
will probably be used rarely.
--live, --config, and --current options - if you specify --live, only
the live state of the network will be updated. If you also specify
--config, then the persistent configuration will also be updated;
these two commands can be given separately, or both together. If you
don't specify either (you can optionally specify "--current" for the
same effect), then the "current" config will be updated (i.e. if the
network is active, then only its live config is affected, but if the
network is inactive, only the persistent config is affected).
2012-09-19 11:38:43 +00:00
|
|
|
Both I<--live> and I<--config> flags may be given, but I<--current> is
|
|
|
|
exclusive. Not specifying any flag is the same as specifying I<--current>.
|
|
|
|
|
2014-06-23 21:01:52 +00:00
|
|
|
=item B<net-dhcp-leases> I<network> [I<mac>]
|
|
|
|
|
|
|
|
Get a list of dhcp leases for all network interfaces connected to the given
|
|
|
|
virtual I<network> or limited output just for one interface if I<mac> is
|
|
|
|
specified.
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=back
|
|
|
|
|
2011-05-31 19:45:50 +00:00
|
|
|
=head1 INTERFACE COMMANDS
|
|
|
|
|
|
|
|
The following commands manipulate host interfaces. Often, these host
|
|
|
|
interfaces can then be used by name within domain <interface> elements
|
|
|
|
(such as a system-created bridge interface), but there is no
|
|
|
|
requirement that host interfaces be tied to any particular guest
|
|
|
|
configuration XML at all.
|
|
|
|
|
|
|
|
Many of the commands for host interfaces are similar to the ones used
|
|
|
|
for domains, and the way to name an interface is either by its name or
|
|
|
|
its MAC address. However, using a MAC address for an I<iface>
|
|
|
|
argument only works when that address is unique (if an interface and a
|
|
|
|
bridge share the same MAC address, which is often the case, then using
|
|
|
|
that MAC address results in an error due to ambiguity, and you must
|
|
|
|
resort to a name instead).
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
virsh: add iface-bridge and iface-unbridge commands
One of the top questions by libvirt users is how to create a host
bridge device so that guests can be directly on the physical
network. There are several example documents that explain how to do
this manually, but following them often results in confusion and
failure. virt-manager does a good job of creating a bridge based on an
existing network device, but not everyone wants to use virt-manager.
This patch adds a new command, iface-bridge that makes it just about
as simple as possible to create a new bridge device based on an
existing ethernet/vlan/bond device (including associating IP
configuration with the bridge rather than the now-attached device),
and start that new bridge up ready for action, eg:
virsh iface-bridge eth0 br0
For symmetry's sake, it also adds a command to remove a device from a
bridge, restoring the IP config to the now-unattached device:
virsh iface-unbridge br0
(I had a short debate about whether to do "iface-unbridge eth0"
instead, but that would involve searching through all bridge devices
for the one that contained eth0, which seems like a bit too much
trouble).
NOTE: These two commands require that the netcf library be available
on the host. Hopefully this will provide some extra incentive for
people using suse, debian, ubuntu, and other similar systems to polish
up (and push downstream) the ports to those distros recently pushed to
the upstream netcf repo by Dan Berrange. Anyone interested in helping
with that effort in any way should join the netcf-devel mailing list
(subscription info at
https://fedorahosted.org/mailman/listinfo/netcf-devel)
During creation of the bridge, it's possible to specify whether or not
the STP protocol should be started up on the bridge and, if so, how
many seconds the bridge should squelch traffic from newly added
devices while learning new topology (defaults are stp='on' and
delay='0', which seems to usually work best for bridges used in the
context of libvirt guests).
There is also an option to not immediately start the bridge (and a
similar option to not immediately start the un-attached device after
destroying the bridge. Default is to start the new device, because in
the case of iface-unbridge not starting is strongly discouraged as it
will leave the system with no network connectivity on that interface
(because it's necessary to destroy/undefine the bridge device before
the unattached device can be defined), and it seemed better to make
the option for iface-bridge behave consistently.
NOTE TO THOSE TRYING THESE COMMANDS FOR THE FIRST TIME: to guard
against any "unexpected" change to configuration, it is advisable to
issue an "virsh iface-begin" command before starting any interface
config changes, and "virsh iface-commit" only after you've verified
that everything is working as you expect. If something goes wrong,
you can always run "virsh iface-rollback" or reboot the system (which
should automatically do iface-rollback).
Aside from adding the code for these two functions, and the two
entries into the command table, the only other change to virsh.c was
to add the option name to vshCommandOptInterfaceBy(), because the
iface-unbridge command names its interface option as "bridge".
virsh.pod has also been updated with short descriptions of these two
new commands.
2011-11-07 16:15:58 +00:00
|
|
|
=item B<iface-bridge> I<interface> I<bridge> [I<--no-stp>] [I<delay>]
|
|
|
|
[I<--no-start>]
|
|
|
|
|
|
|
|
Create a bridge device named I<bridge>, and attach the existing
|
|
|
|
network device I<interface> to the new bridge. The new bridge
|
|
|
|
defaults to starting immediately, with STP enabled and a delay of 0;
|
|
|
|
these settings can be altered with I<--no-stp>, I<--no-start>, and an
|
|
|
|
integer number of seconds for I<delay>. All IP address configuration
|
|
|
|
of I<interface> will be moved to the new bridge device.
|
|
|
|
|
|
|
|
See also B<iface-unbridge> for undoing this operation.
|
|
|
|
|
2011-05-31 19:45:50 +00:00
|
|
|
=item B<iface-define> I<file>
|
|
|
|
|
2015-02-25 14:37:00 +00:00
|
|
|
Define an inactive persistent physical host interface or modify an existing
|
|
|
|
persistent one from the XML I<file>.
|
2011-05-31 19:45:50 +00:00
|
|
|
|
|
|
|
=item B<iface-destroy> I<interface>
|
|
|
|
|
2011-07-06 21:42:47 +00:00
|
|
|
Destroy (stop) a given host interface, such as by running "if-down" to
|
2011-05-31 19:45:50 +00:00
|
|
|
disable that interface from active use. This takes effect immediately.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<iface-dumpxml> I<interface> [I<--inactive>]
|
2011-05-31 19:45:50 +00:00
|
|
|
|
|
|
|
Output the host interface information as an XML dump to stdout. If
|
|
|
|
I<--inactive> is specified, then the output reflects the persistent
|
|
|
|
state of the interface that will be used the next time it is started.
|
|
|
|
|
|
|
|
=item B<iface-edit> I<interface>
|
|
|
|
|
|
|
|
Edit the XML configuration file for a host interface.
|
|
|
|
|
|
|
|
This is equivalent to:
|
|
|
|
|
|
|
|
virsh iface-dumpxml iface > iface.xml
|
|
|
|
vi iface.xml (or make changes with your other text editor)
|
|
|
|
virsh iface-define iface.xml
|
|
|
|
|
|
|
|
except that it does some error checking.
|
|
|
|
|
|
|
|
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
|
|
|
|
variables, and defaults to C<vi>.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<iface-list> [I<--inactive> | I<--all>]
|
2011-05-31 19:45:50 +00:00
|
|
|
|
|
|
|
Returns the list of active host interfaces. If I<--all> is specified
|
|
|
|
this will also include defined but inactive interfaces. If
|
|
|
|
I<--inactive> is specified only the inactive ones will be listed.
|
|
|
|
|
2011-07-19 03:19:25 +00:00
|
|
|
=item B<iface-name> I<interface>
|
2011-05-31 19:45:50 +00:00
|
|
|
|
2011-07-19 03:19:25 +00:00
|
|
|
Convert a host interface MAC to interface name, if the MAC address is unique
|
|
|
|
among the host's interfaces.
|
2011-05-31 19:45:50 +00:00
|
|
|
|
2011-07-19 03:19:25 +00:00
|
|
|
I<interface> specifies the interface MAC address.
|
|
|
|
|
|
|
|
=item B<iface-mac> I<interface>
|
2011-05-31 19:45:50 +00:00
|
|
|
|
|
|
|
Convert a host interface name to MAC address.
|
|
|
|
|
2011-07-19 03:19:25 +00:00
|
|
|
I<interface> specifies the interface name.
|
|
|
|
|
|
|
|
=item B<iface-start> I<interface>
|
2011-05-31 19:45:50 +00:00
|
|
|
|
|
|
|
Start a (previously defined) host interface, such as by running "if-up".
|
|
|
|
|
virsh: add iface-bridge and iface-unbridge commands
One of the top questions by libvirt users is how to create a host
bridge device so that guests can be directly on the physical
network. There are several example documents that explain how to do
this manually, but following them often results in confusion and
failure. virt-manager does a good job of creating a bridge based on an
existing network device, but not everyone wants to use virt-manager.
This patch adds a new command, iface-bridge that makes it just about
as simple as possible to create a new bridge device based on an
existing ethernet/vlan/bond device (including associating IP
configuration with the bridge rather than the now-attached device),
and start that new bridge up ready for action, eg:
virsh iface-bridge eth0 br0
For symmetry's sake, it also adds a command to remove a device from a
bridge, restoring the IP config to the now-unattached device:
virsh iface-unbridge br0
(I had a short debate about whether to do "iface-unbridge eth0"
instead, but that would involve searching through all bridge devices
for the one that contained eth0, which seems like a bit too much
trouble).
NOTE: These two commands require that the netcf library be available
on the host. Hopefully this will provide some extra incentive for
people using suse, debian, ubuntu, and other similar systems to polish
up (and push downstream) the ports to those distros recently pushed to
the upstream netcf repo by Dan Berrange. Anyone interested in helping
with that effort in any way should join the netcf-devel mailing list
(subscription info at
https://fedorahosted.org/mailman/listinfo/netcf-devel)
During creation of the bridge, it's possible to specify whether or not
the STP protocol should be started up on the bridge and, if so, how
many seconds the bridge should squelch traffic from newly added
devices while learning new topology (defaults are stp='on' and
delay='0', which seems to usually work best for bridges used in the
context of libvirt guests).
There is also an option to not immediately start the bridge (and a
similar option to not immediately start the un-attached device after
destroying the bridge. Default is to start the new device, because in
the case of iface-unbridge not starting is strongly discouraged as it
will leave the system with no network connectivity on that interface
(because it's necessary to destroy/undefine the bridge device before
the unattached device can be defined), and it seemed better to make
the option for iface-bridge behave consistently.
NOTE TO THOSE TRYING THESE COMMANDS FOR THE FIRST TIME: to guard
against any "unexpected" change to configuration, it is advisable to
issue an "virsh iface-begin" command before starting any interface
config changes, and "virsh iface-commit" only after you've verified
that everything is working as you expect. If something goes wrong,
you can always run "virsh iface-rollback" or reboot the system (which
should automatically do iface-rollback).
Aside from adding the code for these two functions, and the two
entries into the command table, the only other change to virsh.c was
to add the option name to vshCommandOptInterfaceBy(), because the
iface-unbridge command names its interface option as "bridge".
virsh.pod has also been updated with short descriptions of these two
new commands.
2011-11-07 16:15:58 +00:00
|
|
|
=item B<iface-unbridge> I<bridge> [I<--no-start>]
|
|
|
|
|
|
|
|
Tear down a bridge device named I<bridge>, releasing its underlying
|
|
|
|
interface back to normal usage, and moving all IP address
|
|
|
|
configuration from the bridge device to the underlying device. The
|
|
|
|
underlying interface is restarted unless I<--no-start> is present;
|
|
|
|
this flag is present for symmetry, but generally not recommended.
|
|
|
|
|
|
|
|
See also B<iface-bridge> for creating a bridge.
|
|
|
|
|
2011-07-19 03:19:25 +00:00
|
|
|
=item B<iface-undefine> I<interface>
|
2011-05-31 19:45:50 +00:00
|
|
|
|
|
|
|
Undefine the configuration for an inactive host interface.
|
|
|
|
|
|
|
|
=item B<iface-begin>
|
|
|
|
|
|
|
|
Create a snapshot of current host interface settings, which can later
|
|
|
|
be committed (I<iface-commit>) or restored (I<iface-rollback>). If a
|
|
|
|
snapshot already exists, then this command will fail until the
|
|
|
|
previous snapshot has been committed or restored. Undefined behavior
|
|
|
|
results if any external changes are made to host interfaces outside of
|
|
|
|
the libvirt API between the beginning of a snapshot and its eventual
|
|
|
|
commit or rollback.
|
|
|
|
|
|
|
|
=item B<iface-commit>
|
|
|
|
|
|
|
|
Declare all changes since the last I<iface-begin> as working, and
|
|
|
|
delete the rollback point. If no interface snapshot has already been
|
|
|
|
started, then this command will fail.
|
|
|
|
|
|
|
|
=item B<iface-rollback>
|
|
|
|
|
|
|
|
Revert all host interface settings back to the state recorded in the
|
|
|
|
last I<iface-begin>. If no interface snapshot has already been
|
|
|
|
started, then this command will fail. Rebooting the host also serves
|
|
|
|
as an implicit rollback point.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
=head1 STORAGE POOL COMMANDS
|
|
|
|
|
|
|
|
The following commands manipulate storage pools. Libvirt has the
|
|
|
|
capability to manage various storage solutions, including files, raw
|
|
|
|
partitions, and domain-specific formats, used to provide the storage
|
|
|
|
volumes visible as devices within virtual machines. For more detailed
|
|
|
|
information about this feature, see the documentation at
|
2011-05-31 19:45:50 +00:00
|
|
|
L<http://libvirt.org/formatstorage.html> . Many of the commands for
|
2010-04-05 23:21:02 +00:00
|
|
|
pools are similar to the ones used for domains.
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<find-storage-pool-sources> I<type> [I<srcSpec>]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2015-02-25 22:41:34 +00:00
|
|
|
Returns XML describing all possible available storage pool sources that
|
|
|
|
could be used to create or define a storage pool of a given I<type>. If
|
|
|
|
I<srcSpec> is provided, it is a file that contains XML to further restrict
|
|
|
|
the query for pools.
|
|
|
|
|
|
|
|
Not all storage pools support discovery in this manner. Furthermore, for
|
|
|
|
those that do support discovery, only specific XML elements are required
|
|
|
|
in order to return valid data, while other elements and even attributes
|
|
|
|
of some elements are ignored since they are not necessary to find the pool
|
|
|
|
based on the search criteria. The following lists the supported I<type>
|
|
|
|
options and the expected minimal XML elements used to perform the search.
|
|
|
|
|
|
|
|
For a "netfs" or "gluster" pool, the minimal expected XML required is the
|
|
|
|
<host> element with a "name" attribute describing the IP address or hostname
|
|
|
|
to be used to find the pool. The "port" attribute will be ignored as will
|
|
|
|
any other provided XML elements in I<srcSpec>.
|
|
|
|
|
|
|
|
For a "logical" pool, the contents of the I<srcSpec> file are ignored,
|
|
|
|
although if provided the file must at least exist.
|
|
|
|
|
|
|
|
For an "iscsi" pool, the minimal expect XML required is the <host> element
|
|
|
|
with a "name" attribute describing the IP address or hostname to be used to
|
|
|
|
find the pool (the iSCSI server address). Optionally, the "port" attribute
|
|
|
|
may be provided, although it will default to 3260. Optionally, an <initiator>
|
|
|
|
XML element with a "name" attribute may be provided to further restrict the
|
|
|
|
iSCSI target search to a specific initiator for multi-iqn iSCSI storage pools.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<find-storage-pool-sources-as> I<type> [I<host>] [I<port>]
|
|
|
|
[I<initiator>]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2015-02-25 22:41:34 +00:00
|
|
|
Rather than providing I<srcSpec> XML file for B<find-storage-pool-sources>
|
|
|
|
use this command option in order to have virsh generate the query XML file
|
|
|
|
using the optional arguments. The command will return the same output
|
|
|
|
XML as B<find-storage-pool-sources>.
|
|
|
|
|
|
|
|
Use I<host> to describe a specific host to use for networked storage, such
|
|
|
|
as netfs, gluster, and iscsi I<type> pools.
|
|
|
|
|
|
|
|
Use I<port> to further restrict which networked port to utilize for the
|
|
|
|
connection if required by the specific storage backend, such as iscsi.
|
|
|
|
|
|
|
|
Use I<initiator> to further restrict the iscsi I<type> pool searches to
|
|
|
|
specific target initiators.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<pool-autostart> I<pool-or-uuid> [I<--disable>]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Configure whether I<pool> should automatically start at boot.
|
|
|
|
|
2011-08-31 13:55:32 +00:00
|
|
|
=item B<pool-build> I<pool-or-uuid> [I<--overwrite>] [I<--no-overwrite>]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Build a given pool.
|
|
|
|
|
2011-08-31 13:55:32 +00:00
|
|
|
Options I<--overwrite> and I<--no-overwrite> can only be used for
|
2015-01-09 12:36:01 +00:00
|
|
|
B<pool-build> a filesystem or disk pool. For a file system pool if
|
|
|
|
neither of them is specified, B<pool-build> makes the directory. If
|
2011-08-31 13:55:32 +00:00
|
|
|
I<--no-overwrite> is specified, it probes to determine if a
|
|
|
|
filesystem already exists on the target device, returning an error
|
2015-01-09 12:36:01 +00:00
|
|
|
if exists, or using mkfs to format the target device if not. If
|
|
|
|
I<--overwrite> is specified, mkfs is always executed and any existing
|
|
|
|
data on the target device is overwritten unconditionally. For a disk
|
|
|
|
pool, if neither of them is specified or I<--no-overwrite> is specified,
|
|
|
|
B<pool-build> will use 'parted --print' in order to determine if the
|
|
|
|
disk already has a label before attempting to create one. Only if a disk
|
|
|
|
does not already have one will a label be created. If I<--overwrite> is
|
|
|
|
specified or it's been determined that the disk doesn't already have one,
|
|
|
|
'parted mklabel' will be used to create a label of the format specified
|
|
|
|
by the pool source format type or "dos" if not specified for the pool.
|
2011-08-31 13:55:32 +00:00
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
=item B<pool-create> I<file>
|
2015-11-25 14:51:51 +00:00
|
|
|
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Create and start a pool object from the XML I<file>.
|
|
|
|
|
2015-11-25 14:51:51 +00:00
|
|
|
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]] perform a
|
|
|
|
B<pool-build> after creation in order to remove the need for a
|
|
|
|
follow-up command to build the pool. The I<--overwrite> and
|
|
|
|
I<--no-overwrite> flags follow the same rules as B<pool-build>. If
|
|
|
|
just I<--build> is provided, then B<pool-build> is called with no flags.
|
|
|
|
|
2014-12-04 00:46:54 +00:00
|
|
|
=item B<pool-create-as> I<name> I<type> [I<--print-xml>]
|
|
|
|
[I<--source-host hostname>] [I<--source-path path>] [I<--source-dev path>]
|
|
|
|
[I<--source-name name>] [I<--target path>] [I<--source-format format>]
|
2014-12-03 23:45:50 +00:00
|
|
|
[I<--auth-type authtype> I<--auth-username username> I<--secret-usage usage>]
|
2014-12-04 14:22:30 +00:00
|
|
|
[[I<--adapter-name name>] | [I<--adapter-wwnn> I<--adapter-wwpn>]
|
|
|
|
[I<--adapter-parent parent>]]
|
2015-11-25 14:51:51 +00:00
|
|
|
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]]
|
2014-12-04 14:22:30 +00:00
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Create and start a pool object I<name> from the raw parameters. If
|
|
|
|
I<--print-xml> is specified, then print the XML of the pool object
|
|
|
|
without creating the pool. Otherwise, the pool has the specified
|
2015-01-16 00:12:42 +00:00
|
|
|
I<type>. When using B<pool-create-as> for a pool of I<type> "disk",
|
|
|
|
the existing partitions found on the I<--source-dev path> will be used
|
|
|
|
to populate the disk pool. Therefore, it is suggested to use
|
|
|
|
B<pool-define-as> and B<pool-build> with the I<--overwrite> in order
|
|
|
|
to properly initialize the disk pool.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2014-12-04 00:46:54 +00:00
|
|
|
[I<--source-host hostname>] provides the source hostname for pools backed
|
|
|
|
by storage from a remote server (pool types netfs, iscsi, rbd, sheepdog,
|
|
|
|
gluster).
|
|
|
|
|
|
|
|
[I<--source-path path>] provides the source directory path for pools backed
|
|
|
|
by directories (pool type dir).
|
|
|
|
|
|
|
|
[I<--source-dev path>] provides the source path for pools backed by physical
|
|
|
|
devices (pool types fs, logical, disk, iscsi, zfs).
|
|
|
|
|
|
|
|
[I<--source-name name>] provides the source name for pools backed by storage
|
|
|
|
from a named element (pool types logical, rbd, sheepdog, gluster).
|
|
|
|
|
|
|
|
[I<--target path>] is the path for the mapping of the storage pool into
|
|
|
|
the host file system.
|
|
|
|
|
|
|
|
[I<--source-format format>] provides information about the format of the
|
|
|
|
pool (pool types fs, netfs, disk, logical).
|
|
|
|
|
2014-12-03 23:45:50 +00:00
|
|
|
[I<--auth-type authtype> I<--auth-username username> I<--secret-usage usage>]
|
|
|
|
provides the elements required to generate authentication credentials for
|
|
|
|
the storage pool. The I<authtype> is either chap for iscsi I<type> pools or
|
|
|
|
ceph for rbd I<type> pools.
|
|
|
|
|
2014-12-04 14:22:30 +00:00
|
|
|
[I<--adapter-name name>] defines the scsi_hostN adapter name to be used for
|
|
|
|
the scsi_host adapter type pool.
|
|
|
|
|
|
|
|
[I<--adapter-wwnn> I<--adapter-wwpn> [I<--adapter-parent parent>]] defines
|
|
|
|
the wwnn and wwpn to be used for the fc_host adapter type pool. The parent
|
|
|
|
optionally provides the name of the scsi_hostN node device to be used for
|
|
|
|
the vHBA.
|
|
|
|
|
2015-11-25 14:51:51 +00:00
|
|
|
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]] perform a
|
|
|
|
B<pool-build> after creation in order to remove the need for a
|
|
|
|
follow-up command to build the pool. The I<--overwrite> and
|
|
|
|
I<--no-overwrite> flags follow the same rules as B<pool-build>. If
|
|
|
|
just I<--build> is provided, then B<pool-build> is called with no flags.
|
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
=item B<pool-define> I<file>
|
|
|
|
|
2015-02-25 14:51:41 +00:00
|
|
|
Define an inactive persistent storage pool or modify an existing persistent one
|
|
|
|
from the XML I<file>.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2014-12-04 00:46:54 +00:00
|
|
|
=item B<pool-define-as> I<name> I<type> [I<--print-xml>]
|
|
|
|
[I<--source-host hostname>] [I<--source-path path>] [I<--source-dev path>]
|
|
|
|
[I<--source-name name>] [I<--target path>] [I<--source-format format>]
|
2014-12-03 23:45:50 +00:00
|
|
|
[I<--auth-type authtype> I<--auth-username username> I<--secret-usage usage>]
|
2014-12-04 14:22:30 +00:00
|
|
|
[[I<--adapter-name name>] | [I<--adapter-wwnn> I<--adapter-wwpn>]
|
|
|
|
[I<--adapter-parent parent>]]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Create, but do not start, a pool object I<name> from the raw parameters. If
|
|
|
|
I<--print-xml> is specified, then print the XML of the pool object
|
|
|
|
without defining the pool. Otherwise, the pool has the specified
|
|
|
|
I<type>.
|
|
|
|
|
2015-11-25 14:51:51 +00:00
|
|
|
Use the same arguments as B<pool-create-as>, except for the I<--build>,
|
|
|
|
I<--overwrite>, and I<--no-overwrite> options.
|
2014-12-04 00:46:54 +00:00
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
=item B<pool-destroy> I<pool-or-uuid>
|
|
|
|
|
2011-07-06 21:42:47 +00:00
|
|
|
Destroy (stop) a given I<pool> object. Libvirt will no longer manage the
|
2010-04-05 23:21:02 +00:00
|
|
|
storage described by the pool object, but the raw data contained in
|
|
|
|
the pool is not changed, and can be later recovered with
|
|
|
|
B<pool-create>.
|
|
|
|
|
|
|
|
=item B<pool-delete> I<pool-or-uuid>
|
|
|
|
|
|
|
|
Destroy the resources used by a given I<pool> object. This operation
|
|
|
|
is non-recoverable. The I<pool> object will still exist after this
|
2011-07-06 21:42:47 +00:00
|
|
|
command, ready for the creation of new storage volumes.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2012-06-25 10:24:45 +00:00
|
|
|
=item B<pool-dumpxml> [I<--inactive>] I<pool-or-uuid>
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Returns the XML information about the I<pool> object.
|
2012-06-25 10:24:45 +00:00
|
|
|
I<--inactive> tells virsh to dump pool configuration that will be used
|
|
|
|
on next start of the pool as opposed to the current pool configuration.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
=item B<pool-edit> I<pool-or-uuid>
|
|
|
|
|
|
|
|
Edit the XML configuration file for a storage pool.
|
|
|
|
|
|
|
|
This is equivalent to:
|
|
|
|
|
|
|
|
virsh pool-dumpxml pool > pool.xml
|
2010-11-17 14:15:12 +00:00
|
|
|
vi pool.xml (or make changes with your other text editor)
|
2010-04-05 23:21:02 +00:00
|
|
|
virsh pool-define pool.xml
|
|
|
|
|
|
|
|
except that it does some error checking.
|
|
|
|
|
|
|
|
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
|
|
|
|
variables, and defaults to C<vi>.
|
|
|
|
|
|
|
|
=item B<pool-info> I<pool-or-uuid>
|
|
|
|
|
|
|
|
Returns basic information about the I<pool> object.
|
|
|
|
|
2012-09-05 06:36:33 +00:00
|
|
|
=item B<pool-list> [I<--inactive>] [I<--all>]
|
|
|
|
[I<--persistent>] [I<--transient>]
|
|
|
|
[I<--autostart>] [I<--no-autostart>]
|
|
|
|
[[I<--details>] [<type>]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2012-09-04 15:16:30 +00:00
|
|
|
List pool objects known to libvirt. By default, only active pools
|
|
|
|
are listed; I<--inactive> lists just the inactive pools, and I<--all>
|
2012-09-05 06:36:33 +00:00
|
|
|
lists all pools.
|
|
|
|
|
2012-09-06 16:01:24 +00:00
|
|
|
In addition, there are several sets of filtering flags. I<--persistent> is to
|
|
|
|
list the persistent pools, I<--transient> is to list the transient pools.
|
|
|
|
I<--autostart> lists the autostarting pools, I<--no-autostart> lists the pools
|
|
|
|
with autostarting disabled.
|
2012-09-05 06:36:33 +00:00
|
|
|
|
|
|
|
You may also want to list pools with specified types using I<type>, the
|
|
|
|
pool types must be separated by comma, e.g. --type dir,disk. The valid pool
|
|
|
|
types include 'dir', 'fs', 'netfs', 'logical', 'disk', 'iscsi', 'scsi',
|
2013-12-13 09:31:50 +00:00
|
|
|
'mpath', 'rbd', 'sheepdog' and 'gluster'.
|
2012-09-05 06:36:33 +00:00
|
|
|
|
|
|
|
The I<--details> option instructs virsh to additionally
|
2012-09-04 15:16:30 +00:00
|
|
|
display pool persistence and capacity related information where available.
|
2010-04-05 23:21:02 +00:00
|
|
|
|
2012-09-05 06:36:33 +00:00
|
|
|
NOTE: When talking to older servers, this command is forced to use a series of
|
|
|
|
API calls with an inherent race, where a pool might not be listed or might appear
|
|
|
|
more than once if it changed state between calls while the list was being
|
|
|
|
collected. Newer servers do not have this problem.
|
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
=item B<pool-name> I<uuid>
|
|
|
|
|
|
|
|
Convert the I<uuid> to a pool name.
|
|
|
|
|
|
|
|
=item B<pool-refresh> I<pool-or-uuid>
|
|
|
|
|
|
|
|
Refresh the list of volumes contained in I<pool>.
|
|
|
|
|
|
|
|
=item B<pool-start> I<pool-or-uuid>
|
2015-11-25 14:51:51 +00:00
|
|
|
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]]
|
2010-04-05 23:21:02 +00:00
|
|
|
|
|
|
|
Start the storage I<pool>, which is previously defined but inactive.
|
|
|
|
|
2015-11-25 14:51:51 +00:00
|
|
|
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]] perform a
|
|
|
|
B<pool-build> prior to B<pool-start> to ensure the pool environment is
|
|
|
|
in an expected state rather than needing to run the build command prior
|
|
|
|
to startup. The I<--overwrite> and I<--no-overwrite> flags follow the
|
|
|
|
same rules as B<pool-build>. If just I<--build> is provided, then
|
|
|
|
B<pool-build> is called with no flags.
|
|
|
|
|
storage: Add document for possible problem on volume detection
For pool which relies on remote resources, such as a "iscsi" type
pool, since how long it takes to export the corresponding devices
to host's sysfs is really depended, it could depend on the network
connection, it also could depend on the host's udev procedures. So
it's likely that the volumes are not able to be detected during pool
starting process, polling the sysfs doesn't work, since we don't
know how much time is best for the polling, and even worse, the
volumes could still be not detected or partly not detected even after
the polling. So we end up with a documentation to prompt the fact,
in virsh manual.
And as a small improvement, let's explicitly say no LUNs found in
the debug log in that case.
2014-01-22 14:39:42 +00:00
|
|
|
B<Note>: A storage pool that relies on remote resources such as an
|
|
|
|
"iscsi" or a (v)HBA backed "scsi" pool may need to be refreshed multiple
|
|
|
|
times in order to have all the volumes detected (see B<pool-refresh>).
|
|
|
|
This is because the corresponding volume devices may not be present in
|
|
|
|
the host's filesystem during the initial pool startup or the current
|
2015-03-26 06:36:07 +00:00
|
|
|
refresh attempt. The number of refresh retries is dependent upon the
|
storage: Add document for possible problem on volume detection
For pool which relies on remote resources, such as a "iscsi" type
pool, since how long it takes to export the corresponding devices
to host's sysfs is really depended, it could depend on the network
connection, it also could depend on the host's udev procedures. So
it's likely that the volumes are not able to be detected during pool
starting process, polling the sysfs doesn't work, since we don't
know how much time is best for the polling, and even worse, the
volumes could still be not detected or partly not detected even after
the polling. So we end up with a documentation to prompt the fact,
in virsh manual.
And as a small improvement, let's explicitly say no LUNs found in
the debug log in that case.
2014-01-22 14:39:42 +00:00
|
|
|
network connection and the time the host takes to export the
|
|
|
|
corresponding devices.
|
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
=item B<pool-undefine> I<pool-or-uuid>
|
|
|
|
|
|
|
|
Undefine the configuration for an inactive I<pool>.
|
|
|
|
|
|
|
|
=item B<pool-uuid> I<pool>
|
|
|
|
|
|
|
|
Returns the UUID of the named I<pool>.
|
|
|
|
|
2010-05-30 03:28:42 +00:00
|
|
|
=back
|
|
|
|
|
2010-06-08 15:00:24 +00:00
|
|
|
=head1 VOLUME COMMANDS
|
|
|
|
|
2010-06-18 16:17:59 +00:00
|
|
|
=over 4
|
|
|
|
|
2012-12-05 10:48:08 +00:00
|
|
|
=item B<vol-create> I<pool-or-uuid> I<FILE> [I<--prealloc-metadata>]
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Create a volume from an XML <file>.
|
|
|
|
I<pool-or-uuid> is the name or UUID of the storage pool to create the volume in.
|
|
|
|
I<FILE> is the XML <file> with the volume definition. An easy way to create the
|
|
|
|
XML <file> is to use the B<vol-dumpxml> command to obtain the definition of a
|
|
|
|
pre-existing volume.
|
2012-12-05 10:48:08 +00:00
|
|
|
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
|
|
|
|
support full allocation). This option creates a sparse image file with metadata,
|
|
|
|
resulting in higher performance compared to images with no preallocation and
|
|
|
|
only slightly higher initial disk space usage.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
B<Example>
|
|
|
|
|
|
|
|
virsh vol-dumpxml --pool storagepool1 appvolume1 > newvolume.xml
|
2010-11-17 14:15:12 +00:00
|
|
|
vi newvolume.xml (or make changes with your other text editor)
|
2010-06-08 15:00:24 +00:00
|
|
|
virsh vol-create differentstoragepool newvolume.xml
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-create-from> I<pool-or-uuid> I<FILE> [I<--inputpool>
|
2012-12-05 10:48:08 +00:00
|
|
|
I<pool-or-uuid>] I<vol-name-or-key-or-path> [I<--prealloc-metadata>]
|
2015-02-03 03:05:27 +00:00
|
|
|
[I<--reflink>]
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Create a volume, using another volume as input.
|
|
|
|
I<pool-or-uuid> is the name or UUID of the storage pool to create the volume in.
|
|
|
|
I<FILE> is the XML <file> with the volume definition.
|
|
|
|
I<--inputpool> I<pool-or-uuid> is the name or uuid of the storage pool the
|
|
|
|
source volume is in.
|
|
|
|
I<vol-name-or-key-or-path> is the name or key or path of the source volume.
|
2012-12-05 10:48:08 +00:00
|
|
|
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
|
|
|
|
support full allocation). This option creates a sparse image file with metadata,
|
|
|
|
resulting in higher performance compared to images with no preallocation and
|
|
|
|
only slightly higher initial disk space usage.
|
2015-02-03 03:05:27 +00:00
|
|
|
When I<--reflink> is specified, perform a COW lightweight copy,
|
|
|
|
where the data blocks are copied only when modified.
|
|
|
|
If this is not possible, the copy fails.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-create-as> I<pool-or-uuid> I<name> I<capacity>
|
|
|
|
[I<--allocation> I<size>] [I<--format> I<string>] [I<--backing-vol>
|
|
|
|
I<vol-name-or-key-or-path>] [I<--backing-vol-format> I<string>]
|
2012-12-05 10:48:08 +00:00
|
|
|
[I<--prealloc-metadata>]
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Create a volume from a set of arguments.
|
|
|
|
I<pool-or-uuid> is the name or UUID of the storage pool to create the volume
|
|
|
|
in.
|
2015-01-16 00:12:42 +00:00
|
|
|
I<name> is the name of the new volume. For a disk pool, this must match the
|
|
|
|
partition name as determined from the pool's source device path and the next
|
|
|
|
available partition. For example, a source device path of /dev/sdb and there
|
|
|
|
are no partitions on the disk, then the name must be sdb1 with the next
|
|
|
|
name being sdb2 and so on.
|
2012-03-08 01:10:30 +00:00
|
|
|
I<capacity> is the size of the volume to be created, as a scaled integer
|
|
|
|
(see B<NOTES> above), defaulting to bytes if there is no suffix.
|
|
|
|
I<--allocation> I<size> is the initial size to be allocated in the volume,
|
|
|
|
also as a scaled integer defaulting to bytes.
|
2010-06-08 15:00:24 +00:00
|
|
|
I<--format> I<string> is used in file based storage pools to specify the volume
|
2015-01-16 00:12:42 +00:00
|
|
|
file format to use; raw, bochs, qcow, qcow2, vmdk, qed. Use extended for disk
|
|
|
|
storage pools in order to create an extended partition (other values are
|
|
|
|
validity checked but not preserved when libvirtd is restarted or the pool
|
|
|
|
is refreshed).
|
2010-06-08 16:38:32 +00:00
|
|
|
I<--backing-vol> I<vol-name-or-key-or-path> is the source backing
|
2010-06-08 15:00:24 +00:00
|
|
|
volume to be used if taking a snapshot of an existing volume.
|
2010-06-08 16:38:32 +00:00
|
|
|
I<--backing-vol-format> I<string> is the format of the snapshot backing volume;
|
2012-06-18 11:20:01 +00:00
|
|
|
raw, bochs, qcow, qcow2, qed, vmdk, host_device. These are, however, meant for
|
|
|
|
file based storage pools.
|
2012-12-05 10:48:08 +00:00
|
|
|
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
|
|
|
|
support full allocation). This option creates a sparse image file with metadata,
|
|
|
|
resulting in higher performance compared to images with no preallocation and
|
|
|
|
only slightly higher initial disk space usage.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-clone> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
|
2015-02-03 03:05:27 +00:00
|
|
|
I<name> [I<--prealloc-metadata>] [I<--reflink>]
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Clone an existing volume. Less powerful, but easier to type, version of
|
|
|
|
B<vol-create-from>.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool to create
|
|
|
|
the volume in.
|
2010-06-08 15:00:24 +00:00
|
|
|
I<vol-name-or-key-or-path> is the name or key or path of the source volume.
|
|
|
|
I<name> is the name of the new volume.
|
2012-12-05 10:48:08 +00:00
|
|
|
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
|
|
|
|
support full allocation). This option creates a sparse image file with metadata,
|
|
|
|
resulting in higher performance compared to images with no preallocation and
|
|
|
|
only slightly higher initial disk space usage.
|
2015-02-03 03:05:27 +00:00
|
|
|
When I<--reflink> is specified, perform a COW lightweight copy,
|
|
|
|
where the data blocks are copied only when modified.
|
|
|
|
If this is not possible, the copy fails.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-delete> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Delete a given volume.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in.
|
2010-06-08 15:00:24 +00:00
|
|
|
I<vol-name-or-key-or-path> is the name or key or path of the volume to delete.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-upload> [I<--pool> I<pool-or-uuid>] [I<--offset> I<bytes>]
|
|
|
|
[I<--length> I<bytes>] I<vol-name-or-key-or-path> I<local-file>
|
2009-07-14 13:24:53 +00:00
|
|
|
|
|
|
|
Upload the contents of I<local-file> to a storage volume.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in.
|
2013-04-02 12:33:49 +00:00
|
|
|
I<vol-name-or-key-or-path> is the name or key or path of the volume where the
|
|
|
|
file will be uploaded.
|
2009-07-14 13:24:53 +00:00
|
|
|
I<--offset> is the position in the storage volume at which to start writing
|
2014-07-15 12:26:28 +00:00
|
|
|
the data. The value must be 0 or larger. I<--length> is an upper bound
|
|
|
|
of the amount of data to be uploaded. A negative value is interpreted
|
|
|
|
as an unsigned long long value to essentially include everything from
|
|
|
|
the offset to the end of the volume.
|
2012-10-11 16:31:20 +00:00
|
|
|
An error will occur if the I<local-file> is greater than the specified length.
|
2014-07-28 12:39:09 +00:00
|
|
|
See the description for the libvirt virStorageVolUpload API for details
|
|
|
|
regarding possible target volume and pool changes as a result of the
|
|
|
|
pool refresh when the upload is attempted.
|
2009-07-14 13:24:53 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-download> [I<--pool> I<pool-or-uuid>] [I<--offset> I<bytes>]
|
|
|
|
[I<--length> I<bytes>] I<vol-name-or-key-or-path> I<local-file>
|
2009-07-14 13:24:53 +00:00
|
|
|
|
2013-04-02 12:33:49 +00:00
|
|
|
Download the contents of a storage volume to I<local-file>.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in.
|
2013-04-02 12:33:49 +00:00
|
|
|
I<vol-name-or-key-or-path> is the name or key or path of the volume to download.
|
2009-07-14 13:24:53 +00:00
|
|
|
I<--offset> is the position in the storage volume at which to start reading
|
2014-07-15 12:26:28 +00:00
|
|
|
the data. The value must be 0 or larger. I<--length> is an upper bound of
|
|
|
|
the amount of data to be downloaded. A negative value is interpreted as
|
|
|
|
an unsigned long long value to essentially include everything from the
|
|
|
|
offset to the end of the volume.
|
2009-07-14 13:24:53 +00:00
|
|
|
|
2012-01-09 16:05:03 +00:00
|
|
|
=item B<vol-wipe> [I<--pool> I<pool-or-uuid>] [I<--algorithm> I<algorithm>]
|
|
|
|
I<vol-name-or-key-or-path>
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
Wipe a volume, ensure data previously on the volume is not accessible to
|
|
|
|
future reads. I<--pool> I<pool-or-uuid> is the name or UUID of the storage
|
|
|
|
pool the volume is in.
|
2010-06-08 15:00:24 +00:00
|
|
|
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
|
2012-01-09 16:05:03 +00:00
|
|
|
It is possible to choose different wiping algorithms instead of re-writing
|
|
|
|
volume with zeroes. This can be done via I<--algorithm> switch.
|
|
|
|
|
|
|
|
B<Supported algorithms>
|
|
|
|
zero - 1-pass all zeroes
|
|
|
|
nnsa - 4-pass NNSA Policy Letter NAP-14.1-C (XVI-8) for
|
|
|
|
sanitizing removable and non-removable hard disks:
|
|
|
|
random x2, 0x00, verify.
|
|
|
|
dod - 4-pass DoD 5220.22-M section 8-306 procedure for
|
2013-11-30 06:33:17 +00:00
|
|
|
sanitizing removable and non-removable rigid
|
2012-01-09 16:05:03 +00:00
|
|
|
disks: random, 0x00, 0xff, verify.
|
|
|
|
bsi - 9-pass method recommended by the German Center of
|
|
|
|
Security in Information Technologies
|
|
|
|
(http://www.bsi.bund.de): 0xff, 0xfe, 0xfd, 0xfb,
|
|
|
|
0xf7, 0xef, 0xdf, 0xbf, 0x7f.
|
|
|
|
gutmann - The canonical 35-pass sequence described in
|
|
|
|
Gutmann's paper.
|
|
|
|
schneier - 7-pass method described by Bruce Schneier in
|
|
|
|
"Applied Cryptography" (1996): 0x00, 0xff,
|
|
|
|
random x5.
|
|
|
|
pfitzner7 - Roy Pfitzner's 7-random-pass method: random x7.
|
|
|
|
pfitzner33 - Roy Pfitzner's 33-random-pass method: random x33.
|
|
|
|
random - 1-pass pattern: random.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2012-02-29 09:48:58 +00:00
|
|
|
B<Note>: The availability of algorithms may be limited by the version
|
|
|
|
of the C<scrub> binary installed on the host.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-dumpxml> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Output the volume information as an XML dump to stdout.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in. I<vol-name-or-key-or-path> is the name or key or path of the volume
|
|
|
|
to output the XML of.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-info> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Returns basic information about the given storage volume.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in. I<vol-name-or-key-or-path> is the name or key or path of the volume
|
|
|
|
to return information for.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-list> [I<--pool> I<pool-or-uuid>] [I<--details>]
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Return the list of volumes in the given storage pool.
|
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool.
|
2010-07-05 13:46:54 +00:00
|
|
|
The I<--details> option instructs virsh to additionally display volume
|
|
|
|
type and capacity related information where available.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-pool> [I<--uuid>] I<vol-key-or-path>
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2010-06-11 16:26:58 +00:00
|
|
|
Return the pool name or UUID for a given volume. By default, the pool name is
|
|
|
|
returned. If the I<--uuid> option is given, the pool UUID is returned instead.
|
|
|
|
I<vol-key-or-path> is the key or path of the volume to return the pool
|
|
|
|
information for.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-path> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key>
|
2010-06-08 15:00:24 +00:00
|
|
|
|
|
|
|
Return the path for a given volume.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in.
|
2010-06-08 15:00:24 +00:00
|
|
|
I<vol-name-or-key> is the name or key of the volume to return the path for.
|
|
|
|
|
|
|
|
=item B<vol-name> I<vol-key-or-path>
|
|
|
|
|
|
|
|
Return the name for a given volume.
|
|
|
|
I<vol-key-or-path> is the key or path of the volume to return the name for.
|
|
|
|
|
2011-07-14 17:36:21 +00:00
|
|
|
=item B<vol-key> [I<--pool> I<pool-or-uuid>] I<vol-name-or-path>
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2010-06-11 11:51:55 +00:00
|
|
|
Return the volume key for a given volume.
|
2011-07-14 17:36:21 +00:00
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in. I<vol-name-or-path> is the name or path of the volume to return the
|
|
|
|
volume key for.
|
2010-06-08 15:00:24 +00:00
|
|
|
|
2012-01-27 05:29:56 +00:00
|
|
|
=item B<vol-resize> [I<--pool> I<pool-or-uuid>] I<vol-name-or-path>
|
|
|
|
I<pool-or-uuid> I<capacity> [I<--allocate>] [I<--delta>] [I<--shrink>]
|
|
|
|
|
|
|
|
Resize the capacity of the given volume, in bytes.
|
|
|
|
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
|
|
|
|
is in. I<vol-name-or-key-or-path> is the name or key or path of the volume
|
|
|
|
to resize. The new capacity might be sparse unless I<--allocate> is
|
|
|
|
specified. Normally, I<capacity> is the new size, but if I<--delta>
|
|
|
|
is present, then it is added to the existing size. Attempts to shrink
|
2012-03-08 01:10:30 +00:00
|
|
|
the volume will fail unless I<--shrink> is present; I<capacity> cannot
|
|
|
|
be negative unless I<--shrink> is provided, but a negative sign is not
|
|
|
|
necessary. I<capacity> is a scaled integer (see B<NOTES> above), which
|
|
|
|
defaults to bytes if there is no suffix. This command is only safe
|
|
|
|
for storage volumes not in use by an active guest; see also
|
|
|
|
B<blockresize> for live resizing.
|
2012-01-27 05:29:56 +00:00
|
|
|
|
2010-06-08 15:00:24 +00:00
|
|
|
=back
|
|
|
|
|
2013-10-24 08:57:20 +00:00
|
|
|
=head1 SECRET COMMANDS
|
2009-07-28 10:27:25 +00:00
|
|
|
|
|
|
|
The following commands manipulate "secrets" (e.g. passwords, passphrases and
|
|
|
|
encryption keys). Libvirt can store secrets independently from their use, and
|
|
|
|
other objects (e.g. volumes or domains) can refer to the secrets for encryption
|
2014-04-20 20:07:46 +00:00
|
|
|
or possibly other uses. Secrets are identified using a UUID. See
|
2009-07-28 10:27:25 +00:00
|
|
|
L<http://libvirt.org/formatsecret.html> for documentation of the XML format
|
|
|
|
used to represent properties of secrets.
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item B<secret-define> I<file>
|
|
|
|
|
|
|
|
Create a secret with the properties specified in I<file>, with no associated
|
|
|
|
secret value. If I<file> does not specify a UUID, choose one automatically.
|
2014-04-20 20:07:46 +00:00
|
|
|
If I<file> specifies a UUID of an existing secret, replace its properties by
|
2009-07-28 10:27:25 +00:00
|
|
|
properties defined in I<file>, without affecting the secret value.
|
|
|
|
|
|
|
|
=item B<secret-dumpxml> I<secret>
|
|
|
|
|
|
|
|
Output properties of I<secret> (specified by its UUID) as an XML dump to stdout.
|
|
|
|
|
|
|
|
=item B<secret-set-value> I<secret> I<base64>
|
|
|
|
|
|
|
|
Set the value associated with I<secret> (specified by its UUID) to the value
|
|
|
|
Base64-encoded value I<base64>.
|
|
|
|
|
|
|
|
=item B<secret-get-value> I<secret>
|
|
|
|
|
|
|
|
Output the value associated with I<secret> (specified by its UUID) to stdout,
|
|
|
|
encoded using Base64.
|
|
|
|
|
|
|
|
=item B<secret-undefine> I<secret>
|
|
|
|
|
|
|
|
Delete a I<secret> (specified by its UUID), including the associated value, if
|
|
|
|
any.
|
|
|
|
|
2012-09-14 08:38:52 +00:00
|
|
|
=item B<secret-list> [I<--ephemeral>] [I<--no-ephemeral>]
|
|
|
|
[I<--private>] [I<--no-private>]
|
2009-07-28 10:27:25 +00:00
|
|
|
|
2012-09-14 08:38:52 +00:00
|
|
|
Returns the list of secrets. You may also want to filter the returned secrets
|
|
|
|
by I<--ephemeral> to list the ephemeral ones, I<--no-ephemeral> to list the
|
|
|
|
non-ephemeral ones, I<--private> to list the private ones, and
|
|
|
|
I<--no-private> to list the non-private ones.
|
2009-07-28 10:27:25 +00:00
|
|
|
|
|
|
|
=back
|
|
|
|
|
2013-10-24 08:57:20 +00:00
|
|
|
=head1 SNAPSHOT COMMANDS
|
2010-04-05 15:17:42 +00:00
|
|
|
|
|
|
|
The following commands manipulate domain snapshots. Snapshots take the
|
|
|
|
disk, memory, and device state of a domain at a point-of-time, and save it
|
|
|
|
for future use. They have many uses, from saving a "clean" copy of an OS
|
|
|
|
image to saving a domain's state before a potentially destructive operation.
|
|
|
|
Snapshots are identified with a unique name. See
|
|
|
|
L<http://libvirt.org/formatsnapshot.html> for documentation of the XML format
|
|
|
|
used to represent properties of snapshots.
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
=item B<snapshot-create> I<domain> [I<xmlfile>] {[I<--redefine> [I<--current>]]
|
2012-01-26 05:17:54 +00:00
|
|
|
| [I<--no-metadata>] [I<--halt>] [I<--disk-only>] [I<--reuse-external>]
|
2012-10-09 10:11:56 +00:00
|
|
|
[I<--quiesce>] [I<--atomic>] [I<--live>]}
|
2010-04-05 15:17:42 +00:00
|
|
|
|
|
|
|
Create a snapshot for domain I<domain> with the properties specified in
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
I<xmlfile>. Normally, the only properties settable for a domain snapshot
|
2011-08-22 23:12:56 +00:00
|
|
|
are the <name> and <description> elements, as well as <disks> if
|
|
|
|
I<--disk-only> is given; the rest of the fields are
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
ignored, and automatically filled in by libvirt. If I<xmlfile> is
|
|
|
|
completely omitted, then libvirt will choose a value for all fields.
|
|
|
|
The new snapshot will become current, as listed by B<snapshot-current>.
|
|
|
|
|
2011-08-18 14:37:26 +00:00
|
|
|
If I<--halt> is specified, the domain will be left in an inactive state
|
|
|
|
after the snapshot is created.
|
|
|
|
|
2011-08-22 23:12:56 +00:00
|
|
|
If I<--disk-only> is specified, the snapshot will only include disk
|
|
|
|
state rather than the usual system checkpoint with vm state. Disk
|
|
|
|
snapshots are faster than full system checkpoints, but reverting to a
|
|
|
|
disk snapshot may require fsck or journal replays, since it is like
|
|
|
|
the disk state at the point when the power cord is abruptly pulled;
|
|
|
|
and mixing I<--halt> and I<--disk-only> loses any data that was not
|
|
|
|
flushed to disk at the time.
|
|
|
|
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
If I<--redefine> is specified, then all XML elements produced by
|
|
|
|
B<snapshot-dumpxml> are valid; this can be used to migrate snapshot
|
|
|
|
hierarchy from one machine to another, to recreate hierarchy for the
|
|
|
|
case of a transient domain that goes away and is later recreated with
|
|
|
|
the same name and UUID, or to make slight alterations in the snapshot
|
|
|
|
metadata (such as host-specific aspects of the domain XML embedded in
|
|
|
|
the snapshot). When this flag is supplied, the I<xmlfile> argument
|
|
|
|
is mandatory, and the domain's current snapshot will not be altered
|
|
|
|
unless the I<--current> flag is also given.
|
|
|
|
|
|
|
|
If I<--no-metadata> is specified, then the snapshot data is created,
|
|
|
|
but any metadata is immediately discarded (that is, libvirt does not
|
|
|
|
treat the snapshot as current, and cannot revert to the snapshot
|
|
|
|
unless I<--redefine> is later used to teach libvirt about the
|
|
|
|
metadata again).
|
|
|
|
|
2012-01-09 18:57:46 +00:00
|
|
|
If I<--reuse-external> is specified, and the snapshot XML requests an
|
|
|
|
external snapshot with a destination of an existing file, then the
|
2014-07-07 12:38:10 +00:00
|
|
|
destination must exist and be pre-created with correct format and
|
|
|
|
metadata. The file is then reused; otherwise, a snapshot is refused
|
2012-01-09 18:57:46 +00:00
|
|
|
to avoid losing contents of the existing files.
|
|
|
|
|
2012-01-24 14:47:09 +00:00
|
|
|
If I<--quiesce> is specified, libvirt will try to use guest agent
|
|
|
|
to freeze and unfreeze domain's mounted file systems. However,
|
|
|
|
if domain has no guest agent, snapshot creation will fail.
|
|
|
|
Currently, this requires I<--disk-only> to be passed as well.
|
|
|
|
|
snapshot: add atomic create flag
Right now, it is appallingly easy to cause qemu disk snapshots
to alter a domain then fail; for example, by requesting a two-disk
snapshot where the second disk name resides on read-only storage.
In this failure scenario, libvirt reports failure, but modifies
the live domain XML in-place to record that the first disk snapshot
was taken; and places a difficult burden on the management app
to grab the XML and reparse it to see which disks, if any, were
altered by the partial snapshot.
This patch adds a new flag where implementations can request that
the hypervisor make snapshots atomically; either no changes to
XML occur, or all disks were altered as a group. If you request
the flag, you either get outright failure up front, or you take
advantage of hypervisor abilities to make an atomic snapshot. Of
course, drivers should prefer the atomic means even without the
flag explicitly requested.
There's no way to make snapshots 100% bulletproof - even if the
hypervisor does it perfectly atomic, we could run out of memory
during the followup tasks of updating our in-memory XML, and report
a failure. However, these sorts of catastrophic failures are rare
and unlikely, and it is still nicer to know that either all
snapshots happened or none of them, as that is an easier state to
recover from.
* include/libvirt/libvirt.h.in
(VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC): New flag.
* src/libvirt.c (virDomainSnapshotCreateXML): Document it.
* tools/virsh.c (cmdSnapshotCreate, cmdSnapshotCreateAs): Expose it.
* tools/virsh.pod (snapshot-create, snapshot-create-as): Document
it.
2012-03-16 21:23:00 +00:00
|
|
|
If I<--atomic> is specified, libvirt will guarantee that the snapshot
|
|
|
|
either succeeds, or fails with no changes; not all hypervisors support
|
|
|
|
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.
|
|
|
|
|
2012-10-09 10:11:56 +00:00
|
|
|
If I<--live> is specified, libvirt takes the snapshot while the guest is
|
|
|
|
running. This increases the size of the memory image of the external
|
|
|
|
checkpoint. This is currently supported only for external checkpoints.
|
|
|
|
|
2011-08-12 02:24:19 +00:00
|
|
|
Existence of snapshot metadata will prevent attempts to B<undefine>
|
|
|
|
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).
|
|
|
|
|
2011-08-18 14:37:26 +00:00
|
|
|
=item B<snapshot-create-as> I<domain> {[I<--print-xml>]
|
2012-03-28 02:22:49 +00:00
|
|
|
| [I<--no-metadata>] [I<--halt>] [I<--reuse-external>]} [I<name>]
|
2012-11-07 03:55:53 +00:00
|
|
|
[I<description>] [I<--disk-only> [I<--quiesce>]] [I<--atomic>]
|
|
|
|
[[I<--live>] [I<--memspec> B<memspec>]] [I<--diskspec>] B<diskspec>]...
|
2011-06-15 22:19:13 +00:00
|
|
|
|
|
|
|
Create a snapshot for domain I<domain> with the given <name> and
|
|
|
|
<description>; if either value is omitted, libvirt will choose a
|
2011-06-15 22:24:40 +00:00
|
|
|
value. If I<--print-xml> is specified, then XML appropriate for
|
|
|
|
I<snapshot-create> is output, rather than actually creating a snapshot.
|
2011-08-18 14:37:26 +00:00
|
|
|
Otherwise, if I<--halt> is specified, the domain will be left in an
|
2011-08-22 23:12:56 +00:00
|
|
|
inactive state after the snapshot is created, and if I<--disk-only>
|
|
|
|
is specified, the snapshot will not include vm state.
|
|
|
|
|
2012-11-07 03:55:53 +00:00
|
|
|
The I<--memspec> option can be used to control whether a checkpoint
|
|
|
|
is internal or external. The I<--memspec> flag is mandatory, followed
|
|
|
|
by a B<memspec> of the form B<[file=]name[,snapshot=type]>, where
|
2014-03-28 11:38:03 +00:00
|
|
|
type can be B<no>, B<internal>, or B<external>. To include a literal
|
2013-01-25 10:50:43 +00:00
|
|
|
comma in B<file=name>, escape it with a second comma. I<--memspec> cannot
|
|
|
|
be used together with I<--disk-only>.
|
2012-11-07 03:55:53 +00:00
|
|
|
|
|
|
|
The I<--diskspec> option can be used to control how I<--disk-only> and
|
|
|
|
external checkpoints create external files. This option can occur
|
|
|
|
multiple times, according to the number of <disk> elements in the domain
|
|
|
|
xml. Each <diskspec> is in the
|
2014-07-11 08:20:33 +00:00
|
|
|
form B<disk[,snapshot=type][,driver=type][,file=name]>. A I<diskspec>
|
|
|
|
must be provided for disks backed by block devices as libvirt doesn't
|
|
|
|
auto-generate file names for those. To include a
|
2011-08-22 23:12:56 +00:00
|
|
|
literal comma in B<disk> or in B<file=name>, escape it with a second
|
2012-10-11 16:31:20 +00:00
|
|
|
comma. A literal I<--diskspec> must precede each B<diskspec> unless
|
2011-09-14 21:20:08 +00:00
|
|
|
all three of I<domain>, I<name>, and I<description> are also present.
|
|
|
|
For example, a diskspec of "vda,snapshot=external,file=/path/to,,new"
|
2011-08-22 23:12:56 +00:00
|
|
|
results in the following XML:
|
|
|
|
<disk name='vda' snapshot='external'>
|
|
|
|
<source file='/path/to,new'/>
|
|
|
|
</disk>
|
2011-06-15 22:19:13 +00:00
|
|
|
|
2012-01-09 18:57:46 +00:00
|
|
|
If I<--reuse-external> is specified, and the domain XML or I<diskspec>
|
|
|
|
option requests an external snapshot with a destination of an existing
|
2014-07-07 12:38:10 +00:00
|
|
|
file, then the destination must exist and be pre-created with correct
|
|
|
|
format and metadata. The file is then reused; otherwise, a snapshot
|
|
|
|
is refused to avoid losing contents of the existing files.
|
2012-01-09 18:57:46 +00:00
|
|
|
|
2012-01-24 14:47:09 +00:00
|
|
|
If I<--quiesce> is specified, libvirt will try to use guest agent
|
|
|
|
to freeze and unfreeze domain's mounted file systems. However,
|
|
|
|
if domain has no guest agent, snapshot creation will fail.
|
|
|
|
Currently, this requires I<--disk-only> to be passed as well.
|
|
|
|
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
If I<--no-metadata> is specified, then the snapshot data is created,
|
|
|
|
but any metadata is immediately discarded (that is, libvirt does not
|
|
|
|
treat the snapshot as current, and cannot revert to the snapshot
|
|
|
|
unless B<snapshot-create> is later used to teach libvirt about the
|
|
|
|
metadata again). This flag is incompatible with I<--print-xml>.
|
|
|
|
|
snapshot: add atomic create flag
Right now, it is appallingly easy to cause qemu disk snapshots
to alter a domain then fail; for example, by requesting a two-disk
snapshot where the second disk name resides on read-only storage.
In this failure scenario, libvirt reports failure, but modifies
the live domain XML in-place to record that the first disk snapshot
was taken; and places a difficult burden on the management app
to grab the XML and reparse it to see which disks, if any, were
altered by the partial snapshot.
This patch adds a new flag where implementations can request that
the hypervisor make snapshots atomically; either no changes to
XML occur, or all disks were altered as a group. If you request
the flag, you either get outright failure up front, or you take
advantage of hypervisor abilities to make an atomic snapshot. Of
course, drivers should prefer the atomic means even without the
flag explicitly requested.
There's no way to make snapshots 100% bulletproof - even if the
hypervisor does it perfectly atomic, we could run out of memory
during the followup tasks of updating our in-memory XML, and report
a failure. However, these sorts of catastrophic failures are rare
and unlikely, and it is still nicer to know that either all
snapshots happened or none of them, as that is an easier state to
recover from.
* include/libvirt/libvirt.h.in
(VIR_DOMAIN_SNAPSHOT_CREATE_ATOMIC): New flag.
* src/libvirt.c (virDomainSnapshotCreateXML): Document it.
* tools/virsh.c (cmdSnapshotCreate, cmdSnapshotCreateAs): Expose it.
* tools/virsh.pod (snapshot-create, snapshot-create-as): Document
it.
2012-03-16 21:23:00 +00:00
|
|
|
If I<--atomic> is specified, libvirt will guarantee that the snapshot
|
|
|
|
either succeeds, or fails with no changes; not all hypervisors support
|
|
|
|
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.
|
|
|
|
|
2012-10-09 10:11:56 +00:00
|
|
|
If I<--live> is specified, libvirt takes the snapshot while the guest is
|
|
|
|
running. This increases the size of the memory image of the external
|
|
|
|
checkpoint. This is currently supported only for external checkpoints.
|
|
|
|
|
2011-09-27 23:33:55 +00:00
|
|
|
=item B<snapshot-current> I<domain> {[I<--name>] | [I<--security-info>]
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
| [I<snapshotname>]}
|
|
|
|
|
|
|
|
Without I<snapshotname>, this will output the snapshot XML for the domain's
|
|
|
|
current snapshot (if any). If I<--name> is specified, just the
|
|
|
|
current snapshot name instead of the full xml. Otherwise, using
|
|
|
|
I<--security-info> will also include security sensitive information in
|
|
|
|
the XML.
|
|
|
|
|
|
|
|
With I<snapshotname>, this is a request to make the existing named
|
|
|
|
snapshot become the current snapshot, without reverting the domain.
|
2010-04-05 15:17:42 +00:00
|
|
|
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
=item B<snapshot-edit> I<domain> [I<snapshotname>] [I<--current>]
|
snapshot: avoid accidental renames with snapshot-edit
I was a bit surprised that 'virsh snapshot-edit dom name' silently
allowed me to clone things, while still telling me the old name,
especially since other commands like 'virsh edit dom' reject rename
attempts (*). This fixes things to be more explicit (**).
(*) Technically, 'virsh edit dom' relies on virDomainDefineXML
behavior, which rejects attempts to mix a new name with existing
uuid or new uuid with existing name, but you can create a new
domain by changing both uuid and name. On the other hand, while
snapshot-edit --clone is a true clone, creating a new domain
would also have to decide whether to clone snapshot metadata,
managed save, and any other secondary data related to the domain.
Domain renames are not trivial either.
(**) Renaming or creating a clone is still a risky proposition -
for offline snapshots and system checkpoints, if the new name
does not match an actual name recorded in the qcow2 internal
snapshots, then you cannot revert to the new checkpoint. But it
is assumed that anyone using the new virsh flags knows what they
are doing, and can deal with the fallout caused by a rename/clone;
that is, we can't completely prevent a user from shooting
themselves in the foot, so much as we are making the default
action less risky.
* tools/virsh.c (cmdSnapshotEdit): Add --rename, --clone.
* tools/virsh.pod (snapshot-edit): Document them.
2011-10-07 22:20:58 +00:00
|
|
|
{[I<--rename>] | [I<--clone>]}
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
|
|
|
|
Edit the XML configuration file for I<snapshotname> of a domain. If
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
both I<snapshotname> and I<--current> are specified, also force the
|
|
|
|
edited snapshot to become the current snapshot. If I<snapshotname>
|
|
|
|
is omitted, then I<--current> must be supplied, to edit the current
|
|
|
|
snapshot.
|
snapshot: improve virsh snapshot-create, add snapshot-edit
Wire up the new snapshot creation flags in virsh. For convenience,
teach 'snapshot-current' how to make an existing snapshot become
current (can be used after upgrading to newer libvirt to recover
from the fact that the older libvirt lost track of the current
snapshot after a restart). The snapshot-create-as command is
intentionally not taught --redefine or --current, as this would
imply adding a lot of other options for everything else that can
appear in the <domainsnapshot> xml, but which is normally read-only.
Besides, redefining will usually be done on files created by
snapshot-dumpxml, rather than something built up by hand on the
command line. And now that we can redefine, we can edit.
* tools/virsh.c (cmdSnapshotCreate): Add --redefine, --current,
and --no-metadata.
(cmdSnapshotCreateAs): Add --no-metadata.
(cmdSnapshotCurrent): Add snapshotname to alter current snapshot.
(cmdSnapshotEdit): New command.
* tools/virsh.pod (snapshot-create, snapshot-create-as)
(snapshot-current, snapshot-edit): Document these.
2011-09-01 20:21:28 +00:00
|
|
|
|
|
|
|
This is equivalent to:
|
|
|
|
|
|
|
|
virsh snapshot-dumpxml dom name > snapshot.xml
|
|
|
|
vi snapshot.xml (or make changes with your other text editor)
|
|
|
|
virsh snapshot-create dom snapshot.xml --redefine [--current]
|
|
|
|
|
|
|
|
except that it does some error checking.
|
|
|
|
|
|
|
|
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
|
|
|
|
variables, and defaults to C<vi>.
|
2010-04-05 15:17:42 +00:00
|
|
|
|
snapshot: avoid accidental renames with snapshot-edit
I was a bit surprised that 'virsh snapshot-edit dom name' silently
allowed me to clone things, while still telling me the old name,
especially since other commands like 'virsh edit dom' reject rename
attempts (*). This fixes things to be more explicit (**).
(*) Technically, 'virsh edit dom' relies on virDomainDefineXML
behavior, which rejects attempts to mix a new name with existing
uuid or new uuid with existing name, but you can create a new
domain by changing both uuid and name. On the other hand, while
snapshot-edit --clone is a true clone, creating a new domain
would also have to decide whether to clone snapshot metadata,
managed save, and any other secondary data related to the domain.
Domain renames are not trivial either.
(**) Renaming or creating a clone is still a risky proposition -
for offline snapshots and system checkpoints, if the new name
does not match an actual name recorded in the qcow2 internal
snapshots, then you cannot revert to the new checkpoint. But it
is assumed that anyone using the new virsh flags knows what they
are doing, and can deal with the fallout caused by a rename/clone;
that is, we can't completely prevent a user from shooting
themselves in the foot, so much as we are making the default
action less risky.
* tools/virsh.c (cmdSnapshotEdit): Add --rename, --clone.
* tools/virsh.pod (snapshot-edit): Document them.
2011-10-07 22:20:58 +00:00
|
|
|
If I<--rename> is specified, then the edits can change the snapshot
|
|
|
|
name. If I<--clone> is specified, then changing the snapshot name
|
|
|
|
will create a clone of the snapshot metadata. If neither is specified,
|
|
|
|
then the edits must not change the snapshot name. Note that changing
|
|
|
|
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.
|
|
|
|
|
2012-05-24 21:53:24 +00:00
|
|
|
=item B<snapshot-info> I<domain> {I<snapshot> | I<--current>}
|
|
|
|
|
|
|
|
Output basic information about a named <snapshot>, or the current snapshot
|
|
|
|
with I<--current>.
|
|
|
|
|
2013-03-01 14:42:25 +00:00
|
|
|
=item B<snapshot-list> I<domain> [I<--metadata>] [I<--no-metadata>]
|
|
|
|
[{I<--parent> | I<--roots> | [{I<--tree> | I<--name>}]}]
|
2011-09-30 23:36:00 +00:00
|
|
|
[{[I<--from>] B<snapshot> | I<--current>} [I<--descendants>]]
|
2014-04-02 10:56:51 +00:00
|
|
|
[I<--leaves>] [I<--no-leaves>] [I<--inactive>] [I<--active>]
|
2013-03-01 14:42:25 +00:00
|
|
|
[I<--disk-only>] [I<--internal>] [I<--external>]
|
2010-04-05 15:17:42 +00:00
|
|
|
|
2011-09-24 23:42:50 +00:00
|
|
|
List all of the available snapshots for the given domain, defaulting
|
|
|
|
to show columns for the snapshot name, creation time, and domain state.
|
2010-04-05 15:17:42 +00:00
|
|
|
|
2011-08-16 19:34:22 +00:00
|
|
|
If I<--parent> is specified, add a column to the output table giving
|
2011-09-24 23:42:50 +00:00
|
|
|
the name of the parent of each snapshot. If I<--roots> is specified,
|
|
|
|
the list will be filtered to just snapshots that have no parents.
|
|
|
|
If I<--tree> is specified, the output will be in a tree format, listing
|
2013-03-01 14:42:25 +00:00
|
|
|
just snapshot names. These three options are mutually exclusive. If
|
|
|
|
I<--name> is specified only the snapshot name is printed. This option is
|
|
|
|
mutually exclusive with I<--tree>.
|
2011-08-16 19:34:22 +00:00
|
|
|
|
2011-09-29 17:51:23 +00:00
|
|
|
If I<--from> is provided, filter the list to snapshots which are
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
children of the given B<snapshot>; or if I<--current> is provided,
|
|
|
|
start at the current snapshot. When used in isolation or with
|
2011-09-29 17:51:23 +00:00
|
|
|
I<--parent>, the list is limited to direct children unless
|
|
|
|
I<--descendants> is also present. When used with I<--tree>, the
|
|
|
|
use of I<--descendants> is implied. This option is not compatible
|
2012-10-25 21:17:38 +00:00
|
|
|
with I<--roots>. Note that the starting point of I<--from> or
|
|
|
|
I<--current> is not included in the list unless the I<--tree>
|
|
|
|
option is also present.
|
2011-09-29 17:51:23 +00:00
|
|
|
|
2011-09-30 23:36:00 +00:00
|
|
|
If I<--leaves> is specified, the list will be filtered to just
|
2012-06-08 22:31:24 +00:00
|
|
|
snapshots that have no children. Likewise, if I<--no-leaves> is
|
|
|
|
specified, the list will be filtered to just snapshots with
|
|
|
|
children. (Note that omitting both options does no filtering,
|
|
|
|
while providing both options will either produce the same list
|
|
|
|
or error out depending on whether the server recognizes the flags).
|
2012-11-12 17:29:14 +00:00
|
|
|
Filtering options are not compatible with I<--tree>.
|
2011-09-30 23:36:00 +00:00
|
|
|
|
2011-08-16 19:34:22 +00:00
|
|
|
If I<--metadata> is specified, the list will be filtered to just
|
|
|
|
snapshots that involve libvirt metadata, and thus would prevent
|
|
|
|
B<undefine> of a persistent domain, or be lost on B<destroy> of
|
2012-06-08 22:31:24 +00:00
|
|
|
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.
|
2011-08-16 19:34:22 +00:00
|
|
|
|
2012-11-12 17:29:14 +00:00
|
|
|
If I<--inactive> is specified, the list will be filtered to snapshots
|
|
|
|
that were taken when the domain was shut off. If I<--active> is
|
|
|
|
specified, the list will be filtered to snapshots that were taken
|
|
|
|
when the domain was running, and where the snapshot includes the
|
|
|
|
memory state to revert to that running state. If I<--disk-only> is
|
|
|
|
specified, the list will be filtered to snapshots that were taken
|
|
|
|
when the domain was running, but where the snapshot includes only
|
|
|
|
disk state.
|
|
|
|
|
|
|
|
If I<--internal> is specified, the list will be filtered to snapshots
|
|
|
|
that use internal storage of existing disk images. If I<--external>
|
|
|
|
is specified, the list will be filtered to snapshots that use external
|
|
|
|
files for disk images or memory state.
|
|
|
|
|
2011-08-16 19:34:22 +00:00
|
|
|
=item B<snapshot-dumpxml> I<domain> I<snapshot> [I<--security-info>]
|
2010-04-05 15:17:42 +00:00
|
|
|
|
|
|
|
Output the snapshot XML for the domain's snapshot named I<snapshot>.
|
2011-08-16 19:34:22 +00:00
|
|
|
Using I<--security-info> will also include security sensitive information.
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
Use B<snapshot-current> to easily access the XML of the current snapshot.
|
2010-04-05 15:17:42 +00:00
|
|
|
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
=item B<snapshot-parent> I<domain> {I<snapshot> | I<--current>}
|
2011-08-10 23:18:55 +00:00
|
|
|
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
Output the name of the parent snapshot, if any, for the given
|
|
|
|
I<snapshot>, or for the current snapshot with I<--current>.
|
2011-08-10 23:18:55 +00:00
|
|
|
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
=item B<snapshot-revert> I<domain> {I<snapshot> | I<--current>}
|
|
|
|
[{I<--running> | I<--paused>}] [I<--force>]
|
2010-04-05 15:17:42 +00:00
|
|
|
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
Revert the given domain to the snapshot specified by I<snapshot>, or to
|
|
|
|
the current snapshot with I<--current>. Be aware
|
2011-08-27 14:16:04 +00:00
|
|
|
that this is a destructive action; any changes in the domain since the last
|
2010-04-05 15:17:42 +00:00
|
|
|
snapshot was taken will be lost. Also note that the state of the domain after
|
2010-04-12 13:36:13 +00:00
|
|
|
snapshot-revert is complete will be the state of the domain at the time
|
2010-04-05 15:17:42 +00:00
|
|
|
the original snapshot was taken.
|
|
|
|
|
2011-08-27 14:16:04 +00:00
|
|
|
Normally, reverting to a snapshot leaves the domain in the state it was
|
|
|
|
at the time the snapshot was created, except that a disk snapshot with
|
|
|
|
no vm state leaves the domain in an inactive state. Passing either the
|
|
|
|
I<--running> or I<--paused> flag will perform additional state changes
|
|
|
|
(such as booting an inactive domain, or pausing a running domain). Since
|
|
|
|
transient domains cannot be inactive, it is required to use one of these
|
|
|
|
flags when reverting to a disk snapshot of a transient domain.
|
|
|
|
|
2011-09-29 23:52:06 +00:00
|
|
|
There are two cases where a snapshot revert involves extra risk, which
|
|
|
|
requires the use of I<--force> to proceed. One is the case of a
|
|
|
|
snapshot that lacks full domain information for reverting
|
|
|
|
configuration (such as snapshots created prior to libvirt 0.9.5);
|
|
|
|
since libvirt cannot prove that the current configuration matches what
|
|
|
|
was in use at the time of the snapshot, supplying I<--force> assures
|
|
|
|
libvirt that the snapshot is compatible with the current configuration
|
|
|
|
(and if it is not, the domain will likely fail to run). The other is
|
|
|
|
the case of reverting from a running domain to an active state where a
|
|
|
|
new hypervisor has to be created rather than reusing the existing
|
|
|
|
hypervisor, because it implies drawbacks such as breaking any existing
|
|
|
|
VNC or Spice connections; this condition happens with an active
|
|
|
|
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.
|
|
|
|
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
=item B<snapshot-delete> I<domain> {I<snapshot> | I<--current>} [I<--metadata>]
|
2011-08-16 22:48:04 +00:00
|
|
|
[{I<--children> | I<--children-only>}]
|
2010-04-05 15:17:42 +00:00
|
|
|
|
snapshot: virsh shorthand for operating on current snap
Rather than having to do:
$ virsh snapshot-revert dom $(virsh snapshot-current dom --name)
I thought it would be nice to do:
$ virsh snapshot-revert dom --current
I didn't add 'virsh snapshot-dumpxml --current' since we already have
'virsh snapshot-current' for the same task. snapshot-list accepted
a name but did not require it, and that remains the case, with
--current serving in place of that name. For all other commands,
name used to be required, and can now be replaced by --current;
I intentionally made it so that omitting both --current and a name
is an error (having the absence of a name imply --current seems
just a bit too magic, so --current must be explicit). I also had
to keep snapshot-edit backwards-compatible, as the only command
that already had a --current argument alongside a name, which still
works to both edit a named snapshot and make it current.
* tools/virsh.c (vshLookupSnapshot): New helper function.
(cmdSnapshotEdit, cmdSnapshotList, cmdSnapshotParent)
(cmdSnapshotDelete, cmdDomainSnapshotRevert): Use it, adding an
option where needed.
* tools/virsh.pod (snapshot-delete, snapshot-edit)
(snapshot-list, snapshot-parent, snapshot-revert): Document
use of --current.
(snapshot-dumpxml): Mention alternative.
2011-10-06 21:01:18 +00:00
|
|
|
Delete the snapshot for the domain named I<snapshot>, or the current
|
|
|
|
snapshot with I<--current>. If this snapshot
|
2010-04-05 15:17:42 +00:00
|
|
|
has child snapshots, changes from this snapshot will be merged into the
|
|
|
|
children. If I<--children> is passed, then delete this snapshot and any
|
2011-08-16 22:48:04 +00:00
|
|
|
children of this snapshot. If I<--children-only> is passed, then delete
|
|
|
|
any children of this snapshot, but leave this snapshot intact. These
|
|
|
|
two flags are mutually exclusive.
|
|
|
|
|
|
|
|
If I<--metadata> is specified, then only delete the snapshot metadata
|
|
|
|
maintained by libvirt, while leaving the snapshot contents intact for
|
|
|
|
access by external tools; otherwise deleting a snapshot also removes
|
|
|
|
the data contents from that point in time.
|
2010-04-05 15:17:42 +00:00
|
|
|
|
|
|
|
=back
|
|
|
|
|
2013-10-24 08:57:20 +00:00
|
|
|
=head1 NWFILTER COMMANDS
|
2010-04-12 21:50:31 +00:00
|
|
|
|
|
|
|
The following commands manipulate network filters. Network filters allow
|
|
|
|
filtering of the network traffic coming from and going to virtual machines.
|
|
|
|
Individual network traffic filters are written in XML and may contain
|
|
|
|
references to other network filters, describe traffic filtering rules,
|
|
|
|
or contain both. Network filters are referenced by virtual machines
|
|
|
|
from within their interface description. A network filter may be referenced
|
|
|
|
by multiple virtual machines' interfaces.
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item B<nwfilter-define> I<xmlfile>
|
|
|
|
|
|
|
|
Make a new network filter known to libvirt. If a network filter with
|
|
|
|
the same name already exists, it will be replaced with the new XML.
|
|
|
|
Any running virtual machine referencing this network filter will have
|
|
|
|
its network traffic rules adapted. If for any reason the network traffic
|
|
|
|
filtering rules cannot be instantiated by any of the running virtual
|
|
|
|
machines, then the new XML will be rejected.
|
|
|
|
|
|
|
|
=item B<nwfilter-undefine> I<nwfilter-name>
|
|
|
|
|
|
|
|
Delete a network filter. The deletion will fail if any running virtual
|
|
|
|
machine is currently using this network filter.
|
|
|
|
|
|
|
|
=item B<nwfilter-list>
|
|
|
|
|
|
|
|
List all of the available network filters.
|
|
|
|
|
|
|
|
=item B<nwfilter-dumpxml> I<nwfilter-name>
|
|
|
|
|
|
|
|
Output the network filter XML.
|
|
|
|
|
|
|
|
=item B<nwfilter-edit> I<nwfilter-name>
|
|
|
|
|
|
|
|
Edit the XML of a network filter.
|
|
|
|
|
|
|
|
This is equivalent to:
|
|
|
|
|
|
|
|
virsh nwfilter-dumpxml myfilter > myfilter.xml
|
2010-11-17 14:15:12 +00:00
|
|
|
vi myfilter.xml (or make changes with your other text editor)
|
2010-04-12 21:50:31 +00:00
|
|
|
virsh nwfilter-define myfilter.xml
|
|
|
|
|
|
|
|
except that it does some error checking.
|
|
|
|
The new network filter may be rejected due to the same reason as
|
|
|
|
mentioned in I<nwfilter-define>.
|
|
|
|
|
|
|
|
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
|
|
|
|
variables, and defaults to C<vi>.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
2014-01-31 23:52:17 +00:00
|
|
|
=head1 HYPERVISOR-SPECIFIC COMMANDS
|
2010-04-13 18:08:59 +00:00
|
|
|
|
|
|
|
NOTE: Use of the following commands is B<strongly> discouraged. They
|
|
|
|
can cause libvirt to become confused and do the wrong thing on subsequent
|
2014-01-31 23:52:17 +00:00
|
|
|
operations. Once you have used these commands, please do not report
|
|
|
|
problems to the libvirt developers; the reports will be ignored. If
|
|
|
|
you find that these commands are the only way to accomplish something,
|
|
|
|
then it is better to request that the feature be added as a first-class
|
|
|
|
citizen in the regular libvirt library.
|
2010-04-13 18:08:59 +00:00
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2011-05-05 16:32:07 +00:00
|
|
|
=item B<qemu-attach> I<pid>
|
|
|
|
|
|
|
|
Attach an externally launched QEMU process to the libvirt QEMU driver.
|
|
|
|
The QEMU process must have been created with a monitor connection
|
|
|
|
using the UNIX driver. Ideally the process will also have had the
|
|
|
|
'-name' argument specified.
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
|
|
|
$ qemu-kvm -cdrom ~/demo.iso \
|
|
|
|
-monitor unix:/tmp/demo,server,nowait \
|
|
|
|
-name foo \
|
|
|
|
-uuid cece4f9f-dff0-575d-0e8e-01fe380f12ea &
|
|
|
|
$ QEMUPID=$!
|
|
|
|
$ virsh qemu-attach $QEMUPID
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
Not all functions of libvirt are expected to work reliably after
|
|
|
|
attaching to an externally launched QEMU process. There may be
|
2014-10-08 22:54:10 +00:00
|
|
|
issues with the guest ABI changing upon migration and device hotplug
|
|
|
|
or hotunplug may not work. The attached environment should be considered
|
|
|
|
primarily read-only.
|
2011-05-05 16:32:07 +00:00
|
|
|
|
2012-10-04 23:14:19 +00:00
|
|
|
=item B<qemu-monitor-command> I<domain> { [I<--hmp>] | [I<--pretty>] }
|
|
|
|
I<command>...
|
2010-04-13 18:08:59 +00:00
|
|
|
|
|
|
|
Send an arbitrary monitor command I<command> to domain I<domain> through the
|
2011-02-02 15:37:10 +00:00
|
|
|
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
|
2012-10-04 23:14:19 +00:00
|
|
|
the result will also be converted back from QMP. If I<--pretty> is given,
|
|
|
|
and the monitor uses QMP, then the output will be pretty-printed. If more
|
|
|
|
than one argument is provided for I<command>, they are concatenated with a
|
|
|
|
space in between before passing the single command to the monitor.
|
2010-04-13 18:08:59 +00:00
|
|
|
|
2014-01-31 23:52:17 +00:00
|
|
|
=item B<qemu-agent-command> I<domain> [I<--timeout> I<seconds> | I<--async> |
|
|
|
|
I<--block>] I<command>...
|
2012-08-23 03:29:27 +00:00
|
|
|
|
|
|
|
Send an arbitrary guest agent command I<command> to domain I<domain> through
|
|
|
|
qemu agent.
|
|
|
|
I<--timeout>, I<--async> and I<--block> options are exclusive.
|
|
|
|
I<--timeout> requires timeout seconds I<seconds> and it must be positive.
|
|
|
|
When I<--aysnc> is given, the command waits for timeout whether success or
|
|
|
|
failed. And when I<--block> is given, the command waits forever with blocking
|
|
|
|
timeout.
|
|
|
|
|
2014-01-31 23:52:17 +00:00
|
|
|
=item B<qemu-monitor-event> [I<domain>] [I<--event> I<event-name>] [I<--loop>]
|
2014-02-06 21:46:52 +00:00
|
|
|
[I<--timeout> I<seconds>] [I<--pretty>] [I<--regex>] [I<--no-case>]
|
2014-01-31 23:52:17 +00:00
|
|
|
|
|
|
|
Wait for arbitrary QEMU monitor events to occur, and print out the
|
|
|
|
details of events as they happen. The events can optionally be filtered
|
|
|
|
by I<domain> or I<event-name>. The 'query-events' QMP command can be
|
|
|
|
used via I<qemu-monitor-command> to learn what events are supported.
|
2014-02-06 21:46:52 +00:00
|
|
|
If I<--regex> is used, I<event-name> is a basic regular expression
|
|
|
|
instead of a literal string. If I<--no-case> is used, I<event-name>
|
|
|
|
will match case-insensitively.
|
2014-01-31 23:52:17 +00:00
|
|
|
|
|
|
|
By default, this command is one-shot, and returns success once an event
|
|
|
|
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
|
|
|
|
If I<--timeout> is specified, the command gives up waiting for events
|
|
|
|
after I<seconds> have elapsed. With I<--loop>, the command prints all
|
|
|
|
events until a timeout or interrupt key. If I<--pretty> is specified,
|
|
|
|
any JSON event details are pretty-printed for better legibility.
|
|
|
|
|
2012-12-21 16:51:33 +00:00
|
|
|
=item B<lxc-enter-namespace> I<domain> -- /path/to/binary [arg1, [arg2, ...]]
|
|
|
|
|
|
|
|
Enter the namespace of I<domain> and execute the command C</path/to/binary>
|
|
|
|
passing the requested args. The binary path is relative to the container
|
|
|
|
root filesystem, not the host root filesystem. The binary will inherit the
|
|
|
|
environment variables / console visible to virsh. This command only works
|
2013-12-23 16:32:45 +00:00
|
|
|
when connected to the LXC hypervisor driver. This command succeeds only
|
|
|
|
if C</path/to/binary> has 0 exit status.
|
2012-12-21 16:51:33 +00:00
|
|
|
|
2012-08-23 03:29:27 +00:00
|
|
|
=back
|
|
|
|
|
2007-07-23 09:35:59 +00:00
|
|
|
=head1 ENVIRONMENT
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
The following environment variables can be set to alter the behaviour
|
|
|
|
of C<virsh>
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2011-06-30 08:22:45 +00:00
|
|
|
=item VIRSH_DEBUG=<0 to 4>
|
|
|
|
|
|
|
|
Turn on verbose debugging of virsh commands. Valid levels are
|
|
|
|
|
2013-04-05 16:00:20 +00:00
|
|
|
=over 4
|
|
|
|
|
2011-06-30 08:22:45 +00:00
|
|
|
=item * VIRSH_DEBUG=0
|
|
|
|
|
|
|
|
DEBUG - Messages at ALL levels get logged
|
|
|
|
|
|
|
|
=item * VIRSH_DEBUG=1
|
|
|
|
|
|
|
|
INFO - Logs messages at levels INFO, NOTICE, WARNING and ERROR
|
|
|
|
|
|
|
|
=item * VIRSH_DEBUG=2
|
|
|
|
|
|
|
|
NOTICE - Logs messages at levels NOTICE, WARNING and ERROR
|
|
|
|
|
|
|
|
=item * VIRSH_DEBUG=3
|
|
|
|
|
|
|
|
WARNING - Logs messages at levels WARNING and ERROR
|
|
|
|
|
|
|
|
=item * VIRSH_DEBUG=4
|
|
|
|
|
|
|
|
ERROR - Messages at only ERROR level gets logged.
|
|
|
|
|
2013-04-05 16:00:20 +00:00
|
|
|
=back
|
|
|
|
|
2011-06-30 08:22:45 +00:00
|
|
|
=item VIRSH_LOG_FILE=C<LOGFILE>
|
|
|
|
|
|
|
|
The file to log virsh debug messages.
|
|
|
|
|
2007-07-23 09:35:59 +00:00
|
|
|
=item VIRSH_DEFAULT_CONNECT_URI
|
|
|
|
|
|
|
|
The hypervisor to connect to by default. Set this to a URI, in the same
|
2012-03-14 12:30:52 +00:00
|
|
|
format as accepted by the B<connect> option. This environment variable
|
|
|
|
is deprecated in favour of the global B<LIBVIRT_DEFAULT_URI> variable
|
|
|
|
which serves the same purpose.
|
|
|
|
|
|
|
|
=item LIBVIRT_DEFAULT_URI
|
|
|
|
|
|
|
|
The hypervisor to connect to by default. Set this to a URI, in the
|
|
|
|
same format as accepted by the B<connect> option. This overrides
|
|
|
|
the default URI set in any client config file and prevents libvirt
|
|
|
|
from probing for drivers.
|
2007-07-23 09:35:59 +00:00
|
|
|
|
2010-03-12 16:33:22 +00:00
|
|
|
=item VISUAL
|
2010-03-12 16:25:37 +00:00
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
The editor to use by the B<edit> and related options.
|
2010-03-12 16:25:37 +00:00
|
|
|
|
2010-03-12 16:33:22 +00:00
|
|
|
=item EDITOR
|
|
|
|
|
2010-04-05 23:21:02 +00:00
|
|
|
The editor to use by the B<edit> and related options, if C<VISUAL>
|
2010-03-12 16:33:22 +00:00
|
|
|
is not set.
|
|
|
|
|
2013-10-28 13:38:46 +00:00
|
|
|
=item VIRSH_HISTSIZE
|
|
|
|
|
|
|
|
The number of commands to remember in the command history. The
|
|
|
|
default value is 500.
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=item LIBVIRT_DEBUG=LEVEL
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
Turn on verbose debugging of all libvirt API calls. Valid levels are
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=over 4
|
|
|
|
|
|
|
|
=item * LIBVIRT_DEBUG=1
|
|
|
|
|
|
|
|
Messages at level DEBUG or above
|
|
|
|
|
|
|
|
=item * LIBVIRT_DEBUG=2
|
|
|
|
|
|
|
|
Messages at level INFO or above
|
|
|
|
|
|
|
|
=item * LIBVIRT_DEBUG=3
|
|
|
|
|
|
|
|
Messages at level WARNING or above
|
|
|
|
|
|
|
|
=item * LIBVIRT_DEBUG=4
|
|
|
|
|
|
|
|
Messages at level ERROR or above
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
For further information about debugging options consult C<http://libvirt.org/logging.html>
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
=head1 BUGS
|
|
|
|
|
|
|
|
Report any bugs discovered to the libvirt community via the mailing
|
|
|
|
list C<http://libvirt.org/contact.html> or bug tracker C<http://libvirt.org/bugs.html>.
|
|
|
|
Alternatively report bugs to your software distributor / vendor.
|
|
|
|
|
|
|
|
=head1 AUTHORS
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2010-07-12 19:33:35 +00:00
|
|
|
Please refer to the AUTHORS file distributed with libvirt.
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2008-09-25 12:40:01 +00:00
|
|
|
Based on the xm man page by:
|
2007-06-21 07:39:51 +00:00
|
|
|
Sean Dague <sean at dague dot net>
|
|
|
|
Daniel Stekloff <dsteklof at us dot ibm dot com>
|
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=head1 COPYRIGHT
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2015-01-09 12:36:01 +00:00
|
|
|
Copyright (C) 2005, 2007-2015 Red Hat, Inc., and the authors listed in the
|
2010-07-12 19:33:35 +00:00
|
|
|
libvirt AUTHORS file.
|
2009-04-19 15:10:45 +00:00
|
|
|
|
|
|
|
=head1 LICENSE
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
virsh is distributed under the terms of the GNU LGPL v2+.
|
|
|
|
This is free software; see the source for copying conditions. There
|
|
|
|
is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
|
|
PURPOSE
|
|
|
|
|
|
|
|
=head1 SEE ALSO
|
2007-06-21 07:39:51 +00:00
|
|
|
|
2010-11-22 11:55:35 +00:00
|
|
|
L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>, L<virt-df(1)>,
|
|
|
|
L<http://www.libvirt.org/>
|
2008-02-05 19:27:37 +00:00
|
|
|
|
2009-04-19 15:10:45 +00:00
|
|
|
=cut
|