virsh.pod 102.1 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

E
Eric Blake 已提交
27
  virsh [OPTION]... <command> <domain-id> [ARG]...
28

29
Where I<command> is one of the commands listed below, I<domain-id>
30
is the numeric domain id, or the domain name (which will be internally
L
Lai Jiangshan 已提交
31
translated to domain id), and I<ARGS> are command specific
32
options.  There are a few exceptions to this rule in the cases where
33
the command in question acts on all domains, the entire machine,
34
or directly on the xen hypervisor.  Those exceptions will be clear for
35 36
each of those commands.

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

E
Eric Blake 已提交
48 49 50 51 52 53 54 55 56
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 已提交
57
=item B<-v>, B<--version[=short]>
E
Eric Blake 已提交
58

59 60 61
Ignore all other arguments, and prints the version of the libvirt library
virsh is coming from

E
Eric Blake 已提交
62
=item B<-V>, B<--version=long>
63 64 65

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 已提交
66 67 68 69 70 71 72 73 74

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

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

95 96 97 98 99
=item B<-e>, B<--escape> I<string>

Set alternative escape sequence for I<console> command. By default,
telnet's B<^]> is used.

E
Eric Blake 已提交
100 101
=back

102 103
=head1 NOTES

E
Eric Blake 已提交
104 105 106
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>.
107

108
Most B<virsh> commands require root privileges to run due to the
109 110 111
communications channels used to talk to the hypervisor.  Running as
non root will return an error.

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

118
=head1 GENERIC COMMANDS
119

120
The following commands are generic i.e. not specific to a domain.
121 122 123

=over 4

124
=item B<help> [I<command-or-group>]
125

126 127 128 129 130 131 132 133 134 135 136 137 138 139
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
140 141
     qemu-attach                    Attach to existing QEMU process
     qemu-monitor-command           QEMU Monitor Command
E
Eric Blake 已提交
142
     sysinfo                        print the hypervisor sysinfo
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
     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
161

162
=item B<quit>, B<exit>
163

164
quit this interactive terminal
165

166
=item B<version>
167

168
Will print out the major version info about what this built from.
169

170
=over 4
171

172
B<Example>
173

174
B<virsh> version
175

176
Compiled against library: libvir 0.0.6
177

178
Using library: libvir 0.0.6
179

180
Using API: Xen 3.0.0
181

182
Running hypervisor: Xen 3.0.0
183

184
=back
185

186
=item B<cd> [I<directory>]
P
Paolo Bonzini 已提交
187 188 189 190 191 192 193 194 195 196 197

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.

198
=item B<connect> I<URI> [I<--readonly>]
199

E
Eric Blake 已提交
200 201 202 203 204 205
(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:
206

207
=over 4
208

209
=item xen:///
210

211
this is used to connect to the local Xen hypervisor, this is the default
212

213
=item qemu:///system
214

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

217 218
=item qemu:///session

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

D
David Jorm 已提交
221 222 223 224
=item lxc:///

connect to a local linux container

225
=back
226

227
For remote access see the documentation page on how to make URIs.
228
The I<--readonly> option allows for read-only connection
229

230 231 232 233 234 235 236 237
=item B<uri>

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

=item B<hostname>

Print the hypervisor hostname.

E
Eric Blake 已提交
238 239 240 241
=item B<sysinfo>

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

242
=item B<nodeinfo>
243

244
Returns basic information about the node, like number and type of CPU,
J
Jiri Denemark 已提交
245 246 247
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.
248

249
=item B<nodecpustats> [I<cpu>] [I<--percent>]
250 251 252 253 254 255

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.

256
=item B<nodememstats> [I<cell>]
257 258 259 260

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

261 262 263 264 265 266 267
=item B<nodesuspend> [I<target>] [I<duration>] [I<flags>]

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
specified by the 'duration' parameter.

268
=item B<capabilities>
269 270 271 272 273

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

278 279 280 281
=item B<inject-nmi> I<domain-id>

Inject NMI to the guest.

282
=item B<list> [I<--inactive> | I<--all>] [I<--managed-save>] [I<--title>]
283 284
              { [I<--table>] | I<--name> | I<--uuid> } [I<--persistent>]
              [I<--transient>]
285

286
Prints information about existing domains.  If no options are
287
specified it prints out information about running domains.
288 289 290 291

An example format for the list is as follows:

B<virsh> list
292
 Id Name                 State
293

294
----------------------------------
295

296 297
  0 Domain-0             running
  2 fedora               paused
298 299


300
Name is the name of the domain.  ID the domain numeric id.
301
State is the run state (see below).
302

303 304
B<STATES>

305
The State field lists 7 states for a domain, and which ones the
306
current domain is in.
307

308 309
=over 4

310
=item B<running>
311 312 313

The domain is currently running on a CPU

314
=item B<idle>
315

316
The domain is idle, and not running or runnable.  This can be caused
317 318 319
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.

320
=item B<paused>
321 322

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

327
=item B<shutdown>
328

329
The domain is in the process of shutting down, i.e. the guest operating system
330
has been notified and should be in the process of stopping its operations
331
gracefully.
332

333 334 335 336 337
=item B<shut off>

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

338
=item B<crashed>
339 340 341

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

344
=item B<dying>
345 346 347 348 349 350

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

=back

E
Eric Blake 已提交
351 352
If I<--managed-save> is specified, then domains that have managed save
state (only possible if they are in the B<shut off> state) will
353 354 355 356 357 358 359 360 361 362 363 364 365 366
instead show as B<saved> in the listing. This flag is usable only with the
default I<--table> output.

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.

Flag I<--persistent> specifies that persistent domains should be printed.
Similarly I<--transient> enables output of transient domains. These flags
may be combined. Default behavior is as though both were specified. (Note that
if any of these flags is specified, the check for the persistence state is done
and may fail. If none of these flags is specified, the check is skipped.)
E
Eric Blake 已提交
367

368
If I<--title> is specified, then the domain note is printed. The output then
369 370
the output looks as follows. This flag is usable only with the default
I<--table> output.
371

P
Peter Krempa 已提交
372
B<virsh> list --title
373 374 375 376 377
 Id Name                 State      Title
-----------------------------------------------
  0 Domain-0             running    Mailserver 1
  2 fedora               paused

378
=item B<freecell> [B<cellno> | I<--all>]
379 380

Prints the available amount of memory on the machine or within a
E
Eric Blake 已提交
381 382
NUMA cell if I<cellno> is provided.  If I<--all> is provided instead
of I<--cellno>, then show the information on all NUMA cells.
383

384 385 386 387 388 389 390 391
=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.

392 393 394 395 396 397 398 399 400
=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>

401 402 403 404 405 406 407
=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.

408 409
=back

410
=head1 DOMAIN COMMANDS
411

412 413
The following commands manipulate domains directly, as stated
previously most commands take domain-id as the first parameter. The
O
Osier Yang 已提交
414
I<domain-id> can be specified as a short integer, a name or a full UUID.
415

416 417
=over 4

418
=item B<autostart> [I<--disable>] I<domain-id>
419 420 421

Configure a domain to be automatically started at boot.

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

424
=item B<console> I<domain-id> [I<devname>] [I<--safe>] [I<--force>]
425

426 427 428 429
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.
430

431 432 433 434 435 436
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.

437
=item B<create> I<FILE> [I<--console>] [I<--paused>] [I<--autodestroy>]
438

E
Eric Blake 已提交
439 440
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
441 442 443
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.
444 445 446
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
exits.
447 448 449

B<Example>

450
 virsh dumpxml <domain-id> > domain.xml
O
Osier Yang 已提交
451
 vi domain.xml (or make changes with your other text editor)
452
 virsh create < domain.xml
453 454 455

=item B<define> I<FILE>

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

460 461
=item B<desc> [[I<--live>] [I<--config>] | [I<--current>]] [I<--title>]
              [I<--edit>] [I<--new-desc> New description or title message]
462 463 464 465 466 467

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
468 469 470
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
471 472
the description. I<--current> is exclusive and implied if none of these was
specified.
473 474 475 476 477 478 479 480 481

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.

If neither of I<--edit> and I<--new_desc> are specified the note or description
is displayed instead of being modified.

482
=item B<destroy> I<domain-id> [I<--graceful>]
483 484

Immediately terminate the domain domain-id.  This doesn't give the domain
L
Luiz Capitulino 已提交
485
OS any chance to react, and it's the equivalent of ripping the power
486
cord out on a physical machine.  In most cases you will want to use
487 488 489
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.
490

491 492 493 494 495
If I<domain-id> is transient, then the metadata of any snapshots will
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>.

496 497 498 499
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.

500
=item B<domblkstat> I<domain> I<block-device> [I<--human>]
501

502 503
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
504 505
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).
506

