virsh.pod 129.9 KB
Newer Older
1 2 3 4 5 6
=head1 NAME

virsh - management user interface

=head1 SYNOPSIS

L
Lai Jiangshan 已提交
7 8 9
B<virsh> [I<OPTION>]... [I<COMMAND_STRING>]

B<virsh> [I<OPTION>]... I<COMMAND> [I<ARG>]...
10 11 12 13 14

=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
E
Eric Blake 已提交
15 16 17 18 19 20 21 22
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,
23
KVM, LXC, OpenVZ, VirtualBox and VMware ESX.
24

25
The basic structure of most virsh usage is:
26

27
  virsh [OPTION]... <command> <domain> [ARG]...
28

29 30 31 32 33 34 35 36 37 38
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.
39

L
Lai Jiangshan 已提交
40 41 42 43 44 45 46 47 48
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
49
the program.
50

E
Eric Blake 已提交
51 52 53 54 55 56 57 58 59
The B<virsh> program understands the following I<OPTIONS>.

=over 4

=item B<-h>, B<--help>

Ignore all other arguments, and behave as if the B<help> command were
given instead.

E
Eric Blake 已提交
60
=item B<-v>, B<--version[=short]>
E
Eric Blake 已提交
61

62 63 64
Ignore all other arguments, and prints the version of the libvirt library
virsh is coming from

E
Eric Blake 已提交
65
=item B<-V>, B<--version=long>
66 67 68

Ignore all other arguments, and prints the version of the libvirt library
virsh is coming from and which options and driver are compiled in.
E
Eric Blake 已提交
69 70 71 72 73 74 75 76 77

=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
78
range from 0 to 4 (default).  See the documentation of B<VIRSH_DEBUG>
79
environment variable below for the description of each I<LEVEL>.
E
Eric Blake 已提交
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

=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.

98 99 100
=item B<-e>, B<--escape> I<string>

Set alternative escape sequence for I<console> command. By default,
101 102
telnet's B<^]> is used. Allowed characters when using hat notation are:
alphabetic character, @, [, ], \, ^, _.
103

E
Eric Blake 已提交
104 105
=back

106 107
=head1 NOTES

E
Eric Blake 已提交
108 109 110
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>.
111

112
Most B<virsh> commands require root privileges to run due to the
113 114 115
communications channels used to talk to the hypervisor.  Running as
non root will return an error.

116
Most B<virsh> commands act synchronously, except maybe shutdown,
L
Luiz Capitulino 已提交
117
setvcpus and setmem. In those cases the fact that the B<virsh>
118 119 120
program returned, may not mean the action is complete and you
must poll periodically to detect that the guest completed the
operation.
121

E
Eric Blake 已提交
122 123 124 125 126 127
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.

E
Eric Blake 已提交
128 129 130 131
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
J
Ján Tomko 已提交
132
suffixes can be used to select a specific scale:
E
Eric Blake 已提交
133 134 135 136 137 138 139 140 141 142 143 144 145 146
  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

147
=head1 GENERIC COMMANDS
148

149
The following commands are generic i.e. not specific to a domain.
150 151 152

=over 4

153
=item B<help> [I<command-or-group>]
154

155 156 157 158 159 160 161 162 163 164 165 166 167 168
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
     connect                        (re)connect to hypervisor
     freecell                       NUMA free memory
     hostname                       print the hypervisor hostname
169 170
     qemu-attach                    Attach to existing QEMU process
     qemu-monitor-command           QEMU Monitor Command
171
     qemu-agent-command             QEMU Guest Agent Command
E
Eric Blake 已提交
172
     sysinfo                        print the hypervisor sysinfo
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
     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
191

192
=item B<quit>, B<exit>
193

194
quit this interactive terminal
195

196
=item B<version>
197

198
Will print out the major version info about what this built from.
199

200
=over 4
201

202
B<Example>
203

204
B<virsh> version
205

206
Compiled against library: libvir 0.0.6
207

208
Using library: libvir 0.0.6
209

210
Using API: Xen 3.0.0
211

212
Running hypervisor: Xen 3.0.0
213

214
=back
215

216
=item B<cd> [I<directory>]
P
Paolo Bonzini 已提交
217 218 219 220 221 222 223 224 225 226 227

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.

228
=item B<connect> I<URI> [I<--readonly>]
229

E
Eric Blake 已提交
230 231 232 233 234 235
(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:
236

237
=over 4
238

239
=item xen:///
240

241
this is used to connect to the local Xen hypervisor, this is the default
242

243
=item qemu:///system
244

E
Eric Blake 已提交
245
connect locally as root to the daemon supervising QEmu and KVM domains
246

247 248
=item qemu:///session

E
Eric Blake 已提交
249
connect locally as a normal user to his own set of QEmu and KVM domains
250

D
David Jorm 已提交
251 252 253 254
=item lxc:///

connect to a local linux container

255
=back
256

257 258
For remote access see the documentation page at
L<http://libvirt.org/uri.html> on how to make URIs.
259
The I<--readonly> option allows for read-only connection
260

261 262 263 264 265 266 267 268
=item B<uri>

Prints the hypervisor canonical URI, can be useful in shell mode.

=item B<hostname>

Print the hypervisor hostname.

E
Eric Blake 已提交
269 270 271 272
=item B<sysinfo>

Print the XML representation of the hypervisor sysinfo, if available.

273
=item B<nodeinfo>
274

275
Returns basic information about the node, like number and type of CPU,
J
Jiri Denemark 已提交
276 277 278
and size of the physical memory. The output corresponds to virNodeInfo
structure. Specifically, the "CPU socket(s)" field means number of CPU
sockets per NUMA cell.
279

280 281 282 283 284
=item B<nodecpumap>

Displays the node's total number of CPUs, the number of online CPUs
and the list of online CPUs.

285
=item B<nodecpustats> [I<cpu>] [I<--percent>]
286 287 288 289 290 291

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.

292
=item B<nodememstats> [I<cell>]
293 294 295 296

Returns memory stats of the node.
If I<cell> is specified, this will prints specified cell statistics only.

297
=item B<nodesuspend> [I<target>] [I<duration>]
298 299 300 301

Puts the node (host machine) into a system-wide sleep state such as
Suspend-to-RAM, Suspend-to-Disk or Hybrid-Suspend and sets up a
Real-Time-Clock interrupt to fire (to wake up the node) after a time delay
302 303
specified by the 'duration' parameter. The duration time should be
at least 60 seconds.
304

305 306 307 308 309 310
=item B<node-memory-tune> [I<shm-pages-to-scan>] [I<shm-sleep-millisecs>]

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
311 312 313 314
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.
315

316
=item B<capabilities>
317 318 319 320 321

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
322
description see:
M
Mark McLoughlin 已提交
323
  L<http://libvirt.org/formatcaps.html>
324
The XML also show the NUMA topology information if available.
325

326
=item B<inject-nmi> I<domain>
327 328 329

Inject NMI to the guest.

330 331 332 333 334 335 336 337 338
=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>]
339

340
Prints information about existing domains.  If no options are
341
specified it prints out information about running domains.
342 343 344 345

An example format for the list is as follows:

B<virsh> list
346 347 348 349
  Id    Name                           State
 ----------------------------------------------------
  0     Domain-0                       running
  2     fedora                         paused
350

351
Name is the name of the domain.  ID the domain numeric id.
352
State is the run state (see below).
353

354 355
B<STATES>

O
Osier Yang 已提交
356
The State field lists 8 states for a domain, and which ones the
357
current domain is in.
358

359 360
=over 4

361
=item B<running>
362 363 364

The domain is currently running on a CPU

365
=item B<idle>
366

367
The domain is idle, and not running or runnable.  This can be caused
368 369 370
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.

371
=item B<paused>
372 373

The domain has been paused, usually occurring through the administrator
374
running B<virsh suspend>.  When in a paused state the domain will still
375
consume allocated resources like memory, but will not be eligible for
376
scheduling by the hypervisor.
377

378
=item B<shutdown>
379

380
The domain is in the process of shutting down, i.e. the guest operating system
381
has been notified and should be in the process of stopping its operations
382
gracefully.
383

384 385 386 387 388
=item B<shut off>

The domain is not running.  Usually this indicates the domain has been
shut down completely, or has not been started.

389
=item B<crashed>
390 391 392

The domain has crashed, which is always a violent ending.  Usually
this state can only occur if the domain has been configured not to
393
restart on crash.
394

395
=item B<dying>
396 397 398 399

The domain is in process of dying, but hasn't completely shutdown or
crashed.

O
Osier Yang 已提交
400 401 402 403 404
=item B<pmsuspended>

The domain has been suspended by guest power management, e.g. entered
into s3 state.

