virsh.pod 201.5 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
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
P
Peter Krempa 已提交
22
providing a long term stable C API.  It currently supports Xen, QEMU,
23
KVM, LXC, OpenVZ, VirtualBox and VMware ESX.
24

25
The basic structure of most virsh usage is:
26

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

29 30 31 32 33 34 35 36 37 38
Where I<command> is one of the commands listed below; I<domain> is the
numeric domain id, or the domain name, or the domain UUID; and I<ARGS>
are command specific options.  There are a few exceptions to this rule
in the cases where the command in question acts on all domains, the
entire machine, or directly on the xen hypervisor.  Those exceptions
will be clear for each of those commands.  Note: it is permissible to
give numeric names to domains, however, doing so will result in a
domain that can only be identified by domain id. In other words, if a
numeric value is supplied it will be interpreted as a domain id, not
as a name.
39

L
Lai Jiangshan 已提交
40 41 42 43 44 45 46 47 48
The B<virsh> program can be used either to run one I<COMMAND> by giving the
command and its arguments on the shell command line, or a I<COMMAND_STRING>
which is a single shell argument consisting of multiple I<COMMAND> actions
and their arguments joined with whitespace, and separated by semicolons
between commands.  Within I<COMMAND_STRING>, virsh understands the
same single, double, and backslash escapes as the shell, although you must
add another layer of shell escaping in creating the single shell argument.
If no command is given in the command line, B<virsh> will then start a minimal
interpreter waiting for your commands, and the B<quit> command will then exit
49
the program.
50

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

=over 4

=item B<-c>, B<--connect> I<URI>

Connect to the specified I<URI>, as if by the B<connect> command,
instead of the default connection.

=item B<-d>, B<--debug> I<LEVEL>

Enable debug messages at integer I<LEVEL> and above.  I<LEVEL> can
63
range from 0 to 4 (default).  See the documentation of B<VIRSH_DEBUG>
64
environment variable below for the description of each I<LEVEL>.
E
Eric Blake 已提交
65

66 67 68 69 70 71 72 73 74 75 76
=item B<-e>, B<--escape> I<string>

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

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

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

77 78 79 80 81 82 83 84 85 86 87 88
=item B<-k>, B<--keepalive-interval> I<INTERVAL>

Set an I<INTERVAL> (in seconds) for sending keepalive messages to
check whether connection to the server is still alive.  Setting the
interval to 0 disables client keepalive mechanism.

=item B<-K>, B<--keepalive-count> I<COUNT>

Set a number of times keepalive message can be sent without getting an
answer from the server without marking the connection dead.  There is
no effect to this setting in case the I<INTERVAL> is set to 0.

E
Eric Blake 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
=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.

106
=item B<-v>, B<--version[=short]>
107

108 109 110 111 112 113 114
Ignore all other arguments, and prints the version of the libvirt library
virsh is coming from

=item B<-V>, B<--version=long>

Ignore all other arguments, and prints the version of the libvirt library
virsh is coming from and which options and driver are compiled in.
115

E
Eric Blake 已提交
116 117
=back

118 119
=head1 NOTES

E
Eric Blake 已提交
120 121 122
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>.
123

124
Most B<virsh> commands require root privileges to run due to the
125 126 127
communications channels used to talk to the hypervisor.  Running as
non root will return an error.

128
Most B<virsh> commands act synchronously, except maybe shutdown,
L
Luiz Capitulino 已提交
129
setvcpus and setmem. In those cases the fact that the B<virsh>
130 131 132
program returned, may not mean the action is complete and you
must poll periodically to detect that the guest completed the
operation.
133

E
Eric Blake 已提交
134 135 136 137 138 139
B<virsh> strives for backward compatibility.  Although the B<help>
command only lists the preferred usage of a command, if an older
version of B<virsh> supported an alternate spelling of a command or
option (such as I<--tunnelled> instead of I<--tunneled>), then
scripts using that older spelling will continue to work.

E
Eric Blake 已提交
140 141 142 143
Several B<virsh> commands take an optionally scaled integer; if no
scale is provided, then the default is listed in the command (for
historical reasons, some commands default to bytes, while other
commands default to kibibytes).  The following case-insensitive
J
Ján Tomko 已提交
144
suffixes can be used to select a specific scale:
E
Eric Blake 已提交
145 146 147 148 149 150 151 152 153 154 155 156 157 158
  b, byte  byte      1
  KB       kilobyte  1,000
  k, KiB   kibibyte  1,024
  MB       megabyte  1,000,000
  M, MiB   mebibyte  1,048,576
  GB       gigabyte  1,000,000,000
  G, GiB   gibibyte  1,073,741,824
  TB       terabyte  1,000,000,000,000
  T, TiB   tebibyte  1,099,511,627,776
  PB       petabyte  1,000,000,000,000,000
  P, PiB   pebibyte  1,125,899,906,842,624
  EB       exabyte   1,000,000,000,000,000,000
  E, EiB   exbibyte  1,152,921,504,606,846,976

159
=head1 GENERIC COMMANDS
160

161
The following commands are generic i.e. not specific to a domain.
162 163 164

=over 4

165
=item B<help> [I<command-or-group>]
166

167 168 169 170 171 172 173 174 175 176 177
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
178
     cpu-models                     show the CPU models for an architecture
179 180 181
     connect                        (re)connect to hypervisor
     freecell                       NUMA free memory
     hostname                       print the hypervisor hostname
182 183
     qemu-attach                    Attach to existing QEMU process
     qemu-monitor-command           QEMU Monitor Command
184
     qemu-agent-command             QEMU Guest Agent Command
E
Eric Blake 已提交
185
     sysinfo                        print the hypervisor sysinfo
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
     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
204

205
=item B<quit>, B<exit>
206

207
quit this interactive terminal
208

209
=item B<version> [I<--daemon>]
210

211
Will print out the major version info about what this built from.
212 213
If I<--daemon> is specified then the version of the libvirt daemon
is included in the output.
214

215
=over 4
216

217
B<Example>
218

219 220 221 222 223 224 225 226 227 228 229 230
 $ virsh version
 Compiled against library: libvirt 1.2.3
 Using library: libvirt 1.2.3
 Using API: QEMU 1.2.3
 Running hypervisor: QEMU 2.0.50

 $ virsh version --daemon
 Compiled against library: libvirt 1.2.3
 Using library: libvirt 1.2.3
 Using API: QEMU 1.2.3
 Running hypervisor: QEMU 2.0.50
 Running against daemon: 1.2.6
231

232
=back
233

234
=item B<cd> [I<directory>]
P
Paolo Bonzini 已提交
235 236 237 238 239 240 241 242 243 244 245

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.

J
Jiri Denemark 已提交
246
=item B<connect> [I<URI>] [I<--readonly>]
247

E
Eric Blake 已提交
248 249 250 251 252 253
(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:
254

255
=over 4
256

257
=item xen:///
258

J
Jiri Denemark 已提交
259
this is used to connect to the local Xen hypervisor
260

261
=item qemu:///system
262

P
Peter Krempa 已提交
263
connect locally as root to the daemon supervising QEMU and KVM domains
264

265 266
=item qemu:///session

P
Peter Krempa 已提交
267
connect locally as a normal user to his own set of QEMU and KVM domains
268

D
David Jorm 已提交
269 270 271 272
=item lxc:///

connect to a local linux container

273
=back
274

275 276
To find the currently used URI, check the I<uri> command documented below.

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

281 282 283 284 285 286 287 288
=item B<uri>

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

=item B<hostname>

Print the hypervisor hostname.

E
Eric Blake 已提交
289 290 291 292
=item B<sysinfo>

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

293
=item B<nodeinfo>
294

295
Returns basic information about the node, like number and type of CPU,
J
Jiri Denemark 已提交
296 297
and size of the physical memory. The output corresponds to virNodeInfo
structure. Specifically, the "CPU socket(s)" field means number of CPU
298 299
sockets per NUMA cell. The information libvirt displays is dependent
upon what each architecture may provide.
300

301
=item B<nodecpumap> [I<--pretty>]
302 303 304 305

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

306 307
With I<--pretty> the online CPUs are printed as a range instead of a list.

308
=item B<nodecpustats> [I<cpu>] [I<--percent>]
309 310 311 312 313 314

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.

315
=item B<nodememstats> [I<cell>]
316 317 318 319

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

320
=item B<nodesuspend> [I<target>] [I<duration>]
321

322 323 324 325 326 327 328 329
Puts the node (host machine) into a system-wide sleep state and schedule
the node's Real-Time-Clock interrupt to resume the node after the time
duration specified by I<duration> is out.
I<target> specifies the state to which the host will be suspended to, it
can be "mem" (suspend to RAM), "disk" (suspend to disk), or "hybrid"
(suspend to both RAM and disk).  I<duration> specifies the time duration
in seconds for which the host has to be suspended, it should be at least
60 seconds.
330

331
=item B<node-memory-tune> [I<shm-pages-to-scan>] [I<shm-sleep-millisecs>]
332
[I<shm-merge-across-nodes>]
333 334 335 336 337

Allows you to display or set the node memory parameters.
I<shm-pages-to-scan> can be used to set the number of pages to scan
before the shared memory service goes to sleep; I<shm-sleep-millisecs>
can be used to set the number of millisecs the shared memory service should
338 339 340 341
sleep before next scan; I<shm-merge-across-nodes> specifies if pages from
different numa nodes can be merged. When set to 0, only pages which physically
reside in the memory area of same NUMA node can be merged. When set to 1,
pages from all nodes can be merged. Default to 1.
342

343 344 345
B<Note>: Currently the "shared memory service" only means KSM (Kernel Samepage
Merging).

346
=item B<capabilities>
347 348 349 350 351

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

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
=item B<domcapabilities> [I<virttype>] [I<emulatorbin>]
[I<arch>] [I<machine>]

Print an XML document describing the domain capabilities for the
hypervisor we are connected to using information either sourced from an
existing domain or taken from the B<virsh capabilities> output. This may
be useful if you intend to create a new domain and are curious if for
instance it could make use of VFIO by creating a domain for the
hypervisor with a specific emulator and architecture.

Each hypervisor will have different requirements regarding which options
are required and which are optional. A hypervisor can support providing
a default value for any of the options.

The I<virttype> option specifies the virtualization type used. The value
to be used is either from the 'type' attribute of the <domain/> top
level element from the domain XML or the 'type' attribute found within
each <guest/> element from the B<virsh capabilities> output.  The
I<emulatorbin> option specifies the path to the emulator. The value to
be used is either the <emulator> element in the domain XML or the
B<virsh capabilities> output. The I<arch> option specifies the
architecture to be used for the domain. The value to be used is either
the "arch" attribute from the domain's XML <os/> element and <type/>
subelement or the "name" attribute of an <arch/> element from the
B<virsh capabililites> output. The I<machine> specifies the machine type
for the emulator. The value to be used is either the "machine" attribute
from the domain's XML <os/> element and <type/> subelement or one from a
list of machines from the B<virsh capabilities> output for a specific
architecture and domain type.

For the qemu hypervisor, a I<virttype> of either 'qemu' or 'kvm' must be
supplied along with either the I<emulatorbin> or I<arch> in order to
generate output for the default I<machine>.  Supplying a I<machine>
value will generate output for the specific machine.

391
=item B<inject-nmi> I<domain>
392 393 394

Inject NMI to the guest.

395 396 397 398 399 400 401 402 403
=item B<list> [I<--inactive> | I<--all>]
              [I<--managed-save>] [I<--title>]
              { [I<--table>] | I<--name> | I<--uuid> }
              [I<--persistent>] [I<--transient>]
              [I<--with-managed-save>] [I<--without-managed-save>]
              [I<--autostart>] [I<--no-autostart>]
              [I<--with-snapshot>] [I<--without-snapshot>]
              [I<--state-running>] [I<--state-paused>]
              [I<--state-shutoff>] [I<--state-other>]
404

405
Prints information about existing domains.  If no options are
406
specified it prints out information about running domains.
407 408 409 410

An example format for the list is as follows:

B<virsh> list
411 412 413 414
  Id    Name                           State
 ----------------------------------------------------
  0     Domain-0                       running
  2     fedora                         paused
415

416
Name is the name of the domain.  ID the domain numeric id.
417
State is the run state (see below).
418

419 420
B<STATES>

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

424 425
=over 4

426
=item B<running>
427 428 429

The domain is currently running on a CPU

430
=item B<idle>
431

432
The domain is idle, and not running or runnable.  This can be caused
433 434 435
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.

436
=item B<paused>
437 438

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

443
=item B<in shutdown>
444

445
The domain is in the process of shutting down, i.e. the guest operating system
446
has been notified and should be in the process of stopping its operations
447
gracefully.
448

449 450 451 452 453
=item B<shut off>

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

454
=item B<crashed>
455 456 457

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

O
Osier Yang 已提交
460 461 462 463 464
=item B<pmsuspended>

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

465 466
=back

467 468 469
Normally only active domains are listed. To list inactive domains specify
I<--inactive> or I<--all> to list both active and inactive domains.

470 471 472 473 474
To further filter the list of domains you may specify one or more of filtering
flags supported by the B<list> command. These flags are grouped by function.
Specifying one or more flags from a group enables the filter group. Note that
some combinations of flags may yield no results. Supported filtering flags and
groups:
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517

=over 4

=item B<Persistence>

Flag I<--persistent> is used to include persistent domains in the returned
list. To include transient domains specify I<--transient>.

=item B<Existence of managed save image>

To list domains having a managed save image specify flag
I<--with-managed-save>. For domains that don't have a managed save image
specify I<--without-managed-save>.

=item B<Domain state>

The following filter flags select a domain by its state:
I<--state-running> for running domains, I<--state-paused>  for paused domains,
I<--state-shutoff> for turned off domains and I<--state-other> for all
other states as a fallback.

=item B<Autostarting domains>

To list autostarting domains use the flag I<--autostart>. To list domains with
this feature disabled use I<--no-autostart>.

=item B<Snapshot existence>

Domains that have snapshot images can be listed using flag I<--with-snapshot>,
domains without a snapshot I<--without-snapshot>.

=back

When talking to older servers, this command is forced to use a series of API
calls with an inherent race, where a domain might not be listed or might appear
more than once if it changed state between calls while the list was being
collected.  Newer servers do not have this problem.

If I<--managed-save> is specified, then domains that have managed save state
(only possible if they are in the B<shut off> state, so you need to specify
I<--inactive> or I<--all> to actually list them) will instead show as B<saved>
in the listing. This flag is usable only with the default I<--table> output.
Note that this flag does not filter the list of domains.
518 519 520 521

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
522 523 524 525 526
output should be used. This is the default.

If both I<--name> and I<--uuid> are specified, domain UUID's and names
are printed side by side without any header. Flag I<--table> specifies
that the legacy table-formatted output should be used. This is the
527 528
default if neither I<--name> nor I<--uuid> are specified. Option
I<--table> is mutually exclusive with options I<--uuid> and I<--name>.
529

530 531
If I<--title> is specified, then the short domain description (title) is
printed in an extra column. This flag is usable only with the default
532
I<--table> output.
533

534 535
Example:

P
Peter Krempa 已提交
536
B<virsh> list --title
537 538 539 540
  Id    Name                           State      Title
 --------------------------------------------------------------------------
  0     Domain-0                       running    Mailserver 1
  2     fedora                         paused
541

542 543 544 545 546 547 548 549 550 551
=item B<freecell> [{ [I<--cellno>] B<cellno> | I<--all> }]

Prints the available amount of memory on the machine or within a NUMA
cell.  The freecell command can provide one of three different
displays of available memory on the machine depending on the options
specified.  With no options, it displays the total free memory on the
machine.  With the --all option, it displays the free memory in each
cell and the total free memory on the machine.  Finally, with a
numeric argument or with --cellno plus a cell number it will display
the free memory for the specified cell only.
552

553 554 555 556 557 558 559 560
=item B<freepages> [{ [I<--cellno>] I<cellno> [I<--pagesize>] I<pagesize> |
    I<--all> }]

Prints the available amount of pages within a NUMA cell. I<cellno> refers
to the NUMA cell you're interested in. I<pagesize> is a scaled integer (see
B<NOTES> above).  Alternatively, if I<--all> is used, info on each possible
combination of NUMA cell and page size is printed out.

561 562 563 564 565 566 567 568 569 570 571 572
=item B<allocpages> [I<--pagesize>] I<pagesize> [I<--pagecount>] I<pagecount>
[[I<--cellno>] I<cellno>] [I<--add>] [I<--all>]

Change the size of pages pool of I<pagesize> on the host. If
I<--add> is specified, then I<pagecount> pages are added into the
pool. However, if I<--add> wasn't specified, then the
I<pagecount> is taken as the new absolute size of the pool (this
may be used to free some pages and size the pool down). The
I<cellno> modifier can be used to narrow the modification down to
a single host NUMA cell. On the other end of spectrum lies
I<--all> which executes the modification on all NUMA cells.

573
=item B<cpu-baseline> I<FILE> [I<--features>] [I<--migratable>]
574 575 576 577 578

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
579 580 581
B<capabilities> command.  If I<--features> is specified then the
resulting XML description will explicitly include all features that make
up the CPU, without this option features that are part of the CPU model
582 583
will not be listed in the XML description.   If I<--migratable> is specified,
features that block migration will not be included in the resulting CPU.
584

585
=item B<cpu-compare> I<FILE> [I<--error>]
586 587 588 589 590 591

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:
592 593 594 595
L<http://libvirt.org/formatdomain.html#elementsCPU>. If I<--error> is
specified, the command will return an error when the given CPU is
incompatible with host CPU and a message providing more details about the
incompatibility will be printed out.
596

597 598 599 600
=item B<cpu-models> I<arch>

Print the list of CPU models known for the specified architecture.

601 602 603 604 605 606 607
=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.

608 609
=back

610
=head1 DOMAIN COMMANDS
611

612
The following commands manipulate domains directly, as stated
613 614
previously most commands take domain as the first parameter. The
I<domain> can be specified as a short integer, a name or a full UUID.
615

616 617
=over 4

618
=item B<autostart> [I<--disable>] I<domain>
619 620 621

Configure a domain to be automatically started at boot.

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

624
=item B<console> I<domain> [I<devname>] [I<--safe>] [I<--force>]
625

626 627 628 629
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.
630

631 632 633 634 635 636
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.

637
=item B<create> I<FILE> [I<--console>] [I<--paused>] [I<--autodestroy>]
638
[I<--pass-fds N,M,...>]
639

E
Eric Blake 已提交
640 641
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
642 643 644
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.
645 646 647
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
exits.
648

649 650
If I<--pass-fds> is specified, the argument is a comma separated list
of open file descriptors which should be pass on into the guest. The
N
Nehal J Wani 已提交
651
file descriptors will be re-numbered in the guest, starting from 3. This
652 653
is only supported with container based virtualization.

654 655
B<Example>

656
 virsh dumpxml <domain> > domain.xml
O
Osier Yang 已提交
657
 vi domain.xml (or make changes with your other text editor)
G
Guido Günther 已提交
658
 virsh create domain.xml
659 660 661

=item B<define> I<FILE>

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

666
=item B<desc> I<domain> [[I<--live>] [I<--config>] |
667 668
              [I<--current>]] [I<--title>] [I<--edit>] [I<--new-desc>
              New description or title message]
669 670 671 672

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.
673
(See also B<metadata> that works with XML based domain metadata.)
674 675

Flags I<--live> or I<--config> select whether this command works on live
676 677 678
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
679 680
the description. I<--current> is exclusive and implied if none of these was
specified.
681 682 683 684 685 686

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.

687
If neither of I<--edit> and I<--new-desc> are specified the note or description
688 689
is displayed instead of being modified.

690
=item B<destroy> I<domain> [I<--graceful>]
691

692
Immediately terminate the domain I<domain>.  This doesn't give the domain
L
Luiz Capitulino 已提交
693
OS any chance to react, and it's the equivalent of ripping the power
694
cord out on a physical machine.  In most cases you will want to use
695 696 697
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.
698

