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

virsh - management user interface

=head1 SYNOPSIS

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

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

=head1 DESCRIPTION

The B<virsh> program is the main interface for managing virsh guest
domains. The program can be used to create, pause, and shutdown
E
Eric Blake 已提交
15 16 17 18 19 20 21 22
domains. It can also be used to list current domains. Libvirt is a C
toolkit to interact with the virtualization capabilities of recent
versions of Linux (and other OSes). It is free software available
under the GNU Lesser General Public License. Virtualization of the
Linux Operating System means the ability to run multiple instances of
Operating Systems concurrently on a single hardware system where the
basic resources are driven by a Linux instance. The library aims at
providing a long term stable C API.  It currently supports Xen, QEmu,
23
KVM, LXC, OpenVZ, VirtualBox and VMware ESX.
24

25
The basic structure of most virsh usage is:
26

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

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

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

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

=over 4

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

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

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

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

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

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

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

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

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

Enable debug messages at integer I<LEVEL> and above.  I<LEVEL> can
S
Supriya Kannery 已提交
75
range from 0 (default) to 4.
E
Eric Blake 已提交
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95

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

=back

96 97
=head1 NOTES

E
Eric Blake 已提交
98 99 100
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>.
101

102
Most B<virsh> commands require root privileges to run due to the
103 104 105
communications channels used to talk to the hypervisor.  Running as
non root will return an error.

106
Most B<virsh> commands act synchronously, except maybe shutdown,
L
Luiz Capitulino 已提交
107
setvcpus and setmem. In those cases the fact that the B<virsh>
108 109 110
program returned, may not mean the action is complete and you
must poll periodically to detect that the guest completed the
operation.
111

112
=head1 GENERIC COMMANDS
113

114
The following commands are generic i.e. not specific to a domain.
115 116 117

=over 4

118
=item B<help> [I<command-or-group>]
119

120 121 122 123 124 125 126 127 128 129 130 131 132 133
This lists each of the virsh commands.  When used without options, all
commands are listed, one per line, grouped into related categories,
displaying the keyword for each group.

To display only commands for a specific group, give the keyword for that
group as an option.  For example:

 virsh # help host

  Host and Hypervisor (help keyword 'host'):
     capabilities                   capabilities
     connect                        (re)connect to hypervisor
     freecell                       NUMA free memory
     hostname                       print the hypervisor hostname
134 135
     qemu-attach                    Attach to existing QEMU process
     qemu-monitor-command           QEMU Monitor Command
E
Eric Blake 已提交
136
     sysinfo                        print the hypervisor sysinfo
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
     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
155

156
=item B<quit>, B<exit>
157

158
quit this interactive terminal
159

160
=item B<version>
161

162
Will print out the major version info about what this built from.
163

164
=over 4
165

166
B<Example>
167

168
B<virsh> version
169

170
Compiled against library: libvir 0.0.6
171

172
Using library: libvir 0.0.6
173

174
Using API: Xen 3.0.0
175

176
Running hypervisor: Xen 3.0.0
177

178
=back
179

180
=item B<cd> [I<directory>]
P
Paolo Bonzini 已提交
181 182 183 184 185 186 187 188 189 190 191

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.

192
=item B<connect> I<URI> [I<--readonly>]
193