405 406
=back

407 408 409
Normally only active domains are listed. To list inactive domains specify
I<--inactive> or I<--all> to list both active and inactive domains.

410 411 412 413 414
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:
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457

=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.
458 459 460 461 462 463 464

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.

465 466
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
467
I<--table> output.
468

469 470
Example:

P
Peter Krempa 已提交
471
B<virsh> list --title
472 473 474 475
  Id    Name                           State      Title
 --------------------------------------------------------------------------
  0     Domain-0                       running    Mailserver 1
  2     fedora                         paused
476

477 478 479 480 481 482 483 484 485 486
=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.
487

488 489 490 491 492 493 494 495
=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.

496 497 498 499 500 501 502 503 504
=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>

505 506 507 508 509 510 511
=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.

512 513
=back

514
=head1 DOMAIN COMMANDS
515

516
The following commands manipulate domains directly, as stated
517 518
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.
519

520 521
=over 4

522
=item B<autostart> [I<--disable>] I<domain>
523 524 525

Configure a domain to be automatically started at boot.

E
Eric Blake 已提交
526
The option I<--disable> disables autostarting.
527

528
=item B<console> I<domain> [I<devname>] [I<--safe>] [I<--force>]
529

530 531 532 533
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.
534

535 536 537 538 539 540
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.

541
=item B<create> I<FILE> [I<--console>] [I<--paused>] [I<--autodestroy>]
542

E
Eric Blake 已提交
543 544
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
545 546 547
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.
548 549 550
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
exits.
551 552 553

B<Example>

554
 virsh dumpxml <domain> > domain.xml
O
Osier Yang 已提交
555
 vi domain.xml (or make changes with your other text editor)
G
Guido Günther 已提交
556
 virsh create domain.xml
557 558 559

=item B<define> I<FILE>

560
Define a domain from an XML <file>. The domain definition is registered
E
Eric Blake 已提交
561 562
but not started.  If domain is already running, the changes will take
effect on the next boot.
563

564
=item B<desc> I<domain> [[I<--live>] [I<--config>] |
565 566
              [I<--current>]] [I<--title>] [I<--edit>] [I<--new-desc>
              New description or title message]
567 568 569 570 571 572

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.

Flags I<--live> or I<--config> select whether this command works on live
573 574 575
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
576 577
the description. I<--current> is exclusive and implied if none of these was
specified.
578 579 580 581 582 583

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.

584
If neither of I<--edit> and I<--new-desc> are specified the note or description
585 586
is displayed instead of being modified.

587
=item B<destroy> I<domain> [I<--graceful>]
588

589
Immediately terminate the domain I<domain>.  This doesn't give the domain
L
Luiz Capitulino 已提交
590
OS any chance to react, and it's the equivalent of ripping the power
591
cord out on a physical machine.  In most cases you will want to use
592 593 594
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.
595

596
If I<domain> is transient, then the metadata of any snapshots will
597 598 599 600
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>.

601 602 603 604
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.

605
=item B<domblkstat> I<domain> I<block-device> [I<--human>]
606

607 608
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
609 610
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).
611

612 613 614 615 616 617
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.

J
Ján Tomko 已提交
618
B<Explanation of fields> (fields appear in the following order):
619 620 621 622 623 624 625 626 627 628 629
  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 -->

630 631 632 633
=item B<domifstat> I<domain> I<interface-device>

Get network interface stats for a running domain.

634
=item B<domif-setlink> I<domain> I<interface-device> I<state> [I<--config>]
635 636

Modify link state of the domain's virtual interface. Possible values for
637 638 639
state are "up" and "down. If I<--config> is specified, only the persistent
configuration of the domain is modified, for compatibility purposes,
I<--persistent> is alias of I<--config>.
640
I<interface-device> can be the interface's target name or the MAC address.
641

642 643 644 645 646
=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>.
647

648
I<interface-device> can be the interface's target name or the MAC address.
649

650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
=item B<domiftune> I<domain> I<interface-device>
[[I<--config>] [I<--live>] | [I<--current>]]
[I<--inbound average,peak,burst>]
[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
inbound or outbound bandwidth. I<average,peak,burst> is the same as
in command I<attach-interface>.

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<--current> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

671 672 673 674
=item B<dommemstat> I<domain>

Get memory stats for a running domain.

675
=item B<domblkerror> I<domain>
676 677 678 679 680 681

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.

682 683
=item B<domblkinfo> I<domain> I<block-device>

684 685
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
686 687 688
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).

689 690 691 692 693 694 695 696 697 698
=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.
699

700 701 702 703 704 705 706 707 708
=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.

E
Eric Blake 已提交
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
=item B<blockcommit> I<domain> I<path> [I<bandwidth>]
{[I<base>] | [I<--shallow>]} [I<top>] [I<--delete>]
[I<--wait> [I<--verbose>] [I<--timeout> B<seconds>]]

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
starts; using the I<--delete> flag will remove these files at the successful
completion of the commit operation.

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
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.

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
qemu, it may be non-zero only for an online domain.

E
Eric Blake 已提交
739
=item B<blockcopy> I<domain> I<path> I<dest> [I<bandwidth>] [I<--shallow>]
J
Jiri Denemark 已提交
740
[I<--reuse-external>] [I<--raw>] [I<--wait> [I<--verbose>]
E
Eric Blake 已提交
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
[{I<--pivot> | I<--finish>}] [I<--timeout> B<seconds>] [I<--async>]]

Copy a disk backing image chain to I<dest>. 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 I<dest> must exist and have
contents identical to the resulting backing file (that is, it must
start with contents matching the backing file I<disk> if I<--shallow>
is used, otherwise it must start empty); this option is typically used
to set up a relative backing file name in the destination.

The format of the destination is determined by the first match in the
following list: if I<--raw> is specified, it will be raw; if
I<--reuse-external> is specified, the existing destination is probed
for a format; and in all other cases, the destination format will
match the source format.

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>
will produce periodic status updates.  Using I<--pivot> or I<--finish>
along with I<--wait> will additionally end the job cleanly rather than
leaving things in the mirroring phase.  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.

I<path> specifies fully-qualified path of the disk.
778
I<bandwidth> specifies copying bandwidth limit in MiB/s.
E
Eric Blake 已提交
779

E
Eric Blake 已提交
780
=item B<blockpull> I<domain> I<path> [I<bandwidth>] [I<base>]
J
Jiri Denemark 已提交
781
[I<--wait> [I<--verbose>] [I<--timeout> B<seconds>] [I<--async>]]
E
Eric Blake 已提交
782 783 784 785 786 787 788

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.
789 790 791 792 793 794 795 796 797 798 799

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.
800

801 802 803 804
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).
805
I<bandwidth> specifies copying bandwidth limit in MiB/s.
806

L
Lei Li 已提交
807 808
=item B<blkdeviotune> I<domain> I<device>
[[I<--config>] [I<--live>] | [I<--current>]]
E
Eric Blake 已提交
809 810
[[I<total-bytes-sec>] | [I<read-bytes-sec>] [I<write-bytes-sec>]]
[[I<total-iops-sec>] | [I<read-iops-sec>] [I<write-iops-sec>]]
L
Lei Li 已提交
811 812 813 814 815 816 817 818

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:
E
Eric Blake 已提交
819 820 821 822 823 824 825 826 827
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.

Older versions of virsh only accepted these options with underscore
instead of dash, as in I<--total_bytes_sec>.
L
Lei Li 已提交
828

E
Eric Blake 已提交
829
Bytes and iops values are independent, but setting only one value (such
E
Eric Blake 已提交
830
as --read-bytes-sec) resets the other two in that category to unlimited.
E
Eric Blake 已提交
831
An explicit 0 also clears any limit.  A non-zero value for a given total
L
Lei Li 已提交
832 833 834 835 836 837 838 839 840
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.
Both I<--live> and I<--current> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

E
Eric Blake 已提交
841
=item B<blockjob> I<domain> I<path> { [I<--abort>] [I<--async>] [I<--pivot>] |
842
[I<--info>] | [I<bandwidth>] }
843

844 845
Manage active block operations.  There are three modes: I<--info>,
I<bandwidth>, and I<--abort>; I<--info> is default except that I<--async>
E
Eric Blake 已提交
846
or I<--pivot> implies I<--abort>.
847 848 849 850 851

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).
852

A
Alex Jia 已提交
853
If I<--abort> is specified, the active job on the specified disk will
854
be aborted.  If I<--async> is also specified, this command will return
E
Eric Blake 已提交
855 856 857
immediately, rather than waiting for the cancelation to complete.  If
I<--pivot> is specified, this requests that an active copy job
be pivoted over to the new copy.
858 859 860 861
If I<--info> is specified, the active job information on the specified
disk will be printed.
I<bandwidth> can be used to set bandwidth limit for the active job.

