2007-06-21 07:39:51 +00:00
=head1 NAME
virsh - management user interface
=head1 SYNOPSIS
virsh <subcommand> [args]
=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
providing a long term stable C API. It currently supports Xen, QEmu,
KVM, LXC, OpenVZ, VirtualBox, OpenNebula, 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
2007-06-21 15:00:17 +00:00
virsh <command> <domain-id> [OPTIONS]
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
Where I<command> is one of the commands listed below, I<domain-id>
2007-06-21 07:39:51 +00:00
is the numeric domain id, or the domain name (which will be internally
2007-06-21 15:00:17 +00:00
translated to domain id), and I<OPTIONS> are command specific
2007-06-21 07:39:51 +00:00
options. There are a few exceptions to this rule in the cases where
2007-06-21 15:00:17 +00:00
the command in question acts on all domains, the entire machine,
2007-06-21 07:39:51 +00:00
or directly on the xen hypervisor. Those exceptions will be clear for
2007-06-21 15:00:17 +00:00
each of those commands.
The B<virsh> program can be used either to run one command at a time
by giving the command as an argument on the command line, or as a shell
if no command is given in the command line, it will then start a minimal
interpreter waiting for your commands and the B<quit> command will then exit
the program.
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,
setvcpus and setmem. In those case the fact that the B<virsh>
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
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
2007-06-21 15:00:17 +00:00
=item B<help> optional I<command>
2007-06-21 07:39:51 +00:00
2007-08-14 07:02:18 +00:00
This prints a small synopsis about all commands available for B<virsh>
2007-06-21 15:00:17 +00:00
B<help> I<command> will print out a detailed help message on that command.
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
2008-02-05 19:27:37 +00:00
=item B<version>
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.
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
2008-02-05 19:27:37 +00:00
B<virsh> version
2007-06-21 07:39:51 +00:00
2008-02-05 19:27:37 +00:00
Compiled against library: libvir 0.0.6
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
Using library: libvir 0.0.6
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
Using API: Xen 3.0.0
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
Running hypervisor: Xen 3.0.0
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
2009-07-16 14:40:08 +00:00
=item B<cd> I<directory> optional
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.
2007-06-21 15:00:17 +00:00
=item B<connect> I<URI> optional I<--readonly>
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
(Re)-Connect to the hypervisor. This is a build-in command after shell
start up, and usually get an I<URI> parameter specifying how to connect
to the hypervisor. The documentation page at L<http://libvirt.org/uri.html>
2007-06-21 15:57:49 +00:00
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
2007-06-21 15:00:17 +00:00
this is used to connect to the local Xen hypervisor, this is the default
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
2008-03-17 10:27:31 +00:00
allow to 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
2008-12-18 06:48:13 +00:00
allow to 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
2007-08-14 07:02:18 +00:00
For remote access see the documentation page 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.
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,
and size of the physical memory.
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
2008-02-05 19:27:37 +00:00
=item B<list>
2007-06-21 07:39:51 +00:00
Prints information about one or more domains. If no domains are
specified it prints out information about all domains.
An example format for the list is as follows:
B<virsh> list
2008-02-05 19:27:37 +00:00
Id Name State
2007-06-21 07:39:51 +00:00
2008-02-05 19:27:37 +00:00
----------------------------------
2007-06-21 07:39:51 +00:00
2008-02-05 19:27:37 +00:00
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>
2008-09-25 12:40:01 +00:00
The State field lists 6 states for a domain, and which ones the
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.
2007-06-21 07:39:51 +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
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.
=back
2008-09-25 12:40:01 +00:00
=item B<freecell> optional I<cellno>
Prints the available amount of memory on the machine or within a
NUMA cell if I<cellno> is provided.
2010-02-17 13:52:07 +00:00
=item B<cpu-baseline> I<FILE>
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
B<capabilities> command.
2010-01-20 14:16:29 +00:00
=item B<cpu-compare> I<FILE>
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:
L<http://libvirt.org/formatdomain.html#elementsCPU>
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
previously most commands take domain-id as the first parameter. The
I<domain-id> can be specified as an 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
2007-06-21 15:46:04 +00:00
=item B<autostart> optional I<--disable> I<domain-id>
2007-06-21 15:00:17 +00:00
Configure a domain to be automatically started at boot.
2007-06-21 15:46:04 +00:00
The option I<--disable> disable autostarting.
2007-06-21 15:00:17 +00:00
=item B<console> I<domain-id>
Connect the virtual serial console for the guest.
2008-02-05 19:27:37 +00:00
=item B<create> I<FILE>
2007-06-21 15:00:17 +00:00
2008-09-25 12:40:01 +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 pre-existing guest.
2007-06-21 15:00:17 +00:00
B<Example>
2008-02-05 19:27:37 +00:00
virsh dumpxml <domain-id> > file.
2007-06-21 15:00:17 +00:00
=item B<define> I<FILE>
Define a domain from an XML <file>. The domain definitions is registered
but not started.
=item B<destroy> I<domain-id>
Immediately terminate the domain domain-id. This doesn't give the domain
OS any chance to react, and it the equivalent of ripping the power
cord out on a physical machine. In most cases you will want to use
the B<shutdown> command instead.
2008-04-15 15:20:43 +00:00
=item B<domblkstat> I<domain> I<block-device>
Get device block stats for a running domain.
=item B<domifstat> I<domain> I<interface-device>
Get network interface stats for a running domain.
2009-12-21 14:24:56 +00:00
=item B<dommemstat> I<domain>
Get memory stats for a running domain.
2008-02-05 19:27:37 +00:00
=item B<dominfo> I<domain-id>
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
=item B<dominfo> I<domain-id>
Returns basic information about the domain.
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
=item B<domstate> I<domain-id>
Returns state about a running domain.
2008-04-15 15:20:43 +00:00
=item B<dump> I<domain-id> I<corefilepath>
Dumps the core of a domain to a file for analysis.
2007-06-21 15:00:17 +00:00
=item B<dumpxml> I<domain-id>
2008-03-14 11:08:03 +00:00
Output the domain information as an XML dump to stdout, this format can be used by the B<create> command.
2007-06-21 07:39:51 +00:00
2008-08-01 14:30:41 +00:00
=item B<edit> I<domain-id>
Edit the XML configuration file for a domain.
This is equivalent to:
virsh dumpxml domain > domain.xml
edit domain.xml
virsh define domain.xml
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
2010-04-01 16:05:38 +00:00
=item B<managedsave> I<domain-id>
Ask libvirt to save a running domain state in a place managed by libvirt.
If libvirt is asked to restart the domain later on it will resume it from
the saved domain state (and the state is discarded).
2009-12-11 09:00:44 +00:00
=item B<migrate> optional I<--live> I<--suspend> I<domain-id> I<desturi> I<migrateuri>
2008-04-15 15:20:43 +00:00
2009-12-11 09:00:44 +00:00
Migrate domain to another host. Add --live for live migration; --suspend
leaves the domain paused on the destination host. The I<desturi> is the
connection URI of the destination host, and I<migrateuri> is the
2008-04-15 15:20:43 +00:00
migration URI, which usually can be omitted.
2007-06-21 07:39:51 +00:00
2010-03-17 16:18:36 +00:00
=item B<migrate-setmaxdowntime> I<domain-id> I<downtime>
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.
2007-06-21 07:39:51 +00:00
=item B<reboot> I<domain-id>
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.
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
=item B<restore> I<state-file>
Restores a domain from an B<virsh save> state file. See I<save> for more info.
=item B<save> I<domain-id> I<state-file>
Saves a running domain to a state file so that it can be restored
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.
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.
2008-10-08 16:28:48 +00:00
=item B<schedinfo> optional I<--set> B<parameter=value> I<domain-id>
2008-04-15 15:20:43 +00:00
=item B<schedinfo> optional I<--weight> B<number> optional I<--cap> B<number> I<domain-id>
2010-01-17 23:48:39 +00:00
Allows you to show (and set) the domain scheduler parameters. The parameters available for each hypervisor are:
LXC, QEMU/KVM (posix scheduler): cpu_shares
Xen (credit scheduler): weight, cap
ESX (allocation scheduler): reservation, limit, shares
B<Note>: The cpu_shares parameter has a valid value range of 0-262144.
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
2007-06-21 15:00:17 +00:00
=item B<setmem> I<domain-id> B<kilobytes>
Change the current memory allocation in the guest domain. This should take
effect immediately. The memory limit is specified in
kilobytes.
2008-01-25 12:03:05 +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
=item B<setmaxmem> I<domain-id> B<kilobytes>
Change the maximum memory allocation limit in the guest domain. This should
2008-02-05 19:27:37 +00:00
not change the current memory use. The memory limit is specified in
2007-06-21 15:00:17 +00:00
kilobytes.
=item B<setvcpus> I<domain-id> I<count>
Change the number of virtual CPUs active in the guest domain. Note that
2008-02-05 19:27:37 +00:00
I<count> may be limited by host, hypervisor or limit coming from the
2007-06-21 15:00:17 +00:00
original description of domain.
2008-01-25 12:03:05 +00:00
For Xen, you can only adjust the virtual CPUs of a running domain if
the domain is paravirtualized.
2007-06-21 07:39:51 +00:00
=item B<shutdown> I<domain-id>
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
2008-04-15 15:20:43 +00:00
=item B<start> I<domain-name>
Start a (previously defined) inactive domain.
2007-06-21 15:00:17 +00:00
=item B<suspend> I<domain-id>
Suspend a running domain. It is kept in memory but won't be scheduled
anymore.
2007-06-21 07:39:51 +00:00
=item B<resume> I<domain-id>
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
2007-07-26 08:41:16 +00:00
=item B<ttyconsole> I<domain-id>
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
2007-06-21 15:00:17 +00:00
=item B<undefine> I<domain-id>
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
Undefine the configuration for an inactive domain. Since it's not running
the domain name or UUId must be used as the I<domain-id>.
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
=item B<vcpuinfo> I<domain-id>
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
2007-06-21 15:00:17 +00:00
=item B<vcpupin> I<domain-id> I<vcpu> I<cpulist>
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
Pin domain VCPUs to host physical CPUs. The I<vcpu> number must be provided
and I<cpulist> is a comma separated list of physical CPU numbers.
2007-06-21 07:39:51 +00:00
2007-06-21 15:00:17 +00:00
=item B<vncdisplay> I<domain-id>
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.
The domain-id can be specified as an short integer, a name or a full UUID.
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
2007-06-21 15:00:17 +00:00
=item B<attach-device> I<domain-id> I<FILE>
Attach a device to the domain, using a device definition in an XML file.
See the documentation to learn about libvirt XML format for a device.
=item B<attach-disk> I<domain-id> I<source> I<target> optional I<--driver driver> I<--subdriver subdriver> I<--type type> I<--mode mode>
Attach a new disk device to the domain.
I<source> and I<target> are paths for the files and devices.
I<driver> can be I<file>, I<tap> or I<phy> depending on the kind of access.
I<type> can indicate I<cdrom> or I<floppy> as alternative to the disk default.
I<mode> can specify the two specific mode I<readonly> or I<shareable>.
=item B<attach-interface> I<domain-id> I<type> I<source> optional I<--target target> I<--mac mac> I<--script script>
Attach a new network interface to the domain.
I<type> can be either I<network> to indicate a physical network device or I<bridge> to indicate a bridge to a device.
I<source> indicates the source device.
I<target> allows to indicate the target device in the guest.
I<mac> allows to specify the MAC address of the network interface.
I<script> allows to specify a path to a script handling a bridge instead of
the default one.
=item B<detach-device> I<domain-id> I<FILE>
Detach a device from the domain, takes the same kind of XML descriptions
as command B<attach-device>.
=item B<detach-disk> I<domain-id> I<target>
Detach a disk device from a domain. The I<target> is the device as seen
from the domain.
=item B<detach-interface> I<domain-id> I<type> optional I<--mac mac>
2007-08-14 07:02:18 +00:00
Detach a network interface from a domain.
2007-06-21 15:00:17 +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.
2007-06-21 07:39:51 +00:00
2009-04-19 15:10:45 +00:00
=back
=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
2009-08-11 14:37:33 +00:00
see the documentation at L<http://libvirt.org/formatnetwork.html> . A lot
2007-06-21 15:00:17 +00:00
of the command for virtual networks are similar to the one used for domains,
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
2007-06-21 15:00:17 +00:00
=item B<net-autostart> I<network> optional I<--disable>
Configure a virtual network to be automatically started at boot.
The I<--disable> option disable autostarting.
=item B<net-create> I<file>
Create a virtual network from an XML I<file>, see the documentation to get
2008-02-05 19:27:37 +00:00
a description of the XML network format used by libvirt.
2007-06-21 15:00:17 +00:00
=item B<net-define> I<file>
Define a virtual network from an XML I<file>, the network is just defined but
2007-08-14 07:02:18 +00:00
not instantiated.
2007-06-21 15:00:17 +00:00
=item B<net-destroy> I<network>
Destroy a given virtual network specified by its name or UUID. This takes
effect immediately.
=item B<net-dumpxml> I<network>
Output the virtual network information as an XML dump to stdout.
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:
virsh net-dumpxml network > network.xml
edit network.xml
virsh define network.xml
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
2007-06-21 15:00:17 +00:00
=item B<net-list> optional I<--inactive> or I<--all>
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
inactive ones will be listed.
=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>
Undefine the configuration for an inactive network.
=item B<net-uuid> I<network-name>
Convert a network name to network UUID.
2009-04-19 15:10:45 +00:00
=back
2009-07-28 10:27:25 +00:00
=head1 SECRET COMMMANDS
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
or possibly other uses. Secrets are identified using an UUID. See
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.
If I<file> specifies an UUID of an existing secret, replace its properties by
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.
=item B<secret-list>
Output a list of UUIDs of known secrets to stdout.
=back
2010-04-05 15:17:42 +00:00
=head1 SNAPSHOT COMMMANDS
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
=item B<snapshot-create> I<domain> I<xmlfile>
Create a snapshot for domain I<domain> with the properties specified in
I<xmlfile>. The only properties settable for a domain snapshot are the
<name> and <description>; the rest of the fields are ignored, and
automatically filled in by libvirt. If I<xmlfile> is completely omitted,
then libvirt will choose a value for all fields.
=item B<snapshot-current> I<domain>
Output the snapshot XML for the domain's current snapshot (if any).
=item B<snapshot-list> I<domain>
List all of the available snapshots for the given domain.
=item B<snapshot-dumpxml> I<domain> I<snapshot>
Output the snapshot XML for the domain's snapshot named I<snapshot>.
=item B<revert-to-snapshot> I<domain> I<snapshot>
Revert the given domain to the snapshot specified by I<snapshot>. Be aware
that this is a destructive action; any changes in the domain since the
snapshot was taken will be lost. Also note that the state of the domain after
revert-to-snapshot is complete will be the state of the domain at the time
the original snapshot was taken.
=item B<snapshot-delete> I<domain> I<snapshot> I<--children>
Delete the snapshot for the domain named I<snapshot>. If this snapshot
has child snapshots, changes from this snapshot will be merged into the
children. If I<--children> is passed, then delete this snapshot and any
children of this snapshot.
=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
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
format as accepted by the B<connect> option.
2010-03-12 16:33:22 +00:00
=item VISUAL
2010-03-12 16:25:37 +00:00
The editor to use by the B<edit> and B<net-edit> options.
2010-03-12 16:33:22 +00:00
=item EDITOR
The editor to use by the B<edit> and B<net-edit> options, if C<VISUAL>
is not set.
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
2008-02-05 19:27:37 +00:00
Andrew Puch <apuch @ redhat.com>
2007-06-21 07:39:51 +00:00
Daniel Veillard <veillard @ redhat.com>
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
2010-03-12 16:25:37 +00:00
Copyright (C) 2005, 2007-2010 Red Hat, Inc.
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
2009-04-19 15:10:45 +00:00
L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>, L<virt-mem(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