699
If I<domain> is transient, then the metadata of any snapshots will
700 701 702 703
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>.

704 705 706 707
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.

708
=item B<domblkstat> I<domain> [I<block-device>] [I<--human>]
709

710 711
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
712
file='name'/>) for one of the disk devices attached to I<domain> (see
713 714 715
also B<domblklist> for listing these names). On a lxc or qemu domain,
omitting the I<block-device> yields device block stats summarily for the
entire domain.
716

717 718 719 720 721 722
Use I<--human> for a more human readable output.

Availability of these fields depends on hypervisor. Unsupported fields are
missing from the output. Other fields may appear if communicating with a newer
version of libvirtd.

J
Ján Tomko 已提交
723
B<Explanation of fields> (fields appear in the following order):
724 725 726 727 728 729 730 731 732 733 734
  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 -->

N
Nehal J Wani 已提交
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750

=item B<domifaddr> I<domain> [I<interface>] [I<--full>]
              [I<--source lease|agent>]

Get a list of interfaces of a running domain along with their IP and MAC
addresses, or limited output just for one interface if I<interface> is
specified. Note that I<interface> can be driver dependent, it can be the name
within guest OS or the name you would see in domain XML. Moreover, the whole
command may require a guest agent to be configured for the queried domain under
some drivers, notably qemu. If I<--full> is specified, the interface name is
always displayed when the interface has multiple addresses or alias, otherwise
it only displays the interface name for the first address, and "-" for the
others. The I<--source> argument specifies what data source to use for the
addresses, currently one of 'lease' to read DHCP leases, or 'agent' to query
the guest OS via an agent. If unspecified, 'lease' is the default.

751 752 753 754
=item B<domifstat> I<domain> I<interface-device>

Get network interface stats for a running domain.

755
=item B<domif-setlink> I<domain> I<interface-device> I<state> [I<--config>]
756 757

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

763 764 765 766 767
=item B<domif-getlink> I<domain> I<interface-device> [I<--config>]

Query link state of the domain's virtual interface. If I<--config>
is specified, query the persistent configuration, for compatibility
purposes, I<--persistent> is alias of I<--config>.
768

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

771 772
=item B<domiftune> I<domain> I<interface-device>
[[I<--config>] [I<--live>] | [I<--current>]]
773
[I<--inbound average,peak,burst,floor>]
774 775 776 777 778 779 780 781
[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
782 783 784 785
inbound or outbound bandwidth. I<average,peak,burst,floor> is the same as
in command I<attach-interface>.  Values for I<average>, I<peak> and I<floor>
are expressed in kilobytes per second, while I<burst> is expressed in kilobytes
in a single burst at I<peak> speed as described in the Network XML
J
John Ferlan 已提交
786
documentation at L<http://libvirt.org/formatnetwork.html#elementQoS>.
787

788
To clear inbound or outbound settings, use I<--inbound> or I<--outbound>
789
respectfully with average value of zero.
790

791 792 793
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.
794
Both I<--live> and I<--config> flags may be given, but I<--current> is
795 796 797
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

798 799
=item B<dommemstat> I<domain> [I<--period> B<seconds>]
[[I<--config>] [I<--live>] | [I<--current>]]
800 801 802

Get memory stats for a running domain.

803 804 805 806 807 808 809 810 811 812 813 814 815
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>:
  swap_in           - The amount of data read from swap space (in kB)
  swap_out          - The amount of memory written out to swap space (in kB)
  major_fault       - The number of page faults where disk IO was required
  minor_fault       - The number of other page faults
  unused            - The amount of memory left unused by the system (in kB)
  available         - The amount of usable memory as seen by the domain (in kB)
  actual            - Current balloon value (in KB)
  rss               - Resident Set Size of the running domain's process (in kB)
816 817
  usable            - The amount of memory which can be reclaimed by balloon
without causing host swapping (in KB)
818
  last-update       - Timestamp of the last update of statistics (in seconds)
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836

For QEMU/KVM with a memory balloon, setting the optional I<--period> to a
value larger than 0 in seconds will allow the balloon driver to return
additional statistics which will be displayed by subsequent B<dommemstat>
commands. Setting the I<--period> to 0 will stop the balloon driver collection,
but does not clear the statistics in the balloon driver. Requires at least
QEMU/KVM 1.5 to be running on the host.

The I<--live>, I<--config>, and I<--current> flags are only valid when using
the I<--period> option in order to set the collection period for the balloon
driver. If I<--live> is specified, only the running guest collection period
is affected. If I<--config> is specified, affect the next boot of a persistent
guest. If I<--current> is specified, affect the current guest state.

Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on the guest state.

837
=item B<domblkerror> I<domain>
838 839 840 841 842 843

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.

844 845
=item B<domblkinfo> I<domain> I<block-device>

846 847
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
848 849 850
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).

851 852 853 854 855 856 857 858 859 860
=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.
861

862
=item B<domstats> [I<--raw>] [I<--enforce>] [I<--backing>] [I<--state>]
863
[I<--cpu-total>] [I<--balloon>] [I<--vcpu>] [I<--interface>] [I<--block>]
Q
Qiaowei Ren 已提交
864
[I<--perf>] [[I<--list-active>] [I<--list-inactive>] [I<--list-persistent>]
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
[I<--list-transient>] [I<--list-running>] [I<--list-paused>]
[I<--list-shutoff>] [I<--list-other>]] | [I<domain> ...]

Get statistics for multiple or all domains. Without any argument this
command prints all available statistics for all domains.

