Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
VIRTSECRETD(8)		    Virtualization Support		VIRTSECRETD(8)

NAME
       virtsecretd - libvirt secret data management daemon

SYNOPSIS
       virtsecretd [OPTION]...

DESCRIPTION
       The  virtsecretd	 program is a server side daemon component of the lib-
       virt virtualization management system.

       It is one of a collection of modular daemons that replace functionality
       previously provided by the monolithic libvirtd daemon.

       This daemon runs	on virtualization hosts	to provide management for  se-
       cret data.

       The virtsecretd daemon only listens for requests	on a local Unix	domain
       socket.	Remote	access	via  TLS/TCP  and backwards compatibility with
       legacy clients expecting	libvirtd is provided by	the virtproxyd daemon.

       Restarting virtsecretd does not interrupt running guests.  Guests  con-
       tinue to	operate	and changes in their state will	generally be picked up
       automatically  during startup. None the less it is recommended to avoid
       restarting with running guests whenever practical.

DAEMON STARTUP MODES
       The virtsecretd daemon is capable of starting in	two modes.

   Socket activation mode
       On hosts	with systemd it	is started in socket activation	 mode  and  it
       will  rely on systemd to	create and listen on the UNIX sockets and pass
       them as pre-opened file descriptors. In this mode most  of  the	socket
       related	config options in /etc/libvirt/virtsecretd.conf	will no	longer
       have any	effect.

   Traditional service mode
       On hosts	without	systemd, it will create	and listen on UNIX sockets it-
       self.

OPTIONS
       -h, --help

       Display command line help usage then exit.

       -d, --daemon

       Run as a	daemon & write PID file.

       -f, --config *FILE*

       Use this	configuration file, overriding the default value.

       -p, --pid-file *FILE*

       Use this	name for the PID file, overriding the default value.

       -t, --timeout *SECONDS*

       Exit after timeout period (in seconds), provided	there are neither  any
       client connections nor any ephemeral secrets.

       -v, --verbose

       Enable output of	verbose	messages.

       --version

       Display version information then	exit.

SIGNALS
       On receipt of SIGHUP virtsecretd	will reload its	configuration.

FILES
   When	run as root
        /usr/local/etc/libvirt/virtsecretd.conf

       The  default  configuration file	used by	virtsecretd, unless overridden
       on the command line using the -f	| --config option.

        /var/run/libvirt/virtsecretd-sock

        /var/run/libvirt/virtsecretd-sock-ro

        /var/run/libvirt/virtsecretd-admin-sock

       The sockets virtsecretd will use.

       The TLS Server private key virtsecretd will use.

        /var/run/virtsecretd.pid

       The PID file to use, unless overridden by the -p	| --pid-file option.

   When	run as non-root
        $XDG_CONFIG_HOME/libvirt/virtsecretd.conf

       The default configuration file used by virtsecretd,  unless  overridden
       on the command line using the -f``|--config`` option.

        $XDG_RUNTIME_DIR/libvirt/virtsecretd-sock

        $XDG_RUNTIME_DIR/libvirt/virtsecretd-admin-sock

       The sockets virtsecretd will use.

        $XDG_RUNTIME_DIR/libvirt/virtsecretd.pid

       The PID file to use, unless overridden by the -p``|--pid-file`` option.

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

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

EXAMPLES
       To retrieve the version of virtsecretd:

	  # virtsecretd	--version
	  virtsecretd (libvirt)	11.1.0

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

	  # virtsecretd	-d
	  # ls -la /var/run/virtsecretd.pid
	  -rw-r--r-- 1 root root 6 Jul	9 02:40	/var/run/virtsecretd.pid

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

       1. the mailing list

	   <https://libvirt.org/contact.html>

       2. the bug tracker

	   <https://libvirt.org/bugs.html>

       Alternatively, you may report bugs to your software distributor /  ven-
       dor.

AUTHORS
       Please refer to the AUTHORS file	distributed with libvirt.

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

LICENSE
       virtsecretd 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 PUR-
       POSE

SEE ALSO
       virsh(1), libvirtd(8),
	<https://libvirt.org/daemons.html> ,
	<https://libvirt.org/drvsecret.html>

								VIRTSECRETD(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=virtsecretd&sektion=8&manpath=FreeBSD+Ports+14.3.quarterly>

home | help