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

SIGNALS

57       On receipt of SIGUSR1, virtlockd will re-exec() its binary, while main‐
58       taining all current locks and clients. This allows for live upgrades of
59       the virtlockd service.
60

FILES

62   When run as root
63       • /etc/libvirt/virtlockd.conf
64
65       The default configuration file used by virtlockd, unless overridden  on
66       the command line using the -f | --config option.
67
68       • /run/libvirt/virtlockd-sock
69
70       The sockets virtlockd will use.
71
72       • /run/virtlockd.pid
73
74       The PID file to use, unless overridden by the -p | --pid-file option.
75
76   When run as non-root
77       • $XDG_CONFIG_HOME/libvirt/virtlockd.conf
78
79       The  default configuration file used by virtlockd, unless overridden on
80       the command line using the -f | --config option.
81
82       • $XDG_RUNTIME_DIR/libvirt/virtlockd-sock
83
84       The socket virtlockd will use.
85
86       • $XDG_RUNTIME_DIR/libvirt/virtlockd.pid
87
88       The PID file to use, unless overridden by the -p | --pid-file option.
89
90       If $XDG_CONFIG_HOME is not set in your environment, virtlockd will  use
91       $HOME/.config
92
93       If  $XDG_RUNTIME_DIR is not set in your environment, virtlockd will use
94       $HOME/.cache
95

EXAMPLES

97       To retrieve the version of virtlockd:
98
99          # virtlockd --version
100          virtlockd (libvirt) 8.1.0
101
102       To start virtlockd, instructing it to daemonize and create a PID file:
103
104          # virtlockd -d
105          # ls -la /run/virtlockd.pid
106          -rw-r--r-- 1 root root 6 Jul  9 02:40 /run/virtlockd.pid
107

BUGS

109       Please report all bugs you discover.  This should be done via either:
110
111       1. the mailing list
112
113          https://libvirt.org/contact.html
114
115       2. the bug tracker
116
117          https://libvirt.org/bugs.html
118
119       Alternatively, you may report bugs to your software distributor /  ven‐
120       dor.
121

AUTHORS

123       Please refer to the AUTHORS file distributed with libvirt.
124

COPYRIGHT

126       Copyright  (C)  2006-2013  Red Hat, Inc., and the authors listed in the
127       libvirt AUTHORS file.
128

LICENSE

130       virtlockd is distributed under the terms of the GNU LGPL  v2.1+.   This
131       is  free  software;  see the source for copying conditions. There is NO
132       warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
133       POSE
134