507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
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.

B<Explanation of fields> (fields appear in the folowing order):
  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 -->

525 526 527 528
=item B<domifstat> I<domain> I<interface-device>

Get network interface stats for a running domain.

529
=item B<domif-setlink> I<domain> I<interface-device> I<state> I<--persistent>
530 531 532 533

Modify link state of the domain's virtual interface. Possible values for
state are "up" and "down. If --persistent is specified, only the persistent
configuration of the domain is modified.
534
I<interface-device> can be the interface's target name or the MAC address.
535

536
=item B<domif-getlink> I<domain> I<interface-device> I<--persistent>
537 538 539

Query link state of the domain's virtual interface. If --persistent
is specified, query the persistent configuration.
540
I<interface-device> can be the interface's target name or the MAC address.
541

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
=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.

563 564 565 566
=item B<dommemstat> I<domain>

Get memory stats for a running domain.

567 568 569 570 571 572 573
=item B<domblkerror> I<domain-id>

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.

574 575
=item B<domblkinfo> I<domain> I<block-device>

576 577
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
578 579 580
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).

581 582 583 584 585 586 587 588 589 590
=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.
591

592 593 594 595 596 597 598 599 600
=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.

601 602 603 604 605 606 607 608 609 610
=item B<blockpull> I<domain> I<path> [I<bandwidth>]

Populate a disk from its backing image. Once all data from its backing
image has been pulled, the disk no longer depends on the backing image.
It pulls data for the entire disk in the background, the process of the
operation can be checked with B<blockjob>.

I<path> specifies fully-qualified path of the disk.
I<bandwidth> specifies copying bandwidth limit in Mbps.

L
Lei Li 已提交
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
=item B<blkdeviotune> I<domain> I<device>
[[I<--config>] [I<--live>] | [I<--current>]]
[[I<total_bytes_sec>] | [I<read_bytes_sec>] [I<write_bytes_sec>]]
[[I<total_iops_sec>] | [I<read_iops_sec>] [I<write_iops_sec>]]

Set or query the block disk io parameters for a block device of I<domain>.
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:
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.

E
Eric Blake 已提交
630 631 632
Bytes and iops values are independent, but setting only one value (such
as --read_bytes_sec) resets the other two in that category to unlimited.
An explicit 0 also clears any limit.  A non-zero value for a given total
L
Lei Li 已提交
633 634 635 636 637 638 639 640 641
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.

642 643 644 645 646
=item B<blockjob> I<domain> I<path> [I<--abort>] [I<--info>] [I<bandwidth>]

Manage active block operations.

I<path> specifies fully-qualified path of the disk.
A
Alex Jia 已提交
647
If I<--abort> is specified, the active job on the specified disk will
648 649 650 651 652
be aborted.
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.

653 654 655 656 657 658
=item B<blockresize> I<domain> I<--path> I<--size>

Resize a block device of domain while the domain is running, I<--path>
specifies the absolute path of the block device, I<--size> specifies the
new size in kilobytes

659
=item B<dominfo> I<domain-id>
660 661 662 663 664 665 666

Returns basic information about the domain.

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

Convert a domain name or id to domain UUID

667
=item B<domid> I<domain-name-or-uuid>
668

669
Convert a domain name (or UUID) to a domain id
670

671
=item B<domjobabort> I<domain-id-or-uuid>
E
Eric Blake 已提交
672 673 674 675 676 677 678

Abort the currently running domain job.

=item B<domjobinfo> I<domain-id-or-uuid>

Returns information about jobs running on a domain.

