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

DAEMON STARTUP MODES

31       The virtqemud daemon is capable of starting in two modes.
32
33   Socket activation mode
34       On  hosts  with  systemd it is started in socket activation mode and it
35       will rely on systemd to create and listen on the UNIX sockets and  pass
36       them  as  pre-opened  file descriptors. In this mode most of the socket
37       related config options in /etc/libvirt/virtqemud.conf  will  no  longer
38       have any effect.
39
40   Traditional service mode
41       On hosts without systemd, it will create and listen on UNIX sockets it‐
42       self.
43

OPTIONS

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

SIGNALS

75       On receipt of SIGHUP virtqemud will reload its configuration.
76

FILES

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

EXAMPLES

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

BUGS

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

AUTHORS

171       Please refer to the AUTHORS file distributed with libvirt.
172

COPYRIGHT

174       Copyright (C) 2006-2020 Red Hat, Inc., and the authors  listed  in  the
175       libvirt AUTHORS file.
176

LICENSE

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