E
Eric Blake 已提交
194 195 196 197 198 199
(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:
200

201
=over 4
202

203
=item xen:///
204

205
this is used to connect to the local Xen hypervisor, this is the default
206

207
=item qemu:///system
208

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

211 212
=item qemu:///session

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

D
David Jorm 已提交
215 216 217 218
=item lxc:///

connect to a local linux container

219
=back
220

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

224 225 226 227 228 229 230 231
=item B<uri>

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

=item B<hostname>

Print the hypervisor hostname.

E
Eric Blake 已提交
232 233 234 235
=item B<sysinfo>

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

236
=item B<nodeinfo>
237

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

243
=item B<nodecpustats> [I<cpu>] [I<--percent>]
244 245 246 247 248 249

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.

250
=item B<nodememstats> [I<cell>]
251 252 253 254

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

255
=item B<capabilities>
256 257 258 259 260

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

265 266 267 268
=item B<inject-nmi> I<domain-id>

Inject NMI to the guest.

269
=item B<list> [I<--inactive> | I<--all>]
270 271

Prints information about one or more domains.  If no domains are
272
specified it prints out information about running domains.
273 274 275 276

An example format for the list is as follows:

B<virsh> list
277
 Id Name                 State
278

279
----------------------------------
280

281 282
  0 Domain-0             running
  2 fedora               paused
283 284


285
Name is the name of the domain.  ID the domain numeric id.
286
State is the run state (see below).
287

288 289
B<STATES>

290
The State field lists 7 states for a domain, and which ones the
291
current domain is in.
292

293 294
=over 4

295
=item B<running>
296 297 298

The domain is currently running on a CPU

299
=item B<idle>
300

301
The domain is idle, and not running or runnable.  This can be caused
302 303 304
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.

305
=item B<paused>
306 307

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

312
=item B<shutdown>
313

314
The domain is in the process of shutting down, i.e. the guest operating system
315
has been notified and should be in the process of stopping its operations
316
gracefully.
317

318 319 320 321 322
=item B<shut off>

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

323
=item B<crashed>
324 325 326

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

329
=item B<dying>
330 331 332 333 334 335

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

=back

336
=item B<freecell> [B<cellno> | I<--all>]
337 338

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

342 343 344 345 346 347 348 349
=item B<cpu-baseline> I<FILE>

Compute baseline CPU which will be supported by all host CPUs given in <file>.
The list of host CPUs is built by extracting all <cpu> elements from the
<file>. Thus, the <file> can contain either a set of <cpu> elements separated
by new lines or even a set of complete <capabilities> elements printed by
B<capabilities> command.

350 351 352 353 354 355 356 357 358
=item B<cpu-compare> I<FILE>

Compare CPU definition from XML <file> with host CPU. The XML <file> may
contain either host or guest CPU definition. The host CPU definition is the
<cpu> element and its contents as printed by B<capabilities> command. The
guest CPU definition is the <cpu> element and its contents from domain XML
definition. For more information on guest CPU definition see:
L<http://libvirt.org/formatdomain.html#elementsCPU>

359 360
=back

361
=head1 DOMAIN COMMANDS
362

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

367 368
=over 4

369
=item B<autostart> [I<--disable>] I<domain-id>
370 371 372

Configure a domain to be automatically started at boot.

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

375
=item B<console> I<domain-id> [I<devname>]
376

377 378 379 380
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.
381

382
=item B<create> I<FILE> [I<--console>] [I<--paused>] [I<--autodestroy>]
383

E
Eric Blake 已提交
384 385
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
386 387 388
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.
389 390 391
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
exits.
392 393 394

B<Example>

395
 virsh dumpxml <domain-id> > domain.xml
O
Osier Yang 已提交
396
 vi domain.xml (or make changes with your other text editor)
397
 virsh create < domain.xml
398 399 400

=item B<define> I<FILE>

401
Define a domain from an XML <file>. The domain definition is registered
402 403 404 405 406
but not started.

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

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

413 414 415 416 417 418 419 420
=item B<domblkstat> I<domain> I<block-device>

Get device block stats for a running domain.

=item B<domifstat> I<domain> I<interface-device>

Get network interface stats for a running domain.

421 422 423 424
=item B<dommemstat> I<domain>

Get memory stats for a running domain.

425 426 427 428
=item B<domblkinfo> I<domain> I<block-device>

Get block device size info for a domain.

429
=item B<dominfo> I<domain-id>
430 431 432 433 434 435 436

Returns basic information about the domain.

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

Convert a domain name or id to domain UUID

437
=item B<domid> I<domain-name-or-uuid>
438

439
Convert a domain name (or UUID) to a domain id
440

441
=item B<domjobabort> I<domain-id-or-uuid>
E
Eric Blake 已提交
442 443 444 445 446 447 448

Abort the currently running domain job.

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

Returns information about jobs running on a domain.

449
=item B<domname> I<domain-id-or-uuid>
450

451
Convert a domain Id (or UUID) to domain name
452

453
=item B<domstate> I<domain-id> [I<--reason>]
454

455 456
Returns state about a domain.  I<--reason> tells virsh to also print
reason for the state.
457

458 459 460 461 462 463
=item B<domcontrol> I<domain-id>

Returns state of an interface to VMM used to control a domain.  For
states other than "ok" or "error" the command also prints number of
seconds elapsed since the control interface entered its current state.

E
Eric Blake 已提交
464 465 466 467 468 469 470 471 472 473
=item B<domxml-from-native> I<format> I<config>

Convert the file I<config> in the native guest configuration format
named by I<format> to a domain XML format.

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

Convert the file I<xml> in domain XML format to the native guest
configuration format named by I<format>.

474 475 476 477
=item B<dump> I<domain-id> I<corefilepath>

Dumps the core of a domain to a file for analysis.

478 479
=item B<dumpxml> I<domain-id> [I<--inactive>] [I<--security-info>]
[I<--update-cpu>]
480 481 482 483 484 485 486 487

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.
Using I<--security-info> security sensitive information will also be included
in the XML dump. I<--update-cpu> updates domain CPU requirements according to
host CPU.
488

489
=item B<echo> [I<--shell>] [I<--xml>] [I<arg>...]
E
Eric Blake 已提交
490 491 492 493 494 495

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.

496 497 498 499 500
=item B<edit> I<domain-id>

Edit the XML configuration file for a domain.

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

502
 virsh dumpxml domain > domain.xml
O
Osier Yang 已提交
503
 vi domain.xml (or make changes with your other text editor)
504
 virsh define domain.xml
E
Eric Blake 已提交
505

506 507
except that it does some error checking.

508 509
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
510

511 512
=item B<managedsave> I<domain-id>

513
Save and destroy (stop) a running domain, so it can be restarted from the same
514 515
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.
516

517 518
=item B<managedsave-remove> I<domain-id>

519 520
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.
521

522
=item B<maxvcpus> [I<type>]
E
Eric Blake 已提交
523 524 525 526 527

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.

528 529 530 531
=item B<migrate> [I<--live>] [I<--direct>] [I<--p2p> [I<--tunnelled>]]
[I<--persistent>] [I<--undefinesource>] [I<--suspend>] [I<--copy-storage-all>]
[I<--copy-storage-inc>] [I<--verbose>] I<domain-id> I<desturi> [I<migrateuri>]
[I<dname>] [I<--timeout> B<seconds>]
532 533 534 535 536 537 538 539 540

Migrate domain to another host.  Add I<--live> for live migration; I<--p2p>
for peer-2-peer migration; I<--direct> for direct migration; or I<--tunnelled>
for tunnelled migration.  I<--persistent> leaves the domain persistent on
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).
W
Wen Congyang 已提交
541
I<--verbose> displays the progress of migration.
542 543 544 545 546

