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 off-host	access and backwards compatibility with	legacy
       clients expecting libvirtd is provided by the virtproxy 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.

SYSTEM SOCKET ACTIVATION
       The virtsecretd daemon is capable of starting in	two modes.

       In  the traditional mode, it will create	and listen on UNIX sockets it-
       self.

       In socket activation mode, 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/lib-
       virt/virtsecretd.conf will no longer have any effect.

       Socket  activation mode is generally the	default	when running on	a host
       OS that uses systemd. To	revert to the traditional mode,	all the	socket
       unit files must be masked:

	  $ systemctl mask virtsecretd.socket virtsecretd-ro.socket \
	     virtsecretd-admin.socket

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 running domains.

       -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
       o /usr/local/etc/libvirt/virtsecretd.conf

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

       o /var/run/libvirt/virtsecretd-sock

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

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

       The sockets virtsecretd will use.

       The TLS Server private key virtsecretd will use.

       o /var/run/virtsecretd.pid

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

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

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

       o $XDG_RUNTIME_DIR/libvirt/virtsecretd-sock

       o $XDG_RUNTIME_DIR/libvirt/virtsecretd-admin-sock

       The sockets virtsecretd will use.

       o $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)	7.4.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://www.libvirt.org/daemons.html,
       https://www.libvirt.org/drvsecret.html

								VIRTSECRETD(8)

NAME | SYNOPSIS | DESCRIPTION | SYSTEM SOCKET ACTIVATION | OPTIONS | SIGNALS | FILES | EXAMPLES | BUGS | AUTHORS | COPYRIGHT | LICENSE | SEE ALSO

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

home | help