E
Eric Blake 已提交
862
=item B<blockresize> I<domain> I<path> I<size>
863

E
Eric Blake 已提交
864
Resize a block device of domain while the domain is running, I<path>
865 866 867 868 869 870 871 872 873
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).
874

875
=item B<domdisplay> I<domain> [I<--include-password>]
876 877 878 879 880

Output a URI which can be used to connect to the graphical display of the
domain via VNC, SPICE or RDP. If I<--include-password> is specified, the
SPICE channel password will be included in the URI.

881 882 883 884 885 886 887 888 889 890 891 892 893 894
=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.

895
=item B<domhostname> I<domain>
G
Guido Günther 已提交
896 897 898

Returns the hostname of a domain, if the hypervisor makes it available.

899
=item B<dominfo> I<domain>
900 901 902 903 904 905 906

Returns basic information about the domain.

=item B<domuuid> I<domain-name-or-id>

Convert a domain name or id to domain UUID

907
=item B<domid> I<domain-name-or-uuid>
908

909
Convert a domain name (or UUID) to a domain id
910

911
=item B<domjobabort> I<domain>
E
Eric Blake 已提交
912 913 914

Abort the currently running domain job.

915
=item B<domjobinfo> I<domain>
E
Eric Blake 已提交
916 917 918

Returns information about jobs running on a domain.

919
=item B<domname> I<domain-id-or-uuid>
920

921
Convert a domain Id (or UUID) to domain name
922

923
=item B<domstate> I<domain> [I<--reason>]
924

925 926
Returns state about a domain.  I<--reason> tells virsh to also print
reason for the state.
927

928
=item B<domcontrol> I<domain>
929 930 931 932 933

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.

E
Eric Blake 已提交
934 935 936
=item B<domxml-from-native> I<format> I<config>

Convert the file I<config> in the native guest configuration format
937 938 939
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
I<format> argument may be B<xen-xm> or B<xen-sxpr>.
E
Eric Blake 已提交
940 941 942 943

=item B<domxml-to-native> I<format> I<xml>

Convert the file I<xml> in domain XML format to the native guest
944 945 946
configuration format named by I<format>. For QEMU/KVM hypervisor,
the I<format> argument must be B<qemu-argv>. For Xen hypervisor, the
I<format> argument may be B<xen-xm> or B<xen-sxpr>.
E
Eric Blake 已提交
947

948
=item B<dump> I<domain> I<corefilepath> [I<--bypass-cache>]
949
{ [I<--live>] | [I<--crash>] | [I<--reset>] } [I<--verbose>] [I<--memory-only>]
950 951

Dumps the core of a domain to a file for analysis.
952 953 954 955
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.
956 957
If I<--reset> is specified, the domain is reset after successful dump.
Note, these three switches are mutually exclusive.
958 959
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
960 961 962
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.
963

964
The progress may be monitored using B<domjobinfo> virsh command and canceled
965 966 967
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.
968

969 970 971
NOTE: Some hypervisors may require the user to manually ensure proper
permissions on file and path specified by argument I<corefilepath>.

972
=item B<dumpxml> I<domain> [I<--inactive>] [I<--security-info>]
973
[I<--update-cpu>] [I<--migratable>]
974 975 976 977 978

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.
979
Using I<--security-info> will also include security sensitive information
980
in the XML dump. I<--update-cpu> updates domain CPU requirements according to
981 982 983 984
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.
985

986
=item B<edit> I<domain>
987

E
Eric Blake 已提交
988 989
Edit the XML configuration file for a domain, which will affect the
next boot of the guest.
990 991

This is equivalent to:
E
Eric Blake 已提交
992

E
Eric Blake 已提交
993
 virsh dumpxml --inactive --security-info domain > domain.xml
O
Osier Yang 已提交
994
 vi domain.xml (or make changes with your other text editor)
995
 virsh define domain.xml
E
Eric Blake 已提交
996

997 998
except that it does some error checking.

999 1000
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
1001

1002
=item B<managedsave> I<domain> [I<--bypass-cache>]
1003
[{I<--running> | I<--paused>}] [I<--verbose>]
1004

1005
Save and destroy (stop) a running domain, so it can be restarted from the same
1006 1007
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.
1008 1009
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
1010

1011
The progress may be monitored using B<domjobinfo> virsh command and canceled
1012 1013 1014
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.
1015

1016 1017 1018 1019 1020
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.

1021 1022 1023
The B<dominfo> command can be used to query whether a domain currently
has any managed save image.

1024
=item B<managedsave-remove> I<domain>
1025

1026 1027
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.
1028

1029
=item B<maxvcpus> [I<type>]
E
Eric Blake 已提交
1030 1031 1032 1033 1034

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.

1035 1036 1037 1038 1039 1040 1041 1042
=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.

L
liguang 已提交
1043
=item B<migrate> [I<--live>] [I<--offline>] [I<--direct>] [I<--p2p> [I<--tunnelled>]]
1044
[I<--persistent>] [I<--undefinesource>] [I<--suspend>] [I<--copy-storage-all>]
1045
[I<--copy-storage-inc>] [I<--change-protection>] [I<--unsafe>] [I<--verbose>]
1046
I<domain> I<desturi> [I<migrateuri>] [I<dname>]
1047
[I<--timeout> B<seconds>] [I<--xml> B<file>]
1048

L
liguang 已提交
1049
Migrate domain to another host.  Add I<--live> for live migration; <--p2p>
1050
for peer-2-peer migration; I<--direct> for direct migration; or I<--tunnelled>
L
liguang 已提交
1051 1052 1053 1054
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
1055 1056 1057 1058 1059
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).
1060 1061 1062 1063 1064 1065
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
host. 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
1066 1067
used to reject the migration if the hypervisor lacks change protection
support.  I<--verbose> displays the progress of migration.
1068

J
Jiri Denemark 已提交
1069 1070 1071
B<Note>: Individual hypervisors usually do not support all possible types of
migration. For example, QEMU does not support direct migration.

1072 1073 1074 1075 1076 1077 1078 1079
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.

1080 1081 1082
The I<desturi> is the connection URI of the destination host, and
I<migrateuri> is the migration URI, which usually can be omitted.
I<dname> is used for renaming the domain to new name during migration, which
1083 1084 1085 1086 1087
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.
1088

1089 1090
I<--timeout> B<seconds> forces guest to suspend when live migration exceeds
that many seconds, and
W
Wen Congyang 已提交
1091 1092
then the migration will complete offline. It can only be used with I<--live>.

1093 1094 1095
Running migration can be canceled by interrupting virsh (usually using
C<Ctrl-C>) or by B<domjobabort> command sent from another virsh instance.

1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
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

1109
=item B<migrate-setmaxdowntime> I<domain> I<downtime>
1110 1111 1112 1113 1114

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.

1115
=item B<migrate-setspeed> I<domain> I<bandwidth>
1116 1117 1118 1119

Set the maximum migration bandwidth (in Mbps) for a domain which is being
migrated to another host.

1120
=item B<migrate-getspeed> I<domain>
1121 1122 1123

Get the maximum migration bandwidth (in Mbps) for a domain.

H
Hu Tao 已提交
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
=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.

I<mode> can be one of `strict', `interleave' and `preferred'.  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'.

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.

1143
=item B<reboot> I<domain> [I<--mode MODE-LIST>]
1144

1145 1146 1147 1148
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.
1149

1150 1151
The exact behavior of a domain when it reboots is set by the
I<on_reboot> parameter in the domain's XML definition.
1152

1153 1154
By default the hypervisor will try to pick a suitable shutdown
method. To specify an alternative method, the I<--mode> parameter
1155 1156 1157 1158 1159
can specify a comma separated list which includes C<acpi>, C<agent>,
C<initctl> and C<signal>. The order in which drivers will try each
mode is undefined, and not related to the order specified to virsh.
For strict control over ordering, use a single mode at a time and
repeat the command.
1160

1161
=item B<reset> I<domain>
X
Xu He Jie 已提交
1162 1163 1164 1165 1166 1167 1168

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.

1169
=item B<restore> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
1170
[{I<--running> | I<--paused>}]
1171

E
Eric Blake 已提交
1172
Restores a domain from a B<virsh save> state file. See I<save> for more info.
1173

1174 1175 1176
If I<--bypass-cache> is specified, the restore will avoid the file system
cache, although this may slow down the operation.

1177 1178 1179 1180 1181 1182
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.

1183 1184 1185 1186 1187
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.