679
=item B<domname> I<domain-id-or-uuid>
680

681
Convert a domain Id (or UUID) to domain name
682

683
=item B<domstate> I<domain-id> [I<--reason>]
684

685 686
Returns state about a domain.  I<--reason> tells virsh to also print
reason for the state.
687

688 689 690 691 692 693
=item B<domcontrol> I<domain-id>

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 已提交
694 695 696
=item B<domxml-from-native> I<format> I<config>

Convert the file I<config> in the native guest configuration format
697 698 699
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 已提交
700 701 702 703

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

Convert the file I<xml> in domain XML format to the native guest
704 705 706
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 已提交
707

708
=item B<dump> I<domain-id> I<corefilepath> [I<--bypass-cache>]
709
{ [I<--live>] | [I<--crash>] | [I<--reset>] } [I<--verbose>]
710 711

Dumps the core of a domain to a file for analysis.
712 713 714 715
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.
716 717
If I<--reset> is specified, the domain is reset after successful dump.
Note, these three switches are mutually exclusive.
718 719
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
720

721
The progress may be monitored using B<domjobinfo> virsh command and canceled
722 723 724
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.
725

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

729 730
=item B<dumpxml> I<domain-id> [I<--inactive>] [I<--security-info>]
[I<--update-cpu>]
731 732 733 734 735

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.
736
Using I<--security-info> will also include security sensitive information
737 738
in the XML dump. I<--update-cpu> updates domain CPU requirements according to
host CPU.
739

740 741
=item B<edit> I<domain-id>

E
Eric Blake 已提交
742 743
Edit the XML configuration file for a domain, which will affect the
next boot of the guest.
744 745

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

E
Eric Blake 已提交
747
 virsh dumpxml --inactive --security-info domain > domain.xml
O
Osier Yang 已提交
748
 vi domain.xml (or make changes with your other text editor)
749
 virsh define domain.xml
E
Eric Blake 已提交
750

751 752
except that it does some error checking.

753 754
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
755

756
=item B<managedsave> I<domain-id> [I<--bypass-cache>]
757
[{I<--running> | I<--paused>}] [I<--verbose>]
758

759
Save and destroy (stop) a running domain, so it can be restarted from the same
760 761
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.
762 763
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
764

765
The progress may be monitored using B<domjobinfo> virsh command and canceled
766 767 768
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.
769

770 771 772 773 774
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.

775 776 777
The B<dominfo> command can be used to query whether a domain currently
has any managed save image.

778 779
=item B<managedsave-remove> I<domain-id>

780 781
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.
782

783
=item B<maxvcpus> [I<type>]
E
Eric Blake 已提交
784 785 786 787 788

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.

789
=item B<migrate> [I<--live>] [I<--direct>] [I<--p2p> [I<--tunnelled>]]
790
[I<--persistent>] [I<--undefinesource>] [I<--suspend>] [I<--copy-storage-all>]
791
[I<--copy-storage-inc>] [I<--change-protection>] [I<--unsafe>] [I<--verbose>]
792 793
I<domain-id> I<desturi> [I<migrateuri>] [I<dname>]
[I<--timeout> B<seconds>] [I<--xml> B<file>]
794 795 796

Migrate domain to another host.  Add I<--live> for live migration; I<--p2p>
for peer-2-peer migration; I<--direct> for direct migration; or I<--tunnelled>
797
for tunnelled migration.  I<--persistent> leaves the domain persistent on
798 799 800 801 802
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).
803 804 805 806 807 808
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
809 810
used to reject the migration if the hypervisor lacks change protection
support.  I<--verbose> displays the progress of migration.
811

812 813 814 815 816 817 818 819
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.

820 821 822
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
823 824 825 826 827
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.
828

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

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

836 837 838 839 840 841 842 843 844 845 846 847 848
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

849 850 851 852 853 854
=item B<migrate-setmaxdowntime> I<domain-id> I<downtime>

Set maximum tolerable downtime for a domain which is being live-migrated to
another host.  The I<downtime> is a number of milliseconds the guest is allowed
to be down at the end of live migration.

855 856 857 858 859
=item B<migrate-setspeed> I<domain-id> I<bandwidth>

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

860 861 862 863
=item B<migrate-getspeed> I<domain-id>

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

H
Hu Tao 已提交
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
=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.

883
=item B<reboot> I<domain-id> [I<--mode acpi|agent>]
884 885 886 887 888 889

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.

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

893 894 895 896
By default the hypervisor will try to pick a suitable shutdown
method. To specify an alternative method, the I<--mode> parameter
can specify C<acpi> or C<agent>.

X
Xu He Jie 已提交
897 898 899 900 901 902 903 904
=item B<reset> I<domain-id>

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.

905
=item B<restore> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
906
[{I<--running> | I<--paused>}]
907

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

910 911 912
If I<--bypass-cache> is specified, the restore will avoid the file system
cache, although this may slow down the operation.

913 914 915 916 917 918
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.

919 920 921 922 923
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.

924
B<Note>: To avoid corrupting file system contents within the domain, you
E
Eric Blake 已提交
925 926 927
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.
928

929
=item B<save> I<domain-id> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
930
[{I<--running> | I<--paused>}] [I<--verbose>]
931

E
Eric Blake 已提交
932 933
Saves a running domain (RAM, but not disk state) to a state file so that
it can be restored
934 935 936
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.
937 938
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
939

940
The progress may be monitored using B<domjobinfo> virsh command and canceled
941 942 943
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.
944

945 946 947 948
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.

949 950 951 952 953 954
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.

955 956 957 958 959
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 已提交
960 961 962 963 964
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.

965
=item B<save-image-define> I<file> I<xml> [{I<--running> | I<--paused>}]
966 967 968 969 970 971 972 973

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.

974 975 976 977 978
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.

979 980 981 982 983 984
=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.

985
=item B<save-image-edit> I<file> [{I<--running> | I<--paused>}]
986 987 988 989

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

990 991 992 993 994
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.

995 996 997 998 999 1000 1001 1002 1003 1004 1005
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>.

1006 1007
=item B<schedinfo> [I<--set> B<parameter=value>] I<domain-id> [[I<--config>]
[I<--live>] | [I<--current>]]
1008

