virtlockd(8)

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

NAME

6       virtlockd - libvirt lock management daemon
7

SYNOPSIS

9       virtlockd [OPTION]...
10

DESCRIPTION

12       The virtlockd program is a server side daemon component of the libvirt
13       virtualization management system that is used to manage locks held
14       against virtual machine resources, such as their disks.
15
16       This daemon is not used directly by libvirt client applications, rather
17       it is called on their behalf by libvirtd. By maintaining the locks in a
18       standalone daemon, the main libvirtd daemon can be restarted without
19       risk of losing locks.  The virtlockd daemon has the ability to
20       re-exec() itself upon receiving SIGUSR1, to allow live upgrades without
21       downtime.
22
23       The virtlockd daemon listens for requests on a local Unix domain
24       socket.
25

OPTIONS

27       -h, --help
28           Display command line help usage then exit.
29
30       -d, --daemon
31           Run as a daemon and write PID file.
32
33       -f, --config FILE
34           Use this configuration file, overriding the default value.
35
36       -t, --timeout SECONDS
37           Automatically shutdown after SECONDS have elapsed with no active
38           client or lock.
39
40       -p, --pid-file FILE
41           Use this name for the PID file, overriding the default value.
42
43       -v, --verbose
44           Enable output of verbose messages.
45
46       -V, --version
47           Display version information then exit.
48

SIGNALS

50       On receipt of SIGUSR1 virtlockd will re-exec() its binary, while
51       maintaining all current locks and clients. This allows for live
52       upgrades of the virtlockd service.
53

FILES

55   When run as root.
56       /etc/libvirt/virtlockd.conf
57           The default configuration file used by virtlockd, unless overridden
58           on the command line using the -f|--config option.
59
60       /var/run/libvirt/virtlockd-sock
61           The sockets libvirtd will use.
62
63       /var/run/virtlockd.pid
64           The PID file to use, unless overridden by the -p|--pid-file option.
65
66   When run as non-root.
67       $XDG_CONFIG_HOME/libvirt/virtlockd.conf
68           The default configuration file used by libvirtd, unless overridden
69           on the command line using the -f|--config option.
70
71       $XDG_RUNTIME_DIR/libvirt/virtlockd-sock
72           The socket libvirtd will use.
73
74       $XDG_RUNTIME_DIR/libvirt/virtlockd.pid
75           The PID file to use, unless overridden by the -p|--pid-file option.
76
77       If $XDG_CONFIG_HOME is not set in your environment, libvirtd will use
78       $HOME/.config
79       If $XDG_RUNTIME_DIR is not set in your environment, libvirtd will use
80       $HOME/.cache
81

EXAMPLES

83       To retrieve the version of virtlockd:
84
85        # virtlockd --version
86        virtlockd (libvirt) 1.1.1
87        #
88
89       To start virtlockd, instructing it to daemonize and create a PID file:
90
91        # virtlockd -d
92        # ls -la /var/run/virtlockd.pid
93        -rw-r--r-- 1 root root 6 Jul  9 02:40 /var/run/virtlockd.pid
94        #
95

BUGS

97       Please report all bugs you discover.  This should be done via either:
98
99       a) the mailing list
100           <https://libvirt.org/contact.html>
101
102       or,
103
104       b) the bug tracker
105           <https://libvirt.org/bugs.html>
106
107       Alternatively, you may report bugs to your software distributor /
108       vendor.
109

AUTHORS

111       Please refer to the AUTHORS file distributed with libvirt.
112

COPYRIGHT

114       Copyright (C) 2006-2013 Red Hat, Inc., and the authors listed in the
115       libvirt AUTHORS file.
116

LICENSE

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