1188
B<Note>: To avoid corrupting file system contents within the domain, you
E
Eric Blake 已提交
1189 1190 1191
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.
1192

1193
=item B<save> I<domain> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
1194
[{I<--running> | I<--paused>}] [I<--verbose>]
1195

E
Eric Blake 已提交
1196 1197
Saves a running domain (RAM, but not disk state) to a state file so that
it can be restored
1198 1199 1200
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.
1201 1202
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
1203

1204
The progress may be monitored using B<domjobinfo> virsh command and canceled
1205 1206 1207
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.
1208

1209 1210 1211 1212
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.

1213 1214 1215 1216 1217 1218
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.

1219 1220 1221 1222 1223
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.

E
Eric Blake 已提交
1224 1225 1226 1227 1228
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.

1229
=item B<save-image-define> I<file> I<xml> [{I<--running> | I<--paused>}]
1230 1231 1232 1233 1234 1235 1236 1237

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.

1238 1239 1240 1241 1242
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.

1243 1244 1245 1246 1247 1248
=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.

1249
=item B<save-image-edit> I<file> [{I<--running> | I<--paused>}]
1250 1251 1252 1253

Edit the XML configuration associated with a saved state file I<file>
created by the B<save> command.

1254 1255 1256 1257 1258
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.

1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
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>.

1270
=item B<schedinfo> [I<--set> B<parameter=value>] I<domain> [[I<--config>]
1271
[I<--live>] | [I<--current>]]
1272

1273
=item B<schedinfo> [I<--weight> B<number>] [I<--cap> B<number>]
1274
I<domain>
1275

1276 1277
Allows you to show (and set) the domain scheduler parameters. The parameters
available for each hypervisor are:
D
David Jorm 已提交
1278

1279 1280
LXC (posix scheduler) : cpu_shares

1281 1282
QEMU/KVM (posix scheduler): cpu_shares, vcpu_period, vcpu_quota,
emulator_period, emulator_quota
D
David Jorm 已提交
1283 1284 1285 1286 1287

Xen (credit scheduler): weight, cap

ESX (allocation scheduler): reservation, limit, shares

1288 1289 1290 1291
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.

1292 1293
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.
1294 1295
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.
1296 1297 1298

B<Note>: The weight and cap parameters are defined only for the
XEN_CREDIT scheduler and are now I<DEPRECATED>.
1299

1300 1301 1302 1303
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.
1304

1305
=item B<screenshot> I<domain> [I<imagefilepath>] [I<--screen> B<screenID>]
1306 1307 1308 1309 1310 1311 1312 1313

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.

1314
=item B<send-key> I<domain> [I<--codeset> B<codeset>]
1315 1316
[I<--holdtime> B<holdtime>] I<keycode>...

1317
Parse the I<keycode> sequence as keystrokes to send to I<domain>.
1318 1319 1320 1321 1322 1323
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.

1324 1325 1326 1327
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.

1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
=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>
1392 1393 1394
  # send three strokes 'k', 'e', 'y', using xt codeset. these
  # are all pressed simultaneously and may be received by the guest
  # in random order
1395
  virsh send-key dom --codeset xt 37 18 21
1396

1397 1398
  # send one stroke 'right-ctrl+C'
  virsh send-key dom KEY_RIGHTCTRL KEY_C
1399

1400 1401 1402
  # send a tab, held for 1 second
  virsh send-key --holdtime 1000 0xf

1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
=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

1434
=item B<setmem> I<domain> B<size> [[I<--config>] [I<--live>] |
1435
[I<--current>]]
1436

1437 1438 1439
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.
1440 1441 1442 1443
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.
1444

E
Eric Blake 已提交
1445 1446 1447 1448 1449 1450
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).
1451 1452 1453

For Xen, you can only adjust the memory of a running domain if the domain is
paravirtualized or running the PV balloon driver.
1454

1455
=item B<setmaxmem> I<domain> B<size> [[I<--config>] [I<--live>] |
1456
[I<--current>]]
1457

1458 1459 1460 1461
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.
J
Jiri Denemark 已提交
1462
Both I<--live> and I<--config> flags may be given, but I<--current> is
1463 1464
exclusive. If no flag is specified, behavior is different depending
on hypervisor.
1465

1466
This command works for at least the Xen, QEMU/KVM and vSphere/ESX hypervisors.
1467

E
Eric Blake 已提交
1468 1469 1470 1471 1472 1473
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).
1474

1475
=item B<memtune> I<domain> [I<--hard-limit> B<size>]
E
Eric Blake 已提交
1476 1477
[I<--soft-limit> B<size>] [I<--swap-hard-limit> B<size>]
[I<--min-guarantee> B<size>] [[I<--config>] [I<--live>] | [I<--current>]]
E
Eric Blake 已提交
1478 1479 1480 1481

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
1482
QEMU/KVM support I<--hard-limit>, I<--soft-limit>, and I<--swap-hard-limit>.
E
Eric Blake 已提交
1483 1484
I<--min-guarantee> is supported only by ESX hypervisor.  Each of these
limits are scaled integers (see B<NOTES> above), with a default of
1485 1486 1487 1488
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).
1489

1490 1491 1492
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.
J
Jiri Denemark 已提交
1493
Both I<--live> and I<--config> flags may be given, but I<--current> is
1494 1495 1496
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

1497 1498 1499 1500 1501 1502 1503 1504 1505
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.

=over 4

=item I<--hard-limit>

E
Eric Blake 已提交
1506
The maximum memory the guest can use.
1507 1508 1509

=item I<--soft-limit>

E
Eric Blake 已提交
1510
The memory limit to enforce during memory contention.
1511 1512 1513

=item I<--swap-hard-limit>

E
Eric Blake 已提交
1514 1515
The maximum memory plus swap the guest can use.  This has to be more
than hard-limit value provided.
1516 1517 1518

=item I<--min-guarantee>

E
Eric Blake 已提交
1519
The guaranteed minimum memory allocation for the guest.
1520 1521

=back
1522

1523 1524
Specifying -1 as a value for these limits is interpreted as unlimited.

1525
=item B<blkiotune> I<domain> [I<--weight> B<weight>]
1526
[I<--device-weights> B<device-weights>] [[I<--config>]
D
Daniel P. Berrange 已提交
1527
[I<--live>] | [I<--current>]]
1528 1529 1530 1531

Display or set the blkio parameters. QEMU/KVM supports I<--weight>.
I<--weight> is in range [100, 1000].

1532 1533 1534
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.
Each weight is in the range [100, 1000], or the value 0 to remove that
1535 1536 1537
device from per-device listings.  Only the devices listed in the string
are modified; any existing per-device weights for other devices remain
unchanged.
1538

H
Hu Tao 已提交
1539 1540 1541
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.
J
Jiri Denemark 已提交
1542
Both I<--live> and I<--config> flags may be given, but I<--current> is
H
Hu Tao 已提交
1543 1544 1545
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

1546
=item B<setvcpus> I<domain> I<count> [I<--maximum>] [[I<--config>]
D
Daniel P. Berrange 已提交
1547
[I<--live>] | [I<--current>]]
1548

1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
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.
1560

1561 1562 1563
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
specified together if supported by the hypervisor.
1564

1565 1566 1567
If I<--current> is specified, affect the current guest state.

When no flags are given, the I<--live>
1568 1569 1570 1571
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.
E
Eric Blake 已提交
1572

1573 1574 1575
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
used with the I<--config> flag, and not with the I<--live> flag.
E
Eric Blake 已提交
1576

1577
=item B<shutdown> I<domain> [I<--mode MODE-LIST>]
1578 1579

Gracefully shuts down a domain.  This coordinates with the domain OS
1580
to perform graceful shutdown, so there is no guarantee that it will
1581
succeed, and may take a variable length of time depending on what
1582
services must be shutdown in the domain.
1583

1584 1585
The exact behavior of a domain when it shuts down is set by the
I<on_shutdown> parameter in the domain's XML definition.
1586

1587
If I<domain> is transient, then the metadata of any snapshots will
1588 1589 1590 1591
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>.

1592 1593
By default the hypervisor will try to pick a suitable shutdown
method. To specify an alternative method, the I<--mode> parameter
1594 1595 1596 1597 1598
can specify a comma separated list which includes C<acpi>, C<agent>,
C<initctl> and C<signal>. The order in which drivers will try each
mode is undefined, and not related to the order specified to virsh.
For strict control over ordering, use a single mode at a time and
repeat the command.
1599

1600 1601
=item B<start> I<domain-name-or-uuid> [I<--console>] [I<--paused>]
[I<--autodestroy>] [I<--bypass-cache>] [I<--force-boot>]
1602

