57b1ddcaaa
This is an adaptation of the libvirtd manpage. Reviewed-by: Jiri Denemark <jdenemar@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
4.9 KiB
virtxend
libvirt Xen management daemon
- Manual section
8
- Manual group
Virtualization Support
SYNOPSIS
virtxend [OPTION]...
DESCRIPTION
The virtxend program is a server side daemon component of the libvirt virtualization management system.
It is one of a collection of modular daemons that replace functionality previously provided by the monolithic libvirtd daemon.
This daemon runs on virtualization hosts to provide management for Xen virtual machines.
The virtxend daemon only listens for requests on a local Unix domain socket. Remote off-host access and backwards compatibility with legacy clients expecting libvirtd is provided by the virtproxy daemon.
Restarting virtxend does not interrupt running guests. Guests continue to operate and changes in their state will generally be picked up automatically during startup. None the less it is recommended to avoid restarting with running guests whenever practical.
SYSTEM SOCKET ACTIVATION
The virtxend daemon is capable of starting in two modes.
In the traditional mode, it will create and listen on UNIX sockets itself.
In socket activation mode, it will rely on systemd to create and listen on the UNIX sockets and pass them as pre-opened file descriptors. In this mode most of the socket related config options in /etc/libvirt/virtxend.conf will no longer have any effect.
Socket activation mode is generally the default when running on a host OS that uses systemd. To revert to the traditional mode, all the socket unit files must be masked:
$ systemctl mask virtxend.socket virtxend-ro.socket \
virtxend-admin.socketOPTIONS
-h, --help
Display command line help usage then exit.
-d, --daemon
Run as a daemon & write PID file.
-f, --config *FILE*
Use this configuration file, overriding the default value.
-p, --pid-file *FILE*
Use this name for the PID file, overriding the default value.
-t, --timeout *SECONDS*
Exit after timeout period (in seconds), provided there are neither any client connections nor any running domains.
-v, --verbose
Enable output of verbose messages.
--version
Display version information then exit.
SIGNALS
On receipt of SIGHUP virtxend will reload its configuration.
FILES
When run as root
@SYSCONFDIR@/libvirt/virtxend.conf
The default configuration file used by virtxend, unless overridden on the command line using the -f | --config option.
@RUNSTATEDIR@/libvirt/virtxend-sock@RUNSTATEDIR@/libvirt/virtxend-sock-ro@RUNSTATEDIR@/libvirt/virtxend-admin-sock
The sockets virtxend will use.
The TLS Server private key virtxend will use.
@RUNSTATEDIR@/virtxend.pid
The PID file to use, unless overridden by the -p | --pid-file option.
When run as non-root
$XDG_CONFIG_HOME/libvirt/virtxend.conf
The default configuration file used by virtxend, unless overridden on the command line using the -f|--config option.
$XDG_RUNTIME_DIR/libvirt/virtxend-sock$XDG_RUNTIME_DIR/libvirt/virtxend-admin-sock
The sockets virtxend will use.
$XDG_RUNTIME_DIR/libvirt/virtxend.pid
The PID file to use, unless overridden by the -p|--pid-file option.
If $XDG_CONFIG_HOME is not set in your environment, virtxend will use $HOME/.config
If $XDG_RUNTIME_DIR is not set in your environment, virtxend will use $HOME/.cache
EXAMPLES
To retrieve the version of virtxend:
# virtxend --version
virtxend (libvirt) @VERSION@To start virtxend, instructing it to daemonize and create a PID file:
# virtxend -d
# ls -la @RUNSTATEDIR@/virtxend.pid
-rw-r--r-- 1 root root 6 Jul 9 02:40 @RUNSTATEDIR@/virtxend.pidBUGS
Please report all bugs you discover. This should be done via either:
the mailing list
the bug tracker
Alternatively, you may report bugs to your software distributor / vendor.
AUTHORS
Please refer to the AUTHORS file distributed with libvirt.
COPYRIGHT
Copyright (C) 2006-2020 Red Hat, Inc., and the authors listed in the libvirt AUTHORS file.
LICENSE
virtxend 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
SEE ALSO
virsh(1), libvirtd(8), https://www.libvirt.org/daemons.html, https://www.libvirt.org/drvxen.html