The I<desturi> is the connection URI of the destination host, and
I<migrateuri> is the migration URI, which usually can be omitted.
I<dname> is used for renaming the domain to new name during migration, which
also usually can be omitted.
547

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

552 553 554 555 556 557 558 559 560 561 562 563 564
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

565 566 567 568 569 570
=item B<migrate-setmaxdowntime> I<domain-id> I<downtime>

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

571 572 573 574 575
=item B<migrate-setspeed> I<domain-id> I<bandwidth>

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

576 577 578 579 580 581 582
=item B<reboot> I<domain-id>

Reboot a domain.  This acts just as if the domain had the B<reboot>
command run from the console.  The command returns as soon as it has
executed the reboot action, which may be significantly before the
domain actually reboots.

583 584
The exact behavior of a domain when it reboots is set by the
I<on_reboot> parameter in the domain's XML definition.
585 586 587

=item B<restore> I<state-file>

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

B<Note>: To avoid corrupting file system contents within the domain, you
E
Eric Blake 已提交
591 592 593
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.
594 595 596

=item B<save> I<domain-id> I<state-file>

E
Eric Blake 已提交
597 598
Saves a running domain (RAM, but not disk state) to a state file so that
it can be restored
599 600 601 602 603 604 605 606
later.  Once saved, the domain will no longer be running on the
system, thus the memory allocated for the domain will be free for
other domains to use.  B<virsh restore> restores from this state file.

This is roughly equivalent to doing a hibernate on a running computer,
with all the same limitations.  Open network connections may be
severed upon restore, as TCP timeouts may have expired.

E
Eric Blake 已提交
607 608 609 610 611
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.

612 613
=item B<schedinfo> [I<--set> B<parameter=value>] I<domain-id> [[I<--config>]
[I<--live>] | [I<--current>]]
614

615
=item B<schedinfo> [I<--weight> B<number>] [I<--cap> B<number>]
616
I<domain-id>
617

618 619
Allows you to show (and set) the domain scheduler parameters. The parameters
available for each hypervisor are:
D
David Jorm 已提交
620 621 622 623 624 625 626

LXC, QEMU/KVM (posix scheduler): cpu_shares

Xen (credit scheduler): weight, cap

ESX (allocation scheduler): reservation, limit, shares

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

631 632 633
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.
Therefore, -1 is a useful shorthand for 262144.
634 635 636

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

638
=item B<screenshot> I<domain-id> [I<imagefilepath>] [I<--screen> B<screenID>]
639 640 641 642 643 644 645 646

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.

647 648
=item B<setmem> I<domain-id> B<kilobytes> [[I<--config>] [I<--live>] |
[I<--current>]]
649

650 651 652
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.
653 654 655 656
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.
657 658

Some hypervisors require a larger granularity than kilobytes, and requests
659 660 661
that are not an even multiple will be rounded up.  For example, vSphere/ESX
rounds the parameter up unless the kB argument is evenly divisible by 1024
(that is, the kB argument happens to represent megabytes).
662 663 664

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

666 667
=item B<setmaxmem> I<domain-id> B<kilobytes> [[I<--config>] [I<--live>] |
[I<--current>]]
668

669 670 671 672 673 674 675
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.
Both I<--live> and I<--current> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.
676

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

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

685

686 687 688
=item B<memtune> I<domain-id> [I<--hard-limit> B<kilobytes>]
[I<--soft-limit> B<kilobytes>] [I<--swap-hard-limit> B<kilobytes>]
[I<--min-guarantee> B<kilobytes>] [[I<--config>] [I<--live>] | [I<--current>]]
E
Eric Blake 已提交
689 690 691 692

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
693 694
QEMU/KVM support I<--hard-limit>, I<--soft-limit>, and I<--swap-hard-limit>.