1009
=item B<schedinfo> [I<--weight> B<number>] [I<--cap> B<number>]
1010
I<domain-id>
1011

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

1015 1016 1017
LXC (posix scheduler) : cpu_shares

QEMU/KVM (posix scheduler): cpu_shares, vcpu_period, vcpu_quota
D
David Jorm 已提交
1018 1019 1020 1021 1022

Xen (credit scheduler): weight, cap

ESX (allocation scheduler): reservation, limit, shares

1023 1024 1025 1026
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.

1027 1028
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.
1029 1030
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.
1031 1032 1033

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

1035
B<Note>: The vcpu_period parameter has a valid value range of 1000-1000000 or
1036 1037 1038
0, and the vcpu_quota parameter has 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.
1039

1040
=item B<screenshot> I<domain-id> [I<imagefilepath>] [I<--screen> B<screenID>]
1041 1042 1043 1044 1045 1046 1047 1048

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.

1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
=item B<send-key> I<domain-id> [I<--codeset> B<codeset>]
[I<--holdtime> B<holdtime>] I<keycode>...

Parse the I<keycode> sequence as keystrokes to send to I<domain-id>.
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.

=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>
  # send three strokes 'k', 'e', 'y', using xt codeset
  virsh send-key dom --codeset xt 37 18 21
  # send one stroke 'right-ctrl+C'
  virsh send-key dom KEY_RIGHTCTRL KEY_C
  # send a tab, held for 1 second
  virsh send-key --holdtime 1000 0xf

1130 1131
=item B<setmem> I<domain-id> B<kilobytes> [[I<--config>] [I<--live>] |
[I<--current>]]
1132

1133 1134 1135
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.
1136 1137 1138 1139
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.
1140 1141

Some hypervisors require a larger granularity than kilobytes, and requests
1142 1143 1144
that are not an even multiple will be rounded up.  For example, vSphere/ESX
rounds the parameter up unless the kB argument is evenly divisible by 1024
(that is, the kB argument happens to represent megabytes).
1145 1146 1147

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

1149 1150
=item B<setmaxmem> I<domain-id> B<kilobytes> [[I<--config>] [I<--live>] |
[I<--current>]]
1151

1152 1153 1154 1155
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 已提交
1156
Both I<--live> and I<--config> flags may be given, but I<--current> is
1157 1158
exclusive. If no flag is specified, behavior is different depending
on hypervisor.
1159

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

1162 1163 1164 1165 1166
Some hypervisors require a larger granularity than kilobytes, rounding up
requests that are not an even multiple of the desired amount.  vSphere/ESX
is one of these, requiring the parameter to be evenly divisible by 4MB.  For
vSphere/ESX, 263168 (257MB) would be rounded up because it's not a multiple
of 4MB, while 266240 (260MB) is valid without rounding.
1167

1168

1169 1170 1171
=item B<memtune> I<domain-id> [I<--hard-limit> B<kilobytes>]
[I<--soft-limit> B<kilobytes>] [I<--swap-hard-limit> B<kilobytes>]
[I<--min-guarantee> B<kilobytes>] [[I<--config>] [I<--live>] | [I<--current>]]
E
Eric Blake 已提交
1172 1173 1174 1175

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
1176
QEMU/KVM support I<--hard-limit>, I<--soft-limit>, and I<--swap-hard-limit>.
1177
I<--min-guarantee> is supported only by ESX hypervisor.
1178

1179 1180 1181
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 已提交
1182
Both I<--live> and I<--config> flags may be given, but I<--current> is
1183 1184 1185
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
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>

The maximum memory the guest can use.  The units for this value are kilobytes
(i.e. blocks of 1024 bytes).

=item I<--soft-limit>

The memory limit to enforce during memory contention.  The units for this
value are kilobytes (i.e. blocks of 1024 bytes).

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

The maximum memory plus swap the guest can use.  The units for this value are
kilobytes (i.e. blocks of 1024 bytes).  This has to be more than hard-limit
value provided.

=item I<--min-guarantee>

The guaranteed minimum memory allocation for the guest.  The units for this
value are kilobytes (i.e. blocks of 1024 bytes).

=back
1215

1216 1217
Specifying -1 as a value for these limits is interpreted as unlimited.

1218 1219
=item B<blkiotune> I<domain-id> [I<--weight> B<weight>]
[I<--device-weights> B<device-weights>] [[I<--config>]
D
Daniel P. Berrange 已提交
1220
[I<--live>] | [I<--current>]]
1221 1222 1223 1224

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

1225 1226 1227
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
1228 1229 1230
device from per-device listings.  Only the devices listed in the string
are modified; any existing per-device weights for other devices remain
unchanged.
1231

H
Hu Tao 已提交
1232 1233 1234
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 已提交
1235
Both I<--live> and I<--config> flags may be given, but I<--current> is
H
Hu Tao 已提交
1236 1237 1238
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

1239
=item B<setvcpus> I<domain-id> I<count> [I<--maximum>] [[I<--config>]
D
Daniel P. Berrange 已提交
1240
[I<--live>] | [I<--current>]]
1241

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
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.
1253

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

1258 1259 1260
If I<--current> is specified, affect the current guest state.

When no flags are given, the I<--live>
1261 1262 1263 1264
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 已提交
1265

1266 1267 1268
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 已提交
1269

1270
=item B<shutdown> I<domain-id> [I<--mode acpi|agent>]
1271 1272

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

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

1280 1281 1282 1283 1284
If I<domain-id> is transient, then the metadata of any snapshots will
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>.

1285 1286 1287 1288
By default the hypervisor will try to pick a suitable shutdown
method. To specify an alternative method, the I<--mode> parameter
can specify C<acpi> or C<agent>.

1289
=item B<start> I<domain-name> [I<--console>] [I<--paused>] [I<--autodestroy>]
1290
[I<--bypass-cache>] [I<--force-boot>]
1291

1292 1293 1294 1295
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 已提交
1296
If I<--console> is requested, attach to the console after creation.
1297 1298
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
1299 1300
exits.  If I<--bypass-cache> is specified, and managedsave state exists,
the restore will avoid the file system cache, although this may slow
1301 1302
down the operation.  If I<--force-boot> is specified, then any
managedsave state is discarded and a fresh boot occurs.
1303

