libvirt/docs/manpages/virtbhyved.rst
Daniel P. Berrangé cb20f222a2 docs: add manpage for virtbhyved
This is an adaptation of the libvirtd manpage.

Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2021-01-15 19:08:00 +00:00

4.3 KiB

virtbhyved

libvirt bhyve management daemon

Manual section

8

Manual group

Virtualization Support

SYNOPSIS

virtbhyved [OPTION]...

DESCRIPTION

The virtbhyved program is a server side daemon component of the libvirt 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 bhyve virtual machines.

The virtbhyved 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 virtbhyved does not interrupt running guests. Guests continue 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.

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 virtbhyved will reload its configuration.

FILES

When run as root

  • @SYSCONFDIR@/libvirt/virtbhyved.conf

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

  • @RUNSTATEDIR@/libvirt/virtbhyved-sock
  • @RUNSTATEDIR@/libvirt/virtbhyved-sock-ro
  • @RUNSTATEDIR@/libvirt/virtbhyved-admin-sock

The sockets virtbhyved will use.

The TLS Server private key virtbhyved will use.

  • @RUNSTATEDIR@/virtbhyved.pid

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

When run as non-root

  • $XDG_CONFIG_HOME/libvirt/virtbhyved.conf

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

  • $XDG_RUNTIME_DIR/libvirt/virtbhyved-sock
  • $XDG_RUNTIME_DIR/libvirt/virtbhyved-admin-sock

The sockets virtbhyved will use.

  • $XDG_RUNTIME_DIR/libvirt/virtbhyved.pid

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

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

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

EXAMPLES

To retrieve the version of virtbhyved:

# virtbhyved --version
virtbhyved (libvirt) @VERSION@

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

# virtbhyved -d
# ls -la @RUNSTATEDIR@/virtbhyved.pid
-rw-r--r-- 1 root root 6 Jul  9 02:40 @RUNSTATEDIR@/virtbhyved.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 / vendor.

AUTHORS

Please refer to the AUTHORS file distributed with libvirt.

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

LICENSE

virtbhyved 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

virsh(1), libvirtd(8), https://www.libvirt.org/daemons.html, https://www.libvirt.org/drvbhyve.html