virtxend(8)

1VIRTXEND(8)                 Virtualization Support                 VIRTXEND(8)
2
3
4

NAME

6       virtxend - libvirt Xen management daemon
7

SYNOPSIS

9       virtxend [OPTION]...
10

DESCRIPTION

12       The  virtxend  program is a server side daemon component of the libvirt
13       virtualization management system.
14
15       It is one of a collection of modular daemons that replace functionality
16       previously provided by the monolithic libvirtd daemon.
17
18       This  daemon runs on virtualization hosts to provide management for Xen
19       virtual machines.
20
21       The virtxend daemon only listens for requests on a  local  Unix  domain
22       socket.  Remote off-host access and backwards compatibility with legacy
23       clients expecting libvirtd is provided by the virtproxy daemon.
24
25       Restarting virtxend does not interrupt running guests. Guests  continue
26       to operate and changes in their state will generally be picked up auto‐
27       matically during startup. None the less  it  is  recommended  to  avoid
28       restarting with running guests whenever practical.
29

SYSTEM SOCKET ACTIVATION

31       The virtxend daemon is capable of starting in two modes.
32
33       In  the traditional mode, it will create and listen on UNIX sockets it‐
34       self.
35
36       In socket activation mode, it will rely on systemd to create and listen
37       on  the  UNIX  sockets and pass them as pre-opened file descriptors. In
38       this mode most of  the  socket  related  config  options  in  /etc/lib‐
39       virt/virtxend.conf will no longer have any effect.
40
41       Socket  activation mode is generally the default when running on a host
42       OS that uses systemd. To revert to the traditional mode, all the socket
43       unit files must be masked:
44
45          $ systemctl mask virtxend.socket virtxend-ro.socket \
46             virtxend-admin.socket
47

OPTIONS

49       -h, --help
50
51       Display command line help usage then exit.
52
53       -d, --daemon
54
55       Run as a daemon & write PID file.
56
57       -f, --config *FILE*
58
59       Use this configuration file, overriding the default value.
60
61       -p, --pid-file *FILE*
62
63       Use this name for the PID file, overriding the default value.
64
65       -t, --timeout *SECONDS*
66
67       Exit  after timeout period (in seconds), provided there are neither any
68       client connections nor any running domains.
69
70       -v, --verbose
71
72       Enable output of verbose messages.
73
74       --version
75
76       Display version information then exit.
77

SIGNALS

79       On receipt of SIGHUP virtxend will reload its configuration.
80

FILES

82       The virtxend program must be ran as root. Trying to start  the  program
83       under a different user results in error.
84
85       • /etc/libvirt/virtxend.conf
86
87       The  default  configuration file used by virtxend, unless overridden on
88       the command line using the -f | --config option.
89
90       In addition to the default configuration file, virtxend reads  configu‐
91       ration for the libxl driver from:
92
93       • /etc/libvirt/libxl.conf
94
95       This  file  contains  various  knobs and default values for virtual ma‐
96       chines created within libxl driver, and offers a way  to  override  the
97       built  in  defaults,  Location  of this file can't be overridden by any
98       command line switch.
99
100       • /run/libvirt/virtxend-sock
101
102       • /run/libvirt/virtxend-sock-ro
103
104       • /run/libvirt/virtxend-admin-sock
105
106       The sockets virtxend will use.
107
108       The TLS Server private key virtxend will use.
109
110       • /run/virtxend.pid
111
112       The PID file to use, unless overridden by the -p | --pid-file option.
113

EXAMPLES

115       To retrieve the version of virtxend:
116
117          # virtxend --version
118          virtxend (libvirt) 8.6.0
119
120       To start virtxend, instructing it to daemonize and create a PID file:
121
122          # virtxend -d
123          # ls -la /run/virtxend.pid
124          -rw-r--r-- 1 root root 6 Jul  9 02:40 /run/virtxend.pid
125

BUGS

127       Please report all bugs you discover.  This should be done via either:
128
129       1. the mailing list
130
131          https://libvirt.org/contact.html
132
133       2. the bug tracker
134
135          https://libvirt.org/bugs.html
136
137       Alternatively, you may report bugs to your software distributor /  ven‐
138       dor.
139

AUTHORS

141       Please refer to the AUTHORS file distributed with libvirt.
142

COPYRIGHT

144       Copyright  (C)  2006-2020  Red Hat, Inc., and the authors listed in the
145       libvirt AUTHORS file.
146

LICENSE

148       virtxend is distributed under the terms of the GNU LGPL v2.1+.  This is
149       free  software; see the source for copying conditions. There is NO war‐
150       ranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
151