virtqemud(8)

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

NAME

6       virtqemud - libvirt QEMU management daemon
7

SYNOPSIS

9       virtqemud [OPTION]...
10

DESCRIPTION

12       The  virtqemud 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 QEMU
19       virtual machines.
20
21       The virtqemud 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 virtqemud 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 virtqemud 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/virtqemud.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 virtqemud.socket virtqemud-ro.socket \
46             virtqemud-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 virtqemud will reload its configuration.
80

FILES

82   When run as root
83       • /etc/libvirt/virtqemud.conf
84
85       The default configuration file used by virtqemud, unless overridden  on
86       the command line using the -f | --config option.
87
88       In addition to the default configuration file, virtqemud reads configu‐
89       ration for the QEMU driver from:
90
91       • /etc/libvirt/qemu.conf
92
93       This file contains various knobs and default  values  for  virtual  ma‐
94       chines  created  within  QEMU  driver, and offers a way to override the
95       built in defaults, for instance (but not limited to): paths to  various
96       supplementary  binaries,  TLS certificates location, graphical consoles
97       configuration and others. Location of this file can't be overridden  by
98       any command line switch.
99
100       • /run/libvirt/virtqemud-sock
101
102       • /run/libvirt/virtqemud-sock-ro
103
104       • /run/libvirt/virtqemud-admin-sock
105
106       The sockets virtqemud will use.
107
108       The TLS Server private key virtqemud will use.
109
110       • /run/virtqemud.pid
111
112       The PID file to use, unless overridden by the -p | --pid-file option.
113
114   When run as non-root
115       • $XDG_CONFIG_HOME/libvirt/virtqemud.conf
116
117       The  default configuration file used by virtqemud, unless overridden on
118       the command line using the -f``|--config`` option.
119
120       In addition to the default configuration file, virtqemud reads configu‐
121       ration for the qemu driver from:
122
123       • $XDG_CONFIG_HOME/libvirt/qemu.conf
124
125       If the file exists, it can contain various knobs and default values for
126       virtual machines created within QEMU driver, and offers a way to  over‐
127       ride the built in defaults, for instance (but not limited to): paths to
128       various supplementary binaries, TLS  certificates  location,  graphical
129       consoles configuration and others. Location of this file can't be over‐
130       ridden by any command line switch.
131
132       • $XDG_RUNTIME_DIR/libvirt/virtqemud-sock
133
134       • $XDG_RUNTIME_DIR/libvirt/virtqemud-admin-sock
135
136       The sockets virtqemud will use.
137
138       • $XDG_RUNTIME_DIR/libvirt/virtqemud.pid
139
140       The PID file to use, unless overridden by the -p``|--pid-file`` option.
141
142       If $XDG_CONFIG_HOME is not set in your environment, virtqemud will  use
143       $HOME/.config
144
145       If  $XDG_RUNTIME_DIR is not set in your environment, virtqemud will use
146       $HOME/.cache
147

EXAMPLES

149       To retrieve the version of virtqemud:
150
151          # virtqemud --version
152          virtqemud (libvirt) 8.1.0
153
154       To start virtqemud, instructing it to daemonize and create a PID file:
155
156          # virtqemud -d
157          # ls -la /run/virtqemud.pid
158          -rw-r--r-- 1 root root 6 Jul  9 02:40 /run/virtqemud.pid
159

BUGS

161       Please report all bugs you discover.  This should be done via either:
162
163       1. the mailing list
164
165          https://libvirt.org/contact.html
166
167       2. the bug tracker
168
169          https://libvirt.org/bugs.html
170
171       Alternatively, you may report bugs to your software distributor /  ven‐
172       dor.
173

AUTHORS

175       Please refer to the AUTHORS file distributed with libvirt.
176

COPYRIGHT

178       Copyright  (C)  2006-2020  Red Hat, Inc., and the authors listed in the
179       libvirt AUTHORS file.
180

LICENSE

182       virtqemud is distributed under the terms of the GNU LGPL  v2.1+.   This
183       is  free  software;  see the source for copying conditions. There is NO
184       warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
185       POSE
186