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

SYSTEM SOCKET ACTIVATION

30       The virtvboxd daemon is capable of starting in two modes.
31
32       In the traditional mode, it will create and listen on UNIX sockets  it‐
33       self.
34
35       In socket activation mode, it will rely on systemd to create and listen
36       on the UNIX sockets and pass them as pre-opened  file  descriptors.  In
37       this  mode  most  of  the  socket  related  config options in /etc/lib‐
38       virt/virtvboxd.conf will no longer have any effect.
39
40       Socket activation mode is generally the default when running on a  host
41       OS that uses systemd. To revert to the traditional mode, all the socket
42       unit files must be masked:
43
44          $ systemctl mask virtvboxd.socket virtvboxd-ro.socket \
45             virtvboxd-admin.socket
46

OPTIONS

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

SIGNALS

78       On receipt of SIGHUP virtvboxd will reload its configuration.
79

FILES

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

EXAMPLES

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

BUGS

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

AUTHORS

150       Please refer to the AUTHORS file distributed with libvirt.
151

COPYRIGHT

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

LICENSE

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