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

FreeBSD Manual Pages

  
 
  

home | help
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]	showconsole name
       bmdctl [-f -config_file]	showvgaport name
       bmdctl [-f -config_file]	showconfig [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
       managed by bmd(8).  Root	privileged user	can control  all  virtual  ma-
       chines. 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,  con-
			  nect to the console after booting.

       start [-c] name	  Alias	for boot.

       install [-c] name  Boot	from  ISO media	to install it. If -c is	speci-
			  fied,	connect	to the console	after  booting.	  Note
			  that	the  installed 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
			  shutdown.

       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  ma-
			  chine. See ESCAPE SEQUENCES below.

       com[1-4]	name	  Connect  to the com[1-4] of the virtual machine. See
			  ESCAPE SEQUENCES below.

       showconsole name	  Print	the console device file. (nmdm)

       showvgaport name	  Print	the vnc	listen address and  port  number  that
			  are separated	by space.

       showconfig [name]  Parse	 the  configuration  file and show virtual ma-
			  chine	configurations.	This is	for debugging the con-
			  figuration 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 ma-
			  chine	runs out of control from bmd(8).  Root	privi-
			  lege	is required. 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	 read-
       able, 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 run-
		  ning.

SEE ALSO
       bmd(8), bmd.conf(5)

FreeBSD	Ports 14.quarterly	 Oct 29, 2024			     bmdctl(8)

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

home | help