The list of domains to gather stats for can be either limited by listing
the domains as a space separated list, or by specifying one of the
filtering flags I<--list-*>. (The approaches can't be combined.)

By default some of the returned fields may be converted to more
human friendly values by a set of pretty-printers. To suppress this
behavior use the I<--raw> flag.

The individual statistics groups are selectable via specific flags. By
default all supported statistics groups are returned. Supported
881
statistics groups flags are: I<--state>, I<--cpu-total>, I<--balloon>,
Q
Qiaowei Ren 已提交
882
I<--vcpu>, I<--interface>, I<--block>, I<--perf>.
883

884 885 886
Note that - depending on the hypervisor type and version or the domain state
- not all of the following statistics may be returned.

887 888
When selecting the I<--state> group the following fields are returned:
"state.state" - state of the VM, returned as number from virDomainState enum,
889
"state.reason" - reason for entering given state, returned as int from
890 891 892 893 894 895 896 897 898
virDomain*Reason enum corresponding to given state.

I<--cpu-total> returns:
"cpu.time" - total cpu time spent for this domain in nanoseconds,
"cpu.user" - user cpu time spent in nanoseconds,
"cpu.system" - system cpu time spent in nanoseconds

I<--balloon> returns:
"balloon.current" - the memory in kiB currently used,
899 900 901 902 903 904 905 906 907 908
"balloon.maximum" - the maximum memory in kiB allowed,
"balloon.swap_in" - the amount of data read from swap space (in kB),
"balloon.swap_out" - the amount of memory written out to swap space (in kB),
"balloon.major_fault" - the number of page faults then disk IO was required,
"balloon.minor_fault" - the number of other page faults,
"balloon.unused" - the amount of memory left unused by the system (in kB),
"balloon.available" - the amount of usable memory as seen by the domain (in kB),
"balloon.rss" - Resident Set Size of running domain's process (in kB),
"balloon.usable" - the amount of memory which can be reclaimed by balloon
without causing host swapping (in KB),
909
"balloon.last-update" - timestamp of the last update of statistics (in seconds)
910 911 912 913 914 915 916

I<--vcpu> returns:
"vcpu.current" - current number of online virtual CPUs,
"vcpu.maximum" - maximum number of online virtual CPUs,
"vcpu.<num>.state" - state of the virtual CPU <num>, as number
from virVcpuState enum,
"vcpu.<num>.time" - virtual cpu time spent by virtual CPU <num>
917 918 919 920 921
 (in microseconds),
"vcpu.<num>.wait" - virtual cpu time spent by virtual CPU <num>
waiting on I/O (in microseconds),
"vcpu.<num>.halted" - virtual CPU <num> is halted: yes or no (may indicate
the processor is idle or even disabled, depending on the architecture)
922 923 924 925 926 927 928 929 930 931 932

I<--interface> returns:
"net.count" - number of network interfaces on this domain,
"net.<num>.name" - name of the interface <num>,
"net.<num>.rx.bytes" - number of bytes received,
"net.<num>.rx.pkts" - number of packets received,
"net.<num>.rx.errs" - number of receive errors,
"net.<num>.rx.drop" - number of receive packets dropped,
"net.<num>.tx.bytes" - number of bytes transmitted,
"net.<num>.tx.pkts" - number of packets transmitted,
"net.<num>.tx.errs" - number of transmission errors,
933
"net.<num>.tx.drop" - number of transmit packets dropped
934

Q
Qiaowei Ren 已提交
935
I<--perf> returns the statistics of all enabled perf events:
936 937 938 939 940 941
"perf.cmt" - the cache usage in Byte currently used,
"perf.mbmt" - total system bandwidth from one level of cache,
"perf.mbml" - bandwidth of memory traffic for a memory controller,
"perf.cpu_cycles" - the count of cpu cycles (total/elapsed),
"perf.instructions" - the count of instructions,
"perf.cache_references" - the count of cache hits,
942
"perf.cache_misses" - the count of caches misses,
943
"perf.branch_instructions" - the count of branch instructions,
944
"perf.branch_misses" - the count of branch misses,
945
"perf.bus_cycles" - the count of bus cycles,
946
"perf.stalled_cycles_frontend" - the count of stalled frontend cpu cycles,
947
"perf.stalled_cycles_backend" - the count of stalled backend cpu cycles,
948
"perf.ref_cpu_cycles" - the count of ref cpu cycles
Q
Qiaowei Ren 已提交
949

950 951
See the B<perf> command for more details about each event.

952 953 954 955 956 957 958 959 960 961
I<--block> returns information about disks associated with each
domain.  Using the I<--backing> flag extends this information to
cover all resources in the backing chain, rather than the default
of limiting information to the active layer for each guest disk.
Information listed includes:
"block.count" - number of block devices being listed,
"block.<num>.name" - name of the target of the block device <num> (the
same name for multiple entries if I<--backing> is present),
"block.<num>.backingIndex" - when I<--backing> is present, matches up
with the <backingStore> index listed in domain XML for backing files,
E
Eric Blake 已提交
962 963
"block.<num>.path" - file source of block device <num>, if it is a
local file or block device,
964 965 966 967 968 969 970 971 972
"block.<num>.rd.reqs" - number of read requests,
"block.<num>.rd.bytes" - number of read bytes,
"block.<num>.rd.times" - total time (ns) spent on reads,
"block.<num>.wr.reqs" - number of write requests,
"block.<num>.wr.bytes" - number of written bytes,
"block.<num>.wr.times" - total time (ns) spent on writes,
"block.<num>.fl.reqs" - total flush requests,
"block.<num>.fl.times" - total time (ns) spent on cache flushing,
"block.<num>.errors" - Xen only: the 'oo_req' value,
973 974 975
"block.<num>.allocation" - offset of highest written sector in bytes,
"block.<num>.capacity" - logical size of source file in bytes,
"block.<num>.physical" - physical size of source file in bytes
976

977 978 979 980 981
Selecting a specific statistics groups doesn't guarantee that the
daemon supports the selected group of stats. Flag I<--enforce>
forces the command to fail if the daemon doesn't support the
selected group.

982 983 984 985 986 987 988 989 990
=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.

991
=item B<blockcommit> I<domain> I<path> [I<bandwidth>] [I<--bytes>]
992
[I<base>] [I<--shallow>] [I<top>] [I<--delete>] [I<--keep-relative>]
993 994
[I<--wait> [I<--async>] [I<--verbose>]] [I<--timeout> B<seconds>]
[I<--active>] [{I<--pivot> | I<--keep-overlay>}]
E
Eric Blake 已提交
995 996 997 998 999 1000 1001 1002 1003

Reduce the length of a backing image chain, by committing changes at the
top of the chain (snapshot or delta files) into backing images.  By
default, this command attempts to flatten the entire chain.  If I<base>
and/or I<top> are specified as files within the backing chain, then the
operation is constrained to committing just that portion of the chain;
I<--shallow> can be used instead of I<base> to specify the immediate
backing file of the resulting top image to be committed.  The files
being committed are rendered invalid, possibly as soon as the operation
1004
starts; using the I<--delete> flag will attempt to remove these invalidated
1005 1006
files at the successful completion of the commit operation. When the
I<--keep-relative> flag is used, the backing file paths will be kept relative.
1007 1008 1009 1010 1011 1012 1013 1014 1015

When I<top> is omitted or specified as the active image, it is also
possible to specify I<--active> to trigger a two-phase active commit. In
the first phase, I<top> is copied into I<base> and the job can only be
canceled, with top still containing data not yet in base. In the second
phase, I<top> and I<base> remain identical until a call to B<blockjob>
with the I<--abort> flag (keeping top as the active image that tracks
changes from that point in time) or the I<--pivot> flag (making base
the new active image and invalidating top).
E
Eric Blake 已提交
1016 1017 1018 1019

By default, this command returns as soon as possible, and data for
the entire disk is committed in the background; the progress of the
operation can be checked with B<blockjob>.  However, if I<--wait> is
1020 1021 1022
specified, then this command will block until the operation completes
(or for I<--active>, enters the second phase), or until the operation
is canceled because the optional I<timeout> in seconds elapses
E
Eric Blake 已提交
1023
or SIGINT is sent (usually with C<Ctrl-C>).  Using I<--verbose> along
1024 1025 1026
with I<--wait> will produce periodic status updates.  If job cancellation
is triggered, I<--async> will return control to the user as fast as
possible, otherwise the command may continue to block a little while
1027 1028 1029 1030
longer until the job is done cleaning up.  Using I<--pivot> is shorthand
for combining I<--active> I<--wait> with an automatic B<blockjob>
I<--pivot>; and using I<--keep-overlay> is shorthand for combining
I<--active> I<--wait> with an automatic B<blockjob> I<--abort>.
E
Eric Blake 已提交
1031 1032 1033 1034 1035 1036

I<path> specifies fully-qualified path of the disk; it corresponds
to a unique target name (<target dev='name'/>) or source file (<source
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).
I<bandwidth> specifies copying bandwidth limit in MiB/s, although for
1037 1038 1039
qemu, it may be non-zero only for an online domain. For further information
on the I<bandwidth> argument see the corresponding section for the B<blockjob>
command.
E
Eric Blake 已提交
1040

E
Eric Blake 已提交
1041
=item B<blockcopy> I<domain> I<path> { I<dest> [I<format>] [I<--blockdev>]
1042
| I<--xml> B<file> } [I<--shallow>] [I<--reuse-external>] [I<bandwidth>]
E
Eric Blake 已提交
1043
[I<--wait> [I<--async>] [I<--verbose>]] [{I<--pivot> | I<--finish>}]
1044
[I<--timeout> B<seconds>] [I<granularity>] [I<buf-size>] [I<--bytes>]
E
Eric Blake 已提交
1045 1046

Copy a disk backing image chain to a destination.  Either I<dest> as
1047
the destination file name, or I<--xml> with the name of an XML file containing
E
Eric Blake 已提交
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
a top-level <disk> element describing the destination, must be present.
Additionally, if I<dest> is given, I<format> should be specified to declare
the format of the destination (if I<format> is omitted, then libvirt
will reuse the format of the source, or with I<--reuse-external> will
be forced to probe the destination format, which could be a potential
security hole).  The command supports I<--raw> as a boolean flag synonym for
I<--format=raw>.  When using I<dest>, the destination is treated as a regular
file unless I<--blockdev> is used to signal that it is a block device. By
default, this command flattens the entire chain; but if I<--shallow> is
specified, the copy shares the backing chain.

If I<--reuse-external> is specified, then the destination must exist and have
1060 1061 1062 1063 1064
sufficient space to hold the copy. If I<--shallow> is used in
conjunction with I<--reuse-external> then the pre-created image must have
guest visible contents identical to guest visible contents of the backing
file of the original image. This may be used to modify the backing file
names on the destination.
E
Eric Blake 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076

By default, the copy job runs in the background, and consists of two
phases.  Initially, the job must copy all data from the source, and
during this phase, the job can only be canceled to revert back to the
source disk, with no guarantees about the destination.  After this phase
completes, both the source and the destination remain mirrored until a
call to B<blockjob> with the I<--abort> and I<--pivot> flags pivots over
to the copy, or a call without I<--pivot> leaves the destination as a
faithful copy of that point in time.  However, if I<--wait> is specified,
then this command will block until the mirroring phase begins, or cancel
the operation if the optional I<timeout> in seconds elapses or SIGINT is
sent (usually with C<Ctrl-C>).  Using I<--verbose> along with I<--wait>
E
Eric Blake 已提交
1077 1078 1079 1080 1081 1082 1083
will produce periodic status updates.  Using I<--pivot> (similar to
B<blockjob> I<--pivot>) or I<--finish> (similar to B<blockjob> I<--abort>)
implies I<--wait>, and will additionally end the job cleanly rather than
leaving things in the mirroring phase.  If job cancellation is triggered
by timeout or by I<--finish>, I<--async> will return control to the user
as fast as possible, otherwise the command may continue to block a little
while longer until the job has actually cancelled.
E
Eric Blake 已提交
1084 1085

I<path> specifies fully-qualified path of the disk.
1086
I<bandwidth> specifies copying bandwidth limit in MiB/s. Specifying a negative
E
Eric Blake 已提交
1087 1088
value is interpreted as an unsigned long long value that might be essentially
unlimited, but more likely would overflow; it is safer to use 0 for that
1089 1090 1091 1092
purpose. For further information on the I<bandwidth> argument see the
corresponding section for the B<blockjob> command.
Specifying I<granularity> allows fine-tuning of the granularity that will be
copied when a dirty region is detected; larger values trigger less
E
Eric Blake 已提交
1093
I/O overhead but may end up copying more data overall (the default value is
1094 1095 1096 1097
usually correct); hypervisors may restrict this to be a power of two or fall
within a certain range. Specifying I<buf-size> will control how much data can
be simultaneously in-flight during the copy; larger values use more memory but
may allow faster completion (the default value is usually correct).
E
Eric Blake 已提交
1098

1099
=item B<blockpull> I<domain> I<path> [I<bandwidth>] [I<--bytes>] [I<base>]
J
Jiri Denemark 已提交
1100
[I<--wait> [I<--verbose>] [I<--timeout> B<seconds>] [I<--async>]]
1101
[I<--keep-relative>]
E
Eric Blake 已提交
1102 1103 1104 1105 1106 1107 1108

Populate a disk from its backing image chain. By default, this command
flattens the entire chain; but if I<base> is specified, containing the
name of one of the backing files in the chain, then that file becomes
the new backing file and only the intermediate portion of the chain is
pulled.  Once all requested data from the backing image chain has been
pulled, the disk no longer depends on that portion of the backing chain.
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119

By default, this command returns as soon as possible, and data for
the entire disk is pulled in the background; the progress of the
operation can be checked with B<blockjob>.  However, if I<--wait> is
specified, then this command will block until the operation completes,
or cancel the operation if the optional I<timeout> in seconds elapses
or SIGINT is sent (usually with C<Ctrl-C>).  Using I<--verbose> along
with I<--wait> will produce periodic status updates.  If job cancellation
is triggered, I<--async> will return control to the user as fast as
possible, otherwise the command may continue to block a little while
longer until the job is done cleaning up.
1120

1121 1122 1123
Using the I<--keep-relative> flag will keep the backing chain names
relative.

1124 1125 1126 1127
I<path> specifies fully-qualified path of the disk; it corresponds
to a unique target name (<target dev='name'/>) or source file (<source
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).
1128 1129 1130
I<bandwidth> specifies copying bandwidth limit in MiB/s. For further information
on the I<bandwidth> argument see the corresponding section for the B<blockjob>
command.
1131

L
Lei Li 已提交
1132 1133
=item B<blkdeviotune> I<domain> I<device>
[[I<--config>] [I<--live>] | [I<--current>]]
E
Eric Blake 已提交
1134 1135
[[I<total-bytes-sec>] | [I<read-bytes-sec>] [I<write-bytes-sec>]]
[[I<total-iops-sec>] | [I<read-iops-sec>] [I<write-iops-sec>]]
1136 1137
[[I<total-bytes-sec-max>] | [I<read-bytes-sec-max>] [I<write-bytes-sec-max>]]
[[I<total-iops-sec-max>] | [I<read-iops-sec-max>] [I<write-iops-sec-max>]]
1138 1139 1140 1141
[[I<total-bytes-sec-max-length>] |
[I<read-bytes-sec-max-length>] [I<write-bytes-sec-max-length>]]
[[I<total-iops-sec-max-length>] |
[I<read-iops-sec-max-length>] [I<write-iops-sec-max-length>]]
1142
[I<size-iops-sec>] [I<group_name>]
L
Lei Li 已提交
1143 1144 1145 1146 1147 1148 1149 1150

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:
1151 1152 1153 1154 1155 1156
I<--total-bytes-sec> specifies total throughput limit as a scaled integer, the
default being bytes per second if no suffix is specified.
I<--read-bytes-sec> specifies read throughput limit as a scaled integer, the
default being bytes per second if no suffix is specified.
I<--write-bytes-sec> specifies write throughput limit as a scaled integer, the
default being bytes per second if no suffix is specified.
E
Eric Blake 已提交
1157 1158 1159
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.
1160 1161 1162 1163 1164 1165
I<--total-bytes-sec-max> specifies maximum total throughput limit as a scaled
integer, the default being bytes per second if no suffix is specified
I<--read-bytes-sec-max> specifies maximum read throughput limit as a scaled
integer, the default being bytes per second if no suffix is specified.
I<--write-bytes-sec-max> specifies maximum write throughput limit as a scaled
integer, the default being bytes per second if no suffix is specified.
1166 1167 1168
I<--total-iops-sec-max> specifies maximum total I/O operations limit per second.
I<--read-iops-sec-max> specifies maximum read I/O operations limit per second.
I<--write-iops-sec-max> specifies maximum write I/O operations limit per second.
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
I<--total-bytes-sec-max-length> specifies duration in seconds to allow maximum
total throughput limit.
I<--read-bytes-sec-max-length> specifies duration in seconds to allow maximum
read throughput limit.
I<--write-bytes-sec-max-length> specifies duration in seconds to allow maximum
write throughput limit.
I<--total-iops-sec-max-length> specifies duration in seconds to allow maximum
total I/O operations limit.
I<--read-iops-sec-max-length> specifies duration in seconds to allow maximum
read I/O operations limit.
I<--write-iops-sec-max-length> specifies duration in seconds to allow maximum
write I/O operations limit.
1181
I<--size-iops-sec> specifies size I/O operations limit per second.
1182 1183 1184
I<--group_name> specifies group name to share I/O quota between multiple drives.
For a qemu domain, if no name is provided, then the default is to have a single
group for each I<device>.
E
Eric Blake 已提交
1185 1186 1187

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

E
Eric Blake 已提交
1189
Bytes and iops values are independent, but setting only one value (such
E
Eric Blake 已提交
1190
as --read-bytes-sec) resets the other two in that category to unlimited.
E
Eric Blake 已提交
1191
An explicit 0 also clears any limit.  A non-zero value for a given total
L
Lei Li 已提交
1192 1193
cannot be mixed with non-zero values for read or write.

1194 1195 1196 1197 1198
It is up to the hypervisor to determine how to handle the length values.
For the qemu hypervisor, if an I/O limit value or maximum value is set,
then the default value of 1 second will be displayed. Supplying a 0 will
reset the value back to the default.

L
Lei Li 已提交
1199 1200 1201
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.
1202 1203 1204 1205
When setting the disk io parameters both I<--live> and I<--config> flags may be
given, but I<--current> is exclusive. For querying only one of I<--live>,
I<--config> or I<--current> can be specified. If no flag is specified, behavior
is different depending on hypervisor.
L
Lei Li 已提交
1206

E
Eric Blake 已提交
1207
=item B<blockjob> I<domain> I<path> { [I<--abort>] [I<--async>] [I<--pivot>] |
1208
[I<--info>] [I<--raw>] [I<--bytes>] | [I<bandwidth>] }
1209

1210 1211 1212 1213
Manage active block operations.  There are three mutually-exclusive modes:
I<--info>, I<bandwidth>, and I<--abort>.  I<--async> and I<--pivot> imply
abort mode; I<--raw> implies info mode; and if no mode was given, I<--info>
mode is assumed.
1214 1215 1216 1217 1218

I<path> specifies fully-qualified path of the disk; it corresponds
to a unique target name (<target dev='name'/>) or source file (<source
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).
1219

1220
In I<--abort> mode, the active job on the specified disk will
1221
be aborted.  If I<--async> is also specified, this command will return
N
Nehal J Wani 已提交
1222
immediately, rather than waiting for the cancellation to complete.  If
1223 1224
I<--pivot> is specified, this requests that an active copy or active
commit job be pivoted over to the new image.
1225 1226 1227 1228

In I<--info> mode, the active job information on the specified
disk will be printed.  By default, the output is a single human-readable
summary line; this format may change in future versions.  Adding
1229 1230 1231 1232 1233
I<--raw> lists each field of the struct, in a stable format.  If the
I<--bytes> flag is set, then the command errors out if the server could
not supply bytes/s resolution; when omitting the flag, raw output is
listed in MiB/s and human-readable output automatically selects the
best resolution supported by the server.
1234

1235 1236 1237
I<bandwidth> can be used to set bandwidth limit for the active job in MiB/s.
If I<--bytes> is specified then the bandwidth value is interpreted in
bytes/s. Specifying a negative value is interpreted as an unsigned long
1238
value or essentially unlimited. The hypervisor can choose whether to
1239 1240 1241 1242 1243
reject the value or convert it to the maximum value allowed. Optionally a
scaled positive number may be used as bandwidth (see B<NOTES> above). Using
I<--bytes> with a scaled value allows to use finer granularity. A scaled value
used without I<--bytes> will be rounded down to MiB/s. Note that the
I<--bytes> may be unsupported by the hypervisor.
1244

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

E
Eric Blake 已提交
1247
Resize a block device of domain while the domain is running, I<path>
1248 1249 1250 1251 1252 1253 1254 1255 1256
specifies the absolute path of the block device; it corresponds
to a unique target name (<target dev='name'/>) or source file (<source
file='name'/>) for one of the disk devices attached to I<domain> (see
also B<domblklist> for listing these names).

I<size> is a scaled integer (see B<NOTES> above) which defaults to KiB
(blocks of 1024 bytes) if there is no suffix.  You must use a suffix of
"B" to get bytes (note that for historical reasons, this differs from
B<vol-resize> which defaults to bytes without a suffix).
1257

1258 1259
=item B<domdisplay> I<domain> [I<--include-password>]
[[I<--type>] B<type>] [I<--all>]
1260 1261

Output a URI which can be used to connect to the graphical display of the
1262 1263 1264
domain via VNC, SPICE or RDP.  The particular graphical display type can
be selected using the B<type> parameter (e.g. "vnc", "spice", "rdp").  If
I<--include-password> is specified, the SPICE channel password will be
1265 1266
included in the URI. If I<--all> is specified, then all show all possible
graphical displays, for a VM could have more than one graphical displays.
1267

T
Tomoki Sekiyama 已提交
1268 1269 1270 1271 1272 1273 1274 1275 1276
=item B<domfsinfo> I<domain>

Show a list of mounted filesystems within the running domain. The list contains
mountpoints, names of a mounted device in the guest, filesystem types, and
unique target names used in the domain XML (<target dev='name'/>).

Note that this command requires a guest agent configured and running in the
domain's guest OS.

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
=item B<domfsfreeze> I<domain> [[I<--mountpoint>] B<mountpoint>...]

Freeze mounted filesystems within a running domain to prepare for consistent
snapshots.

The I<--mountpoint> option takes a parameter B<mountpoint>, which is a
mount point path of the filesystem to be frozen. This option can occur
multiple times. If this is not specified, every mounted filesystem is frozen.

Note: B<snapshot-create> command has a I<--quiesce> option to freeze
and thaw the filesystems automatically to keep snapshots consistent.
B<domfsfreeze> command is only needed when a user wants to utilize the
native snapshot features of storage devices not supported by libvirt.

=item B<domfsthaw> I<domain> [[I<--mountpoint>] B<mountpoint>...]

Thaw mounted filesystems within a running domain, which have been frozen by
domfsfreeze command.

The I<--mountpoint> option takes a parameter B<mountpoint>, which is a
mount point path of the filesystem to be thawed. This option can occur
multiple times. If this is not specified, every mounted filesystem is thawed.

1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
=item B<domfstrim> I<domain> [I<--minimum> B<bytes>]
[I<--mountpoint mountPoint>]

Issue a fstrim command on all mounted filesystems within a running
domain. It discards blocks which are not in use by the filesystem.
If I<--minimum> B<bytes> is specified, it tells guest kernel length
of contiguous free range. Smaller than this may be ignored (this is
a hint and the guest may not respect it). By increasing this value,
the fstrim operation will complete more quickly for filesystems
with badly fragmented free space, although not all blocks will
be discarded.  The default value is zero, meaning "discard
N
Nitesh Konkar 已提交
1311
every free block". Moreover, if a user wants to trim only one mount
1312 1313
point, it can be specified via optional I<--mountpoint> parameter.

1314
=item B<domhostname> I<domain>
G
Guido Günther 已提交
1315 1316 1317

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

1318
=item B<dominfo> I<domain>
1319 1320 1321 1322 1323 1324 1325

Returns basic information about the domain.

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

Convert a domain name or id to domain UUID

1326
=item B<domid> I<domain-name-or-uuid>
1327

1328
Convert a domain name (or UUID) to a domain id
1329

1330
=item B<domjobabort> I<domain>
E
Eric Blake 已提交
1331 1332 1333

Abort the currently running domain job.

1334
=item B<domjobinfo> I<domain> [I<--completed>]
E
Eric Blake 已提交
1335

1336 1337 1338
Returns information about jobs running on a domain. I<--completed> tells
virsh to return information about a recently finished job. Statistics of
a completed job are automatically destroyed once read or when libvirtd
1339 1340 1341 1342
is restarted. Note that time information returned for completed
migrations may be completely irrelevant unless both source and
destination hosts have synchronized time (i.e., NTP daemon is running
on both of them).
E
Eric Blake 已提交
1343

1344
=item B<domname> I<domain-id-or-uuid>
1345

1346
Convert a domain Id (or UUID) to domain name
1347

1348 1349 1350 1351 1352 1353 1354
=item B<domrename> I<domain> I<new-name>

Rename a domain. This command changes current domain name to the new name
specified in the second argument.

B<Note>: Domain must be inactive and without snapshots.

1355
=item B<domstate> I<domain> [I<--reason>]
1356

1357 1358
Returns state about a domain.  I<--reason> tells virsh to also print
reason for the state.
1359

1360
=item B<domcontrol> I<domain>
1361 1362 1363 1364 1365

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.

1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
=item B<domtime> I<domain> { [I<--now>] [I<--pretty>] [I<--sync>]
[I<--time> B<time>] }

Gets or sets the domain's system time. When run without any arguments
(but I<domain>), the current domain's system time is printed out. The
I<--pretty> modifier can be used to print the time in more human
readable form.

When I<--time> B<time> is specified, the domain's time is
not gotten but set instead. The I<--now> modifier acts like if it was
an alias for I<--time> B<$now>, which means it sets the time that is
currently on the host virsh is running at. In both cases (setting and
getting), time is in seconds relative to Epoch of 1970-01-01 in UTC.
The I<--sync> modifies the set behavior a bit: The time passed is
ignored, but the time to set is read from domain's RTC instead. Please
note, that some hypervisors may require a guest agent to be configured
in order to get or set the guest time.

E
Eric Blake 已提交
1384 1385 1386
=item B<domxml-from-native> I<format> I<config>

Convert the file I<config> in the native guest configuration format
1387 1388
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
1389 1390
I<format> argument may be B<xen-xm>, B<xen-xl>, or B<xen-sxpr>. For
LXC hypervisor, the I<format> argument must be B<lxc-tools>.
E
Eric Blake 已提交
1391 1392 1393 1394

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

Convert the file I<xml> in domain XML format to the native guest
1395 1396
configuration format named by I<format>. For QEMU/KVM hypervisor,
the I<format> argument must be B<qemu-argv>. For Xen hypervisor, the
1397 1398
I<format> argument may be B<xen-xm>, B<xen-xl>, or B<xen-sxpr>. For
LXC hypervisor, the I<format> argument must be B<lxc-tools>.
E
Eric Blake 已提交
1399

1400
=item B<dump> I<domain> I<corefilepath> [I<--bypass-cache>]
1401
{ [I<--live>] | [I<--crash>] | [I<--reset>] } [I<--verbose>] [I<--memory-only>]
1402
[I<--format> I<string>]
1403 1404

Dumps the core of a domain to a file for analysis.
1405 1406 1407 1408
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.
1409 1410
If I<--reset> is specified, the domain is reset after successful dump.
Note, these three switches are mutually exclusive.
1411 1412
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
1413 1414 1415
If I<--memory-only> is specified, the file is elf file, and will only
include domain's memory and cpu common register value. It is very
useful if the domain uses host devices directly.
1416 1417 1418 1419
I<--format> I<string> is used to specify the format of 'memory-only'
dump, and I<string> can be one of them: elf, kdump-zlib(kdump-compressed
format with zlib-compressed), kdump-lzo(kdump-compressed format with
lzo-compressed), kdump-snappy(kdump-compressed format with snappy-compressed).
1420

1421
The progress may be monitored using B<domjobinfo> virsh command and canceled
1422 1423 1424
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.
1425

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

1429 1430 1431 1432 1433
NOTE: Crash dump in a old kvmdump format is being obsolete and cannot be loaded
and processed by crash utility since its version 6.1.0. A --memory-only option
is required in order to produce valid ELF file which can be later processed by
the crash utility.

1434
=item B<dumpxml> I<domain> [I<--inactive>] [I<--security-info>]
1435
[I<--update-cpu>] [I<--migratable>]
1436 1437 1438 1439 1440

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.
1441
Using I<--security-info> will also include security sensitive information
1442
in the XML dump. I<--update-cpu> updates domain CPU requirements according to
1443 1444 1445 1446
host CPU. With I<--migratable> one can request an XML that is suitable for
migrations, i.e., compatible with older libvirt releases and possibly amended
with internal run-time options. This option may automatically enable other
options (I<--update-cpu>, I<--security-info>, ...) as necessary.
1447

1448
=item B<edit> I<domain>
1449

E
Eric Blake 已提交
1450 1451
Edit the XML configuration file for a domain, which will affect the
next boot of the guest.
1452 1453

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

E
Eric Blake 已提交
1455
 virsh dumpxml --inactive --security-info domain > domain.xml
O
Osier Yang 已提交
1456
 vi domain.xml (or make changes with your other text editor)
1457
 virsh define domain.xml
E
Eric Blake 已提交
1458

1459 1460
except that it does some error checking.

1461 1462
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
1463

1464
=item B<event> {[I<domain>] { I<event> | I<--all> } [I<--loop>]
1465
[I<--timeout> I<seconds>] [I<--timestamp>] | I<--list>}
1466 1467 1468 1469 1470

Wait for a class of domain events to occur, and print appropriate details
of events as they happen.  The events can optionally be filtered by
I<domain>.  Using I<--list> as the only argument will provide a list
of possible I<event> values known by this client, although the connection
1471 1472 1473
might not allow registering for all these events.  It is also possible
to use I<--all> instead of I<event> to register for all possible event
types at once.
1474 1475 1476 1477 1478 1479 1480

By default, this command is one-shot, and returns success once an event
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
If I<--timeout> is specified, the command gives up waiting for events
after I<seconds> have elapsed.   With I<--loop>, the command prints all
events until a timeout or interrupt key.

1481 1482 1483
When I<--timestamp> is used, a human-readable timestamp will be printed
before the event.

1484
=item B<iothreadinfo> I<domain> [[I<--live>] [I<--config>] | [I<--current>]]
J
John Ferlan 已提交
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495

Display basic domain IOThreads information including the IOThread ID and
the CPU Affinity for each IOThread.

If I<--live> is specified, get the IOThreads data from the running guest. If
the guest is not running, an error is returned.
If I<--config> is specified, get the IOThreads data from the next boot of
a persistent guest.
If I<--current> is specified or I<--live> and I<--config> are not specified,
then get the IOThread data based on the current guest state.

J
John Ferlan 已提交
1496 1497 1498 1499
=item B<iothreadpin> I<domain> I<iothread> I<cpulist>
[[I<--live>] [I<--config>] | [I<--current>]]

Change the pinning of a domain IOThread to host physical CPUs. In order
1500
to retrieve a list of all IOThreads, use B<iothreadinfo>. To pin an
J
John Ferlan 已提交
1501
I<iothread> specify the I<cpulist> desired for the IOThread ID as listed
1502
in the B<iothreadinfo> output.
J
John Ferlan 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521

I<cpulist> is a list of physical CPU numbers. Its syntax is a comma
separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can
also be allowed. The '-' denotes the range and the '^' denotes exclusive.
If you want to reset iothreadpin setting, that is, to pin an I<iothread>
to all physical cpus, simply specify 'r' as a I<cpulist>.

If I<--live> is specified, affect a running guest. If the guest is not running,
an error is returned.
If I<--config> is specified, affect the next boot of a persistent guest.
If I<--current> is specified or I<--live> and I<--config> are not specified,
affect the current guest state.
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
but I<--current> is exclusive.
If no flag is specified, behavior is different depending on hypervisor.

B<Note>: The expression is sequentially evaluated, so "0-15,^8" is
identical to "9-14,0-7,15" but not identical to "^8,0-15".

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 1547 1548
=item B<iothreadadd> I<domain> I<iothread_id>
[[I<--config>] [I<--live>] | [I<--current>]]

Add a new IOThread to the domain using the specified I<iothread_id>.
If the I<iothread_id> already exists, the command will fail. The
I<iothread_id> must be greater than zero.

If I<--live> is specified, affect a running guest. If the guest is not
running an error is returned.
If I<--config> is specified, affect the next boot of a persistent guest.
If I<--current> is specified or I<--live> and I<--config> are not specified,
affect the current guest state.

=item B<iothreaddel> I<domain> I<iothread_id>
[[I<--config>] [I<--live>] | [I<--current>]]

Delete an IOThread from the domain using the specified I<iothread_id>.
If an IOThread is currently assigned to a disk resource such as via the
B<attach-disk> command, then the attempt to remove the IOThread will fail.
If the I<iothread_id> does not exist an error will occur.

If I<--live> is specified, affect a running guest. If the guest is not
running an error is returned.
If I<--config> is specified, affect the next boot of a persistent guest.
If I<--current> is specified or I<--live> and I<--config> are not specified,
affect the current guest state.

1549
=item B<managedsave> I<domain> [I<--bypass-cache>]
1550
[{I<--running> | I<--paused>}] [I<--verbose>]
1551

1552
Save and destroy (stop) a running domain, so it can be restarted from the same
1553 1554
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.
1555 1556
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
1557

1558
The progress may be monitored using B<domjobinfo> virsh command and canceled
1559 1560 1561
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.
1562

1563 1564 1565 1566 1567
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.

1568 1569 1570
The B<dominfo> command can be used to query whether a domain currently
has any managed save image.

1571
=item B<managedsave-remove> I<domain>
1572

1573 1574
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.
1575

1576
=item B<maxvcpus> [I<type>]
E
Eric Blake 已提交
1577 1578 1579 1580 1581

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.

1582 1583 1584 1585 1586 1587 1588 1589
=item B<cpu-stats> I<domain> [I<--total>] [I<start>] [I<count>]

Provide cpu statistics information of a domain. The domain should
be running. Default it shows stats for all CPUs, and a total. Use
I<--total> for only the total stats, I<start> for only the per-cpu
stats of the CPUs from I<start>, I<count> for only I<count> CPUs'
stats.

1590 1591 1592 1593 1594 1595 1596
=item B<metadata> I<domain> [[I<--live>] [I<--config>] | [I<--current>]]
[I<--edit>] [I<uri>] [I<key>] [I<set>] [I<--remove>]

Show or modify custom XML metadata of a domain. The metadata is a user
defined XML that allows to store arbitrary XML data in the domain definition.
Multiple separate custom metadata pieces can be stored in the domain XML.
The pieces are identified by a private XML namespace provided via the
1597 1598
I<uri> argument. (See also B<desc> that works with textual metadata of
a domain.)
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620

Flags I<--live> or I<--config> select whether this command works on live
or persistent definitions of the domain. If both I<--live> and I<--config>
are specified, the I<--config> option takes precedence on getting the current
description and both live configuration and config are updated while setting
the description. I<--current> is exclusive and implied if none of these was
specified.

Flag I<--remove> specifies that the metadata element specified by the I<uri>
argument should be removed rather than updated.

Flag I<--edit> specifies that an editor with the metadata identified by the
I<uri> argument should be opened and the contents saved back afterwards.
Otherwise the new contents can be provided via the I<set> argument.

When setting metadata via I<--edit> or I<set> the I<key> argument must be
specified and is used to prefix the custom elements to bind them
to the private namespace.

If neither of I<--edit> and I<set> are specified the XML metadata corresponding
to the I<uri> namespace is displayed instead of being modified.

L
liguang 已提交
1621
=item B<migrate> [I<--live>] [I<--offline>] [I<--direct>] [I<--p2p> [I<--tunnelled>]]
1622
[I<--persistent>] [I<--undefinesource>] [I<--suspend>] [I<--copy-storage-all>]
1623
[I<--copy-storage-inc>] [I<--change-protection>] [I<--unsafe>] [I<--verbose>]
1624
[I<--rdma-pin-all>] [I<--abort-on-error>] [I<--postcopy>] [I<--postcopy-after-precopy>]
1625
I<domain> I<desturi> [I<migrateuri>] [I<graphicsuri>] [I<listen-address>] [I<dname>]
1626
[I<--timeout> B<seconds> [I<--timeout-suspend> | I<--timeout-postcopy>]]
1627
[I<--xml> B<file>] [I<--migrate-disks> B<disk-list>] [I<--disks-port> B<port>]
1628 1629
[I<--compressed>] [I<--comp-methods> B<method-list>]
[I<--comp-mt-level>] [I<--comp-mt-threads>] [I<--comp-mt-dthreads>]
1630
[I<--comp-xbzrle-cache>] [I<--auto-converge>] [I<auto-converge-initial>]
1631
[I<auto-converge-increment>] [I<--persistent-xml> B<file>]
1632

L
liguang 已提交
1633
Migrate domain to another host.  Add I<--live> for live migration; <--p2p>
1634
for peer-2-peer migration; I<--direct> for direct migration; or I<--tunnelled>
L
liguang 已提交
1635 1636 1637 1638
for tunnelled migration.  I<--offline> migrates domain definition without
starting the domain on destination and without stopping it on source host.
Offline migration may be used with inactive domains and it must be used with
I<--persistent> option.  I<--persistent> leaves the domain persistent on
1639 1640 1641 1642 1643
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).
1644 1645 1646
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
1647 1648 1649 1650 1651 1652 1653
host. By default only non-shared non-readonly images are transferred. Use
I<--migrate-disks> to explicitly specify a list of disk targets to
transfer via the comma separated B<disk-list> argument. I<--change-protection>
enforces that no incompatible configuration changes will be made to the domain
while the migration is underway; this flag is implicitly enabled when supported
by the hypervisor, but can be explicitly used to reject the migration if the
hypervisor lacks change protection support.  I<--verbose> displays the progress
1654
of migration.  I<--abort-on-error> cancels
1655
the migration if a soft error (for example I/O error) happens during the
1656
migration. I<--postcopy> enables post-copy logic in migration, but does not
1657 1658
actually start post-copy, i.e., migration is started in pre-copy mode.
Once migration is running, the user may switch to post-copy using the
1659
B<migrate-postcopy> command sent from another virsh instance or use
1660 1661
I<--postcopy-after-precopy> along with I<--postcopy> to let libvirt
automatically switch to post-copy after the first pass of pre-copy is finished.
1662