1304 1305 1306 1307
=item B<suspend> I<domain-id>

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

=item B<resume> I<domain-id>

1311
Moves a domain out of the suspended state.  This will allow a previously
1312
suspended domain to now be eligible for scheduling by the underlying
1313
hypervisor.
1314

1315
=item B<dompmsuspend> I<domain-id> I<target>
1316 1317 1318 1319 1320 1321 1322

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

1323 1324 1325 1326 1327 1328
=item B<dompmwakeup> I<domain-id>

Wakeup a domain suspended by dompmsuspend command. Injects a wakeup
into the guest that previously used dompmsuspend, rather than waiting
for the previously requested duration (if any) to elapse.

1329 1330 1331
=item B<ttyconsole> I<domain-id>

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

E
Eric Blake 已提交
1334
=item B<undefine> I<domain-id> [I<--managed-save>] [I<--snapshots-metadata>]
1335
[ {I<--storage> B<volumes> | I<--remove-all-storage>} I<--wipe-storage>]
1336

1337 1338 1339 1340
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.

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

1345 1346 1347 1348 1349 1350
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.

1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
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.

1368 1369
NOTE: For an inactive domain, the domain name or UUID must be used as the
I<domain-id>.
1370

1371 1372
=item B<vcpucount> I<domain-id>  [{I<--maximum> | I<--active>}
{I<--config> | I<--live> | I<--current>}]
E
Eric Blake 已提交
1373 1374 1375 1376

Print information about the virtual cpu counts of the given
I<domain-id>.  If no flags are specified, all possible counts are
listed in a table; otherwise, the output is limited to just the
1377 1378 1379
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 已提交
1380 1381

I<--maximum> requests information on the maximum cap of vcpus that a
1382
domain can add via B<setvcpus>, while I<--active> shows the current
E
Eric Blake 已提交
1383
usage; these two flags cannot both be specified.  I<--config>
1384 1385 1386 1387 1388 1389
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 已提交
1390

1391
=item B<vcpuinfo> I<domain-id>
1392

1393 1394
Returns basic information about the domain virtual CPUs, like the number of
vCPUs, the running time, the affinity to physical processors.
1395

1396 1397
=item B<vcpupin> I<domain-id> [I<vcpu>] [I<cpulist>] [[I<--live>]
[I<--config>] | [I<--current>]]
1398

1399 1400 1401 1402 1403
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
1404 1405
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.
1406 1407
If you want to reset vcpupin setting, that is, to pin vcpu all physical cpus,
simply specify 'r' as a cpulist.
1408 1409 1410
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.
1411 1412
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
but I<--current> is exclusive.
1413
If no flag is specified, behavior is different depending on hypervisor.
1414

1415 1416
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".
1417

1418
=item B<vncdisplay> I<domain-id>
1419

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

1423 1424 1425
=back

=head1 DEVICE COMMANDS
1426 1427

The following commands manipulate devices associated to domains.
O
Osier Yang 已提交
1428
The domain-id can be specified as a short integer, a name or a full UUID.
1429
To better understand the values allowed as options for the command
M
Mark McLoughlin 已提交
1430
reading the documentation at L<http://libvirt.org/formatdomain.html> on the
1431 1432
format of the device sections to get the most accurate set of accepted values.

1433 1434
=over 4

1435 1436 1437 1438
=item B<attach-device> I<domain-id> I<FILE>

Attach a device to the domain, using a device definition in an XML file.
See the documentation to learn about libvirt XML format for a device.
E
Eric Blake 已提交
1439 1440
For cdrom and floppy devices, this command only replaces the media within
the single existing device; consider using B<update-device> for this usage.
1441 1442
For passthrough host devices, see also B<nodedev-dettach>, needed if
the device does not use managed mode.
1443

1444 1445 1446
=item B<attach-disk> I<domain-id> I<source> I<target>
[I<--driver driver>] [I<--subdriver subdriver>] [I<--cache cache>]
[I<--type type>] [I<--mode mode>] [I<--persistent>] [I<--sourcetype soucetype>]
1447
[I<--serial serial>] [I<--shareable>] [I<--rawio>] [I<--address address>]
1448
[I<--multifunction>]
1449 1450 1451

Attach a new disk device to the domain.
I<source> and I<target> are paths for the files and devices.
1452 1453
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.
E
Eric Blake 已提交
1454 1455 1456
I<type> can indicate 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.
1457
I<mode> can specify the two specific mode I<readonly> or I<shareable>.
1458 1459
I<persistent> indicates the changes will affect the next boot of the domain.
I<sourcetype> can indicate the type of source (block|file)
1460 1461
I<cache> can be one of "default", "none", "writethrough", "writeback",
"directsync" or "unsafe".
1462 1463
I<serial> is the serial of disk device. I<shareable> indicates the disk device
is shareable between domains.
1464
I<rawio> indicates the disk needs rawio capability.
1465 1466
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.
1467 1468
I<multifunction> indicates specified pci address is a multifunction pci device
address.
1469

1470 1471
=item B<attach-interface> I<domain-id> I<type> I<source>
[I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>]
1472
[I<--persistent>] [I<--inbound average,peak,burst>] [I<--outbound average,peak,burst>]
1473 1474

Attach a new network interface to the domain.
1475 1476
I<type> can be either I<network> to indicate a physical network device or
I<bridge> to indicate a bridge to a device.
1477 1478 1479 1480 1481
I<source> indicates the source device.
I<target> allows to indicate the target device in the guest.
I<mac> allows to specify the MAC address of the network interface.
I<script> allows to specify a path to a script handling a bridge instead of
the default one.
1482 1483
I<model> allows to specify the model type.
I<persistent> indicates the changes will affect the next boot of the domain.
1484 1485 1486
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.
1487

1488 1489 1490 1491
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.

1492 1493 1494 1495
=item B<detach-device> I<domain-id> I<FILE>

Detach a device from the domain, takes the same kind of XML descriptions
as command B<attach-device>.
1496 1497
For passthrough host devices, see also B<nodedev-reattach>, needed if
the device does not use managed mode.
1498 1499 1500 1501 1502 1503

