FreeBSD Manual Pages
bmdctl(8) System Manager's Manual bmdctl(8) NAME bmdctl -- control utility for bhyve management daemon (bmd) SYNOPSIS bmdctl [-f -config_file] list [-r] [-s colname] bmdctl [-f -config_file] boot [-c] name bmdctl [-f -config_file] install [-c] name bmdctl [-f -config_file] shutdown name bmdctl [-f -config_file] poweroff name bmdctl [-f -config_file] reset name bmdctl [-f -config_file] console name bmdctl [-f -config_file] com[1-4] name bmdctl [-f -config_file] vconsole name bmdctl [-f -config_file] vconsole[N] name bmdctl [-f -config_file] vconsole[N].[M] name bmdctl [-f -config_file] show com[1-4] name bmdctl [-f -config_file] show console name bmdctl [-f -config_file] show vgaport name bmdctl [-f -config_file] show vconsole[N] name bmdctl [-f -config_file] show vconsole[N].[M] name bmdctl [-f -config_file] show config [name] bmdctl [-f -config_file] inspect name bmdctl [-f -config_file] run [-i] [-s] name DESCRIPTION The bmdctl command is a control utility for virtual machines which are man- aged by bmd(8). Root privileged user can control all virtual machines. Non-privileged user can control its own virtual machines. list [-r] [-s colname] Show list of virtual machines sorted by `id' column. -s option changes the sort key column. -r option shows the reverse list. boot [-c] name Boot the virtual machine. If -c is specified, connect to the console after booting. start [-c] name Alias for boot. install [-c] name Boot from ISO media to install it. If -c is specified, connect to the console after booting. Note that the in- stalled system never reboots just quits even if user commands in anyway, reboot the virtual machine manually after shutting down it. shutdown name Send SIGTERM to the bhyve process to trigger ACPI shut- down. stop name Alias for shutdown. poweroff name Force to quit the bhyve process. reset name Force to reset the bhyve process. console name Connect to the console (com1) of the virtual machine. See ESCAPE SEQUENCES below. com[1-4] name Connect to the com[1-4] of the virtual machine. See ES- CAPE SEQUENCES below. vconsole name Connect to one of the free virt_console ports. The BMD remembers the user ID and the tty name where bmdctl is running. They are specified in the port request message. If the same user on the same tty requests the virt_con- sole next, the BMD will assign the same virt_console port as before. If no unused port is found, the BMD may assign a port that was previously used by another user or tty. vconsole[N] name Connect to the Nth virt_console of the virtual machine, where N starts with 0. The maximum of N is the total number of virt_console ports among all controllers minus 1. See ESCAPE SEQUENCES below. vconsole[N].[M] name Connect to the Mth port of the Nth virt_console con- troller of the virtual machine, where N and M are be- tween 0 and 15. See ESCAPE SEQUENCES below. show com[1-4] name Print the com[1-4] device file. (nmdm) show console name Print the console device file. (nmdm) show vgaport name Print the vnc listen address and port number that are separated by space. show vconsole[N] name Print the Nth virt_console Unix Domain Socket path. show vconsole[N].[M] name Print the Mth port of Nth virt_console controller's Unix Domain Socket path. show config [name] Parse the configuration file and show virtual machine configurations. This is for debugging the configuration parser. inspect name Inspect disks and iso images and show the results for loadcmd and installcmd. run [-i] [-s] name Boot the virtual machine directly. The virtual machine runs out of control from bmd(8). Root privilege is re- quired. If -i is specified, boot from ISO image. If -s is specified, boot single user mode. The bmdctl command connects to the unix domain socket of bmd(8) and sends a request of sub-command (excludes the run sub-command). The unix domain socket path is read from bmd.conf(5). The file path of bmd.conf(5) can be specified -f option. If bmd.conf(5) is not readable, use the default path of /var/run/bmd.sock. ESCAPE SEQUENCES The following escape sequences are available for bmdctl console. ~. or ~^D Drop connection and exit. ~^Z Stop bmdctl console (only available with job control). ~^Y Stop only the "local side" of bmdctl console (only available with job control); the "remote side" of bmdctl console, the side that displays output from the remote host, is left running. SEE ALSO bmd(8), bmd.conf(5) FreeBSD ports 15.quarterly Apl 18, 2026 bmdctl(8)
NAME | SYNOPSIS | DESCRIPTION | ESCAPE SEQUENCES | SEE ALSO
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bmdctl&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>