virtproxyd(8)

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

NAME

6       virtproxyd - libvirt proxy daemon
7

SYNOPSIS

9       virtproxyd [OPTION]...
10

DESCRIPTION

12       The virtproxyd 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 and
19
20          • Listens  on  a  UNIX socket to provide backwards compatibility for
21            clients that previously connected to the libvirtd socket.
22
23          • Optionally listens on TCP  ports  for  connections  from  off-node
24            clients
25
26       Upon receiving RPC messages from a client virtproxyd will transparently
27       forward them on to the appropriate modular daemon, and similarly  relay
28       back any asynchronous events.
29
30       By  default, the virtproxyd daemon listens for requests on a local Unix
31       domain socket with the same path previously used by libvirtd.  The con‐
32       figuration  file  can  be  used  to  instruct  it to also listen on TCP
33       socket(s).  Systemd socket activation is also supported to allow it  to
34       receive pre-opened listener sockets on startup.
35
36       Since  virtproxyd  merely  forwards  RPC  messages, it has no important
37       state, and can be restarted at any time. Clients should expect  to  re‐
38       connect after the restart.
39

SYSTEM SOCKET ACTIVATION

41       The virtproxyd daemon is capable of starting in two modes.
42
43       In  the traditional mode, it will create and listen on UNIX sockets it‐
44       self.  It will also listen on TCP/IP socket(s), according to  the  lis‐
45       ten_tcp and listen_tls options in /etc/libvirt/virtproxyd.conf
46
47       In socket activation mode, it will rely on systemd to create and listen
48       on the UNIX, and optionally TCP/IP, sockets and pass them as pre-opened
49       file  descriptors.  In  this mode most of the socket related config op‐
50       tions in /etc/libvirt/virtproxyd.conf will no longer have  any  effect.
51       To enable TCP or TLS sockets use either
52
53          $ systemctl start virtproxyd-tls.socket
54
55       Or
56
57          $ systemctl start virtproxyd-tcp.socket
58
59       Socket  activation mode is generally the default when running on a host
60       OS that uses systemd. To revert to the traditional mode, all the socket
61       unit files must be masked:
62
63          $ systemctl mask virtproxyd.socket virtproxyd-ro.socket \
64             virtproxyd-admin.socket virtproxyd-tls.socket virtproxyd-tcp.socket
65

OPTIONS

67       -h, --help
68
69       Display command line help usage then exit.
70
71       -d, --daemon
72
73       Run as a daemon & write PID file.
74
75       -f, --config *FILE*
76
77       Use this configuration file, overriding the default value.
78
79       -p, --pid-file *FILE*
80
81       Use this name for the PID file, overriding the default value.
82
83       -t, --timeout *SECONDS*
84
85       Exit  after timeout period (in seconds), provided there are neither any
86       client connections nor any running domains.
87
88       -v, --verbose
89
90       Enable output of verbose messages.
91
92       --version
93
94       Display version information then exit.
95

SIGNALS

97       On receipt of SIGHUP virtproxyd will reload its configuration.
98

FILES

100   When run as root
101       • /etc/libvirt/virtproxyd.conf
102
103       The default configuration file used by virtproxyd, unless overridden on
104       the command line using the -f | --config option.
105
106       • /run/libvirt/libvirt-sock
107
108       • /run/libvirt/libvirt-sock-ro
109
110       The sockets virtproxyd will use.
111
112       • /etc/pki/CA/cacert.pem
113
114       The TLS Certificate Authority certificate virtproxyd will use.
115
116       • /etc/pki/libvirt/servercert.pem
117
118       The TLS Server certificate virtproxyd will use.
119
120       • /etc/pki/libvirt/private/serverkey.pem
121
122       The TLS Server private key virtproxyd will use.
123
124       • /run/virtproxyd.pid
125
126       The PID file to use, unless overridden by the -p | --pid-file option.
127
128   When run as non-root
129       • $XDG_CONFIG_HOME/libvirt/virtproxyd.conf
130
131       The default configuration file used by virtproxyd, unless overridden on
132       the command line using the -f``|--config`` option.
133
134       • $XDG_RUNTIME_DIR/libvirt/libvirt-sock
135
136       The socket virtproxyd will use.
137
138       • $HOME/.pki/libvirt/cacert.pem
139
140       The TLS Certificate Authority certificate virtproxyd will use.
141
142       • $HOME/.pki/libvirt/servercert.pem
143
144       The TLS Server certificate virtproxyd will use.
145
146       • $HOME/.pki/libvirt/serverkey.pem
147
148       The TLS Server private key virtproxyd will use.
149
150       • $XDG_RUNTIME_DIR/libvirt/virtproxyd.pid
151
152       The PID file to use, unless overridden by the -p``|--pid-file`` option.
153
154       If $XDG_CONFIG_HOME is not set in your environment, virtproxyd will use
155       $HOME/.config
156
157       If $XDG_RUNTIME_DIR is not set in your environment, virtproxyd will use
158       $HOME/.cache
159

EXAMPLES

161       To retrieve the version of virtproxyd:
162
163          # virtproxyd --version
164          virtproxyd (libvirt) 7.6.0
165
166       To start virtproxyd, instructing it to daemonize and create a PID file:
167
168          # virtproxyd -d
169          # ls -la /run/virtproxyd.pid
170          -rw-r--r-- 1 root root 6 Jul  9 02:40 /run/virtproxyd.pid
171

BUGS

173       Please report all bugs you discover.  This should be done via either:
174
175       1. the mailing list
176
177          https://libvirt.org/contact.html
178
179       2. the bug tracker
180
181          https://libvirt.org/bugs.html
182
183       Alternatively, you may report bugs to your software distributor /  ven‐
184       dor.
185

AUTHORS

187       Please refer to the AUTHORS file distributed with libvirt.
188

COPYRIGHT

190       Copyright  (C)  2006-2020  Red Hat, Inc., and the authors listed in the
191       libvirt AUTHORS file.
192

LICENSE

194       virtproxyd is distributed under the terms of the GNU LGPL v2.1+.   This
195       is  free  software;  see the source for copying conditions. There is NO
196       warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
197       POSE
198