BHYVECTL(8)

πŸ“¦ version 15.1, in freebsd 14.5, freebsd 15.1

hey bestie πŸ’– this is the bhyvectl(8) page, straight from the System Manager's Manual, and we're gonna make it make sense. periodt. ✨

🌸 NAME 🌸

bhyvectl β€” control utility for bhyve instances. that's the whole vibe. πŸ’…

✨ SYNOPSIS ✨

bhyvectl --vm=<vmname> [--create] [--destroy] [--get-stats]
         [--inject-nmi] [--force-reset] [--force-poweroff]
         [--checkpoint=<file>] [--suspend=<file>]

πŸ’– DESCRIPTION πŸ’–

okay so the bhyvectl command is literally the control utility for active bhyve(8) virtual machine instances. think remote control, but for VMs. πŸŽ€

The user-facing options are as follows:

  • --vm=<vmname> β€” operate on the virtual machine <vmname>. πŸ’…
  • --create β€” create the specified VM. ✨
  • --destroy β€” destroy the specified VM. πŸ’€
  • --get-stats β€” retrieve statistics for the specified VM. πŸ“Š
  • --inject-nmi β€” inject a non-maskable interrupt (NMI) into the VM. ⚑
  • --force-reset β€” force the VM to reset. πŸ”„
  • --force-poweroff β€” force the VM to power off. πŸ”Œ
  • --checkpoint=<file> β€” save a snapshot of a virtual machine. The guest memory contents are saved in the file given in <file>. The guest device and vCPU state are saved in the file <file>.kern. 🫢
  • --suspend=<file> β€” save a snapshot of a virtual machine similar to --checkpoint. The virtual machine will terminate after the snapshot has been saved. 🧚
Note: most bhyvectl flags are intended for querying and setting the state of an active instance. These commands are intended for development purposes, and are not documented here. A complete list can be obtained by executing bhyvectl without any arguments. πŸ™ˆ

πŸŽ€ EXIT STATUS πŸŽ€

The bhyvectl utility exits 0 on success, and >0 if an error occurs. simple as that. ✨

πŸ¦‹ EXAMPLES πŸ¦‹

destroy the VM called fbsd10:

bhyvectl --vm=fbsd10 --destroy

Running VMs will be visible in /dev/vmm/. πŸ‘€

πŸ’… COMPATIBILITY πŸ’…

real talk: the snapshot file format is not yet stable and is subject to future changes. Backwards compatibility support for the current snapshot file format is not guaranteed when future changes are made. so don't count on it forever, bestie. 😭

πŸ‘‘ SEE ALSO πŸ‘‘

bhyve(8), bhyveload(8). go read those too. πŸ’–

🌈 HISTORY 🌈

The bhyvectl command first appeared in FreeBSD 10.1. iconic. πŸ‘‘

πŸ“ AUTHORS πŸ“

The bhyvectl utility was written by Peter Grehan and Neel Natu. legends. 🫢


πŸ’– that's the whole page, bestie β€” from the Debian manual page, dated May 8, 2025, for BHYVECTL(8). periodt. πŸ’…

πŸ“¦ where this page comes from