695 696 697 698 699 700 701
If I<--live> is specified, affect a running guest.
If I<--config> is specified, affect the next boot of a persistent guest.
If I<--current> is specified, affect the current guest state.
Both I<--live> and I<--current> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
For QEMU/KVM, the parameters are applied to the QEMU process as a whole.
Thus, when counting them, one needs to add up guest RAM, guest video RAM, and
some memory overhead of QEMU itself.  The last piece is hard to determine so
one needs guess and try.

=over 4

=item I<--hard-limit>

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

=item I<--soft-limit>

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

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

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

=item I<--min-guarantee>

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

=back
731

732 733
=item B<blkiotune> I<domain-id> [I<--weight> B<weight>] [[I<--config>]
[I<--live] | [I<--current>]]
734 735 736 737

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

H
Hu Tao 已提交
738 739 740 741 742 743 744
If I<--live> is specified, affect a running guest.
If I<--config> is specified, affect the next boot of a persistent guest.
If I<--current> is specified, affect the current guest state.
Both I<--live> and I<--current> flags may be given, but I<--current> is
exclusive. If no flag is specified, behavior is different depending
on hypervisor.

745 746
=item B<setvcpus> I<domain-id> I<count> [I<--maximum>] [[I<--config>]
[I<--live>] | [I<--current]]
747

748 749 750 751 752 753 754 755 756 757 758
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.
759

760 761 762
If I<--live> is specified, the guest domain must be active, and the change
takes place immediately.  Both the I<--config> and I<--live> flags may be
specified together if supported by the hypervisor.
763

764 765 766
If I<--current> is specified, affect the current guest state.

When no flags are given, the I<--live>
767 768 769 770
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 已提交
771

772 773 774
The I<--maximum> flag controls the maximum number of virtual cpus that can
be hot-plugged the next time the domain is booted.  As such, it must only be
used with the I<--config> flag, and not with the I<--live> flag.
E
Eric Blake 已提交
775

776 777 778
=item B<shutdown> I<domain-id>

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

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

786
=item B<start> I<domain-name> [I<--console>] [I<--paused>] [I<--autodestroy>]
787

788 789 790 791
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 已提交
792
If I<--console> is requested, attach to the console after creation.
793 794 795
If I<--autodestroy> is requested, then the guest will be automatically
destroyed when virsh closes its connection to libvirt, or otherwise
exits.
796

797 798 799 800
=item B<suspend> I<domain-id>

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

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

804
Moves a domain out of the suspended state.  This will allow a previously
805
suspended domain to now be eligible for scheduling by the underlying
806
hypervisor.
807

808 809 810
=item B<ttyconsole> I<domain-id>

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

813
=item B<undefine> I<domain-id>
814

815
Undefine the configuration for an inactive domain. Since it's not running
816
the domain name or UUID must be used as the I<domain-id>.
817

818 819
=item B<vcpucount> I<domain-id>  [{I<--maximum> | I<--current>}
{I<--config> | I<--live>}]
E
Eric Blake 已提交
820 821 822 823 824 825 826 827 828 829 830 831 832

Print information about the virtual cpu counts of the given
I<domain-id>.  If no flags are specified, all possible counts are
listed in a table; otherwise, the output is limited to just the
numeric value requested.

I<--maximum> requests information on the maximum cap of vcpus that a
domain can add via B<setvcpus>, while I<--current> shows the current
usage; these two flags cannot both be specified.  I<--config>
requests information regarding the next time the domain will be
booted, while I<--live> requires a running domain and lists current
values; these two flags cannot both be specified.

833
=item B<vcpuinfo> I<domain-id>
834

835 836
Returns basic information about the domain virtual CPUs, like the number of
vCPUs, the running time, the affinity to physical processors.
837

838 839
=item B<vcpupin> I<domain-id> [I<vcpu>] [I<cpulist>] [[I<--live>]
[I<--config>] | [I<--current>]]
840

841 842 843 844 845
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
846 847
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.
848 849
If you want to reset vcpupin setting, that is, to pin vcpu all physical cpus,
simply specify 'r' as a cpulist.
850 851 852
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.
853 854
Both I<--live> and I<--config> flags may be given if I<cpulist> is present,
but I<--current> is exclusive.
855
If no flag is specified, behavior is different depending on hypervisor.
856

857 858
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".
859

860
=item B<vncdisplay> I<domain-id>
861

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

865 866 867
=back

=head1 DEVICE COMMANDS
868 869

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

875 876
=over 4

877 878 879 880
=item B<attach-device> I<domain-id> I<FILE>

Attach a device to the domain, using a device definition in an XML file.
See the documentation to learn about libvirt XML format for a device.
E
Eric Blake 已提交
881 882
For cdrom and floppy devices, this command only replaces the media within
the single existing device; consider using B<update-device> for this usage.
883

