~ubuntu-branches/ubuntu/maverick/libvirt/maverick

« back to all changes in this revision

Viewing changes to docs/virsh.pod

Tags: upstream-0.6.4
Import upstream version 0.6.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
34
34
 
35
35
All B<virsh> operations rely upon the libvirt library.
36
36
For any virsh commands to run xend/qemu, or what ever virtual library that libvirt supports.  For this reason you should start xend/qemu as a service when your system first boots using xen/qemu. This can usually be done using the command
37
 
B<service start libvirtd> .
 
37
B<service libvirtd start> .
38
38
 
39
39
Most B<virsh> commands require root privileges to run due to the
40
40
communications channels used to talk to the hypervisor.  Running as
150
150
Name is the name of the domain.  ID the domain numeric id.
151
151
State is the run state (see below).
152
152
 
153
 
=over 4
154
 
 
155
153
B<STATES>
156
154
 
157
155
The State field lists 6 states for a domain, and which ones the
158
156
current domain is in.
159
157
 
 
158
=over 4
 
159
 
160
160
=item B<running>
161
161
 
162
162
The domain is currently running on a CPU
198
198
Prints the available amount of memory on the machine or within a
199
199
NUMA cell if I<cellno> is provided.
200
200
 
 
201
=back
 
202
 
201
203
=head1 DOMAIN COMMANDS
202
204
 
203
205
The following commands manipulate domains directly, as stated
204
206
previously most commands take domain-id as the first parameter. The
205
207
I<domain-id> can be specified as an short integer, a name or a full UUID.
206
208
 
 
209
=over 4
 
210
 
207
211
=item B<autostart> optional I<--disable> I<domain-id>
208
212
 
209
213
Configure a domain to be automatically started at boot.
401
405
Output the IP address and port number for the VNC display. If the information
402
406
is not available the processes will provide an exit code of 1.
403
407
 
404
 
=head1 DEVICES COMMANDS
 
408
=back
 
409
 
 
410
=head1 DEVICE COMMANDS
405
411
 
406
412
The following commands manipulate devices associated to domains.
407
413
The domain-id can be specified as an short integer, a name or a full UUID.
409
415
reading the documentation at L<http://libvirt.org/format.html> on the
410
416
format of the device sections to get the most accurate set of accepted values.
411
417
 
 
418
=over 4
 
419
 
412
420
=item B<attach-device> I<domain-id> I<FILE>
413
421
 
414
422
Attach a device to the domain, using a device definition in an XML file.
449
457
It is recommended to use the I<mac> option to distinguish between the interfaces
450
458
if more than one are present on the domain.
451
459
 
452
 
=head1 VIRTUAL NETWORKS COMMANDS
 
460
=back
 
461
 
 
462
=head1 VIRTUAL NETWORK COMMANDS
453
463
 
454
464
The following commands manipulate networks. Libvirt has the capability to
455
465
define virtual networks which can then be used by domains and linked to
458
468
of the command for virtual networks are similar to the one used for domains,
459
469
but the way to name a virtual network is either by its name or UUID.
460
470
 
 
471
=over 4
 
472
 
461
473
=item B<net-autostart> I<network> optional I<--disable>
462
474
 
463
475
Configure a virtual network to be automatically started at boot.
517
529
 
518
530
Convert a network name to network UUID.
519
531
 
 
532
=back
 
533
 
520
534
=head1 ENVIRONMENT
521
535
 
 
536
The following environment variables can be set to alter the behaviour
 
537
of C<virsh>
 
538
 
 
539
=over 4
 
540
 
522
541
=item VIRSH_DEFAULT_CONNECT_URI
523
542
 
524
543
The hypervisor to connect to by default. Set this to a URI, in the same
525
544
format as accepted by the B<connect> option.
526
545
 
527
 
=head1 SEE ALSO
528
 
 
529
 
L<virt-install(1)>, L<xm(1)>, L<virt-top(1)>, L<virt-mem(1)>, L<virt-df(1)>, L<http://www.libvirt.org/>
530
 
 
531
 
=head1 AUTHOR
 
546
=item LIBVIRT_DEBUG=LEVEL
 
547
 
 
548
Turn on verbose debugging of all libvirt API calls. Valid levels are
 
549
 
 
550
=over 4
 
551
 
 
552
=item * LIBVIRT_DEBUG=1
 
553
 
 
554
Messages at level DEBUG or above
 
555
 
 
556
=item * LIBVIRT_DEBUG=2
 
557
 
 
558
Messages at level INFO or above
 
559
 
 
560
=item * LIBVIRT_DEBUG=3
 
561
 
 
562
Messages at level WARNING or above
 
563
 
 
564
=item * LIBVIRT_DEBUG=4
 
565
 
 
566
Messages at level ERROR or above
 
567
 
 
568
=back
 
569
 
 
570
For further information about debugging options consult C<http://libvirt.org/logging.html>
 
571
 
 
572
=back
 
573
 
 
574
=head1 BUGS
 
575
 
 
576
Report any bugs discovered to the libvirt community via the mailing
 
577
list C<http://libvirt.org/contact.html> or bug tracker C<http://libvirt.org/bugs.html>.
 
578
Alternatively report bugs to your software distributor / vendor.
 
579
 
 
580
=head1 AUTHORS
532
581
 
533
582
  Andrew Puch <apuch @ redhat.com>
534
583
  Daniel Veillard <veillard @ redhat.com>
537
586
  Sean Dague <sean at dague dot net>
538
587
  Daniel Stekloff <dsteklof at us dot ibm dot com>
539
588
 
540
 
 
541
 
=head1 BUGS
542
 
 
543
 
Bugs can be filed in Red Hat bugzilla under the Virtualization Tools/libvirt
544
 
L<https://bugzilla.redhat.com/>
545
 
 
546
 
L<https://bugzilla.redhat.com/buglist.cgi?product=Virtualization+Tools&component=libvirt&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED>
547
 
 
548
 
=end
 
589
=head1 COPYRIGHT
 
590
 
 
591
Copyright (C) 2005, 2007-2009 Red Hat, Inc.
 
592
 
 
593
=head1 LICENSE
 
594
 
 
595
virsh is distributed under the terms of the GNU LGPL v2+.
 
596
This is free software; see the source for copying conditions. There
 
597
is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
 
598
PURPOSE
 
599
 
 
600
=head1 SEE ALSO
 
601
 
 
602
L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>, L<virt-mem(1)>, L<virt-df(1)>, L<http://www.libvirt.org/>
 
603
 
 
604
=cut