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   Traditional service mode
58       On hosts without systemd, it will create and listen on UNIX sockets it‐
59       self.   It  will also listen on TCP/IP socket(s), according to the lis‐
60       ten_tcp and listen_tls options in /etc/libvirt/virtproxyd.conf
61

OPTIONS

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

SIGNALS

93       On receipt of SIGHUP virtproxyd will reload its configuration.
94

FILES

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

EXAMPLES

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

BUGS

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

AUTHORS

183       Please refer to the AUTHORS file distributed with libvirt.
184

COPYRIGHT

186       Copyright (C) 2006-2020 Red Hat, Inc., and the authors  listed  in  the
187       libvirt AUTHORS file.
188

LICENSE

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