Manpages - virtproxyd.8

virtproxyd - libvirt proxy daemon

virtproxyd [/OPTION/]…

The virtproxyd program is a server side daemon component of the libvirt virtualization management system.

It is one of a collection of modular daemons that replace functionality previously provided by the monolithic libvirtd daemon.

This daemon runs on virtualization hosts and

#+begin_quote

#+begin_quote

• Listens on a UNIX socket to provide backwards compatibility for clients that previously connected to the libvirtd socket.
• Optionally listens on TCP ports for connections from off-node clients

#+end_quote #+end_quote

Upon receiving RPC messages from a client virtproxyd will transparently forward them on to the appropriate modular daemon, and similarly relay back any asynchronous events.

By default, the virtproxyd daemon listens for requests on a local Unix domain socket with the same path previously used by libvirtd. The configuration file can be used to instruct it to also listen on TCP socket(s). Systemd socket activation is also supported to allow it to receive pre-opened listener sockets on startup.

Since virtproxyd merely forwards RPC messages, it has no important state, and can be restarted at any time. Clients should expect to reconnect after the restart.

The virtproxyd daemon is capable of starting in two modes.

In the traditional mode, it will create and listen on UNIX sockets itself. It will also listen on TCP/IP socket(s), according to the listen_tcp and listen_tls options in /etc/libvirt/virtproxyd.conf

In socket activation mode, it will rely on systemd to create and listen on the UNIX, and optionally TCP/IP, sockets and pass them as pre-opened file descriptors. In this mode most of the socket related config options in /etc/libvirt/virtproxyd.conf will no longer have any effect. To enable TCP or TLS sockets use either

#+begin_quote

      $ systemctl start virtproxyd-tls.socket

#+end_quote

Or

#+begin_quote

      $ systemctl start virtproxyd-tcp.socket

#+end_quote

Socket activation mode is generally the default when running on a host OS that uses systemd. To revert to the traditional mode, all the socket unit files must be masked:

#+begin_quote

      $ systemctl mask virtproxyd.socket virtproxyd-ro.socket \
         virtproxyd-admin.socket virtproxyd-tls.socket virtproxyd-tcp.socket

#+end_quote

-h, –help

Display command line help usage then exit.

-d, –daemon

Run as a daemon & write PID file.

-f, –config FILE

Use this configuration file, overriding the default value.

-p, –pid-file FILE

Use this name for the PID file, overriding the default value.

-t, –timeout SECONDS

Exit after timeout period (in seconds), provided there are neither any client connections nor any running domains.

-v, –verbose

Enable output of verbose messages.

–version

Display version information then exit.

On receipt of SIGHUP virtproxyd will reload its configuration.

To retrieve the version of virtproxyd:

#+begin_quote

      # virtproxyd --version
      virtproxyd (libvirt) 7.10.0

#+end_quote

To start virtproxyd, instructing it to daemonize and create a PID file:

#+begin_quote

      # virtproxyd -d
      # ls -la /run/virtproxyd.pid
      -rw-r--r-- 1 root root 6 Jul  9 02:40 /run/virtproxyd.pid

#+end_quote

Please report all bugs you discover. This should be done via either:

1. the mailing list

https://libvirt.org/contact.html

1. the bug tracker

https://libvirt.org/bugs.html

Alternatively, you may report bugs to your software distributor / vendor.

Please refer to the AUTHORS file distributed with libvirt.

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

virtproxyd is distributed under the terms of the GNU LGPL v2.1+. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE

virsh(1), libvirtd(8), https://www.libvirt.org/daemons.html,