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

DAEMON STARTUP MODES

41       The virtproxyd daemon is capable of starting in two modes.
42
43   Socket activation mode
44       On  hosts  with  systemd it is started in socket activation mode and it
45       will rely on systemd to create and listen on the UNIX,  and  optionally
46       TCP/IP,  sockets  and pass them as pre-opened file descriptors. In this
47       mode most of the socket related config  options  in  /etc/libvirt/virt‐
48       proxyd.conf  will no longer have any effect. To enable TCP or TLS sock‐
49       ets use either
50
51          $ systemctl start virtproxyd-tls.socket
52
53       Or
54
55          $ systemctl start virtproxyd-tcp.socket
56
57       Note: The TCP socket uses plain unencrypted TCP connection and thus  is
58       insecure and should not be used.
59
60   Traditional service mode
61       On hosts without systemd, it will create and listen on UNIX sockets it‐
62       self.  It will also listen on TCP/IP socket(s), according to  the  lis‐
63       ten_tcp and listen_tls options in /etc/libvirt/virtproxyd.conf
64

OPTIONS

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

SIGNALS

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

FILES

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

EXAMPLES

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

BUGS

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

AUTHORS

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

COPYRIGHT

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

LICENSE

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