1663 1664 1665 1666 1667
I<--auto-converge> forces convergence during live migration. The initial
guest CPU throttling rate can be set with I<auto-converge-initial>. If the
initial throttling rate is not enough to ensure convergence, the rate is
periodically increased by I<auto-converge-increment>.

1668 1669
I<--rdma-pin-all> can be used with RDMA migration (i.e., when I<migrateuri>
starts with rdma://) to tell the hypervisor to pin all domain's memory at once
1670
before migration starts rather than letting it pin memory pages as needed.
1671

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

1675 1676 1677 1678 1679 1680 1681 1682
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.

1683
I<dname> is used for renaming the domain to new name during migration, which
1684 1685 1686 1687 1688
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.
1689 1690 1691
If I<--persistent> is enabled, I<--persistent-xml> B<file> can be used to
supply an alternative XML file which will be used as the persistent domain
definition on the destination host.
1692

1693 1694 1695 1696 1697 1698 1699 1700
I<--timeout> B<seconds> tells virsh to run a specified action when live
migration exceeds that many seconds.  It can only be used with I<--live>.
If I<--timeout-suspend> is specified, the domain will be suspended after
the timeout and the migration will complete offline; this is the default
if no I<--timeout-*> option is specified on the command line.  When
I<--timeout-postcopy> is used, virsh will switch migration from pre-copy
to post-copy upon timeout; migration has to be started with I<--postcopy>
option for this to work.
W
Wen Congyang 已提交
1701

1702 1703 1704 1705 1706 1707 1708 1709 1710 1711
I<--compressed> activates compression, the compression method is chosen
with I<--comp-methods>. Supported methods are "mt" and "xbzrle" and
can be used in any combination. When no methods are specified, a hypervisor
default methods will be used. QEMU defaults to "xbzrle". Compression methods
can be tuned further. I<--comp-mt-level> sets compression level.
Values are in range from 0 to 9, where 1 is maximum speed and 9 is maximum
compression. I<--comp-mt-threads> and I<--comp-mt-dthreads> set the number
of compress threads on source and the number of decompress threads on target
respectively. I<--comp-xbzrle-cache> sets size of page cache in bytes.

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

1715 1716 1717 1718 1719 1720
The I<desturi> and I<migrateuri> parameters can be used to control which
destination the migration uses.  I<desturi> is important for managed
migration, but unused for direct migration; I<migrateuri> is required
for direct migration, but can usually be automatically determined for
managed migration.

1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
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

1734
When I<migrateuri> is not specified, libvirt will automatically determine the
1735 1736 1737 1738 1739
hypervisor specific URI.  Some hypervisors, including QEMU, have an optional
"migration_host" configuration parameter (useful when the host has multiple
network interfaces).  If this is unspecified, libvirt determines a name
by looking up the target host's configured hostname.

1740 1741 1742 1743 1744 1745 1746 1747 1748
There are a few scenarios where specifying I<migrateuri> may help:

=over 4

=item * The configured hostname is incorrect, or DNS is broken.  If a host has a
hostname which will not resolve to match one of its public IP addresses, then
libvirt will generate an incorrect URI.  In this case I<migrateuri> should be
explicitly specified, using an IP address, or a correct hostname.

N
Nehal J Wani 已提交
1749
=item * The host has multiple network interfaces.  If a host has multiple network
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
interfaces, it might be desirable for the migration data stream to be sent over
a specific interface for either security or performance reasons.  In this case
I<migrateuri> should be explicitly specified, using an IP address associated
with the network to be used.

=item * The firewall restricts what ports are available.  When libvirt generates
a migration URI, it will pick a port number using hypervisor specific rules.
Some hypervisors only require a single port to be open in the firewalls, while
others require a whole range of port numbers.  In the latter case I<migrateuri>
might be specified to choose a specific port number outside the default range in
order to comply with local firewall policies.

=back

1764 1765 1766
See L<http://libvirt.org/migration.html#uris> for more details on
migration URIs.

1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782
Optional I<graphicsuri> overrides connection parameters used for automatically
reconnecting a graphical clients at the end of migration. If omitted, libvirt
will compute the parameters based on target host IP address. In case the
client does not have a direct access to the network virtualization hosts are
connected to and needs to connect through a proxy, I<graphicsuri> may be used
to specify the address the client should connect to. The URI is formed as
follows:

    protocol://hostname[:port]/[?parameters]

where protocol is either "spice" or "vnc" and parameters is a list of protocol
specific parameters separated by '&'. Currently recognized parameters are
"tlsPort" and "tlsSubject". For example,

    spice://target.host.com:1234/?tlsPort=4567

1783 1784 1785 1786 1787 1788
Optional I<listen-address> sets the listen address that hypervisor on the
destination side should bind to for incoming migration. Both IPv4 and IPv6
addresses are accepted as well as hostnames (the resolving is done on
destination). Some hypervisors do not support this feature and will return an
error if this parameter is used.

1789 1790 1791
Optional I<disks-port> sets the port that hypervisor on destination side should
bind to for incoming disks traffic. Currently it is supported only by qemu.

1792
=item B<migrate-setmaxdowntime> I<domain> I<downtime>
1793 1794 1795 1796 1797

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.

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
=item B<migrate-compcache> I<domain> [I<--size> B<bytes>]

Sets and/or gets size of the cache (in bytes) used for compressing repeatedly
transferred memory pages during live migration. When called without I<size>,
the command just prints current size of the compression cache. When I<size>
is specified, the hypervisor is asked to change compression cache to I<size>
bytes and then the current size is printed (the result may differ from the
requested size due to rounding done by the hypervisor). The I<size> option
is supposed to be used while the domain is being live-migrated as a reaction
to migration progress and increasing number of compression cache misses
obtained from domjobinfo.

1810
=item B<migrate-setspeed> I<domain> I<bandwidth>
1811

1812
Set the maximum migration bandwidth (in MiB/s) for a domain which is being
1813 1814 1815 1816
migrated to another host. I<bandwidth> is interpreted as an unsigned long
long value. Specifying a negative value results in an essentially unlimited
value being provided to the hypervisor. The hypervisor can choose whether to
reject the value or convert it to the maximum value allowed.
1817

1818
=item B<migrate-getspeed> I<domain>
1819

1820
Get the maximum migration bandwidth (in MiB/s) for a domain.
1821

1822 1823 1824 1825 1826
=item B<migrate-postcopy> I<domain>

Switch the current migration from pre-copy to post-copy. This is only
supported for a migration started with I<--postcopy> option.

H
Hu Tao 已提交
1827 1828 1829 1830 1831 1832 1833
=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.

1834 1835 1836 1837 1838
I<mode> can be one of `strict', `interleave' and `preferred' or any
valid number from the virDomainNumatuneMemMode enum in case the daemon
supports it.  For a running domain, the mode can't be changed, and the
nodeset can be changed only if the domain was started with a mode of
`strict'.
H
Hu Tao 已提交
1839 1840 1841 1842 1843 1844 1845 1846 1847

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.

1848
=item B<reboot> I<domain> [I<--mode MODE-LIST>]
1849

1850 1851 1852 1853
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.
1854

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

1858 1859
By default the hypervisor will try to pick a suitable shutdown
method. To specify an alternative method, the I<--mode> parameter
1860
can specify a comma separated list which includes C<acpi>, C<agent>,
1861 1862
C<initctl>, C<signal> and C<paravirt>. The order in which drivers will
try each mode is undefined, and not related to the order specified to virsh.
1863 1864
For strict control over ordering, use a single mode at a time and
repeat the command.
1865

1866
=item B<reset> I<domain>
X
Xu He Jie 已提交
1867 1868 1869 1870 1871 1872 1873

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.

1874
=item B<restore> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
1875
[{I<--running> | I<--paused>}]
1876

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

1879 1880 1881
If I<--bypass-cache> is specified, the restore will avoid the file system
cache, although this may slow down the operation.

1882 1883 1884 1885 1886 1887
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.

1888 1889 1890 1891 1892
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.

1893
B<Note>: To avoid corrupting file system contents within the domain, you
E
Eric Blake 已提交
1894 1895 1896
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.
1897

1898
=item B<save> I<domain> I<state-file> [I<--bypass-cache>] [I<--xml> B<file>]
1899
[{I<--running> | I<--paused>}] [I<--verbose>]
1900

E
Eric Blake 已提交
1901 1902
Saves a running domain (RAM, but not disk state) to a state file so that
it can be restored
1903 1904 1905
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.
1906 1907
If I<--bypass-cache> is specified, the save will avoid the file system
cache, although this may slow down the operation.
1908

1909
The progress may be monitored using B<domjobinfo> virsh command and canceled
1910 1911 1912
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.
1913

1914 1915 1916 1917
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.

1918 1919 1920 1921 1922 1923
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.

1924 1925 1926 1927 1928
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 已提交
1929 1930 1931 1932 1933
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.

1934
=item B<save-image-define> I<file> I<xml> [{I<--running> | I<--paused>}]
1935 1936 1937 1938 1939 1940 1941 1942

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.

1943 1944 1945 1946 1947
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.

1948 1949 1950 1951 1952 1953
=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.

1954
=item B<save-image-edit> I<file> [{I<--running> | I<--paused>}]
1955 1956 1957 1958

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

1959 1960 1961 1962 1963
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.

1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
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>.

1975 1976
=item B<schedinfo> I<domain> [[I<--config>] [I<--live>] | [I<--current>]]
[[I<--set>] B<parameter=value>]...
1977

1978
=item B<schedinfo> [I<--weight> B<number>] [I<--cap> B<number>]
1979
I<domain>
1980

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

1984
LXC (posix scheduler) : cpu_shares, vcpu_period, vcpu_quota
1985

1986
QEMU/KVM (posix scheduler): cpu_shares, vcpu_period, vcpu_quota,
1987
emulator_period, emulator_quota, iothread_quota, iothread_period
D
David Jorm 已提交
1988 1989 1990 1991 1992

Xen (credit scheduler): weight, cap

ESX (allocation scheduler): reservation, limit, shares

1993 1994 1995 1996
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.

1997 1998
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.
1999 2000
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.
2001 2002

B<Note>: The weight and cap parameters are defined only for the
2003
XEN_CREDIT scheduler.
2004

2005 2006 2007 2008
B<Note>: The vcpu_period, emulator_period, and iothread_period parameters
have a valid value range of 1000-1000000 or 0, and the vcpu_quota,
emulator_quota, and iothread_quota parameters have a valid value range of
1000-18446744073709551 or less than 0. The value 0 for
2009
either parameter is the same as not specifying that parameter.
2010

2011
=item B<screenshot> I<domain> [I<imagefilepath>] [I<--screen> B<screenID>]
2012 2013 2014 2015 2016 2017 2018 2019

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.

2020
=item B<send-key> I<domain> [I<--codeset> B<codeset>]
2021 2022
[I<--holdtime> B<holdtime>] I<keycode>...

2023
Parse the I<keycode> sequence as keystrokes to send to I<domain>.
2024 2025 2026 2027 2028 2029
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.

2030 2031 2032 2033
If multiple keycodes are specified, they are all sent simultaneously
to the guest, and they may be received in random order. If you need
distinct keypresses, you must use multiple send-key invocations.

2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097
=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>
2098 2099 2100
  # send three strokes 'k', 'e', 'y', using xt codeset. these
  # are all pressed simultaneously and may be received by the guest
  # in random order
2101
  virsh send-key dom --codeset xt 37 18 21
2102

2103 2104
  # send one stroke 'right-ctrl+C'
  virsh send-key dom KEY_RIGHTCTRL KEY_C
2105

2106 2107 2108
  # send a tab, held for 1 second
  virsh send-key --holdtime 1000 0xf

2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
=item B<send-process-signal> I<domain-id> I<pid> I<signame>

Send a signal I<signame> to the process identified by I<pid> running in
the virtual domain I<domain-id>. The I<pid> is a process ID in the virtual
domain namespace.

The I<signame> argument may be either an integer signal constant number,
or one of the symbolic names:

    "nop", "hup", "int", "quit", "ill",
    "trap", "abrt", "bus", "fpe", "kill",
    "usr1", "segv", "usr2", "pipe", "alrm",
    "term", "stkflt", "chld", "cont", "stop",
    "tstp", "ttin", "ttou", "urg", "xcpu",
    "xfsz", "vtalrm", "prof", "winch", "poll",
    "pwr", "sys", "rt0", "rt1", "rt2", "rt3",
    "rt4", "rt5", "rt6", "rt7", "rt8", "rt9",
    "rt10", "rt11", "rt12", "rt13", "rt14", "rt15",
    "rt16", "rt17", "rt18", "rt19", "rt20", "rt21",
    "rt22", "rt23", "rt24", "rt25", "rt26", "rt27",
    "rt28", "rt29", "rt30", "rt31", "rt32"

The symbol name may optionally be prefixed with 'sig' or 'sig_' and
may be in uppercase or lowercase.

B<Examples>
  virsh send-process-signal myguest 1 15
  virsh send-process-signal myguest 1 term
  virsh send-process-signal myguest 1 sigterm
  virsh send-process-signal myguest 1 SIG_HUP

2140
=item B<setmem> I<domain> B<size> [[I<--config>] [I<--live>] |
2141
[I<--current>]]
2142

2143 2144 2145
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.
2146 2147 2148 2149
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.
2150

E
Eric Blake 已提交
2151 2152 2153 2154 2155 2156
I<size> is a scaled integer (see B<NOTES> above); it defaults to kibibytes
(blocks of 1024 bytes) unless you provide a suffix (and the older option
name I<--kilobytes> is available as a deprecated synonym) .  Libvirt rounds
up to the nearest kibibyte.  Some hypervisors require a larger granularity
than KiB, and requests that are not an even multiple will be rounded up.
For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes).
2157 2158 2159

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

2161 2162 2163 2164 2165 2166 2167
For LXC, the value being set is the cgroups value for limit_in_bytes or the
maximum amount of user memory (including file cache). When viewing memory
inside the container, this is the /proc/meminfo "MemTotal" value. When viewing
the value from the host, use the B<virsh memtune> command. In order to view
the current memory in use and the maximum value allowed to set memory, use
the B<virsh dominfo> command.

2168 2169 2170 2171 2172 2173 2174 2175 2176 2177
=item B<set-user-password> I<domain> I<user> I<password> [I<--encrypted>]

Set the password for the I<user> account in the guest domain.

If I<--encrypted> is specified, the password is assumed to be already
encrypted by the method required by the guest OS.

For QEMU/KVM, this requires the guest agent to be configured
and running.

2178
=item B<setmaxmem> I<domain> B<size> [[I<--config>] [I<--live>] |
2179
[I<--current>]]
2180

2181 2182 2183 2184
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 已提交
2185
Both I<--live> and I<--config> flags may be given, but I<--current> is
2186 2187
exclusive. If no flag is specified, behavior is different depending
on hypervisor.
2188

2189
Some hypervisors such as QEMU/KVM don't support live changes (especially
2190 2191 2192 2193
increasing) of the maximum memory limit.  Even persistent configuration changes
might not be performed with some hypervisors/configuration (e.g. on NUMA enabled
domains on QEMU).  For complex configuration changes use command B<edit>
instead).
2194

E
Eric Blake 已提交
2195 2196 2197 2198 2199 2200
I<size> is a scaled integer (see B<NOTES> above); it defaults to kibibytes
(blocks of 1024 bytes) unless you provide a suffix (and the older option
name I<--kilobytes> is available as a deprecated synonym) .  Libvirt rounds
up to the nearest kibibyte.  Some hypervisors require a larger granularity
than KiB, and requests that are not an even multiple will be rounded up.
For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes).
2201

2202
=item B<memtune> I<domain> [I<--hard-limit> B<size>]
E
Eric Blake 已提交
2203 2204
[I<--soft-limit> B<size>] [I<--swap-hard-limit> B<size>]
[I<--min-guarantee> B<size>] [[I<--config>] [I<--live>] | [I<--current>]]
E
Eric Blake 已提交
2205 2206 2207 2208

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
2209
QEMU/KVM support I<--hard-limit>, I<--soft-limit>, and I<--swap-hard-limit>.
E
Eric Blake 已提交
2210 2211
I<--min-guarantee> is supported only by ESX hypervisor.  Each of these
limits are scaled integers (see B<NOTES> above), with a default of
2212 2213 2214 2215
kibibytes (blocks of 1024 bytes) if no suffix is present. Libvirt rounds
up to the nearest kibibyte.  Some hypervisors require a larger granularity
than KiB, and requests that are not an even multiple will be rounded up.
For example, vSphere/ESX rounds the parameter up to mebibytes (1024 kibibytes).
2216

2217 2218 2219
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 已提交
2220
Both I<--live> and I<--config> flags may be given, but I<--current> is
2221 2222 2223
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

2224 2225 2226 2227 2228
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.

2229 2230 2231
For LXC, the displayed hard_limit value is the current memory setting
from the XML or the results from a B<virsh setmem> command.

2232 2233 2234 2235
=over 4

=item I<--hard-limit>

E
Eric Blake 已提交
2236
The maximum memory the guest can use.
2237 2238 2239

=item I<--soft-limit>

E
Eric Blake 已提交
2240
The memory limit to enforce during memory contention.
2241 2242 2243

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

E
Eric Blake 已提交
2244 2245
The maximum memory plus swap the guest can use.  This has to be more
than hard-limit value provided.
2246 2247 2248

=item I<--min-guarantee>

E
Eric Blake 已提交
2249
The guaranteed minimum memory allocation for the guest.
2250 2251

=back
2252

2253 2254
Specifying -1 as a value for these limits is interpreted as unlimited.

2255 2256
=item B<perf> I<domain> [I<--enable> B<eventSpec>]
[I<--disable> B<eventSpec>]
2257
[[I<--config>] [I<--live>] | [I<--current>]]
2258 2259

Get the current perf events setting or enable/disable specific perf
2260
events for a guest domain.
2261 2262 2263 2264 2265 2266 2267 2268 2269

Perf is a performance analyzing tool in Linux, and it can instrument
CPU performance counters, tracepoints, kprobes, and uprobes (dynamic
tracing). Perf supports a list of measurable events, and can measure
events coming from different sources. For instance, some event are
pure kernel counters, in this case they are called software events,
including context-switches, minor-faults, etc.. Now dozens of events
from different sources can be supported by perf.

2270
Currently only QEMU/KVM supports this command. The I<--enable> and I<--disable>
2271
option combined with B<eventSpec> can be used to enable or disable specific
2272
performance event. B<eventSpec> is a string list of one or more events
2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284
separated by commas. Valid event names are as follows:

B<Valid perf event names>
  cmt              - A PQos (Platform Qos) feature to monitor the
                     usage of cache by applications running on the
                     platform.
  mbmt             - Provides a way to monitor the total system
                     memory bandwidth between one level of cache
                     and another.
  mbml             - Provides a way to limit the amount of data
                     (bytes/s) send through the memory controller
                     on the socket.
Q
Qiaowei Ren 已提交
2285 2286 2287 2288 2289 2290
  cache_misses     - Provides the count of cache misses by
                     applications running on the platform.
  cache_references - Provides the count of cache hits by
                     applications running on th e platform.
  instructions     - Provides the count of instructions executed
                     by applications running on the platform.
2291 2292 2293 2294
  cpu_cycles       - Provides the count of cpu cycles
                     (total/elapsed). May be used with
                     instructions in order to get a cycles
                     per instruction.
2295 2296 2297
  branch_instructions - Provides the count of branch instructions
                        executed by applications running on the
                        platform.
2298 2299
  branch_misses    - Provides the count of branch misses executed
                     by applications running on the platform.
2300 2301
  bus_cycles       - Provides the count of bus cycles executed
                     by applications running on the platform.
2302 2303 2304 2305
  stalled_cycles_frontend - Provides the count of stalled cpu
                            cycles in the frontend of the
                            instruction processor pipeline by
                            applications running on the platform.
2306 2307 2308 2309
  stalled_cycles_backend - Provides the count of stalled cpu
                           cycles in the backend of the
                           instruction processor pipeline by
                           applications running on the platform.
2310 2311 2312
  ref_cpu_cycles   -  Provides the count of total cpu cycles
                      not affected by CPU frequency scaling by
                      applications running on the platform.
2313 2314 2315

B<Note>: The statistics can be retrieved using the B<domstats> command using
the I<--perf> flag.
2316

2317 2318 2319 2320 2321 2322 2323
If I<--live> is specified, affect a running guest.
If I<--config> is specified, affect the next boot of a persistent guest.
If I<--current> is specified, affect the current guest state.
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

2324
=item B<blkiotune> I<domain> [I<--weight> B<weight>]
2325 2326 2327 2328 2329 2330
[I<--device-weights> B<device-weights>]
[I<--device-read-iops-sec> B<device-read-iops-sec>]
[I<--device-write-iops-sec> B<device-write-iops-sec>]
[I<--device-read-bytes-sec> B<device-read-bytes-sec>]
[I<--device-write-bytes-sec> B<device-write-bytes-sec>]
[[I<--config>] [I<--live>] | [I<--current>]]
2331 2332

Display or set the blkio parameters. QEMU/KVM supports I<--weight>.
2333 2334
I<--weight> is in range [100, 1000]. After kernel 2.6.39, the value
could be in the range [10, 1000].
2335

2336 2337
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.
2338 2339 2340 2341
Each weight is in the range [100, 1000], [10, 1000] after kernel 2.6.39,
or the value 0 to remove that device from per-device listings.
Only the devices listed in the string are modified;
any existing per-device weights for other devices remain unchanged.
2342

2343 2344 2345
B<device-read-iops-sec> is a single string listing one or more device/read_iops_sec
pairs, int the format of /path/to/device,read_iops_sec,/path/to/device,read_iops_sec.
Each read_iops_sec is a number which type is unsigned int, value 0 to remove that
N
Nitesh Konkar 已提交
2346
device from per-device listing.
2347 2348 2349 2350 2351 2352
Only the devices listed in the string are modified;
any existing per-device read_iops_sec for other devices remain unchanged.

B<device-write-iops-sec> is a single string listing one or more device/write_iops_sec
pairs, int the format of /path/to/device,write_iops_sec,/path/to/device,write_iops_sec.
Each write_iops_sec is a number which type is unsigned int, value 0 to remove that
N
Nitesh Konkar 已提交
2353
device from per-device listing.
2354 2355 2356 2357 2358 2359
Only the devices listed in the string are modified;
any existing per-device write_iops_sec for other devices remain unchanged.

B<device-read-bytes-sec> is a single string listing one or more device/read_bytes_sec
pairs, int the format of /path/to/device,read_bytes_sec,/path/to/device,read_bytes_sec.
Each read_bytes_sec is a number which type is unsigned long long, value 0 to remove
N
Nitesh Konkar 已提交
2360
that device from per-device listing.
2361 2362 2363 2364 2365 2366
Only the devices listed in the string are modified;
any existing per-device read_bytes_sec for other devices remain unchanged.

B<device-write-bytes-sec> is a single string listing one or more device/write_bytes_sec
pairs, int the format of /path/to/device,write_bytes_sec,/path/to/device,write_bytes_sec.
Each write_bytes_sec is a number which type is unsigned long long, value 0 to remove
N
Nitesh Konkar 已提交
2367
that device from per-device listing.
2368 2369 2370
Only the devices listed in the string are modified;
any existing per-device write_bytes_sec for other devices remain unchanged.

H
Hu Tao 已提交
2371 2372 2373
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 已提交
2374
Both I<--live> and I<--config> flags may be given, but I<--current> is
H
Hu Tao 已提交
2375 2376 2377
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

2378
=item B<setvcpus> I<domain> I<count> [I<--maximum>] [[I<--config>]
2379
[I<--live>] | [I<--current>]] [I<--guest>] [I<--hotpluggable>]
2380

2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391
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.
2392

2393 2394
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
2395 2396 2397
specified together if supported by the hypervisor.  If this command is run
before the guest has finished booting, the guest may fail to process
the change.
2398

2399 2400 2401
If I<--current> is specified, affect the current guest state.

When no flags are given, the I<--live>
2402 2403 2404 2405
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 已提交
2406

2407 2408 2409
If I<--guest> is specified, then the count of cpus is modified in the guest
instead of the hypervisor. This flag is usable only for live domains
and may require guest agent to be configured in the guest.
2410

2411 2412 2413 2414 2415
To allow adding vcpus to persistent definitions that can be later hotunplugged
after the domain is booted it is necessary to specify the I<--hotpluggable>
flag. Vcpus added to live domains supporting vcpu unplug are automatically
marked as hotpluggable.

2416 2417
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
2418 2419
used with the I<--config> flag, and not with the I<--live> or the I<--current>
flag.
E
Eric Blake 已提交
2420

2421
=item B<shutdown> I<domain> [I<--mode MODE-LIST>]
2422 2423

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

2428
The exact behavior of a domain when it shuts down is set by the
2429
I<on_poweroff> parameter in the domain's XML definition.
2430

2431
If I<domain> is transient, then the metadata of any snapshots will
2432 2433 2434 2435
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>.

2436 2437
By default the hypervisor will try to pick a suitable shutdown
method. To specify an alternative method, the I<--mode> parameter
2438
can specify a comma separated list which includes C<acpi>, C<agent>,
2439 2440
C<initctl>, C<signal> and C<paravirt>. The order in which drivers will
try each mode is undefined, and not related to the order specified to virsh.
2441 2442
For strict control over ordering, use a single mode at a time and
repeat the command.
2443

2444
=item B<start> I<domain-name-or-uuid> [I<--console>] [I<--paused>]
2445
[I<--autodestroy>] [I<--bypass-cache>] [I<--force-boot>] [I<--pass-fds N,M,...>]
2446

2447 2448 2449 2450
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 已提交
2451
If I<--console> is requested, attach to the console after creation.
2452 2453
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
2454 2455
exits.  If I<--bypass-cache> is specified, and managedsave state exists,
the restore will avoid the file system cache, although this may slow
2456 2457
down the operation.  If I<--force-boot> is specified, then any
managedsave state is discarded and a fresh boot occurs.
2458

2459 2460
If I<--pass-fds> is specified, the argument is a comma separated list
of open file descriptors which should be pass on into the guest. The
N
Nitesh Konkar 已提交
2461
file descriptors will be re-numbered in the guest, starting from 3. This
2462 2463
is only supported with container based virtualization.

2464
=item B<suspend> I<domain>
2465 2466 2467

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

2469
=item B<resume> I<domain>
2470

2471
Moves a domain out of the suspended state.  This will allow a previously
2472
suspended domain to now be eligible for scheduling by the underlying
2473
hypervisor.
2474

2475
=item B<dompmsuspend> I<domain> I<target> [I<--duration>]
2476 2477 2478

Suspend a running domain into one of these states (possible I<target>
values):
N
Nehal J Wani 已提交
2479 2480
    mem equivalent of S3 ACPI state
    disk equivalent of S4 ACPI state
2481 2482
    hybrid RAM is saved to disk but not powered off

2483 2484 2485 2486 2487 2488 2489 2490
The I<--duration> argument specifies number of seconds before the domain is
woken up after it was suspended (see also B<dompmwakeup>). Default is 0 for
unlimited suspend time. (This feature isn't currently supported by any
hypervisor driver and 0 should be used.).

Note that this command requires a guest agent configured and running in the
domain's guest OS.

2491 2492 2493 2494 2495 2496 2497
Beware that at least for QEMU, the domain's process will be terminated when
target disk is used and a new process will be launched when libvirt is asked
to wake up the domain. As a result of this, any runtime changes, such as
device hotplug or memory settings, are lost unless such changes were made
with I<--config> flag.


2498
=item B<dompmwakeup> I<domain>
2499

2500 2501 2502 2503
Wakeup a domain from pmsuspended state (either suspended by dompmsuspend or
from the guest itself). Injects a wakeup into the guest that is in pmsuspended
state, rather than waiting for the previously requested duration (if any) to
elapse. This operation doesn't not necessarily fail if the domain is running.
2504

2505
=item B<ttyconsole> I<domain>
2506 2507

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

2510
=item B<undefine> I<domain> [I<--managed-save>] [I<--snapshots-metadata>]
2511
[I<--nvram>] [I<--keep-nvram>]
2512 2513
[ {I<--storage> B<volumes> | I<--remove-all-storage> [I<--delete-snapshots>]}
I<--wipe-storage>]
2514

2515 2516 2517 2518
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.

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

2523 2524 2525 2526 2527 2528
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.

2529 2530
I<--nvram> and I<--keep-nvram> specify accordingly to delete or keep nvram
(/domain/os/nvram/) file. If the domain has an nvram file and the flags are
2531 2532
omitted, the undefine will fail.

2533 2534 2535 2536 2537 2538 2539
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
2540 2541
deleted. Only volumes managed by libvirt in storage pools can be removed this
way.
2542 2543 2544 2545 2546 2547
(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.

2548 2549 2550 2551 2552
The I<--delete-snapshots> flag specifies that any snapshots associated with
the storage volume should be deleted as well. Requires the
I<--remove-all-storage> flag to be provided. Not all storage drivers
support this option, presently only rbd.

2553 2554 2555
The flag I<--wipe-storage> specifies that the storage volumes should be
wiped before removal.

2556
NOTE: For an inactive domain, the domain name or UUID must be used as the
2557
I<domain>.
2558

2559
=item B<vcpucount> I<domain>  [{I<--maximum> | I<--active>}
2560
{I<--config> | I<--live> | I<--current>}] [I<--guest>]
E
Eric Blake 已提交
2561 2562

Print information about the virtual cpu counts of the given
2563
I<domain>.  If no flags are specified, all possible counts are
E
Eric Blake 已提交
2564
listed in a table; otherwise, the output is limited to just the
2565 2566 2567
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 已提交
2568 2569

I<--maximum> requests information on the maximum cap of vcpus that a
2570
domain can add via B<setvcpus>, while I<--active> shows the current
E
Eric Blake 已提交
2571
usage; these two flags cannot both be specified.  I<--config>
2572 2573 2574 2575 2576
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.
2577

2578 2579 2580
If I<--guest> is specified, then the count of cpus is reported from
the perspective of the guest. This flag is usable only for live domains
and may require guest agent to be configured in the guest.
E
Eric Blake 已提交
2581

2582
=item B<vcpuinfo> I<domain> [I<--pretty>]
2583

2584 2585
Returns basic information about the domain virtual CPUs, like the number of
vCPUs, the running time, the affinity to physical processors.
2586

2587 2588
With I<--pretty>, cpu affinities are shown as ranges.

2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637
An example output is

 $ virsh vcpuinfo fedora
 VCPU:           0
 CPU:            0
 State:          running
 CPU time:       7,0s
 CPU Affinity:   yyyy

 VCPU:           1
 CPU:            1
 State:          running
 CPU time:       0,7s
 CPU Affinity:   yyyy

B<STATES>

The State field displays the current operating state of a virtual CPU

=over 4

=item B<offline>

The virtual CPU is offline and not usable by the domain.
This state is not supported by all hypervisors.

=item B<running>

The virtual CPU is available to the domain and is operating.

=item B<blocked>

The virtual CPU is available to the domain but is waiting for a resource.
This state is not supported by all hypervisors, in which case I<running>
may be reported instead.

=item B<no state>

The virtual CPU state could not be determined. This could happen if
the hypervisor is newer than virsh.

=item B<N/A>

There's no information about the virtual CPU state available. This can
be the case if the domain is not running or the hypervisor does
not report the virtual CPU state.

=back

2638
=item B<vcpupin> I<domain> [I<vcpu>] [I<cpulist>] [[I<--live>]
2639
[I<--config>] | [I<--current>]]
2640

2641 2642 2643 2644 2645
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
2646 2647
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.
2648
For pinning the I<vcpu> to all physical cpus specify 'r' as a I<cpulist>.
2649 2650 2651
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.
2652 2653
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
but I<--current> is exclusive.
2654
If no flag is specified, behavior is different depending on hypervisor.
2655

2656 2657
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".
2658

H
Hu Tao 已提交
2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673
=item B<emulatorpin> I<domain> [I<cpulist>] [[I<--live>] [I<--config>]
 | [I<--current>]]

Query or change the pinning of domain's emulator threads to host physical
CPUs.

See B<vcpupin> for I<cpulist>.

If I<--live> is specified, affect a running guest.
If I<--config> is specified, affect the next boot of a persistent guest.
If I<--current> is specified, affect the current guest state.
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
but I<--current> is exclusive.
If no flag is specified, behavior is different depending on hypervisor.

2674 2675 2676 2677 2678 2679 2680 2681 2682 2683
=item B<guestvcpus> I<domain> [[I<--enable>] | [I<--disable>]] [I<cpulist>]

Query or change state of vCPUs from guest's point of view using the guest agent.
When invoked without I<cpulist> the guest is queried for available guest vCPUs,
their state and possibility to be offlined.

If I<cpulist> is provided then one of I<--enable> or I<--disable> must be
provided too. The desired operation is then executed on the domain.

See B<vcpupin> for information on I<cpulist>.
H
Hu Tao 已提交
2684

2685
=item B<vncdisplay> I<domain>
2686

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

2690 2691 2692
=back

=head1 DEVICE COMMANDS
2693 2694

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

2700 2701
=over 4

2702 2703
=item B<attach-device> I<domain> I<FILE>
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
2704

2705 2706 2707 2708 2709 2710
Attach a device to the domain, using a device definition in an XML
file using a device definition element such as <disk> or <interface>
as the top-level element.  See the documentation at
L<http://libvirt.org/formatdomain.html#elementsDevices> to learn about
libvirt XML format for a device.  If I<--config> is specified the
command alters the persistent domain configuration with the device
2711
attach taking effect the next time libvirt starts the domain.
2712 2713 2714
For cdrom and floppy devices, this command only replaces the media
within an existing device; consider using B<update-device> for this
usage.  For passthrough host devices, see also B<nodedev-detach>,
2715
needed if the PCI device does not use managed mode.
2716

2717 2718 2719 2720 2721 2722 2723 2724 2725 2726
If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain.
If I<--current> is specified, affect the current domain state.
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. When no flag is specified legacy API is used whose behavior depends
on the hypervisor driver.

For compatibility purposes, I<--persistent> behaves like I<--config> for
an offline domain, and like I<--live> I<--config> for a running domain.

2727 2728 2729 2730
B<Note>: using of partial device definition XML files may lead to unexpected
results as some fields may be autogenerated and thus match devices other than
expected.

2731 2732
=item B<attach-disk> I<domain> I<source> I<target> [[[I<--live>] [I<--config>]
| [I<--current>]] | [I<--persistent>]] [I<--targetbus bus>] [I<--driver
2733 2734
driver>] [I<--subdriver subdriver>] [I<--iothread iothread>]
[I<--cache cache>] [I<--type type>]
2735 2736
[I<--mode mode>] [I<--sourcetype sourcetype>] [I<--serial serial>] [I<--wwn
wwn>] [I<--rawio>] [I<--address address>] [I<--multifunction>] [I<--print-xml>]
2737 2738

Attach a new disk device to the domain.
2739 2740
I<source> is path for the files and devices. I<target> controls the bus or
device under which the disk is exposed to the guest OS. It indicates the
2741 2742 2743 2744 2745 2746
"logical" device name; the optional I<targetbus> attribute specifies the type
of disk device to emulate; possible values are driver specific, with typical
values being I<ide>, I<scsi>, I<virtio>, I<xen>, I<usb>, I<sata>, or I<sd>, if
omitted, the bus type is inferred from the style of the device name (e.g.  a
device named 'sda' will typically be exported using a SCSI bus).  I<driver> can
be I<file>, I<tap> or I<phy> for the Xen
2747
hypervisor depending on the kind of access; or I<qemu> for the QEMU emulator.
2748 2749 2750 2751 2752 2753 2754 2755 2756
Further details to the driver can be passed using I<subdriver>. For Xen
I<subdriver> can be I<aio>, while for QEMU subdriver should match the format
of the disk source, such as I<raw> or I<qcow2>.  Hypervisor default will be
used if I<subdriver> is not specified.  However, the default may not be
correct, esp. for QEMU as for security reasons it is configured not to detect
disk formats.  I<type> can indicate I<lun>, I<cdrom> or I<floppy> as
alternative to the disk default, although this use only replaces the media
within the existing virtual cdrom or floppy device; consider using
B<update-device> for this usage instead.
2757
I<mode> can specify the two specific mode I<readonly> or I<shareable>.
2758
I<sourcetype> can indicate the type of source (block|file)
2759 2760
I<cache> can be one of "default", "none", "writethrough", "writeback",
"directsync" or "unsafe".
2761 2762
I<iothread> is the number within the range of domain IOThreads to which
this disk may be attached (QEMU only).
2763
I<serial> is the serial of disk device. I<wwn> is the wwn of disk device.
2764
I<rawio> indicates the disk needs rawio capability.
2765
I<address> is the address of disk device in the form of pci:domain.bus.slot.function,
2766 2767
scsi:controller.bus.unit, ide:controller.bus.unit or ccw:cssid.ssid.devno.
Virtio-ccw devices must have their cssid set to 0xfe.
2768 2769
I<multifunction> indicates specified pci address is a multifunction pci device
address.
2770

2771 2772 2773
If I<--print-xml> is specified, then the XML of the disk that would be attached
is printed instead.

2774 2775 2776 2777 2778 2779 2780 2781 2782
If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain.
If I<--current> is specified, affect the current domain state.
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. When no flag is specified legacy API is used whose behavior depends
on the hypervisor driver.

For compatibility purposes, I<--persistent> behaves like I<--config> for
an offline domain, and like I<--live> I<--config> for a running domain.
2783
Likewise, I<--shareable> is an alias for I<--mode shareable>.
2784

2785
=item B<attach-interface> I<domain> I<type> I<source>
2786
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
2787
[I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>]
2788
[I<--inbound average,peak,burst,floor>] [I<--outbound average,peak,burst>]
2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799
[I<--managed>] [I<--print-xml>]

Attach a new network interface to the domain.

B<type> can be one of the:

=over 4

I<network> to indicate connection via a libvirt virtual network,

I<bridge> to indicate connection via a bridge device on the host,
2800

2801
I<direct> to indicate connection directly to one of the host's network
2802 2803
interfaces or bridges,

2804 2805 2806
I<hostdev> to indicate connection using a passthrough of PCI device
on the host.

2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819
=back

B<source> indicates the source of the connection.  The source depends
on the type of the interface:

=over 4

I<network> name of the virtual network,

I<bridge> the name of the bridge device,

I<direct> the name of the host's interface or bridge,

2820 2821 2822
I<hostdev> the PCI address of the host's interface formatted
as domain:bus:slot.function.

2823 2824 2825 2826 2827 2828 2829 2830
=back

B<--target> is used to specify the tap/macvtap device to be used to
connect the domain to the source.  Names starting with 'vnet' are
considered as auto-generated and are blanked out/regenerated each
time the interface is attached.

B<--mac> specifies the MAC address of the network interface; if a MAC
2831 2832
address is not given, a new address will be automatically generated
(and stored in the persistent configuration if "--config" is given on
2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845
the command line).

B<--script> is used to specify a path to a custom script to be called
while attaching to a bridge - this will be called instead of the default
script not in addition to it.  This is valid only for interfaces of
I<bridge> type and only for Xen domains.

B<--model> specifies the network device model to be presented to the
domain.

B<--inbound> and B<--outbound> control the bandwidth of the
interface.  At least one from the I<average>, I<floor> pair must be
specified.  The other two I<peak> and I<burst> are optional, so
2846
"average,peak", "average,,burst", "average,,,floor", "average" and
2847
",,,floor" are also legal.  Values for I<average>, I<floor> and I<peak>
2848 2849 2850
are expressed in kilobytes per second, while I<burst> is expressed in
kilobytes in a single burst at I<peak> speed as described in the
Network XML documentation at
2851
L<http://libvirt.org/formatnetwork.html#elementQoS>.
2852

2853 2854 2855 2856
B<--managed> is usable only for I<hostdev> type and tells libvirt
that the interface should be managed, which means detached and reattached
from/to the host by libvirt.

2857
If B<--print-xml> is specified, then the XML of the interface that would be
2858 2859
attached is printed instead.

2860 2861 2862 2863 2864 2865
If B<--live> is specified, affect a running domain.
If B<--config> is specified, affect the next startup of a persistent domain.
If B<--current> is specified, affect the current domain state.
Both B<--live> and B<--config> flags may be given, but B<--current> is
exclusive.  When no flag is specified legacy API is used whose behavior
depends on the hypervisor driver.
2866

2867 2868
For compatibility purposes, B<--persistent> behaves like B<--config> for
an offline domain, and like B<--live> B<--config> for a running domain.
2869

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

2874 2875
=item B<detach-device> I<domain> I<FILE>
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
2876 2877 2878

Detach a device from the domain, takes the same kind of XML descriptions
as command B<attach-device>.
2879 2880
For passthrough host devices, see also B<nodedev-reattach>, needed if
the device does not use managed mode.
2881

2882 2883 2884 2885 2886 2887
B<Note>: The supplied XML description of the device should be as specific
as its definition in the domain XML. The set of attributes used
to match the device are internal to the drivers. Using a partial definition,
or attempting to detach a device that is not present in the domain XML,
but shares some specific attributes with one that is present,
may lead to unexpected results.
2888

2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901
If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain.
If I<--current> is specified, affect the current domain state.
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. When no flag is specified legacy API is used whose behavior depends
on the hypervisor driver.

For compatibility purposes, I<--persistent> behaves like I<--config> for
an offline domain, and like I<--live> I<--config> for a running domain.

Note that older versions of virsh used I<--config> as an alias for
I<--persistent>.

2902 2903
=item B<detach-disk> I<domain> I<target>
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
2904 2905 2906

Detach a disk device from a domain. The I<target> is the device as seen
from the domain.
2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919

If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain.
If I<--current> is specified, affect the current domain state.
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. When no flag is specified legacy API is used whose behavior depends
on the hypervisor driver.

For compatibility purposes, I<--persistent> behaves like I<--config> for
an offline domain, and like I<--live> I<--config> for a running domain.

Note that older versions of virsh used I<--config> as an alias for
I<--persistent>.
2920

2921 2922
=item B<detach-interface> I<domain> I<type> [I<--mac mac>]
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
2923

2924
Detach a network interface from a domain.
2925 2926 2927 2928
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.
2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941

If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain.
If I<--current> is specified, affect the current domain state.
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. When no flag is specified legacy API is used whose behavior depends
on the hypervisor driver.

For compatibility purposes, I<--persistent> behaves like I<--config> for
an offline domain, and like I<--live> I<--config> for a running domain.

Note that older versions of virsh used I<--config> as an alias for
I<--persistent>.
2942

2943 2944
=item B<update-device> I<domain> I<file> [I<--force>]
[[[I<--live>] [I<--config>] | [I<--current>]] | [I<--persistent>]]
2945

2946
Update the characteristics of a device associated with I<domain>,
2947 2948 2949
based on the device definition in an XML I<file>.  The I<--force> option
can be used to force device update, e.g., to eject a CD-ROM even if it is
locked/mounted in the domain. See the documentation at
2950 2951
L<http://libvirt.org/formatdomain.html#elementsDevices> to learn about
libvirt XML format for a device.
E
Eric Blake 已提交
2952

2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964
If I<--live> is specified, affect a running domain.
If I<--config> is specified, affect the next startup of a persistent domain.
If I<--current> is specified, affect the current domain state.
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. Not specifying any flag is the same as specifying I<--current>.

For compatibility purposes, I<--persistent> behaves like I<--config> for
an offline domain, and like I<--live> I<--config> for a running domain.

Note that older versions of virsh used I<--config> as an alias for
I<--persistent>.

2965 2966 2967 2968
B<Note>: using of partial device definition XML files may lead to unexpected
results as some fields may be autogenerated and thus match devices other than
expected.

2969
=item B<change-media> I<domain> I<path> [I<--eject>] [I<--insert>]
O
Osier Yang 已提交
2970
[I<--update>] [I<source>] [I<--force>] [[I<--live>] [I<--config>] | [I<--current>]]
2971
[I<--print-xml>] [I<--block>]
O
Osier Yang 已提交
2972 2973 2974

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>
2975 2976 2977
specifies the path of the media to be inserted or updated. Flag I<--block>
allows to set the backing type in case a block device is used as media for the
CDROM or floppy drive instead of a file.
O
Osier Yang 已提交
2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996

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.
2997 2998
If I<--print-xml> is specified, the XML that would be used to change media is
printed instead of changing the media.
O
Osier Yang 已提交
2999

3000 3001
=back

3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018
=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
3019
guest domains, nor by multiple active guests at once.  If the
3020 3021
<hostdev> description of a PCI device includes the attribute B<managed='yes'>,
and the hypervisor driver supports it, then the device is in managed mode, and
3022
attempts to use that passthrough device in an active guest will
3023
automatically behave as if B<nodedev-detach> (guest start, device
3024
hot-plug) and B<nodedev-reattach> (guest stop, device hot-unplug) were
3025 3026 3027
called at the right points.  If a PCI device is not marked as managed,
then it must manually be detached before guests can use it, and manually
reattached to be returned to the host.  Also, if a device is manually detached,
3028 3029
then the host does not regain control of the device without a matching
reattach, even if the guests use the device in managed mode.
3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040

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

3041
=item B<nodedev-destroy> I<device>
3042

3043
Destroy (stop) a device on the host. I<device> can be either device
3044 3045 3046
name or wwn pair in "wwnn,wwpn" format (only works for vHBA currently).
Note that this makes libvirt quit managing a host device, and may even
make that device unusable by the rest of the physical host until a reboot.
3047

3048
=item B<nodedev-detach> I<nodedev> [I<--driver backend_driver>]
3049 3050 3051

Detach I<nodedev> from the host, so that it can safely be used by
guests via <hostdev> passthrough.  This is reversed with
3052
B<nodedev-reattach>, and is done automatically for managed devices.
3053

3054 3055 3056 3057 3058 3059
Different backend drivers expect the device to be bound to different
dummy devices. For example, QEMU's "kvm" backend driver (the default)
expects the device to be bound to pci-stub, but its "vfio" backend
driver expects the device to be bound to vfio-pci. The I<--driver>
parameter can be used to specify the desired backend driver.

3060
=item B<nodedev-dumpxml> I<device>
3061 3062 3063 3064

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
3065 3066 3067
libvirt (such as whether device reset is supported). I<device> can
be either device name or wwn pair in "wwnn,wwpn" format (only works
for HBA).
3068 3069 3070 3071

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

List all of the devices available on the node that are known by libvirt.
3072 3073 3074
I<cap> is used to filter the list by capability types, the types must be
separated by comma, e.g. --cap pci,scsi, valid capability types include
'system', 'pci', 'usb_device', 'usb', 'net', 'scsi_host', 'scsi_target',
3075 3076 3077
'scsi', 'storage', 'fc_host', 'vports', 'scsi_generic'. If I<--tree> is
used, the output is formatted in a tree representing parents of each node.
I<cap> and I<--tree> are mutually exclusive.
3078

3079 3080 3081
=item B<nodedev-reattach> I<nodedev>

Declare that I<nodedev> is no longer in use by any guests, and that
3082
the host can resume normal use of the device.  This is done
3083 3084
automatically for PCI devices in managed mode and USB devices, but
must be done explicitly to match any explicit B<nodedev-detach>.
3085 3086 3087 3088 3089 3090 3091 3092

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

3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110
=item B<nodedev-event> {[I<nodedev>] I<event> [I<--loop>] [I<--timeout>
I<seconds>] [I<--timestamp>] | I<--list>}

Wait for a class of node device events to occur, and print appropriate
details of events as they happen.  The events can optionally be filtered
by I<nodedev>.  Using I<--list> as the only argument will provide a list
of possible I<event> values known by this client, although the connection
might not allow registering for all these events.

By default, this command is one-shot, and returns success once an event
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
If I<--timeout> is specified, the command gives up waiting for events
after I<seconds> have elapsed.   With I<--loop>, the command prints all
events until a timeout or interrupt key.

When I<--timestamp> is used, a human-readable timestamp will be printed
before the event.

3111 3112
=back

3113
=head1 VIRTUAL NETWORK COMMANDS
3114 3115 3116

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

3122 3123
=over 4

3124
=item B<net-autostart> I<network> [I<--disable>]
3125 3126 3127 3128 3129 3130

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

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

G
Gene Czarcinski 已提交
3131 3132 3133 3134
Create a transient (temporary) virtual network from an
XML I<file> and instantiate (start) the network.
See the documentation at L<http://libvirt.org/formatnetwork.html>
to get a description of the XML network format used by libvirt.
3135 3136 3137

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

3138 3139
Define an inactive persistent virtual network or modify an existing persistent
one from the XML I<file>.
3140 3141 3142

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

G
Gene Czarcinski 已提交
3143 3144
Destroy (stop) a given transient or persistent virtual network
specified by its name or UUID. This takes effect immediately.
3145

3146
=item B<net-dumpxml> I<network> [I<--inactive>]
3147 3148

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

3152 3153 3154 3155 3156
=item B<net-edit> I<network>

Edit the XML configuration file for a network.

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

3158
 virsh net-dumpxml --inactive network > network.xml
O
Osier Yang 已提交
3159
 vi network.xml (or make changes with your other text editor)
E
Eric Blake 已提交
3160 3161
 virsh net-define network.xml

3162 3163
except that it does some error checking.

3164 3165
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
3166

E
Eric Blake 已提交
3167
=item B<net-event> {[I<network>] I<event> [I<--loop>] [I<--timeout>
3168
I<seconds>] [I<--timestamp>] | I<--list>}
E
Eric Blake 已提交
3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181

Wait for a class of network events to occur, and print appropriate details
of events as they happen.  The events can optionally be filtered by
I<network>.  Using I<--list> as the only argument will provide a list
of possible I<event> values known by this client, although the connection
might not allow registering for all these events.

By default, this command is one-shot, and returns success once an event
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
If I<--timeout> is specified, the command gives up waiting for events
after I<seconds> have elapsed.   With I<--loop>, the command prints all
events until a timeout or interrupt key.

3182 3183 3184
When I<--timestamp> is used, a human-readable timestamp will be printed
before the event.

O
Osier Yang 已提交
3185 3186 3187 3188
=item B<net-info> I<network>

Returns basic information about the I<network> object.

3189
=item B<net-list> [I<--inactive> | I<--all>]
3190
                  { [I<--table>] | I<--name> | I<--uuid> }
3191 3192
                  [I<--persistent>] [<--transient>]
                  [I<--autostart>] [<--no-autostart>]
3193 3194 3195

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
3196
inactive ones will be listed. You may also want to filter the returned networks
P
Peter Krempa 已提交
3197
by I<--persistent> to list the persistent ones, I<--transient> to list the
3198 3199 3200
transient ones, I<--autostart> to list the ones with autostart enabled, and
I<--no-autostart> to list the ones with autostart disabled.

3201 3202 3203 3204 3205 3206
If I<--name> is specified, network names are printed instead of the table
formatted one per line. If I<--uuid> is specified network's UUID's are printed
instead of names. Flag I<--table> specifies that the legacy table-formatted
output should be used. This is the default. All of these are mutually
exclusive.

3207 3208 3209 3210
NOTE: When talking to older servers, this command is forced to use a series of
API calls with an inherent race, where a pool might not be listed or might appear
more than once if it changed state between calls while the list was being
collected.  Newer servers do not have this problem.
3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221

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

L
Li Yang 已提交
3222 3223
Undefine the configuration for a persistent network. If the network is active,
make it transient.
3224 3225 3226 3227 3228

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

Convert a network name to network UUID.

L
Laine Stump 已提交
3229 3230 3231 3232 3233 3234 3235 3236 3237 3238
=item B<net-update> I<network> I<command> I<section> I<xml>
 [I<--parent-index> I<index>] [[I<--live>] [I<--config>] | [I<--current>]]

Update the given section of an existing network definition, with the
changes optionally taking effect immediately, without needing to
destroy and re-start the network.

I<command> is one of "add-first", "add-last", "add" (a synonym for
add-last), "delete", or "modify".

E
Eric Blake 已提交
3239
I<section> is one of "bridge", "domain", "ip", "ip-dhcp-host",
L
Laine Stump 已提交
3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261
"ip-dhcp-range", "forward", "forward-interface", "forward-pf",
"portgroup", "dns-host", "dns-txt", or "dns-srv", each section being
named by a concatenation of the xml element hierarchy leading to the
element being changed. For example, "ip-dhcp-host" will change a
<host> element that is contained inside a <dhcp> element inside an
<ip> element of the network.

I<xml> is either the text of a complete xml element of the type being
changed (e.g. "<host mac="00:11:22:33:44:55' ip='1.2.3.4'/>", or the
name of a file that contains a complete xml element. Disambiguation is
done by looking at the first character of the provided text - if the
first character is "<", it is xml text, if the first character is not
"<", it is the name of a file that contains the xml text to be used.

The I<--parent-index> option is used to specify which of several
parent elements the requested element is in (0-based). For example, a
dhcp <host> element could be in any one of multiple <ip> elements in
the network; if a parent-index isn't provided, the "most appropriate"
<ip> element will be selected (usually the only one that already has a
<dhcp> element), but if I<--parent-index> is given, that particular
instance of <ip> will get the modification.

3262 3263 3264
If I<--live> is specified, affect a running network.
If I<--config> is specified, affect the next startup of a persistent network.
If I<--current> is specified, affect the current network state.
L
Laine Stump 已提交
3265 3266 3267
Both I<--live> and I<--config> flags may be given, but I<--current> is
exclusive. Not specifying any flag is the same as specifying I<--current>.

3268 3269 3270 3271 3272 3273
=item B<net-dhcp-leases> I<network> [I<mac>]

Get a list of dhcp leases for all network interfaces connected to the given
virtual I<network> or limited output just for one interface if I<mac> is
specified.

3274 3275
=back

E
Eric Blake 已提交
3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293
=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

3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305
=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 已提交
3306 3307
=item B<iface-define> I<file>

3308 3309
Define an inactive persistent physical host interface or modify an existing
persistent one from the XML I<file>.
E
Eric Blake 已提交
3310 3311 3312

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

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

3316
=item B<iface-dumpxml> I<interface> [I<--inactive>]
E
Eric Blake 已提交
3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336

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

3337
=item B<iface-list> [I<--inactive> | I<--all>]
E
Eric Blake 已提交
3338 3339 3340 3341 3342

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.

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

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

3348 3349 3350
I<interface> specifies the interface MAC address.

=item B<iface-mac> I<interface>
E
Eric Blake 已提交
3351 3352 3353

Convert a host interface name to MAC address.

3354 3355 3356
I<interface> specifies the interface name.

=item B<iface-start> I<interface>
E
Eric Blake 已提交
3357 3358 3359

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

3360 3361 3362 3363 3364 3365 3366 3367 3368 3369
=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.

3370
=item B<iface-undefine> I<interface>
E
Eric Blake 已提交
3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398

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 已提交
3399 3400 3401 3402 3403 3404 3405
=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 已提交
3406
L<http://libvirt.org/formatstorage.html> . Many of the commands for
E
Eric Blake 已提交
3407 3408 3409 3410
pools are similar to the ones used for domains.

=over 4

3411
=item B<find-storage-pool-sources> I<type> [I<srcSpec>]
E
Eric Blake 已提交
3412

3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438
Returns XML describing all possible available storage pool sources that
could be used to create or define a storage pool of a given I<type>. If
I<srcSpec> is provided, it is a file that contains XML to further restrict
the query for pools.

Not all storage pools support discovery in this manner. Furthermore, for
those that do support discovery, only specific XML elements are required
in order to return valid data, while other elements and even attributes
of some elements are ignored since they are not necessary to find the pool
based on the search criteria. The following lists the supported I<type>
options and the expected minimal XML elements used to perform the search.

For a "netfs" or "gluster" pool, the minimal expected XML required is the
<host> element with a "name" attribute describing the IP address or hostname
to be used to find the pool. The "port" attribute will be ignored as will
any other provided XML elements in I<srcSpec>.

For a "logical" pool, the contents of the I<srcSpec> file are ignored,
although if provided the file must at least exist.

For an "iscsi" pool, the minimal expect XML required is the <host> element
with a "name" attribute describing the IP address or hostname to be used to
find the pool (the iSCSI server address). Optionally, the "port" attribute
may be provided, although it will default to 3260. Optionally, an <initiator>
XML element with a "name" attribute may be provided to further restrict the
iSCSI target search to a specific initiator for multi-iqn iSCSI storage pools.
E
Eric Blake 已提交
3439

3440 3441
=item B<find-storage-pool-sources-as> I<type> [I<host>] [I<port>]
[I<initiator>]
E
Eric Blake 已提交
3442

3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455
Rather than providing I<srcSpec> XML file for B<find-storage-pool-sources>
use this command option in order to have virsh generate the query XML file
using the optional arguments. The command will return the same output
XML as B<find-storage-pool-sources>.

Use I<host> to describe a specific host to use for networked storage, such
as netfs, gluster, and iscsi I<type> pools.

Use I<port> to further restrict which networked port to utilize for the
connection if required by the specific storage backend, such as iscsi.

Use I<initiator> to further restrict the iscsi I<type> pool searches to
specific target initiators.
E
Eric Blake 已提交
3456

3457
=item B<pool-autostart> I<pool-or-uuid> [I<--disable>]
E
Eric Blake 已提交
3458 3459 3460

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

3461
=item B<pool-build> I<pool-or-uuid> [I<--overwrite>] [I<--no-overwrite>]
E
Eric Blake 已提交
3462 3463 3464

Build a given pool.

3465
Options I<--overwrite> and I<--no-overwrite> can only be used for
3466
B<pool-build> a filesystem, disk, or logical pool.
3467 3468 3469 3470 3471 3472 3473 3474 3475 3476

For a file system pool if neither flag is specified, then B<pool-build>
just makes the target path directory and no attempt to run mkfs on the
target volume device. If I<--no-overwrite> is specified, it probes to
determine if a filesystem already exists on the target device, returning
an error if one exists or using mkfs to format the target device if not.
If I<--overwrite> is specified, mkfs is always executed and any existing
data on the target device is overwritten unconditionally.

For a disk pool, if neither of them is specified or I<--no-overwrite>
3477 3478 3479 3480 3481 3482 3483
is specified, B<pool-build> will check the target volume device for
existing filesystems or partitions before attempting to write a new
label on the target volume device. If the target volume device already
has a label, the command will fail. If I<--overwrite> is specified,
then no check will be made on the target volume device prior to writing
a new label. Writing of the label uses the pool source format type
or "dos" if not specified.
3484

3485 3486 3487 3488 3489 3490 3491 3492 3493 3494
For a logical pool, if neither of them is specified or I<--no-overwrite>
is specified, B<pool-build> will check the target volume devices for
existing filesystems or partitions before attempting to initialize
and format each device for usage by the logical pool. If any target
volume device already has a label, the command will fail. If
I<--overwrite> is specified, then no check will be made on the target
volume devices prior to initializing and formatting each device. Once
all the target volume devices are properly formatted via pvcreate,
the volume group will be created using all the devices.

E
Eric Blake 已提交
3495
=item B<pool-create> I<file>
3496
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]]
E
Eric Blake 已提交
3497 3498 3499

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

3500 3501 3502 3503 3504 3505
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]] perform a
B<pool-build> after creation in order to remove the need for a
follow-up command to build the pool. The I<--overwrite> and
I<--no-overwrite> flags follow the same rules as B<pool-build>. If
just I<--build> is provided, then B<pool-build> is called with no flags.

3506 3507 3508
=item B<pool-create-as> I<name> I<type> [I<--print-xml>]
[I<--source-host hostname>] [I<--source-path path>] [I<--source-dev path>]
[I<--source-name name>] [I<--target path>] [I<--source-format format>]
3509
[I<--auth-type authtype> I<--auth-username username> I<--secret-usage usage>]
3510 3511
[[I<--adapter-name name>] | [I<--adapter-wwnn> I<--adapter-wwpn>]
[I<--adapter-parent parent>]]
3512
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]]
3513

E
Eric Blake 已提交
3514 3515 3516 3517

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
3518 3519 3520 3521 3522
I<type>. When using B<pool-create-as> for a pool of I<type> "disk",
the existing partitions found on the I<--source-dev path> will be used
to populate the disk pool. Therefore, it is suggested to use
B<pool-define-as> and B<pool-build> with the I<--overwrite> in order
to properly initialize the disk pool.
E
Eric Blake 已提交
3523

3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542
[I<--source-host hostname>] provides the source hostname for pools backed
by storage from a remote server (pool types netfs, iscsi, rbd, sheepdog,
gluster).

[I<--source-path path>] provides the source directory path for pools backed
by directories (pool type dir).

[I<--source-dev path>] provides the source path for pools backed by physical
devices (pool types fs, logical, disk, iscsi, zfs).

[I<--source-name name>] provides the source name for pools backed by storage
from a named element (pool types logical, rbd, sheepdog, gluster).

[I<--target path>] is the path for the mapping of the storage pool into
the host file system.

[I<--source-format format>] provides information about the format of the
pool (pool types fs, netfs, disk, logical).

3543 3544 3545 3546 3547
[I<--auth-type authtype> I<--auth-username username> I<--secret-usage usage>]
provides the elements required to generate authentication credentials for
the storage pool. The I<authtype> is either chap for iscsi I<type> pools or
ceph for rbd I<type> pools.

3548 3549 3550 3551 3552 3553 3554 3555
[I<--adapter-name name>] defines the scsi_hostN adapter name to be used for
the scsi_host adapter type pool.

[I<--adapter-wwnn> I<--adapter-wwpn> [I<--adapter-parent parent>]] defines
the wwnn and wwpn to be used for the fc_host adapter type pool. The parent
optionally provides the name of the scsi_hostN node device to be used for
the vHBA.

3556 3557 3558 3559 3560 3561
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]] perform a
B<pool-build> after creation in order to remove the need for a
follow-up command to build the pool. The I<--overwrite> and
I<--no-overwrite> flags follow the same rules as B<pool-build>. If
just I<--build> is provided, then B<pool-build> is called with no flags.

E
Eric Blake 已提交
3562 3563
=item B<pool-define> I<file>

3564 3565
Define an inactive persistent storage pool or modify an existing persistent one
from the XML I<file>.
E
Eric Blake 已提交
3566

3567 3568 3569
=item B<pool-define-as> I<name> I<type> [I<--print-xml>]
[I<--source-host hostname>] [I<--source-path path>] [I<--source-dev path>]
[I<--source-name name>] [I<--target path>] [I<--source-format format>]
3570
[I<--auth-type authtype> I<--auth-username username> I<--secret-usage usage>]
3571 3572
[[I<--adapter-name name>] | [I<--adapter-wwnn> I<--adapter-wwpn>]
[I<--adapter-parent parent>]]
E
Eric Blake 已提交
3573 3574 3575 3576 3577 3578

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

3579 3580
Use the same arguments as B<pool-create-as>, except for the I<--build>,
I<--overwrite>, and I<--no-overwrite> options.
3581

E
Eric Blake 已提交
3582 3583
=item B<pool-destroy> I<pool-or-uuid>

3584
Destroy (stop) a given I<pool> object. Libvirt will no longer manage the
E
Eric Blake 已提交
3585 3586 3587 3588 3589 3590 3591 3592
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
3593
command, ready for the creation of new storage volumes.
E
Eric Blake 已提交
3594

3595
=item B<pool-dumpxml> [I<--inactive>] I<pool-or-uuid>
E
Eric Blake 已提交
3596 3597

Returns the XML information about the I<pool> object.
3598 3599
I<--inactive> tells virsh to dump pool configuration that will be used
on next start of the pool as opposed to the current pool configuration.
E
Eric Blake 已提交
3600 3601 3602 3603 3604 3605 3606 3607

=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 已提交
3608
 vi pool.xml (or make changes with your other text editor)
E
Eric Blake 已提交
3609 3610 3611 3612 3613 3614 3615
 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>.

3616
=item B<pool-info> [I<--bytes>] I<pool-or-uuid>
E
Eric Blake 已提交
3617

3618 3619
Returns basic information about the I<pool> object. If I<--bytes> is specified the sizes
of basic info are not converted to human friendly units.
E
Eric Blake 已提交
3620

3621 3622 3623
=item B<pool-list> [I<--inactive>] [I<--all>]
                   [I<--persistent>] [I<--transient>]
                   [I<--autostart>] [I<--no-autostart>]
3624 3625
                   [[I<--details>] [I<--uuid>]
                   [I<--name>] [<type>]
E
Eric Blake 已提交
3626

3627 3628
List pool objects known to libvirt.  By default, only active pools
are listed; I<--inactive> lists just the inactive pools, and I<--all>
3629 3630
lists all pools.

3631 3632 3633
In addition, there are several sets of filtering flags. I<--persistent> is to
list the persistent pools, I<--transient> is to list the transient pools.
I<--autostart> lists the autostarting pools, I<--no-autostart> lists the pools
3634
with autostarting disabled. If I<--uuid> is specified only pool's UUIDs are printed.
3635 3636 3637 3638
If I<--name> is specified only pool's names are printed. If both I<--name>
and I<--uuid> are specified, pool's UUID and names are printed side by side
without any header. Options I<--uuid> and I<--name> are mutually exclusive
if option I<--details> is specified.
3639 3640 3641 3642

You may also want to list pools with specified types using I<type>, the
pool types must be separated by comma, e.g. --type dir,disk. The valid pool
types include 'dir', 'fs', 'netfs', 'logical', 'disk', 'iscsi', 'scsi',
3643
'mpath', 'rbd', 'sheepdog' and 'gluster'.
3644 3645

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

3648 3649 3650 3651 3652
NOTE: When talking to older servers, this command is forced to use a series of
API calls with an inherent race, where a pool might not be listed or might appear
more than once if it changed state between calls while the list was being
collected.  Newer servers do not have this problem.

E
Eric Blake 已提交
3653 3654 3655 3656 3657 3658 3659 3660 3661
=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>
3662
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]]
E
Eric Blake 已提交
3663 3664 3665

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

3666 3667 3668 3669 3670 3671 3672
[I<--build>] [[I<--overwrite>] | [I<--no-overwrite>]] perform a
B<pool-build> prior to B<pool-start> to ensure the pool environment is
in an expected state rather than needing to run the build command prior
to startup. The I<--overwrite> and I<--no-overwrite> flags follow the
same rules as B<pool-build>. If just I<--build> is provided, then
B<pool-build> is called with no flags.

3673 3674 3675 3676 3677
B<Note>: A storage pool that relies on remote resources such as an
"iscsi" or a (v)HBA backed "scsi" pool may need to be refreshed multiple
times in order to have all the volumes detected (see B<pool-refresh>).
This is because the corresponding volume devices may not be present in
the host's filesystem during the initial pool startup or the current
3678
refresh attempt. The number of refresh retries is dependent upon the
3679 3680 3681
network connection and the time the host takes to export the
corresponding devices.

E
Eric Blake 已提交
3682 3683 3684 3685 3686 3687 3688 3689
=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>.

3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707
=item B<pool-event> {[I<pool>] I<event> [I<--loop>] [I<--timeout>
I<seconds>] [I<--timestamp>] | I<--list>}

Wait for a class of storage pool events to occur, and print appropriate
details of events as they happen.  The events can optionally be filtered
by I<pool>.  Using I<--list> as the only argument will provide a list
of possible I<event> values known by this client, although the connection
might not allow registering for all these events.

By default, this command is one-shot, and returns success once an event
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
If I<--timeout> is specified, the command gives up waiting for events
after I<seconds> have elapsed.   With I<--loop>, the command prints all
events until a timeout or interrupt key.

When I<--timestamp> is used, a human-readable timestamp will be printed
before the event.

3708 3709
=back

3710 3711
=head1 VOLUME COMMANDS

J
Jiri Denemark 已提交
3712 3713
=over 4

3714
=item B<vol-create> I<pool-or-uuid> I<FILE> [I<--prealloc-metadata>]
3715 3716 3717 3718 3719 3720

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.
3721 3722 3723 3724
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
support full allocation). This option creates a sparse image file with metadata,
resulting in higher performance compared to images with no preallocation and
only slightly higher initial disk space usage.
3725 3726 3727 3728

B<Example>

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

3732
=item B<vol-create-from> I<pool-or-uuid> I<FILE> [I<--inputpool>
3733
I<pool-or-uuid>] I<vol-name-or-key-or-path> [I<--prealloc-metadata>]
3734
[I<--reflink>]
3735 3736 3737 3738 3739 3740 3741

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.
3742 3743 3744 3745
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
support full allocation). This option creates a sparse image file with metadata,
resulting in higher performance compared to images with no preallocation and
only slightly higher initial disk space usage.
3746 3747 3748
When I<--reflink> is specified, perform a COW lightweight copy,
where the data blocks are copied only when modified.
If this is not possible, the copy fails.
3749

3750 3751 3752
=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>]
3753
[I<--prealloc-metadata>] [I<--print-xml>]
3754

3755 3756 3757
Create a volume from a set of arguments unless I<--print-xml> is specified, in
which case just the XML of the volume object is printed out without any actual
object creation.
3758 3759
I<pool-or-uuid> is the name or UUID of the storage pool to create the volume
in.
3760 3761 3762 3763 3764
I<name> is the name of the new volume. For a disk pool, this must match the
partition name as determined from the pool's source device path and the next
available partition. For example, a source device path of /dev/sdb and there
are no partitions on the disk, then the name must be sdb1 with the next
name being sdb2 and so on.
E
Eric Blake 已提交
3765 3766 3767 3768
I<capacity> is the size of the volume to be created, as a scaled integer
(see B<NOTES> above), defaulting to bytes if there is no suffix.
I<--allocation> I<size> is the initial size to be allocated in the volume,
also as a scaled integer defaulting to bytes.
3769
I<--format> I<string> is used in file based storage pools to specify the volume
3770 3771 3772 3773
file format to use; raw, bochs, qcow, qcow2, vmdk, qed. Use extended for disk
storage pools in order to create an extended partition (other values are
validity checked but not preserved when libvirtd is restarted or the pool
is refreshed).
3774
I<--backing-vol> I<vol-name-or-key-or-path> is the source backing
3775
volume to be used if taking a snapshot of an existing volume.
3776
I<--backing-vol-format> I<string> is the format of the snapshot backing volume;
3777 3778
raw, bochs, qcow, qcow2, qed, vmdk, host_device. These are, however, meant for
file based storage pools.
3779 3780 3781 3782
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
support full allocation). This option creates a sparse image file with metadata,
resulting in higher performance compared to images with no preallocation and
only slightly higher initial disk space usage.
3783

3784
=item B<vol-clone> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
3785
I<name> [I<--prealloc-metadata>] [I<--reflink>]
3786

3787 3788 3789 3790
Clone an existing volume within the parent pool.  Less powerful,
but easier to type, version of B<vol-create-from>.
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool
that contains the source volume, and will contain the new volume.
3791 3792
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.
3793 3794 3795 3796
[I<--prealloc-metadata>] preallocate metadata (for qcow2 images which don't
support full allocation). This option creates a sparse image file with metadata,
resulting in higher performance compared to images with no preallocation and
only slightly higher initial disk space usage.
3797 3798 3799
When I<--reflink> is specified, perform a COW lightweight copy,
where the data blocks are copied only when modified.
If this is not possible, the copy fails.
3800

3801
=item B<vol-delete> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
3802
[I<--delete-snapshots>]
3803 3804

Delete a given volume.
3805 3806
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
3807 3808
I<vol-name-or-key-or-path> is the name or key or path of the volume to delete.

3809 3810 3811 3812
The I<--delete-snapshots> flag specifies that any snapshots associated with
the storage volume should be deleted as well. Not all storage drivers
support this option, presently only rbd.

3813 3814
=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>
3815 3816

Upload the contents of I<local-file> to a storage volume.
3817 3818
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
3819 3820
I<vol-name-or-key-or-path> is the name or key or path of the volume where the
file will be uploaded.
3821
I<--offset> is the position in the storage volume at which to start writing
3822 3823 3824 3825
the data. The value must be 0 or larger. I<--length> is an upper bound
of the amount of data to be uploaded. A negative value is interpreted
as an unsigned long long value to essentially include everything from
the offset to the end of the volume.
J
Ján Tomko 已提交
3826
An error will occur if the I<local-file> is greater than the specified length.
3827 3828 3829
See the description for the libvirt virStorageVolUpload API for details
regarding possible target volume and pool changes as a result of the
pool refresh when the upload is attempted.
3830

3831 3832
=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>
3833

3834
Download the contents of a storage volume to I<local-file>.
3835 3836
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
3837
I<vol-name-or-key-or-path> is the name or key or path of the volume to download.
3838
I<--offset> is the position in the storage volume at which to start reading
3839 3840 3841 3842
the data. The value must be 0 or larger. I<--length> is an upper bound of
the amount of data to be downloaded. A negative value is interpreted as
an unsigned long long value to essentially include everything from the
offset to the end of the volume.
3843

3844 3845
=item B<vol-wipe> [I<--pool> I<pool-or-uuid>] [I<--algorithm> I<algorithm>]
I<vol-name-or-key-or-path>
3846

3847 3848 3849
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.
3850
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
3851 3852 3853 3854 3855 3856 3857 3858 3859
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
N
Nehal J Wani 已提交
3860
               sanitizing removable and non-removable rigid
3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873
               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.
3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886
  trim       - 1-pass trimming the volume using TRIM or DISCARD

B<Note>: The C<scrub> binary will be used to handle the 'nnsa', 'dod',
'bsi', 'gutmann', 'schneier', 'pfitzner7' and 'pfitzner33' algorithms.
The availability of the algorithms may be limited by the version of
the C<scrub> binary installed on the host. The 'zero' algorithm will
write zeroes to the entire volume. For some volumes, such as sparse
or rbd volumes, this may result in completely filling the volume with
zeroes making it appear to be completely full. As an alternative, the
'trim' algorithm does not overwrite all the data in a volume, rather
it expects the storage driver to be able to discard all bytes in a
volume. It is up to the storage driver to handle how the discarding
occurs. Not all storage drivers or volume types can support 'trim'.
3887

3888
=item B<vol-dumpxml> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
3889 3890

Output the volume information as an XML dump to stdout.
3891 3892 3893
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.
3894

3895
=item B<vol-info> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
3896
[I<--bytes>] [I<--physical>]
3897 3898

Returns basic information about the given storage volume.
3899 3900
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
3901
to return information for. If I<--bytes> is specified the sizes are not
3902 3903 3904 3905 3906
converted to human friendly units. If I<--physical> is specified, then the host
physical size is returned and displayed instead of the allocation value. The
physical value for some file types, such as qcow2 may have a different (larger)
physical value than is shown for allocation. Additionally sparse files will
have different physical and allocation values.
3907

3908
=item B<vol-list> [I<--pool> I<pool-or-uuid>] [I<--details>]
3909 3910 3911

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

3915
=item B<vol-pool> [I<--uuid>] I<vol-key-or-path>
3916

3917 3918 3919 3920
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.
3921

3922
=item B<vol-path> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key>
3923 3924

Return the path for a given volume.
3925 3926
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
3927 3928 3929 3930 3931 3932 3933
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.

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

3936
Return the volume key for a given volume.
3937 3938 3939
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.
3940

3941 3942 3943 3944 3945 3946 3947 3948 3949
=item B<vol-resize> [I<--pool> I<pool-or-uuid>] I<vol-name-or-path>
I<pool-or-uuid> I<capacity> [I<--allocate>] [I<--delta>] [I<--shrink>]

Resize the capacity of the given volume, in bytes.
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in. I<vol-name-or-key-or-path> is the name or key or path of the volume
to resize.  The new capacity might be sparse unless I<--allocate> is
specified.  Normally, I<capacity> is the new size, but if I<--delta>
is present, then it is added to the existing size.  Attempts to shrink
E
Eric Blake 已提交
3950 3951 3952 3953 3954 3955
the volume will fail unless I<--shrink> is present; I<capacity> cannot
be negative unless I<--shrink> is provided, but a negative sign is not
necessary. I<capacity> is a scaled integer (see B<NOTES> above), which
defaults to bytes if there is no suffix.  This command is only safe
for storage volumes not in use by an active guest; see also
B<blockresize> for live resizing.
3956

3957 3958
=back

E
Eric Blake 已提交
3959
=head1 SECRET COMMANDS
3960 3961 3962 3963

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
N
Nehal J Wani 已提交
3964
or possibly other uses.  Secrets are identified using a UUID.  See
3965 3966 3967 3968 3969 3970 3971 3972 3973
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.
N
Nehal J Wani 已提交
3974
If I<file> specifies a UUID of an existing secret, replace its properties by
3975 3976 3977 3978 3979 3980
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.

3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998
=item B<secret-event> {[I<secret>] I<event> [I<--loop>] [I<--timeout>
I<seconds>] [I<--timestamp>] | I<--list>}

Wait for a class of secret events to occur, and print appropriate details
of events as they happen.  The events can optionally be filtered by
I<secret>.  Using I<--list> as the only argument will provide a list
of possible I<event> values known by this client, although the connection
might not allow registering for all these events.

By default, this command is one-shot, and returns success once an event
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
If I<--timeout> is specified, the command gives up waiting for events
after I<seconds> have elapsed.   With I<--loop>, the command prints all
events until a timeout or interrupt key.

When I<--timestamp> is used, a human-readable timestamp will be printed
before the event.

3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013
=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.

4014 4015
=item B<secret-list> [I<--ephemeral>] [I<--no-ephemeral>]
                     [I<--private>] [I<--no-private>]
4016

4017 4018 4019 4020
Returns the list of secrets. You may also want to filter the returned secrets
by I<--ephemeral> to list the ephemeral ones, I<--no-ephemeral> to list the
non-ephemeral ones, I<--private> to list the private ones, and
I<--no-private> to list the non-private ones.
4021 4022 4023

=back

E
Eric Blake 已提交
4024
=head1 SNAPSHOT COMMANDS
4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035

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

4036
=item B<snapshot-create> I<domain> [I<xmlfile>] {[I<--redefine> [I<--current>]]
E
Eric Blake 已提交
4037
| [I<--no-metadata>] [I<--halt>] [I<--disk-only>] [I<--reuse-external>]
4038
[I<--quiesce>] [I<--atomic>] [I<--live>]}
4039 4040

Create a snapshot for domain I<domain> with the properties specified in
4041
I<xmlfile>.  Normally, the only properties settable for a domain snapshot
4042 4043
are the <name> and <description> elements, as well as <disks> if
I<--disk-only> is given; the rest of the fields are
4044 4045 4046 4047
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>.

4048 4049 4050
If I<--halt> is specified, the domain will be left in an inactive state
after the snapshot is created.

4051 4052 4053 4054 4055 4056 4057 4058
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.

4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074
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).

4075 4076
If I<--reuse-external> is specified, and the snapshot XML requests an
external snapshot with a destination of an existing file, then the
4077 4078
destination must exist and be pre-created with correct format and
metadata. The file is then reused; otherwise, a snapshot is refused
4079 4080
to avoid losing contents of the existing files.

4081 4082 4083 4084 4085
If I<--quiesce> is specified, libvirt will try to use guest agent
to freeze and unfreeze domain's mounted file systems. However,
if domain has no guest agent, snapshot creation will fail.
Currently, this requires I<--disk-only> to be passed as well.

E
Eric Blake 已提交
4086 4087 4088 4089 4090 4091
If I<--atomic> is specified, libvirt will guarantee that the snapshot
either succeeds, or fails with no changes; not all hypervisors support
this.  If this flag is not specified, then some hypervisors may fail
after partially performing the action, and B<dumpxml> must be used to
see whether any partial changes occurred.

C
Chen Hanxiao 已提交
4092 4093 4094
If I<--live> is specified, libvirt takes the snapshot (checkpoint) while
the guest is running. Both disk snapshot and domain memory snapshot are
taken. This increases the size of the memory image of the external
4095 4096
checkpoint. This is currently supported only for external checkpoints.

4097 4098 4099 4100 4101
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).

4102
=item B<snapshot-create-as> I<domain> {[I<--print-xml>]
E
Eric Blake 已提交
4103
| [I<--no-metadata>] [I<--halt>] [I<--reuse-external>]} [I<name>]
4104 4105
[I<description>] [I<--disk-only> [I<--quiesce>]] [I<--atomic>]
[[I<--live>] [I<--memspec> B<memspec>]] [I<--diskspec>] B<diskspec>]...
4106 4107 4108

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 已提交
4109 4110
value.  If I<--print-xml> is specified, then XML appropriate for
I<snapshot-create> is output, rather than actually creating a snapshot.
4111
Otherwise, if I<--halt> is specified, the domain will be left in an
4112 4113 4114
inactive state after the snapshot is created, and if I<--disk-only>
is specified, the snapshot will not include vm state.

4115 4116 4117
The I<--memspec> option can be used to control whether a checkpoint
is internal or external.  The I<--memspec> flag is mandatory, followed
by a B<memspec> of the form B<[file=]name[,snapshot=type]>, where
4118
type can be B<no>, B<internal>, or B<external>.  To include a literal
4119 4120
comma in B<file=name>, escape it with a second comma. I<--memspec> cannot
be used together with I<--disk-only>.
4121 4122 4123 4124 4125

The I<--diskspec> option can be used to control how I<--disk-only> and
external checkpoints create external files.  This option can occur
multiple times, according to the number of <disk> elements in the domain
xml.  Each <diskspec> is in the
4126 4127 4128
form B<disk[,snapshot=type][,driver=type][,file=name]>.  A I<diskspec>
must be provided for disks backed by block devices as libvirt doesn't
auto-generate file names for those.  To include a
4129
literal comma in B<disk> or in B<file=name>, escape it with a second
J
Ján Tomko 已提交
4130
comma.  A literal I<--diskspec> must precede each B<diskspec> unless
4131 4132
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"
4133 4134 4135 4136
results in the following XML:
  <disk name='vda' snapshot='external'>
    <source file='/path/to,new'/>
  </disk>
4137

4138 4139
If I<--reuse-external> is specified, and the domain XML or I<diskspec>
option requests an external snapshot with a destination of an existing
4140 4141 4142
file, then the destination must exist and be pre-created with correct
format and metadata. The file is then reused; otherwise, a snapshot
is refused to avoid losing contents of the existing files.
4143

4144 4145 4146 4147 4148
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.

4149 4150 4151 4152 4153 4154
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 已提交
4155 4156 4157 4158 4159 4160
If I<--atomic> is specified, libvirt will guarantee that the snapshot
either succeeds, or fails with no changes; not all hypervisors support
this.  If this flag is not specified, then some hypervisors may fail
after partially performing the action, and B<dumpxml> must be used to
see whether any partial changes occurred.

4161 4162 4163 4164
If I<--live> is specified, libvirt takes the snapshot while the guest is
running. This increases the size of the memory image of the external
checkpoint. This is currently supported only for external checkpoints.

E
Eric Blake 已提交
4165
=item B<snapshot-current> I<domain> {[I<--name>] | [I<--security-info>]
4166 4167 4168 4169 4170 4171 4172 4173 4174 4175
| [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.
4176

4177
=item B<snapshot-edit> I<domain> [I<snapshotname>] [I<--current>]
4178
{[I<--rename>] | [I<--clone>]}
4179 4180

Edit the XML configuration file for I<snapshotname> of a domain.  If
4181 4182 4183 4184
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.
4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195

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

4197 4198 4199 4200 4201 4202 4203 4204
If I<--rename> is specified, then the edits can change the snapshot
name.  If I<--clone> is specified, then changing the snapshot name
will create a clone of the snapshot metadata.  If neither is specified,
then the edits must not change the snapshot name.  Note that changing
a snapshot name must be done with care, since the contents of some
snapshots, such as internal snapshots within a single qcow2 file, are
accessible only from the original name.

E
Eric Blake 已提交
4205 4206 4207 4208 4209
=item B<snapshot-info> I<domain> {I<snapshot> | I<--current>}

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

4210 4211
=item B<snapshot-list> I<domain> [I<--metadata>] [I<--no-metadata>]
[{I<--parent> | I<--roots> | [{I<--tree> | I<--name>}]}]
4212
[{[I<--from>] B<snapshot> | I<--current>} [I<--descendants>]]
4213
[I<--leaves>] [I<--no-leaves>] [I<--inactive>] [I<--active>]
4214
[I<--disk-only>] [I<--internal>] [I<--external>]
4215

4216 4217
List all of the available snapshots for the given domain, defaulting
to show columns for the snapshot name, creation time, and domain state.
4218

4219
If I<--parent> is specified, add a column to the output table giving
4220 4221 4222
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
4223 4224 4225
just snapshot names.  These three options are mutually exclusive. If
I<--name> is specified only the snapshot name is printed. This option is
mutually exclusive with I<--tree>.
4226

4227
If I<--from> is provided, filter the list to snapshots which are
4228 4229
children of the given B<snapshot>; or if I<--current> is provided,
start at the current snapshot.  When used in isolation or with
4230 4231 4232
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
4233 4234 4235
with I<--roots>.  Note that the starting point of I<--from> or
I<--current> is not included in the list unless the I<--tree>
option is also present.
4236

4237
If I<--leaves> is specified, the list will be filtered to just
E
Eric Blake 已提交
4238 4239 4240 4241 4242
snapshots that have no children.  Likewise, if I<--no-leaves> is
specified, the list will be filtered to just snapshots with
children.  (Note that omitting both options does no filtering,
while providing both options will either produce the same list
or error out depending on whether the server recognizes the flags).
4243
Filtering options are not compatible with I<--tree>.
4244

4245 4246 4247
If I<--metadata> is specified, the list will be filtered to just
snapshots that involve libvirt metadata, and thus would prevent
B<undefine> of a persistent domain, or be lost on B<destroy> of
E
Eric Blake 已提交
4248 4249 4250
a transient domain.  Likewise, if I<--no-metadata> is specified,
the list will be filtered to just snapshots that exist without
the need for libvirt metadata.
4251

4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265
If I<--inactive> is specified, the list will be filtered to snapshots
that were taken when the domain was shut off.  If I<--active> is
specified, the list will be filtered to snapshots that were taken
when the domain was running, and where the snapshot includes the
memory state to revert to that running state.  If I<--disk-only> is
specified, the list will be filtered to snapshots that were taken
when the domain was running, but where the snapshot includes only
disk state.

If I<--internal> is specified, the list will be filtered to snapshots
that use internal storage of existing disk images.  If I<--external>
is specified, the list will be filtered to snapshots that use external
files for disk images or memory state.

4266
=item B<snapshot-dumpxml> I<domain> I<snapshot> [I<--security-info>]
4267 4268

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

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

4274 4275
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 已提交
4276

4277 4278
=item B<snapshot-revert> I<domain> {I<snapshot> | I<--current>}
[{I<--running> | I<--paused>}] [I<--force>]
4279

4280 4281
Revert the given domain to the snapshot specified by I<snapshot>, or to
the current snapshot with I<--current>.  Be aware
4282
that this is a destructive action; any changes in the domain since the last
4283
snapshot was taken will be lost.  Also note that the state of the domain after
4284
snapshot-revert is complete will be the state of the domain at the time
4285 4286
the original snapshot was taken.

4287 4288 4289 4290 4291 4292 4293 4294
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 已提交
4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310
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.

4311
=item B<snapshot-delete> I<domain> {I<snapshot> | I<--current>} [I<--metadata>]
4312
[{I<--children> | I<--children-only>}]
4313

4314 4315
Delete the snapshot for the domain named I<snapshot>, or the current
snapshot with I<--current>.  If this snapshot
4316 4317
has child snapshots, changes from this snapshot will be merged into the
children.  If I<--children> is passed, then delete this snapshot and any
4318 4319 4320 4321 4322 4323 4324 4325
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.
4326 4327 4328

=back

E
Eric Blake 已提交
4329
=head1 NWFILTER COMMANDS
4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369

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 已提交
4370
 vi myfilter.xml (or make changes with your other text editor)
4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381
 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

E
Eric Blake 已提交
4382
=head1 HYPERVISOR-SPECIFIC COMMANDS
4383 4384 4385

NOTE: Use of the following commands is B<strongly> discouraged.  They
can cause libvirt to become confused and do the wrong thing on subsequent
E
Eric Blake 已提交
4386 4387 4388 4389 4390
operations.  Once you have used these commands, please do not report
problems to the libvirt developers; the reports will be ignored.  If
you find that these commands are the only way to accomplish something,
then it is better to request that the feature be added as a first-class
citizen in the regular libvirt library.
4391 4392 4393

=over 4

4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413
=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
4414 4415 4416
issues with the guest ABI changing upon migration and device hotplug
or hotunplug may not work. The attached environment should be considered
primarily read-only.
4417

4418 4419
=item B<qemu-monitor-command> I<domain> { [I<--hmp>] | [I<--pretty>] }
I<command>...
4420 4421

Send an arbitrary monitor command I<command> to domain I<domain> through the
4422 4423 4424
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
4425 4426 4427 4428
the result will also be converted back from QMP.  If I<--pretty> is given,
and the monitor uses QMP, then the output will be pretty-printed.  If more
than one argument is provided for I<command>, they are concatenated with a
space in between before passing the single command to the monitor.
4429

E
Eric Blake 已提交
4430 4431
=item B<qemu-agent-command> I<domain> [I<--timeout> I<seconds> | I<--async> |
I<--block>] I<command>...
4432 4433 4434 4435 4436 4437 4438 4439 4440

Send an arbitrary guest agent command I<command> to domain I<domain> through
qemu agent.
I<--timeout>, I<--async> and I<--block> options are exclusive.
I<--timeout> requires timeout seconds I<seconds> and it must be positive.
When I<--aysnc> is given, the command waits for timeout whether success or
failed. And when I<--block> is given, the command waits forever with blocking
timeout.

E
Eric Blake 已提交
4441
=item B<qemu-monitor-event> [I<domain>] [I<--event> I<event-name>] [I<--loop>]
4442
[I<--timeout> I<seconds>] [I<--pretty>] [I<--regex>] [I<--no-case>]
4443
[I<--timestamp>]
E
Eric Blake 已提交
4444 4445 4446 4447 4448

Wait for arbitrary QEMU monitor events to occur, and print out the
details of events as they happen.  The events can optionally be filtered
by I<domain> or I<event-name>.  The 'query-events' QMP command can be
used via I<qemu-monitor-command> to learn what events are supported.
4449 4450 4451
If I<--regex> is used, I<event-name> is a basic regular expression
instead of a literal string.  If I<--no-case> is used, I<event-name>
will match case-insensitively.
E
Eric Blake 已提交
4452 4453 4454 4455 4456 4457 4458 4459

By default, this command is one-shot, and returns success once an event
occurs; you can send SIGINT (usually via C<Ctrl-C>) to quit immediately.
If I<--timeout> is specified, the command gives up waiting for events
after I<seconds> have elapsed.  With I<--loop>, the command prints all
events until a timeout or interrupt key.  If I<--pretty> is specified,
any JSON event details are pretty-printed for better legibility.

4460 4461 4462 4463
When I<--timestamp> is used, a human-readable timestamp will be printed
before the event, and the timing information provided by QEMU will be
omitted.

4464
=item B<lxc-enter-namespace> I<domain> [I<--noseclabel>] -- /path/to/binary [arg1, [arg2, ...]]
4465 4466 4467 4468

Enter the namespace of I<domain> and execute the command C</path/to/binary>
passing the requested args. The binary path is relative to the container
root filesystem, not the host root filesystem. The binary will inherit the
4469 4470 4471 4472
environment variables / console visible to virsh. The command will be run
with the same sVirt context and cgroups placement as processes within the
container. This command only works when connected to the LXC hypervisor
driver.  This command succeeds only if C</path/to/binary> has 0 exit status.
4473

4474 4475 4476 4477
By default the new process will run with the security label of the new
parent container. Use the I<--noseclabel> option to instead have the
process keep the same security label as C<virsh>.

4478 4479
=back

4480 4481
=head1 ENVIRONMENT

4482 4483 4484 4485 4486
The following environment variables can be set to alter the behaviour
of C<virsh>

=over 4

S
Supriya Kannery 已提交
4487 4488 4489 4490
=item VIRSH_DEBUG=<0 to 4>

Turn on verbose debugging of virsh commands. Valid levels are

4491 4492
=over 4

S
Supriya Kannery 已提交
4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512
=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.

4513 4514
=back

S
Supriya Kannery 已提交
4515 4516 4517 4518
=item VIRSH_LOG_FILE=C<LOGFILE>

The file to log virsh debug messages.

4519 4520 4521
=item VIRSH_DEFAULT_CONNECT_URI

The hypervisor to connect to by default. Set this to a URI, in the same
4522 4523 4524 4525 4526 4527 4528 4529 4530 4531
format as accepted by the B<connect> option. This environment variable
is deprecated in favour of the global B<LIBVIRT_DEFAULT_URI> variable
which serves the same purpose.

=item LIBVIRT_DEFAULT_URI

The hypervisor to connect to by default. Set this to a URI, in the
same format as accepted by the B<connect> option. This overrides
the default URI set in any client config file and prevents libvirt
from probing for drivers.
4532

4533
=item VISUAL
E
Eric Blake 已提交
4534

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

4537 4538
=item EDITOR

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

4542 4543 4544 4545 4546
=item VIRSH_HISTSIZE

The number of commands to remember in the command  history.  The
default value is 500.

4547
=item LIBVIRT_DEBUG=LEVEL
4548

4549
Turn on verbose debugging of all libvirt API calls. Valid levels are
4550

4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570
=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

A
Andrea Bolognani 已提交
4571 4572
For further information about debugging options consult
L<http://libvirt.org/logging.html>
4573 4574 4575 4576 4577 4578

=back

=head1 BUGS

Report any bugs discovered to the libvirt community via the mailing
A
Andrea Bolognani 已提交
4579 4580
list L<http://libvirt.org/contact.html> or bug tracker
L<http://libvirt.org/bugs.html>.
4581 4582 4583
Alternatively report bugs to your software distributor / vendor.

=head1 AUTHORS
4584

4585
  Please refer to the AUTHORS file distributed with libvirt.
4586

4587
  Based on the xm man page by:
4588 4589 4590
  Sean Dague <sean at dague dot net>
  Daniel Stekloff <dsteklof at us dot ibm dot com>

4591
=head1 COPYRIGHT
4592

J
John Ferlan 已提交
4593
Copyright (C) 2005, 2007-2015 Red Hat, Inc., and the authors listed in the
4594
libvirt AUTHORS file.
4595 4596

=head1 LICENSE
4597

4598 4599 4600 4601 4602 4603
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
4604

4605 4606
L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>, L<virt-df(1)>,
L<http://www.libvirt.org/>
4607

4608
=cut