=item B<detach-disk> I<domain-id> I<target>

Detach a disk device from a domain. The I<target> is the device as seen
from the domain.

1504
=item B<detach-interface> I<domain-id> I<type> [I<--mac mac>]
1505

1506
Detach a network interface from a domain.
1507 1508 1509 1510
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.
1511

1512
=item B<update-device> I<domain-id> I<file> [I<--persistent>] [I<--force>]
1513 1514 1515 1516 1517 1518 1519

Update the characteristics of a device associated with I<domain-id>, based on
the device definition in an XML I<file>.  If the I<--persistent> option is
used, the changes will affect the next boot of the domain. 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 to learn about libvirt
XML format for a device.
E
Eric Blake 已提交
1520

O
Osier Yang 已提交
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
=item B<change-media> I<domain-id> I<path> [I<--eject>] [I<--insert>]
[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.

1547 1548
=back

1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
=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
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
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
automatically behave as if B<nodedev-dettach> (guest start, device
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.
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598

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

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

Detach I<nodedev> from the host, so that it can safely be used by
guests via <hostdev> passthrough.  This is reversed with
1599
B<nodedev-reattach>, and is done automatically for managed devices.
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617

=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.
If I<cap> is used, the list is filtered to show only the nodes that
include the given capability.  If I<--tree> is used, the output is
formatted in a tree representing parents of each node.

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

Declare that I<nodedev> is no longer in use by any guests, and that
1618 1619 1620
the host can resume normal use of the device.  This is done
automatically for devices in managed mode, but must be done explicitly
to match any explicit B<nodedev-dettach>.
1621 1622 1623 1624 1625 1626 1627 1628 1629 1630

=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

1631
=head1 VIRTUAL NETWORK COMMANDS
1632 1633 1634

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

1640 1641
=over 4

1642
=item B<net-autostart> I<network> [I<--disable>]
1643 1644 1645 1646 1647 1648 1649

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

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

Create a virtual network from an XML I<file>, see the documentation to get
1650
a description of the XML network format used by libvirt.
1651 1652 1653 1654

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

Define a virtual network from an XML I<file>, the network is just defined but
1655
not instantiated.
1656 1657 1658

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

1659 1660
Destroy (stop) a given virtual network specified by its name or UUID. This
takes effect immediately.
1661

1662
=item B<net-dumpxml> I<network> [I<--inactive>]
1663 1664

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

1668 1669 1670 1671 1672
=item B<net-edit> I<network>

Edit the XML configuration file for a network.

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

1674
 virsh net-dumpxml network > network.xml
O
Osier Yang 已提交
1675
 vi network.xml (or make changes with your other text editor)
E
Eric Blake 已提交
1676 1677
 virsh net-define network.xml

1678 1679
except that it does some error checking.

1680 1681
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
1682

O
Osier Yang 已提交
1683 1684 1685 1686
=item B<net-info> I<network>

Returns basic information about the I<network> object.

1687
=item B<net-list> [I<--inactive> | I<--all>]
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708

Returns the list of active networks, if I<--all> is specified this will also
include defined but inactive networks, if I<--inactive> is specified only the
inactive ones will be listed.

=item B<net-name> I<network-UUID>

Convert a network UUID to network name.

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

Start a (previously defined) inactive network.

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

Undefine the configuration for an inactive network.

=item B<net-uuid> I<network-name>

Convert a network name to network UUID.

1709 1710
=back

E
Eric Blake 已提交
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
=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

1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
=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 已提交
1741 1742 1743 1744 1745 1746 1747
=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>

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

1751
=item B<iface-dumpxml> I<interface> [I<--inactive>]
E
Eric Blake 已提交
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771

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

1772
=item B<iface-list> [I<--inactive> | I<--all>]
E
Eric Blake 已提交
1773 1774 1775 1776 1777

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.

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

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

1783 1784 1785
I<interface> specifies the interface MAC address.

=item B<iface-mac> I<interface>
E
Eric Blake 已提交
1786 1787 1788

Convert a host interface name to MAC address.

1789 1790 1791
I<interface> specifies the interface name.

=item B<iface-start> I<interface>
E
Eric Blake 已提交
1792 1793 1794

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

1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
=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.

1805
=item B<iface-undefine> I<interface>
E
Eric Blake 已提交
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833

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 已提交
1834 1835 1836 1837 1838 1839 1840
=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 已提交
1841
L<http://libvirt.org/formatstorage.html> . Many of the commands for
E
Eric Blake 已提交
1842 1843 1844 1845
pools are similar to the ones used for domains.

=over 4

1846
=item B<find-storage-pool-sources> I<type> [I<srcSpec>]
E
Eric Blake 已提交
1847 1848 1849 1850 1851

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.

1852 1853
=item B<find-storage-pool-sources-as> I<type> [I<host>] [I<port>]
[I<initiator>]
E
Eric Blake 已提交
1854 1855

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

1859
=item B<pool-autostart> I<pool-or-uuid> [I<--disable>]
E
Eric Blake 已提交
1860 1861 1862

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

1863
=item B<pool-build> I<pool-or-uuid> [I<--overwrite>] [I<--no-overwrite>]
E
Eric Blake 已提交
1864 1865 1866

Build a given pool.

1867 1868 1869 1870 1871 1872 1873 1874 1875
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 已提交
1876 1877 1878 1879
=item B<pool-create> I<file>

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

1880 1881 1882
=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 已提交
1883 1884 1885 1886 1887 1888 1889 1890 1891 1892

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

1893 1894 1895
=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 已提交
1896 1897 1898 1899 1900 1901 1902 1903

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>

1904
Destroy (stop) a given I<pool> object. Libvirt will no longer manage the
E
Eric Blake 已提交
1905 1906 1907 1908 1909 1910 1911 1912
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
1913
command, ready for the creation of new storage volumes.
E
Eric Blake 已提交
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925

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

Returns the XML information about the I<pool> object.

=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 已提交
1926
 vi pool.xml (or make changes with your other text editor)
E
Eric Blake 已提交
1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937
 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.

1938
=item B<pool-list> [I<--inactive> | I<--all>] [I<--details>]
E
Eric Blake 已提交
1939 1940 1941

List pool objects known to libvirt.  By default, only pools in use by
active domains are listed; I<--inactive> lists just the inactive
1942 1943 1944
pools, and I<--all> lists all pools. The I<--details> option instructs
virsh to additionally display pool persistence and capacity related
information where available.
E
Eric Blake 已提交
1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965

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

1966 1967
=back

1968 1969
=head1 VOLUME COMMANDS

J
Jiri Denemark 已提交
1970 1971
=over 4

1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
=item B<vol-create> I<pool-or-uuid> I<FILE>

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.

B<Example>

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

1986
=item B<vol-create-from> I<pool-or-uuid> I<FILE> [I<--inputpool>
1987 1988 1989 1990 1991 1992 1993 1994 1995
I<pool-or-uuid>] I<vol-name-or-key-or-path>

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.

1996 1997 1998
=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>]
1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009

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.
I<capacity> is the size of the volume to be created, with optional k, M, G, or
T suffix.
I<--allocation> I<size> is the initial size to be allocated in the volume, with
optional k, M, G, or T suffix.
I<--format> I<string> is used in file based storage pools to specify the volume
file format to use; raw, bochs, qcow, qcow2, vmdk.
2010
I<--backing-vol> I<vol-name-or-key-or-path> is the source backing
2011
volume to be used if taking a snapshot of an existing volume.
2012 2013
I<--backing-vol-format> I<string> is the format of the snapshot backing volume;
raw, bochs, qcow, qcow2, vmdk, host_device.
2014

2015 2016
=item B<vol-clone> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
I<name>
2017 2018 2019

Clone an existing volume.  Less powerful, but easier to type, version of
B<vol-create-from>.
2020 2021
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool to create
the volume in.
2022 2023 2024
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.

2025
=item B<vol-delete> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
2026 2027

Delete a given volume.
2028 2029
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2030 2031
I<vol-name-or-key-or-path> is the name or key or path of the volume to delete.

2032 2033
=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>
2034 2035

Upload the contents of I<local-file> to a storage volume.
2036 2037
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2038 2039 2040 2041 2042
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.
An error will occurr if the I<local-file> is greater than the specified length.

2043 2044
=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>
2045 2046

Download the contents of I<local-file> from a storage volume.
2047 2048
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2049 2050 2051 2052
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.

2053 2054
=item B<vol-wipe> [I<--pool> I<pool-or-uuid>] [I<--algorithm> I<algorithm>]
I<vol-name-or-key-or-path>
2055

2056 2057 2058
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.
2059
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
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.
2083

2084 2085 2086
B<Note>: The availability of algorithms may be limited by the version
of the C<scrub> binary installed on the host.

2087
=item B<vol-dumpxml> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
2088 2089

Output the volume information as an XML dump to stdout.
2090 2091 2092
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.
2093

2094
=item B<vol-info> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
2095 2096

Returns basic information about the given storage volume.
2097 2098 2099
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.
2100

2101
=item B<vol-list> [I<--pool> I<pool-or-uuid>] [I<--details>]
2102 2103 2104

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

2108
=item B<vol-pool> [I<--uuid>] I<vol-key-or-path>
2109

2110 2111 2112 2113
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.
2114

2115
=item B<vol-path> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key>
2116 2117

Return the path for a given volume.
2118 2119
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
2120 2121 2122 2123 2124 2125 2126
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.

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

2129
Return the volume key for a given volume.
2130 2131 2132
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.
2133

2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144
=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
the volume will fail unless I<--shrink> is present.

2145 2146
=back

2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189
=head1 SECRET COMMMANDS

The following commands manipulate "secrets" (e.g. passwords, passphrases and
encryption keys).  Libvirt can store secrets independently from their use, and
other objects (e.g. volumes or domains) can refer to the secrets for encryption
or possibly other uses.  Secrets are identified using an UUID.  See
L<http://libvirt.org/formatsecret.html> for documentation of the XML format
used to represent properties of secrets.

=over 4

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

Create a secret with the properties specified in I<file>, with no associated
secret value.  If I<file> does not specify a UUID, choose one automatically.
If I<file> specifies an UUID of an existing secret, replace its properties by
properties defined in I<file>, without affecting the secret value.

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

Output properties of I<secret> (specified by its UUID) as an XML dump to stdout.

=item B<secret-set-value> I<secret> I<base64>

Set the value associated with I<secret> (specified by its UUID) to the value
Base64-encoded value I<base64>.

=item B<secret-get-value> I<secret>

Output the value associated with I<secret> (specified by its UUID) to stdout,
encoded using Base64.

=item B<secret-undefine> I<secret>

Delete a I<secret> (specified by its UUID), including the associated value, if
any.

=item B<secret-list>

Output a list of UUIDs of known secrets to stdout.

=back

2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
=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

2202
=item B<snapshot-create> I<domain> [I<xmlfile>] {[I<--redefine> [I<--current>]]
E
Eric Blake 已提交
2203
| [I<--no-metadata>] [I<--halt>] [I<--disk-only>] [I<--reuse-external>]
2204
[I<--quiesce>]}
2205 2206

Create a snapshot for domain I<domain> with the properties specified in
2207
I<xmlfile>.  Normally, the only properties settable for a domain snapshot
2208 2209
are the <name> and <description> elements, as well as <disks> if
I<--disk-only> is given; the rest of the fields are
2210 2211 2212 2213
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>.

2214 2215 2216
If I<--halt> is specified, the domain will be left in an inactive state
after the snapshot is created.

2217 2218 2219 2220 2221 2222 2223 2224
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.

2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240
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).

