virtlockd Man page

VIRTLOCKD(8) Virtualization Support VIRTLOCKD(8)

NAME

virtlockd – libvirt lock management daemon

SYNOPSIS

virtlockd [ -dvV ] [ -t timeout] [ -f config_file ] [ -p pid_file ]

virtlockd –version

DESCRIPTION

The virtlockd program is a server side daemon component of the libvirt
virtualization management system that is used to manage locks held
against virtual machine resources, such as their disks.

This daemon is not used directly by libvirt client applications, rather
it is called on their behalf by libvirtd. By maintaining the locks in a
standalone daemon, the main libvirtd daemon can be restarted without
risk of losing locks. The virtlockd daemon has the ability to
re-exec() itself upon receiving SIGUSR1, to allow live upgrades without
downtime.

The virtlockd daemon listens for requests on a local Unix domain
socket.

OPTIONS

-h, –help
Display command line help usage then exit.

-d, –daemon
Run as a daemon and write PID file.

-f, –config FILE
Use this configuration file, overriding the default value.

-t, –timeout SECONDS
Automatically shutdown after SECONDS have elapsed with no active
client or lock.

-p, –pid-file FILE
Use this name for the PID file, overriding the default value.

-v, –verbose
Enable output of verbose messages.

-V, –version
Display version information then exit.

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

FILES
When run as root.
SYSCONFDIR/virtlockd.conf
The default configuration file used by virtlockd, unless overridden
on the command line using the -f|–config option.

LOCALSTATEDIR/run/libvirt/virtlockd-sock
The sockets libvirtd will use.

LOCALSTATEDIR/run/virtlockd.pid
The PID file to use, unless overridden by the -p|–pid-file option.

When run as non-root.
$XDG_CONFIG_HOME/virtlockd.conf
The default configuration file used by libvirtd, unless overridden
on the command line using the -f|–config option.

$XDG_RUNTIME_DIR/libvirt/virtlockd-sock
The socket libvirtd will use.

$XDG_RUNTIME_DIR/libvirt/virtlockd.pid
The PID file to use, unless overridden by the -p|–pid-file option.

If $XDG_CONFIG_HOME is not set in your environment, libvirtd will use
$HOME/.config
If $XDG_RUNTIME_DIR is not set in your environment, libvirtd will use
$HOME/.cache

EXAMPLES
To retrieve the version of virtlockd:

# virtlockd –version
virtlockd (libvirt) 1.1.1
#

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

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

BUGS

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

a) the mailing list

or,

b) the bug tracker

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

AUTHORS
Please refer to the AUTHORS file distributed with libvirt.

COPRYRIGHT

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

LICENSE
virtlockd 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

SEE ALSO

libvirtd(8),

libvirt-1.3.1 2016-10-06 VIRTLOCKD(8)