1603 1604 1605 1606
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.
E
Eric Blake 已提交
1607
If I<--console> is requested, attach to the console after creation.
1608 1609
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
1610 1611
exits.  If I<--bypass-cache> is specified, and managedsave state exists,
the restore will avoid the file system cache, although this may slow
1612 1613
down the operation.  If I<--force-boot> is specified, then any
managedsave state is discarded and a fresh boot occurs.
1614

1615
=item B<suspend> I<domain>
1616 1617 1618

Suspend a running domain. It is kept in memory but won't be scheduled
anymore.
1619

1620
=item B<resume> I<domain>
1621

1622
Moves a domain out of the suspended state.  This will allow a previously
1623
suspended domain to now be eligible for scheduling by the underlying
1624
hypervisor.
1625

1626
=item B<dompmsuspend> I<domain> I<target> [I<--duration>]
1627 1628 1629 1630 1631 1632 1633

Suspend a running domain into one of these states (possible I<target>
values):
    mem equivallent of S3 ACPI state
    disk equivallent of S4 ACPI state
    hybrid RAM is saved to disk but not powered off

1634 1635 1636 1637 1638 1639 1640 1641
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.

1642
=item B<dompmwakeup> I<domain>
1643

1644 1645 1646 1647
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.
1648

1649
=item B<ttyconsole> I<domain>
1650 1651

Output the device used for the TTY console of the domain. If the information
1652
is not available the processes will provide an exit code of 1.
1653

1654
=item B<undefine> I<domain> [I<--managed-save>] [I<--snapshots-metadata>]
1655
[ {I<--storage> B<volumes> | I<--remove-all-storage>} I<--wipe-storage>]
1656

1657 1658 1659 1660
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.

1661
The I<--managed-save> flag guarantees that any managed save image (see
1662 1663 1664
the B<managedsave> command) is also cleaned up.  Without the flag, attempts
to undefine a domain with a managed save image will fail.

1665 1666 1667 1668 1669 1670
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.