884 885 886 887
=item B<attach-disk> I<domain-id> I<source> I<target>
[I<--driver driver>] [I<--subdriver subdriver>] [I<--cache cache>]
[I<--type type>] [I<--mode mode>] [I<--persistent>] [I<--sourcetype soucetype>]
[I<--serial serial>] [I<--shareable>] [I<--address address>]
888 889 890 891

Attach a new disk device to the domain.
I<source> and I<target> are paths for the files and devices.
I<driver> can be I<file>, I<tap> or I<phy> depending on the kind of access.
E
Eric Blake 已提交
892 893 894
I<type> can indicate I<cdrom> or I<floppy> as alternative to the disk default,
although this use only replaces the media within the existing virtual cdrom or
floppy device; consider using B<update-device> for this usage instead.
895
I<mode> can specify the two specific mode I<readonly> or I<shareable>.
896 897
I<persistent> indicates the changes will affect the next boot of the domain.
I<sourcetype> can indicate the type of source (block|file)
898 899 900 901 902
I<cache> can be one of "default", "none", "writethrough" or "writeback".
I<serial> is the serial of disk device. I<shareable> indicates the disk device
is shareable between domains.
I<address> is the address of disk device in the form of pci:domain.bus.slot.function,
scsi:controller.bus.unit or ide:controller.bus.unit.
903

904 905 906
=item B<attach-interface> I<domain-id> I<type> I<source>
[I<--target target>] [I<--mac mac>] [I<--script script>] [I<--model model>]
[I<--persistent>]
907 908 909 910 911 912 913 914

Attach a new network interface to the domain.
I<type> can be either I<network> to indicate a physical network device or I<bridge> to indicate a bridge to a device.
I<source> indicates the source device.
I<target> allows to indicate the target device in the guest.
I<mac> allows to specify the MAC address of the network interface.
I<script> allows to specify a path to a script handling a bridge instead of
the default one.
915 916
I<model> allows to specify the model type.
I<persistent> indicates the changes will affect the next boot of the domain.
917 918 919 920 921 922 923 924 925 926 927

=item B<detach-device> I<domain-id> I<FILE>

Detach a device from the domain, takes the same kind of XML descriptions
as command B<attach-device>.

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

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

928
=item B<detach-interface> I<domain-id> I<type> [I<--mac mac>]
929

930
Detach a network interface from a domain.
931 932 933
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.
934

935
=item B<update-device> I<domain-id> I<file> [I<--persistent>] [I<--force>]
936 937 938 939 940 941 942

Update the characteristics of a device associated with I<domain-id>, based on
the device definition in an XML I<file>.  If the I<--persistent> option is
used, the changes will affect the next boot of the domain. The I<--force>
option can be used to force device update, e.g., to eject a CD-ROM even if it
is locked/mounted in the domain. See the documentation to learn about libvirt
XML format for a device.
E
Eric Blake 已提交
943

944 945 946
=back

=head1 VIRTUAL NETWORK COMMANDS
947 948 949

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

955 956
=over 4

957
=item B<net-autostart> I<network> [I<--disable>]
958 959 960 961 962 963 964

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

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

Create a virtual network from an XML I<file>, see the documentation to get
965
a description of the XML network format used by libvirt.
966 967 968 969

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

Define a virtual network from an XML I<file>, the network is just defined but
970
not instantiated.
971 972 973

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

974 975
Destroy (stop) a given virtual network specified by its name or UUID. This
takes effect immediately.
976 977 978 979 980

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

Output the virtual network information as an XML dump to stdout.

981 982 983 984 985
=item B<net-edit> I<network>

Edit the XML configuration file for a network.

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

987
 virsh net-dumpxml network > network.xml
O
Osier Yang 已提交
988
 vi network.xml (or make changes with your other text editor)
E
Eric Blake 已提交
989 990
 virsh net-define network.xml

991 992
except that it does some error checking.

993 994
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
995

O
Osier Yang 已提交
996 997 998 999
=item B<net-info> I<network>

Returns basic information about the I<network> object.

1000
=item B<net-list> [I<--inactive> | I<--all>]
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021

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

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

Convert a network UUID to network name.

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

Start a (previously defined) inactive network.

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

Undefine the configuration for an inactive network.

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

Convert a network name to network UUID.

1022 1023
=back

E
Eric Blake 已提交
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
=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

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

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

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

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

1052
=item B<iface-dumpxml> I<interface> [I<--inactive>]
E
Eric Blake 已提交
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072

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

1073
=item B<iface-list> [I<--inactive> | I<--all>]
E
Eric Blake 已提交
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120

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.

=item B<iface-name> I<iface-MAC>

Convert a host interface MAC to interface name, if the I<iface-MAC> is
unique among the host's interfaces.

=item B<iface-name> I<iface-MAC>

Convert a host interface name to MAC address.

