virtvboxd(8)

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

NAME

6       virtvboxd - libvirt VirtualBox management daemon
7

SYNOPSIS

9       virtvboxd [OPTION]...
10

DESCRIPTION

12       The  virtvboxd 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 Vir‐
19       tualBox virtual machines.
20
21       The virtvboxd 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 virtvboxd 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.
28

DAEMON STARTUP MODES

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

OPTIONS

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

SIGNALS

74       On receipt of SIGHUP virtvboxd will reload its configuration.
75

FILES

77   When run as root
78       • /etc/libvirt/virtvboxd.conf
79
80       The default configuration file used by virtvboxd, unless overridden  on
81       the command line using the -f | --config option.
82
83       • /run/libvirt/virtvboxd-sock
84
85       • /run/libvirt/virtvboxd-sock-ro
86
87       • /run/libvirt/virtvboxd-admin-sock
88
89       The sockets virtvboxd will use.
90
91       The TLS Server private key virtvboxd will use.
92
93       • /run/virtvboxd.pid
94
95       The PID file to use, unless overridden by the -p | --pid-file option.
96
97   When run as non-root
98       • $XDG_CONFIG_HOME/libvirt/virtvboxd.conf
99
100       The  default configuration file used by virtvboxd, unless overridden on
101       the command line using the -f``|--config`` option.
102
103       • $XDG_RUNTIME_DIR/libvirt/virtvboxd-sock
104
105       • $XDG_RUNTIME_DIR/libvirt/virtvboxd-admin-sock
106
107       The sockets virtvboxd will use.
108
109       • $XDG_RUNTIME_DIR/libvirt/virtvboxd.pid
110
111       The PID file to use, unless overridden by the -p``|--pid-file`` option.
112
113       If $XDG_CONFIG_HOME is not set in your environment, virtvboxd will  use
114       $HOME/.config
115
116       If  $XDG_RUNTIME_DIR is not set in your environment, virtvboxd will use
117       $HOME/.cache
118

EXAMPLES

120       To retrieve the version of virtvboxd:
121
122          # virtvboxd --version
123          virtvboxd (libvirt) 9.0.0
124
125       To start virtvboxd, instructing it to daemonize and create a PID file:
126
127          # virtvboxd -d
128          # ls -la /run/virtvboxd.pid
129          -rw-r--r-- 1 root root 6 Jul  9 02:40 /run/virtvboxd.pid
130

BUGS

132       Please report all bugs you discover.  This should be done via either:
133
134       1. the mailing list
135
136          https://libvirt.org/contact.html
137
138       2. the bug tracker
139
140          https://libvirt.org/bugs.html
141
142       Alternatively, you may report bugs to your software distributor /  ven‐
143       dor.
144

AUTHORS

146       Please refer to the AUTHORS file distributed with libvirt.
147

COPYRIGHT

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

LICENSE

153       virtvboxd is distributed under the terms of the GNU LGPL  v2.1+.   This
154       is  free  software;  see the source for copying conditions. There is NO
155       warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
156       POSE
157