1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
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
deleted.
(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.

1688
NOTE: For an inactive domain, the domain name or UUID must be used as the
1689
I<domain>.
1690

1691
=item B<vcpucount> I<domain>  [{I<--maximum> | I<--active>}
1692
{I<--config> | I<--live> | I<--current>}]
E
Eric Blake 已提交
1693 1694

Print information about the virtual cpu counts of the given
1695
I<domain>.  If no flags are specified, all possible counts are
E
Eric Blake 已提交
1696
listed in a table; otherwise, the output is limited to just the
1697 1698 1699
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.
E
Eric Blake 已提交
1700 1701

I<--maximum> requests information on the maximum cap of vcpus that a
1702
domain can add via B<setvcpus>, while I<--active> shows the current
E
Eric Blake 已提交
1703
usage; these two flags cannot both be specified.  I<--config>
1704 1705 1706 1707 1708 1709
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.
Thus, this command always takes exactly zero or two flags.
E
Eric Blake 已提交
1710

1711
=item B<vcpuinfo> I<domain>
1712

1713 1714
Returns basic information about the domain virtual CPUs, like the number of
vCPUs, the running time, the affinity to physical processors.
1715

1716
=item B<vcpupin> I<domain> [I<vcpu>] [I<cpulist>] [[I<--live>]
1717
[I<--config>] | [I<--current>]]
1718

1719 1720 1721 1722 1723
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
1724 1725
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.
1726 1727
If you want to reset vcpupin setting, that is, to pin vcpu all physical cpus,
simply specify 'r' as a cpulist.
1728 1729 1730
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.
1731 1732
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
but I<--current> is exclusive.
1733
If no flag is specified, behavior is different depending on hypervisor.
1734

1735 1736
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".
1737

H
Hu Tao 已提交
1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753
=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.


1754
=item B<vncdisplay> I<domain>
1755

1756
Output the IP address and port number for the VNC display. If the information
1757
is not available the processes will provide an exit code of 1.
1758

1759 1760 1761
=back

=head1 DEVICE COMMANDS
1762 1763

The following commands manipulate devices associated to domains.
1764
The I<domain> can be specified as a short integer, a name or a full UUID.
1765
To better understand the values allowed as options for the command
M
Mark McLoughlin 已提交
1766
reading the documentation at L<http://libvirt.org/formatdomain.html> on the
1767 1768
format of the device sections to get the most accurate set of accepted values.

1769 1770
=over 4

1771
=item B<attach-device> I<domain> I<FILE> [I<--config>]
1772

1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
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
attach taking effect the next time libvirt starts the domain.  For
compatibility purposes, I<--persistent> is an alias of I<--config>.
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>,
needed if the device does not use managed mode.
1785

1786
=item B<attach-disk> I<domain> I<source> I<target>
1787
[I<--driver driver>] [I<--subdriver subdriver>] [I<--cache cache>]
1788
[I<--type type>] [I<--mode mode>] [I<--config>] [I<--sourcetype soucetype>]
1789
[I<--serial serial>] [I<--shareable>] [I<--rawio>] [I<--address address>]
1790
[I<--multifunction>]
1791 1792

Attach a new disk device to the domain.
1793 1794 1795 1796
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
"logical" device name.  I<driver> can be I<file>, I<tap> or I<phy> for the Xen
hypervisor depending on the kind of access; or I<qemu> for the QEMU emulator.
1797 1798 1799 1800 1801 1802 1803 1804 1805
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.
1806
I<mode> can specify the two specific mode I<readonly> or I<shareable>.
1807 1808
I<--config> indicates the changes will affect the next boot of the domain,
for compatibility purposes, I<--persistent> is alias of I<--config>.
1809
I<sourcetype> can indicate the type of source (block|file)
1810 1811
I<cache> can be one of "default", "none", "writethrough", "writeback",
"directsync" or "unsafe".
1812 1813
I<serial> is the serial of disk device. I<shareable> indicates the disk device
is shareable between domains.
1814
I<rawio> indicates the disk needs rawio capability.
1815 1816
I<address> is the address of disk device in the form of pci:domain.bus.slot.function,
scsi:controller.bus.unit or ide:controller.bus.unit.
1817 1818
I<multifunction> indicates specified pci address is a multifunction pci device
address.
1819

1820
=item B<attach-interface> I<domain> I<type> I<source>
1821
[I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>]
1822
[I<--config>] [I<--inbound average,peak,burst>] [I<--outbound average,peak,burst>]
1823 1824

Attach a new network interface to the domain.
1825 1826
I<type> can be either I<network> to indicate a physical network device or
I<bridge> to indicate a bridge to a device.
1827
I<source> indicates the source device.
1828 1829
I<target> allows to indicate the target device in the guest. Names starting
with 'vnet' are considered as auto-generated an hence blanked out.
1830 1831 1832
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.
1833
I<model> allows to specify the model type.
1834 1835
I<--config> indicates the changes will affect the next boot of the domain,
for compatibility purposes, I<--persistent> is alias of I<--config>.
1836 1837 1838
I<inbound> and I<outbound> control the bandwidth of the interface. I<peak>
and I<burst> are optional, so "average,peak", "average,,burst" and
"average" are also legal.
1839

1840 1841 1842 1843
B<Note>: the optional target value is the name of a device to be created
as the back-end on the node. If not provided a device named "vnetN" or "vifN"
will be created automatically.

1844
=item B<detach-device> I<domain> I<FILE> [I<--config>]
1845 1846 1847

Detach a device from the domain, takes the same kind of XML descriptions
as command B<attach-device>.
1848 1849 1850
If I<--config> is specified, alter persistent configuration, effect observed
on next boot, for compatibility purposes, I<--persistent> is alias of
I<--config>.
1851 1852
For passthrough host devices, see also B<nodedev-reattach>, needed if
the device does not use managed mode.
1853

1854
=item B<detach-disk> I<domain> I<target> [I<--config>]
1855 1856 1857

Detach a disk device from a domain. The I<target> is the device as seen
from the domain.
1858 1859 1860
If I<--config> is specified, alter persistent configuration, effect observed
on next boot, for compatibility purposes, I<--persistent> is alias of
I<--config>.
1861

1862
=item B<detach-interface> I<domain> I<type> [I<--mac mac>] [I<--config>]
1863

1864
Detach a network interface from a domain.
1865 1866 1867 1868
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.
1869 1870 1871
If I<--config> is specified, alter persistent configuration, effect observed
on next boot, for compatibility purposes, I<--persistent> is alias of
I<--config>.
1872

1873
=item B<update-device> I<domain> I<file> [I<--config>] [I<--force>]
1874

1875
Update the characteristics of a device associated with I<domain>,
1876 1877 1878 1879 1880 1881 1882 1883
based on the device definition in an XML I<file>.  If the I<--config>
option is used, the changes will take affect the next time libvirt
starts the domain.  For compatibility purposes, I<--persistent> is
alias of I<--config>.  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
L<http://libvirt.org/formatdomain.html#elementsDevices> to learn about
libvirt XML format for a device.
E
Eric Blake 已提交
1884

1885
=item B<change-media> I<domain> I<path> [I<--eject>] [I<--insert>]
O
Osier Yang 已提交
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
[I<--update>] [I<source>] [I<--force>] [[I<--live>] [I<--config>] | [I<--current>]]

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>
specifies the path of the media to be inserted or updated.

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.

1911 1912
=back

1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929
=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
1930 1931 1932 1933
guest domains, nor by multiple active guests at once.  If the
<hostdev> description includes the attribute B<managed='yes'>, and the
hypervisor driver supports it, then the device is in managed mode, and
attempts to use that passthrough device in an active guest will
1934
automatically behave as if B<nodedev-detach> (guest start, device
1935 1936 1937 1938 1939 1940 1941
hot-plug) and B<nodedev-reattach> (guest stop, device hot-unplug) were
called at the right points (currently, qemu does this for PCI devices,
but not USB).  If a 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,
then the host does not regain control of the device without a matching
reattach, even if the guests use the device in managed mode.
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958

=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.

=item B<nodedev-destroy> I<nodedev>

Destroy (stop) a device on the host.  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.

1959
=item B<nodedev-detach> I<nodedev>
1960 1961 1962

Detach I<nodedev> from the host, so that it can safely be used by
guests via <hostdev> passthrough.  This is reversed with
1963
B<nodedev-reattach>, and is done automatically for managed devices.
1964 1965
For compatibility purposes, this command can also be spelled
B<nodedev-dettach>.
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976

=item B<nodedev-dumpxml> I<nodedev>

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
libvirt (such as whether device reset is supported).

=item B<nodedev-list> I<cap> I<--tree>

List all of the devices available on the node that are known by libvirt.
1977 1978 1979 1980 1981 1982
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',
'scsi', 'storage'. 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.
1983 1984 1985
=item B<nodedev-reattach> I<nodedev>

Declare that I<nodedev> is no longer in use by any guests, and that
1986 1987
the host can resume normal use of the device.  This is done
automatically for devices in managed mode, but must be done explicitly
1988
to match any explicit B<nodedev-detach>.
1989 1990 1991 1992 1993 1994 1995 1996 1997 1998

=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

1999
=head1 VIRTUAL NETWORK COMMANDS
2000 2001 2002

The following commands manipulate networks. Libvirt has the capability to
define virtual networks which can then be used by domains and linked to
2003
actual network devices. For more detailed information about this feature
E
Eric Blake 已提交
2004 2005
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,
2006 2007
but the way to name a virtual network is either by its name or UUID.

2008 2009
=over 4

2010
=item B<net-autostart> I<network> [I<--disable>]
2011 2012 2013 2014 2015 2016

Configure a virtual network to be automatically started at boot.
The I<--disable> option disable autostarting.

=item B<net-create> I<file>

2017 2018 2019
Create a virtual network from an XML I<file>, see the documentation at
L<http://libvirt.org/formatnetwork.html> to get a description of the
XML network format used by libvirt.
2020 2021 2022 2023

=item B<net-define> I<file>

Define a virtual network from an XML I<file>, the network is just defined but
2024
not instantiated.
2025 2026 2027

=item B<net-destroy> I<network>

2028 2029
Destroy (stop) a given virtual network specified by its name or UUID. This
takes effect immediately.
2030

2031
=item B<net-dumpxml> I<network> [I<--inactive>]
2032 2033

Output the virtual network information as an XML dump to stdout.
2034 2035
If I<--inactive> is specified, then physical functions are not
expanded into their associated virtual functions.
2036

2037 2038 2039 2040 2041
=item B<net-edit> I<network>

Edit the XML configuration file for a network.

This is equivalent to:
E
Eric Blake 已提交
2042

2043
 virsh net-dumpxml --inactive network > network.xml
O
Osier Yang 已提交
2044
 vi network.xml (or make changes with your other text editor)
E
Eric Blake 已提交
2045 2046
 virsh net-define network.xml

2047 2048
except that it does some error checking.

2049 2050
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
2051

O
Osier Yang 已提交
2052 2053 2054 2055
=item B<net-info> I<network>

Returns basic information about the I<network> object.

2056
=item B<net-list> [I<--inactive> | I<--all>]
2057 2058
                  [I<--persistent>] [<--transient>]
                  [I<--autostart>] [<--no-autostart>]
2059 2060 2061

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
2062 2063 2064 2065 2066 2067 2068 2069 2070
inactive ones will be listed. You may also want to filter the returned networks
by I<--persistent> to list the persitent ones, I<--transient> to list the
transient ones, I<--autostart> to list the ones with autostart enabled, and
I<--no-autostart> to list the ones with autostart disabled.

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.
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087

=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.

L
Laine Stump 已提交
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120
=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".

I<section> is one of ""bridge", "domain", "ip", "ip-dhcp-host",
"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.

2121 2122 2123
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.
L
Laine Stump 已提交
2124 2125 2126
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>.

2127 2128
=back

E
Eric Blake 已提交
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
=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

2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
=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.

E
Eric Blake 已提交
2159 2160 2161 2162 2163 2164 2165
=item B<iface-define> I<file>

Define a host interface from an XML I<file>, the interface is just defined but
not started.

=item B<iface-destroy> I<interface>

2166
Destroy (stop) a given host interface, such as by running "if-down" to
E
Eric Blake 已提交
2167 2168
disable that interface from active use. This takes effect immediately.

2169
=item B<iface-dumpxml> I<interface> [I<--inactive>]
E
Eric Blake 已提交
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189

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>.

2190
=item B<iface-list> [I<--inactive> | I<--all>]
E
Eric Blake 已提交
2191 2192 2193 2194 2195

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.

2196
=item B<iface-name> I<interface>
E
Eric Blake 已提交
2197

2198 2199
Convert a host interface MAC to interface name, if the MAC address is unique
among the host's interfaces.
E
Eric Blake 已提交
2200

2201 2202 2203
I<interface> specifies the interface MAC address.

=item B<iface-mac> I<interface>
E
Eric Blake 已提交
2204 2205 2206

Convert a host interface name to MAC address.

2207 2208 2209
I<interface> specifies the interface name.

=item B<iface-start> I<interface>
E
Eric Blake 已提交
2210 2211 2212

Start a (previously defined) host interface, such as by running "if-up".

2213 2214 2215 2216 2217 2218 2219 2220 2221 2222
=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.

2223
=item B<iface-undefine> I<interface>
E
Eric Blake 已提交
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251

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

E
Eric Blake 已提交
2252 2253 2254 2255 2256 2257 2258
=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
E
Eric Blake 已提交
2259
L<http://libvirt.org/formatstorage.html> . Many of the commands for
E
Eric Blake 已提交
2260 2261 2262 2263
pools are similar to the ones used for domains.

=over 4

2264
=item B<find-storage-pool-sources> I<type> [I<srcSpec>]
E
Eric Blake 已提交
2265 2266 2267 2268 2269

Returns XML describing all storage pools of a given I<type> that could
be found.  If I<srcSpec> is provided, it is a file that contains XML
to further restrict the query for pools.

2270 2271
=item B<find-storage-pool-sources-as> I<type> [I<host>] [I<port>]
[I<initiator>]
E
Eric Blake 已提交
2272 2273

Returns XML describing all storage pools of a given I<type> that could
2274 2275
be found.  If I<host>, I<port>, or I<initiator> are provided, they control
where the query is performed.
E
Eric Blake 已提交
2276

2277
=item B<pool-autostart> I<pool-or-uuid> [I<--disable>]
E
Eric Blake 已提交
2278 2279 2280

Configure whether I<pool> should automatically start at boot.

2281
=item B<pool-build> I<pool-or-uuid> [I<--overwrite>] [I<--no-overwrite>]
E
Eric Blake 已提交
2282 2283 2284

Build a given pool.

2285 2286 2287 2288 2289 2290 2291 2292 2293
Options I<--overwrite> and I<--no-overwrite> can only be used for
B<pool-build> a filesystem pool. If neither of them is specified,
B<pool-build> on a filesystem pool only makes the directory; If
I<--no-overwrite> is specified, it probes to determine if a
filesystem already exists on the target device, returning an error
if exists, or using mkfs to format the target device if not; If
I<--overwrite> is specified, mkfs is always executed, any existed
data on the target device is overwritten unconditionally.

E
Eric Blake 已提交
2294 2295 2296 2297
=item B<pool-create> I<file>

Create and start a pool object from the XML I<file>.

2298 2299 2300
=item B<pool-create-as> I<name> I<--print-xml> I<type> [I<source-host>]
[I<source-path>] [I<source-dev>] [I<source-name>] [<target>]
[I<--source-format format>]
E
Eric Blake 已提交
2301 2302 2303 2304 2305 2306 2307 2308 2309 2310

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
I<type>.

=item B<pool-define> I<file>

Create, but do not start, a pool object from the XML I<file>.

2311 2312 2313
=item B<pool-define-as> I<name> I<--print-xml> I<type> [I<source-host>]
[I<source-path>] [I<source-dev>] [I<source-name>] [<target>]
[I<--source-format format>]
E
Eric Blake 已提交
2314 2315 2316 2317 2318 2319 2320 2321

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>.

=item B<pool-destroy> I<pool-or-uuid>

2322
Destroy (stop) a given I<pool> object. Libvirt will no longer manage the
E
Eric Blake 已提交
2323 2324 2325 2326 2327 2328 2329 2330
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
2331
command, ready for the creation of new storage volumes.
E
Eric Blake 已提交
2332

2333
=item B<pool-dumpxml> [I<--inactive>] I<pool-or-uuid>
E
Eric Blake 已提交
2334 2335

Returns the XML information about the I<pool> object.
2336 2337
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.
E
Eric Blake 已提交
2338 2339 2340 2341 2342 2343 2344 2345

=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
O
Osier Yang 已提交
2346
 vi pool.xml (or make changes with your other text editor)
E
Eric Blake 已提交
2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357
 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.

2358 2359 2360 2361
=item B<pool-list> [I<--inactive>] [I<--all>]
                   [I<--persistent>] [I<--transient>]
                   [I<--autostart>] [I<--no-autostart>]
                   [[I<--details>] [<type>]
E
Eric Blake 已提交
2362

2363 2364
List pool objects known to libvirt.  By default, only active pools
are listed; I<--inactive> lists just the inactive pools, and I<--all>
2365 2366
lists all pools.

2367 2368 2369 2370
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.
2371 2372 2373 2374 2375 2376 2377

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',
'mpath', 'rbd', and 'sheepdog'.

The I<--details> option instructs virsh to additionally
2378
display pool persistence and capacity related information where available.
E
Eric Blake 已提交
2379

2380 2381 2382 2383 2384
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.

E
Eric Blake 已提交
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404
=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>

Start the storage I<pool>, which is previously defined but inactive.

=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>.

2405 2406
=back

2407 2408
=head1 VOLUME COMMANDS

J
Jiri Denemark 已提交
2409 2410
=over 4

2411
=item B<vol-create> I<pool-or-uuid> I<FILE> [I<--prealloc-metadata>]
2412 2413 2414 2415 2416 2417

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.
2418 2419 2420 2421
[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.
2422 2423 2424 2425

B<Example>

 virsh vol-dumpxml --pool storagepool1 appvolume1 > newvolume.xml
O
Osier Yang 已提交
2426
 vi newvolume.xml (or make changes with your other text editor)
2427 2428
 virsh vol-create differentstoragepool newvolume.xml

2429
=item B<vol-create-from> I<pool-or-uuid> I<FILE> [I<--inputpool>
2430
I<pool-or-uuid>] I<vol-name-or-key-or-path> [I<--prealloc-metadata>]
2431 2432 2433 2434 2435 2436 2437

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.
2438 2439 2440 2441
[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.
2442

2443 2444 2445
=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>]
2446
[I<--prealloc-metadata>]
2447 2448 2449 2450 2451

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.
I<name> is the name of the new volume.
E
Eric Blake 已提交
2452 2453 2454 2455
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.
2456
I<--format> I<string> is used in file based storage pools to specify the volume
2457
file format to use; raw, bochs, qcow, qcow2, vmdk, qed.
2458
I<--backing-vol> I<vol-name-or-key-or-path> is the source backing
2459
volume to be used if taking a snapshot of an existing volume.
2460
I<--backing-vol-format> I<string> is the format of the snapshot backing volume;
2461 2462
raw, bochs, qcow, qcow2, qed, vmdk, host_device. These are, however, meant for
file based storage pools.
2463 2464 2465 2466
[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.
2467

2468
=item B<vol-clone> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
2469
I<name> [I<--prealloc-metadata>]
2470 2471 2472

Clone an existing volume.  Less powerful, but easier to type, version of
B<vol-create-from>.
2473 2474
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool to create
the volume in.
2475 2476
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.
2477 2478 2479 2480
[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.
2481

2482
=item B<vol-delete> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
2483 2484

Delete a given volume.
2485 2486
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2487 2488
I<vol-name-or-key-or-path> is the name or key or path of the volume to delete.

2489 2490
=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>
2491 2492

Upload the contents of I<local-file> to a storage volume.
2493 2494
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2495 2496 2497
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
I<--offset> is the position in the storage volume at which to start writing
the data. I<--length> is an upper bound of the amount of data to be uploaded.
J
Ján Tomko 已提交
2498
An error will occur if the I<local-file> is greater than the specified length.
2499

2500 2501
=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>
2502 2503

Download the contents of I<local-file> from a storage volume.
2504 2505
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2506 2507 2508 2509
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
I<--offset> is the position in the storage volume at which to start reading
the data. I<--length> is an upper bound of the amount of data to be downloaded.

2510 2511
=item B<vol-wipe> [I<--pool> I<pool-or-uuid>] [I<--algorithm> I<algorithm>]
I<vol-name-or-key-or-path>
2512

2513 2514 2515
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.
2516
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539
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
               sanitizing removeable and non-removeable rigid
               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.
2540

2541 2542 2543
B<Note>: The availability of algorithms may be limited by the version
of the C<scrub> binary installed on the host.

2544
=item B<vol-dumpxml> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
2545 2546

Output the volume information as an XML dump to stdout.
2547 2548 2549
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.
2550

2551
=item B<vol-info> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
2552 2553

Returns basic information about the given storage volume.
2554 2555 2556
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.
2557

2558
=item B<vol-list> [I<--pool> I<pool-or-uuid>] [I<--details>]
2559 2560 2561

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.
2562 2563
The I<--details> option instructs virsh to additionally display volume
type and capacity related information where available.
2564

2565
=item B<vol-pool> [I<--uuid>] I<vol-key-or-path>
2566

2567 2568 2569 2570
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.
2571

2572
=item B<vol-path> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key>
2573 2574

Return the path for a given volume.
2575 2576
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2577 2578 2579 2580 2581 2582 2583
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.

2584
=item B<vol-key> [I<--pool> I<pool-or-uuid>] I<vol-name-or-path>
2585

2586
Return the volume key for a given volume.
2587 2588 2589
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.
2590

2591 2592 2593 2594 2595 2596 2597 2598 2599
=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
E
Eric Blake 已提交
2600 2601 2602 2603 2604 2605
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.
2606

2607 2608
=back

2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645
=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.

2646 2647
=item B<secret-list> [I<--ephemeral>] [I<--no-ephemeral>]
                     [I<--private>] [I<--no-private>]
2648

2649 2650 2651 2652
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.
2653 2654 2655

=back

2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667
=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

2668
=item B<snapshot-create> I<domain> [I<xmlfile>] {[I<--redefine> [I<--current>]]
E
Eric Blake 已提交
2669
| [I<--no-metadata>] [I<--halt>] [I<--disk-only>] [I<--reuse-external>]
2670
[I<--quiesce>] [I<--atomic>] [I<--live>]}
2671 2672

Create a snapshot for domain I<domain> with the properties specified in
2673
I<xmlfile>.  Normally, the only properties settable for a domain snapshot
2674 2675
are the <name> and <description> elements, as well as <disks> if
I<--disk-only> is given; the rest of the fields are
2676 2677 2678 2679
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>.

2680 2681 2682
If I<--halt> is specified, the domain will be left in an inactive state
after the snapshot is created.

2683 2684 2685 2686 2687 2688 2689 2690
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.

2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706
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).

2707 2708
If I<--reuse-external> is specified, and the snapshot XML requests an
external snapshot with a destination of an existing file, then the
E
Eric Blake 已提交
2709
destination must exist, and is reused; otherwise, a snapshot is refused
2710 2711
to avoid losing contents of the existing files.

2712 2713 2714 2715 2716
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.

E
Eric Blake 已提交
2717 2718 2719 2720 2721 2722
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.

2723 2724 2725 2726
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.

2727 2728 2729 2730 2731
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).

2732
=item B<snapshot-create-as> I<domain> {[I<--print-xml>]
E
Eric Blake 已提交
2733
| [I<--no-metadata>] [I<--halt>] [I<--reuse-external>]} [I<name>]
2734 2735
[I<description>] [I<--disk-only> [I<--quiesce>]] [I<--atomic>]
[[I<--live>] [I<--memspec> B<memspec>]] [I<--diskspec>] B<diskspec>]...
2736 2737 2738

Create a snapshot for domain I<domain> with the given <name> and
<description>; if either value is omitted, libvirt will choose a
E
Eric Blake 已提交
2739 2740
value.  If I<--print-xml> is specified, then XML appropriate for
I<snapshot-create> is output, rather than actually creating a snapshot.
2741
Otherwise, if I<--halt> is specified, the domain will be left in an
2742 2743 2744
inactive state after the snapshot is created, and if I<--disk-only>
is specified, the snapshot will not include vm state.

2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
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
type can be B<none>, B<internal>, or B<external>.  To include a literal
comma in B<file=name>, escape it with a second comma.

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
2755 2756
form B<disk[,snapshot=type][,driver=type][,file=name]>.  To include a
literal comma in B<disk> or in B<file=name>, escape it with a second
J
Ján Tomko 已提交
2757
comma.  A literal I<--diskspec> must precede each B<diskspec> unless
2758 2759
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"
2760 2761 2762 2763
results in the following XML:
  <disk name='vda' snapshot='external'>
    <source file='/path/to,new'/>
  </disk>
2764

2765 2766
If I<--reuse-external> is specified, and the domain XML or I<diskspec>
option requests an external snapshot with a destination of an existing
E
Eric Blake 已提交
2767
file, then the destination must exist, and is reused; otherwise, a
2768 2769
snapshot is refused to avoid losing contents of the existing files.

2770 2771 2772 2773 2774
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.

2775 2776 2777 2778 2779 2780
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>.

E
Eric Blake 已提交
2781 2782 2783 2784 2785 2786
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.

2787 2788 2789 2790
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.

E
Eric Blake 已提交
2791
=item B<snapshot-current> I<domain> {[I<--name>] | [I<--security-info>]
2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
| [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.
2802

2803
=item B<snapshot-edit> I<domain> [I<snapshotname>] [I<--current>]
2804
{[I<--rename>] | [I<--clone>]}
2805 2806

Edit the XML configuration file for I<snapshotname> of a domain.  If
2807 2808 2809 2810
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.
2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821

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>.
2822

2823 2824 2825 2826 2827 2828 2829 2830
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.

E
Eric Blake 已提交
2831 2832 2833 2834 2835
=item B<snapshot-info> I<domain> {I<snapshot> | I<--current>}

Output basic information about a named <snapshot>, or the current snapshot
with I<--current>.

2836
=item B<snapshot-list> I<domain> [{I<--parent> | I<--roots> | I<--tree>}]
2837
[{[I<--from>] B<snapshot> | I<--current>} [I<--descendants>]]
E
Eric Blake 已提交
2838
[I<--metadata>] [I<--no-metadata>] [I<--leaves>] [I<--no-leaves>]
2839
[I<--inactive>] [I<--active>] [I<--disk-only>] [I<--internal>] [I<--external>]
2840

2841 2842
List all of the available snapshots for the given domain, defaulting
to show columns for the snapshot name, creation time, and domain state.
2843

2844
If I<--parent> is specified, add a column to the output table giving
2845 2846 2847 2848
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
just snapshot names.  These three options are mutually exclusive.
2849

2850
If I<--from> is provided, filter the list to snapshots which are
2851 2852
children of the given B<snapshot>; or if I<--current> is provided,
start at the current snapshot.  When used in isolation or with
2853 2854 2855
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
2856 2857 2858
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.
2859

2860
If I<--leaves> is specified, the list will be filtered to just
E
Eric Blake 已提交
2861 2862 2863 2864 2865
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).
2866
Filtering options are not compatible with I<--tree>.
2867

2868 2869 2870
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
E
Eric Blake 已提交
2871 2872 2873
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.
2874

2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888
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.

2889
=item B<snapshot-dumpxml> I<domain> I<snapshot> [I<--security-info>]
2890 2891

Output the snapshot XML for the domain's snapshot named I<snapshot>.
2892
Using I<--security-info> will also include security sensitive information.
2893
Use B<snapshot-current> to easily access the XML of the current snapshot.
2894

2895
=item B<snapshot-parent> I<domain> {I<snapshot> | I<--current>}
E
Eric Blake 已提交
2896

2897 2898
Output the name of the parent snapshot, if any, for the given
I<snapshot>, or for the current snapshot with I<--current>.
E
Eric Blake 已提交
2899

2900 2901
=item B<snapshot-revert> I<domain> {I<snapshot> | I<--current>}
[{I<--running> | I<--paused>}] [I<--force>]
2902

2903 2904
Revert the given domain to the snapshot specified by I<snapshot>, or to
the current snapshot with I<--current>.  Be aware
2905
that this is a destructive action; any changes in the domain since the last
2906
snapshot was taken will be lost.  Also note that the state of the domain after
2907
snapshot-revert is complete will be the state of the domain at the time
2908 2909
the original snapshot was taken.

2910 2911 2912 2913 2914 2915 2916 2917
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.

E
Eric Blake 已提交
2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933
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.

2934
=item B<snapshot-delete> I<domain> {I<snapshot> | I<--current>} [I<--metadata>]
2935
[{I<--children> | I<--children-only>}]
2936

2937 2938
Delete the snapshot for the domain named I<snapshot>, or the current
snapshot with I<--current>.  If this snapshot
2939 2940
has child snapshots, changes from this snapshot will be merged into the
children.  If I<--children> is passed, then delete this snapshot and any
2941 2942 2943 2944 2945 2946 2947 2948
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.
2949 2950 2951

=back

2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992
=head1 NWFILTER COMMMANDS

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
O
Osier Yang 已提交
2993
 vi myfilter.xml (or make changes with your other text editor)
2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004
 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

3005 3006 3007 3008 3009 3010 3011 3012 3013
=head1 QEMU-SPECIFIC COMMANDS

NOTE: Use of the following commands is B<strongly> discouraged.  They
can cause libvirt to become confused and do the wrong thing on subsequent
operations.  Once you have used this command, please do not report
problems to the libvirt developers; the reports will be ignored.

=over 4

3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036
=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
issues with the guest ABI changing upon migration, and hotunplug
may not work.

3037 3038
=item B<qemu-monitor-command> I<domain> { [I<--hmp>] | [I<--pretty>] }
I<command>...
3039 3040

Send an arbitrary monitor command I<command> to domain I<domain> through the
3041 3042 3043
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
3044 3045 3046 3047
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.
3048

3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060
=item B<qemu-agent-command> I<domain> [I<--timeout> I<seconds> | I<--async> | I<--block>] I<command>...

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.

=back

3061 3062
=head1 ENVIRONMENT

3063 3064 3065 3066 3067
The following environment variables can be set to alter the behaviour
of C<virsh>

=over 4

S
Supriya Kannery 已提交
3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095
=item VIRSH_DEBUG=<0 to 4>

Turn on verbose debugging of virsh commands. Valid levels are

=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.

=item VIRSH_LOG_FILE=C<LOGFILE>

The file to log virsh debug messages.

3096 3097 3098
=item VIRSH_DEFAULT_CONNECT_URI

The hypervisor to connect to by default. Set this to a URI, in the same
3099 3100 3101 3102 3103 3104 3105 3106 3107 3108
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.
3109

3110
=item VISUAL
E
Eric Blake 已提交
3111

E
Eric Blake 已提交
3112
The editor to use by the B<edit> and related options.
E
Eric Blake 已提交
3113

3114 3115
=item EDITOR

E
Eric Blake 已提交
3116
The editor to use by the B<edit> and related options, if C<VISUAL>
3117 3118
is not set.

3119
=item LIBVIRT_DEBUG=LEVEL
3120

3121
Turn on verbose debugging of all libvirt API calls. Valid levels are
3122

3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153
=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
3154

3155
  Please refer to the AUTHORS file distributed with libvirt.
3156

3157
  Based on the xm man page by:
3158 3159 3160
  Sean Dague <sean at dague dot net>
  Daniel Stekloff <dsteklof at us dot ibm dot com>

3161
=head1 COPYRIGHT
3162

3163 3164
Copyright (C) 2005, 2007-2010 Red Hat, Inc., and the authors listed in the
libvirt AUTHORS file.
3165 3166

=head1 LICENSE
3167

3168 3169 3170 3171 3172 3173
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
3174

3175 3176
L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>, L<virt-df(1)>,
L<http://www.libvirt.org/>
3177

3178
=cut