=item B<iface-start> I<iface>

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

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

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 已提交
1121 1122 1123 1124 1125 1126 1127
=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 已提交
1128
L<http://libvirt.org/formatstorage.html> . Many of the commands for
E
Eric Blake 已提交
1129 1130 1131 1132
pools are similar to the ones used for domains.

=over 4

1133
=item B<find-storage-pool-sources> I<type> [I<srcSpec>]
E
Eric Blake 已提交
1134 1135 1136 1137 1138

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

1139 1140
=item B<find-storage-pool-sources-as> I<type> [I<host>] [I<port>]
[I<initiator>]
E
Eric Blake 已提交
1141 1142

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

1146
=item B<pool-autostart> I<pool-or-uuid> [I<--disable>]
E
Eric Blake 已提交
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157

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

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

Build a given pool.

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

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

1158 1159 1160
=item B<pool-create-as> I<name> I<--print-xml> I<type> [I<source-host>]
[I<source-path>] [I<source-dev>] [I<source-name>] [<target>]
[I<--source-format format>]
E
Eric Blake 已提交
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170

Create and start a pool object I<name> from the raw parameters.  If
I<--print-xml> is specified, then print the XML of the pool object
without creating the pool.  Otherwise, the pool has the specified
I<type>.

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

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

1171 1172 1173
=item B<pool-define-as> I<name> I<--print-xml> I<type> [I<source-host>]
[I<source-path>] [I<source-dev>] [I<source-name>] [<target>]
[I<--source-format format>]
E
Eric Blake 已提交
1174 1175 1176 1177 1178 1179 1180 1181

Create, but do not start, a pool object I<name> from the raw parameters.  If
I<--print-xml> is specified, then print the XML of the pool object
without defining the pool.  Otherwise, the pool has the specified
I<type>.

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

1182
Destroy (stop) a given I<pool> object. Libvirt will no longer manage the
E
Eric Blake 已提交
1183 1184 1185 1186 1187 1188 1189 1190
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
1191
command, ready for the creation of new storage volumes.
E
Eric Blake 已提交
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203

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

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

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

Edit the XML configuration file for a storage pool.

This is equivalent to:

 virsh pool-dumpxml pool > pool.xml
O
Osier Yang 已提交
1204
 vi pool.xml (or make changes with your other text editor)
E
Eric Blake 已提交
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
 virsh pool-define pool.xml

except that it does some error checking.

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

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

Returns basic information about the I<pool> object.

1216
=item B<pool-list> [I<--inactive> | I<--all>] [I<--details>]
E
Eric Blake 已提交
1217 1218 1219

List pool objects known to libvirt.  By default, only pools in use by
active domains are listed; I<--inactive> lists just the inactive
1220 1221 1222
pools, and I<--all> lists all pools. The I<--details> option instructs
virsh to additionally display pool persistence and capacity related
information where available.
E
Eric Blake 已提交
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243

=item B<pool-name> I<uuid>

Convert the I<uuid> to a pool name.

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

Refresh the list of volumes contained in I<pool>.

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

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

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

Undefine the configuration for an inactive I<pool>.

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

Returns the UUID of the named I<pool>.

1244 1245
=back

1246 1247
=head1 VOLUME COMMANDS

J
Jiri Denemark 已提交
1248 1249
=over 4

1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
=item B<vol-create> I<pool-or-uuid> I<FILE>

Create a volume from an XML <file>.
I<pool-or-uuid> is the name or UUID of the storage pool to create the volume in.
I<FILE> is the XML <file> with the volume definition. An easy way to create the
XML <file> is to use the B<vol-dumpxml> command to obtain the definition of a
pre-existing volume.

B<Example>

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

1264
=item B<vol-create-from> I<pool-or-uuid> I<FILE> [I<--inputpool>
1265 1266 1267 1268 1269 1270 1271 1272 1273
I<pool-or-uuid>] I<vol-name-or-key-or-path>

Create a volume, using another volume as input.
I<pool-or-uuid> is the name or UUID of the storage pool to create the volume in.
I<FILE> is the XML <file> with the volume definition.
I<--inputpool> I<pool-or-uuid> is the name or uuid of the storage pool the
source volume is in.
I<vol-name-or-key-or-path> is the name or key or path of the source volume.

1274 1275 1276
=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>]
1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287

Create a volume from a set of arguments.
I<pool-or-uuid> is the name or UUID of the storage pool to create the volume
in.
I<name> is the name of the new volume.
I<capacity> is the size of the volume to be created, with optional k, M, G, or
T suffix.
I<--allocation> I<size> is the initial size to be allocated in the volume, with
optional k, M, G, or T suffix.
I<--format> I<string> is used in file based storage pools to specify the volume
file format to use; raw, bochs, qcow, qcow2, vmdk.
1288
I<--backing-vol> I<vol-name-or-key-or-path> is the source backing
1289
volume to be used if taking a snapshot of an existing volume.
1290 1291
I<--backing-vol-format> I<string> is the format of the snapshot backing volume;
raw, bochs, qcow, qcow2, vmdk, host_device.
1292

