libvirtd.pod.in 3.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
=head1 NAME

libvirtd - libvirtd management daemon

=head1 SYNOPSIS

B<libvirtd> [ -dlv ] [ -f config_file ] [ -p pid_file ] [ -t timeout_seconds ]

B<libvirtd> --version

=head1 DESCRIPTION

The B<libvirtd> program is the server side daemon component of the libvirt
virtualization management system.

This daemon runs on host servers and performs required management tasks for
virtualized guests.  This includes activities such as starting, stopping
and migrating guests between host servers, configuring and manipulating
networking, and managing storage for use by guests.

The libvirt client libraries and utilities connect to this daemon to issue
tasks and collect information about the configuration and resources of the host
system and guests.

By default, the libvirtd daemon listens for requests on a local Unix domain
socket.  Using the B<-l>|B<--listen> command line option, the libvirtd daemon
can be instructed to additionally listen on a TCP/IP socket.  The TCP/IP socket
to use is defined in the libvirtd configuration file.

Restarting libvirtd does not impact running guests.  Guests continue to operate
and will be picked up automatically if their XML configuration has been
defined.  Any guests whose XML configuration has not been defined will be lost
from the configuration.

=head1 OPTIONS

=over

=item B<-d, --daemon>

Run as a daemon & write PID file.

=item B<-f, --config> I<FILE>

Use this configuration file, overriding the default value.

=item B<-l, --listen>

Listen for TCP/IP connections.

=item B<-p, --pid-file> I<FILE>

Use this name for the PID file, overriding the default value.

=item B<-t, --timeout> I<SECONDS>

Exit after timeout period (in seconds) expires.

=item B<-v, --verbose>

Enable output of verbose messages.

=item B<    --version>

Display version information then exit.

=back

=head1 SIGNALS

On receipt of B<SIGHUP> libvirtd will reload its configuration.

=head1 FILES

=over

=item F<@sysconfdir@/libvirtd.conf>

The default configuration file used by libvirtd, unless overridden on the
command line using the B<-f>|B<--config> option.

=item F<@localstatedir@/run/libvirt/libvirt-sock>

=item F<@localstatedir@/run/libvirt/libvirt-sock-ro>

The sockets libvirtd will use when B<run as root>.

88
=item F<$XDG_RUNTIME_DIR/libvirt/libvirt-sock>
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

The socket libvirtd will use when run as a B<non-root> user.

=item F<@sysconfdir@/pki/CA/cacert.pem>

The TLS B<Certificate Authority> certificate libvirtd will use.

=item F<@sysconfdir@/pki/libvirt/servercert.pem>

The TLS B<Server> certificate libvirtd will use.

=item F<@sysconfdir@/pki/libvirt/private/serverkey.pem>

The TLS B<Server> private key libvirtd will use.

=item F<@remote_pid_file@>

The PID file to use, unless overridden by the B<-p>|B<--pid-file> option.

=back

=head1 EXAMPLES

To retrieve the version of libvirtd:

 # libvirtd --version
 libvirtd (libvirt) 0.8.2
 #

To start libvirtd, instructing it to daemonize and create a PID file:

 # libvirtd -d
 # ls -la @remote_pid_file@
 -rw-r--r-- 1 root root 6 Jul  9 02:40 @remote_pid_file@
 #

=head1 BUGS

Please report all bugs you discover.  This should be done via either:

=over

=item a) the mailing list

L<http://libvirt.org/contact.html>

=item or,

B<>

=item b) the bug tracker

L<http://libvirt.org/bugs.html>

=item Alternatively, you may report bugs to your software distributor / vendor.

=back

=head1 AUTHORS

149
Please refer to the AUTHORS file distributed with libvirt.
150 151 152

=head1 COPYRIGHT

153
Copyright (C) 2006-2012 Red Hat, Inc., and the authors listed in the
154
libvirt AUTHORS file.
155 156 157 158 159 160 161 162 163 164 165

=head1 LICENSE

libvirtd is distributed under the terms of the GNU LGPL v2.1+.
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

L<virsh(1)>, L<virt-install(1)>, L<virt-xml-validate(1)>, L<virt-top(1)>,
166
L<virt-df(1)>, L<http://www.libvirt.org/>
167 168

=cut