2241 2242 2243 2244 2245
If I<--reuse-external> is specified, and the snapshot XML requests an
external snapshot with a destination of an existing file, then the
existing file is truncated and reused; otherwise, a snapshot is refused
to avoid losing contents of the existing files.

2246 2247 2248 2249 2250
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.

2251 2252 2253 2254 2255
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).

2256
=item B<snapshot-create-as> I<domain> {[I<--print-xml>]
2257
| [I<--no-metadata>] [I<--halt>] [I<--reuse-existing>]} [I<name>]
2258 2259
[I<description>] [I<--disk-only> [I<--quiesce>]
[[I<--diskspec>] B<diskspec>]...]
2260 2261 2262

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 已提交
2263 2264
value.  If I<--print-xml> is specified, then XML appropriate for
I<snapshot-create> is output, rather than actually creating a snapshot.
2265
Otherwise, if I<--halt> is specified, the domain will be left in an
2266 2267 2268 2269 2270 2271 2272 2273
inactive state after the snapshot is created, and if I<--disk-only>
is specified, the snapshot will not include vm state.

The I<--disk-only> flag is used to request a disk-only snapshot.  When
this flag is in use, the command can also take additional I<diskspec>
arguments to add <disk> elements to the xml.  Each <diskspec> is in the
form B<disk[,snapshot=type][,driver=type][,file=name]>.  To include a
literal comma in B<disk> or in B<file=name>, escape it with a second
2274 2275 2276
comma.  A literal I<--diskspec> must preceed each B<diskspec> unless
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"
2277 2278 2279 2280
results in the following XML:
  <disk name='vda' snapshot='external'>
    <source file='/path/to,new'/>
  </disk>