1293 1294
=item B<vol-clone> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
I<name>
1295 1296 1297

Clone an existing volume.  Less powerful, but easier to type, version of
B<vol-create-from>.
1298 1299
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool to create
the volume in.
1300 1301 1302
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.

1303
=item B<vol-delete> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
1304 1305

Delete a given volume.
1306 1307
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
1308 1309
I<vol-name-or-key-or-path> is the name or key or path of the volume to delete.

1310 1311
=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>
1312 1313

Upload the contents of I<local-file> to a storage volume.
1314 1315
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
1316 1317 1318 1319 1320
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
I<--offset> is the position in the storage volume at which to start writing
the data. I<--length> is an upper bound of the amount of data to be uploaded.
An error will occurr if the I<local-file> is greater than the specified length.

1321 1322
=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>
1323 1324

Download the contents of I<local-file> from a storage volume.
1325 1326
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
1327 1328 1329 1330
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
I<--offset> is the position in the storage volume at which to start reading
the data. I<--length> is an upper bound of the amount of data to be downloaded.

1331
=item B<vol-wipe> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
1332

1333 1334 1335
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.
1336 1337
I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.

1338
=item B<vol-dumpxml> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
1339 1340

Output the volume information as an XML dump to stdout.
1341 1342 1343
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.
1344

1345
=item B<vol-info> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
1346 1347

Returns basic information about the given storage volume.
1348 1349 1350
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in. I<vol-name-or-key-or-path> is the name or key or path of the volume
to return information for.
1351

1352
=item B<vol-list> [I<--pool> I<pool-or-uuid>] [I<--details>]
1353 1354 1355

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

1359
=item B<vol-pool> [I<--uuid>] I<vol-key-or-path>
1360

1361 1362 1363 1364
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.
1365

1366
=item B<vol-path> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key>
1367 1368

Return the path for a given volume.
1369 1370
I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
is in.
1371 1372 1373 1374 1375 1376 1377
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.

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

1380
Return the volume key for a given volume.
1381 1382 1383
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.
1384 1385 1386

=back

1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
=head1 SECRET COMMMANDS

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

=over 4

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

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

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

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

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

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

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

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

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

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

=item B<secret-list>

Output a list of UUIDs of known secrets to stdout.

=back

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
=head1 SNAPSHOT COMMMANDS

The following commands manipulate domain snapshots.  Snapshots take the
disk, memory, and device state of a domain at a point-of-time, and save it
for future use.  They have many uses, from saving a "clean" copy of an OS
image to saving a domain's state before a potentially destructive operation.
Snapshots are identified with a unique name.  See
L<http://libvirt.org/formatsnapshot.html> for documentation of the XML format
used to represent properties of snapshots.

=over 4

1442
=item B<snapshot-create> I<domain> [I<xmlfile>]
1443 1444 1445 1446 1447 1448 1449

Create a snapshot for domain I<domain> with the properties specified in
I<xmlfile>.  The only properties settable for a domain snapshot are the
<name> and <description>; the rest of the fields are ignored, and
automatically filled in by libvirt.  If I<xmlfile> is completely omitted,
then libvirt will choose a value for all fields.

1450 1451
=item B<snapshot-create-as> I<domain> [I<--print-xml>]
[I<name>] [I<description>]
1452 1453 1454

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 已提交
1455 1456
value.  If I<--print-xml> is specified, then XML appropriate for
I<snapshot-create> is output, rather than actually creating a snapshot.
1457

1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
=item B<snapshot-current> I<domain>

Output the snapshot XML for the domain's current snapshot (if any).

=item B<snapshot-list> I<domain>

List all of the available snapshots for the given domain.

=item B<snapshot-dumpxml> I<domain> I<snapshot>

Output the snapshot XML for the domain's snapshot named I<snapshot>.

1470
=item B<snapshot-revert> I<domain> I<snapshot>
1471 1472 1473 1474

Revert the given domain to the snapshot specified by I<snapshot>.  Be aware
that this is a destructive action; any changes in the domain since the
snapshot was taken will be lost.  Also note that the state of the domain after
1475
snapshot-revert is complete will be the state of the domain at the time
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
the original snapshot was taken.

=item B<snapshot-delete> I<domain> I<snapshot> I<--children>

Delete the snapshot for the domain named I<snapshot>.  If this snapshot
has child snapshots, changes from this snapshot will be merged into the
children.  If I<--children> is passed, then delete this snapshot and any
children of this snapshot.

=back

1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
=head1 NWFILTER COMMMANDS

The following commands manipulate network filters. Network filters allow
filtering of the network traffic coming from and going to virtual machines.
Individual network traffic filters are written in XML and may contain
references to other network filters, describe traffic filtering rules,
or contain both. Network filters are referenced by virtual machines
from within their interface description. A network filter may be referenced
by multiple virtual machines' interfaces.