2281

2282 2283 2284 2285 2286
If I<--reuse-external> is specified, and the domain XML or I<diskspec>
option requests an external snapshot with a destination of an existing
file, then the existing file is truncated and reused; otherwise, a
snapshot is refused to avoid losing contents of the existing files.

2287 2288 2289 2290 2291
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.

2292 2293 2294 2295 2296 2297
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 已提交
2298
=item B<snapshot-current> I<domain> {[I<--name>] | [I<--security-info>]
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308
| [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.
2309

2310
=item B<snapshot-edit> I<domain> [I<snapshotname>] [I<--current>]
2311
{[I<--rename>] | [I<--clone>]}
2312 2313

Edit the XML configuration file for I<snapshotname> of a domain.  If
2314 2315 2316 2317
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.
2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328

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

2330 2331 2332 2333 2334 2335 2336 2337
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.

2338
=item B<snapshot-list> I<domain> [{I<--parent> | I<--roots> | I<--tree>}]
2339 2340
[{[I<--from>] B<snapshot> | I<--current>} [I<--descendants>]]
[I<--metadata>] [I<--leaves>]
2341

2342 2343
List all of the available snapshots for the given domain, defaulting
to show columns for the snapshot name, creation time, and domain state.
2344

2345
If I<--parent> is specified, add a column to the output table giving
2346 2347 2348 2349
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.
2350

2351
If I<--from> is provided, filter the list to snapshots which are
2352 2353
children of the given B<snapshot>; or if I<--current> is provided,
start at the current snapshot.  When used in isolation or with
2354 2355 2356 2357 2358
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
with I<--roots>.

2359 2360 2361 2362
If I<--leaves> is specified, the list will be filtered to just
snapshots that have no children.  This option is not compatible
with I<--tree>.

2363 2364 2365 2366 2367 2368
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
a transient domain.

=item B<snapshot-dumpxml> I<domain> I<snapshot> [I<--security-info>]
2369 2370

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

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

2376 2377
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 已提交
2378

2379 2380
=item B<snapshot-revert> I<domain> {I<snapshot> | I<--current>}
[{I<--running> | I<--paused>}] [I<--force>]
2381

2382 2383
Revert the given domain to the snapshot specified by I<snapshot>, or to
the current snapshot with I<--current>.  Be aware
2384
that this is a destructive action; any changes in the domain since the last
2385
snapshot was taken will be lost.  Also note that the state of the domain after
2386
snapshot-revert is complete will be the state of the domain at the time
2387 2388
the original snapshot was taken.

2389 2390 2391 2392 2393 2394 2395 2396
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 已提交
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412
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.

2413
=item B<snapshot-delete> I<domain> {I<snapshot> | I<--current>} [I<--metadata>]
2414
[{I<--children> | I<--children-only>}]
2415

2416 2417
Delete the snapshot for the domain named I<snapshot>, or the current
snapshot with I<--current>.  If this snapshot
2418 2419
has child snapshots, changes from this snapshot will be merged into the
children.  If I<--children> is passed, then delete this snapshot and any
2420 2421 2422 2423 2424 2425 2426 2427
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.
2428 2429 2430

=back

2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
=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 已提交
2472
 vi myfilter.xml (or make changes with your other text editor)
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483
 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

2484 2485 2486 2487 2488 2489 2490 2491 2492
=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

2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515
=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.

2516
=item B<qemu-monitor-command> I<domain> [I<--hmp>] I<command>...
2517 2518

Send an arbitrary monitor command I<command> to domain I<domain> through the
2519 2520 2521
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
2522 2523 2524
the result will also be converted back from QMP.  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.
2525 2526 2527

=back

2528 2529
=head1 ENVIRONMENT

2530 2531 2532 2533 2534
The following environment variables can be set to alter the behaviour
of C<virsh>

=over 4

S
Supriya Kannery 已提交
2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562
=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.

2563 2564 2565 2566 2567
=item VIRSH_DEFAULT_CONNECT_URI

The hypervisor to connect to by default. Set this to a URI, in the same
format as accepted by the B<connect> option.

2568
=item VISUAL
E
Eric Blake 已提交
2569

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

2572 2573
=item EDITOR

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

2577
=item LIBVIRT_DEBUG=LEVEL
2578

2579
Turn on verbose debugging of all libvirt API calls. Valid levels are
2580

2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611
=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
2612

2613
  Please refer to the AUTHORS file distributed with libvirt.
2614

2615
  Based on the xm man page by:
2616 2617 2618
  Sean Dague <sean at dague dot net>
  Daniel Stekloff <dsteklof at us dot ibm dot com>

2619
=head1 COPYRIGHT
2620

2621 2622
Copyright (C) 2005, 2007-2010 Red Hat, Inc., and the authors listed in the
libvirt AUTHORS file.
2623 2624

=head1 LICENSE
2625

2626 2627 2628 2629 2630 2631
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
2632

2633 2634
L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>, L<virt-df(1)>,
L<http://www.libvirt.org/>
2635

2636
=cut