=over 4

=item B<nwfilter-define> I<xmlfile>

Make a new network filter known to libvirt. If a network filter with
the same name already exists, it will be replaced with the new XML.
Any running virtual machine referencing this network filter will have
its network traffic rules adapted. If for any reason the network traffic
filtering rules cannot be instantiated by any of the running virtual
machines, then the new XML will be rejected.

=item B<nwfilter-undefine> I<nwfilter-name>

Delete a network filter. The deletion will fail if any running virtual
machine is currently using this network filter.

=item B<nwfilter-list>

List all of the available network filters.

=item B<nwfilter-dumpxml> I<nwfilter-name>

Output the network filter XML.

=item B<nwfilter-edit> I<nwfilter-name>

Edit the XML of a network filter.

This is equivalent to:

 virsh nwfilter-dumpxml myfilter > myfilter.xml
O
Osier Yang 已提交
1528
 vi myfilter.xml (or make changes with your other text editor)
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
 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

1540 1541 1542 1543 1544 1545 1546 1547 1548
=head1 QEMU-SPECIFIC COMMANDS

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

=over 4

1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
=item B<qemu-attach> I<pid>

Attach an externally launched QEMU process to the libvirt QEMU driver.
The QEMU process must have been created with a monitor connection
using the UNIX driver. Ideally the process will also have had the
'-name' argument specified.

=over 4

     $ qemu-kvm -cdrom ~/demo.iso \
         -monitor unix:/tmp/demo,server,nowait \
         -name foo \
         -uuid cece4f9f-dff0-575d-0e8e-01fe380f12ea  &
     $ QEMUPID=$!
     $ virsh qemu-attach $QEMUPID

=back

Not all functions of libvirt are expected to work reliably after
attaching to an externally launched QEMU process. There may be
issues with the guest ABI changing upon migration, and hotunplug
may not work.

1572
=item B<qemu-monitor-command> I<domain> I<command> [I<--hmp>]
1573 1574

Send an arbitrary monitor command I<command> to domain I<domain> through the
1575 1576 1577 1578
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
the result will also be converted back from QMP.
1579 1580 1581

=back

1582 1583
=head1 ENVIRONMENT

1584 1585 1586 1587 1588
The following environment variables can be set to alter the behaviour
of C<virsh>

=over 4

S
Supriya Kannery 已提交
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
=item VIRSH_DEBUG=<0 to 4>

Turn on verbose debugging of virsh commands. Valid levels are

=item * VIRSH_DEBUG=0

DEBUG - Messages at ALL levels get logged

=item * VIRSH_DEBUG=1

INFO - Logs messages at levels INFO, NOTICE, WARNING and ERROR

=item * VIRSH_DEBUG=2

NOTICE - Logs messages at levels NOTICE, WARNING and ERROR

=item * VIRSH_DEBUG=3

WARNING - Logs messages at levels WARNING and ERROR

=item * VIRSH_DEBUG=4

ERROR - Messages at only ERROR level gets logged.

=item VIRSH_LOG_FILE=C<LOGFILE>

The file to log virsh debug messages.

1617 1618 1619 1620 1621
=item VIRSH_DEFAULT_CONNECT_URI

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

1622
=item VISUAL
E
Eric Blake 已提交
1623

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

1626 1627
=item EDITOR

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

1631
=item LIBVIRT_DEBUG=LEVEL
1632

1633
Turn on verbose debugging of all libvirt API calls. Valid levels are
1634

1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
=over 4

=item * LIBVIRT_DEBUG=1

Messages at level DEBUG or above

=item * LIBVIRT_DEBUG=2

Messages at level INFO or above

=item * LIBVIRT_DEBUG=3

Messages at level WARNING or above

=item * LIBVIRT_DEBUG=4

Messages at level ERROR or above

=back

For further information about debugging options consult C<http://libvirt.org/logging.html>

=back

=head1 BUGS

Report any bugs discovered to the libvirt community via the mailing
list C<http://libvirt.org/contact.html> or bug tracker C<http://libvirt.org/bugs.html>.
Alternatively report bugs to your software distributor / vendor.

=head1 AUTHORS
1666

1667
  Please refer to the AUTHORS file distributed with libvirt.
1668

1669
  Based on the xm man page by:
1670 1671 1672
  Sean Dague <sean at dague dot net>
  Daniel Stekloff <dsteklof at us dot ibm dot com>

1673
=head1 COPYRIGHT
1674

1675 1676
Copyright (C) 2005, 2007-2010 Red Hat, Inc., and the authors listed in the
libvirt AUTHORS file.
1677 1678

=head1 LICENSE
1679

1680 1681 1682 1683 1684 1685
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
1686

1687 1688
L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>, L<virt-df(1)>,
L<http://www.libvirt.org/>
1689

1690
=cut