Command Reference - churchers/vm-bhyve GitHub Wiki

vm-bhyve commands

🔧 Global and System Commands

  • vm version – Shows vm-bhyve version and revision.
  • vm init – Initializes vm-bhyve directories, default datastore, and switch.
  • vm set [setting=value] – Sets a global vm-bhyve configuration option.
  • vm get [all|setting] – Displays global settings or a specific one.

🖧 Switch Management

  • vm switch list – Lists all defined virtual switches.
  • vm switch info <name> – Displays info about a specific switch.
  • vm switch create <name> – Creates a new switch (options: -t type, -i interface, etc.).
  • vm switch vlan <name> <vlan|0> – Assigns VLAN ID to the switch.
  • vm switch nat <name> <on|off> – Enables or disables NAT on the switch.
  • vm switch private <name> <on|off> – Toggles private mode (no external interfaces).
  • vm switch add <name> <interface> – Adds a physical interface to the switch.
  • vm switch remove <name> <interface> – Removes an interface from the switch.
  • vm switch destroy <name> – Deletes the switch.

💾 Datastore Management

  • vm datastore list – Lists all datastores.
  • vm datastore add <name> <path> – Adds a datastore at the given path.
  • vm datastore remove <name> – Removes a datastore.

🖥️ VM Management

  • vm list – Lists all VMs.
  • vm info <name> – Shows detailed info for a VM.
  • vm create <name> – Creates a new VM (with optional template/datastore).
  • vm install <name> <iso> – Boots VM from ISO for installation.
  • vm start <name> – Starts a VM.
  • vm stop <name> – Gracefully stops a VM.
  • vm restart <name> – Restarts a VM.
  • vm console <name> – Connects to a VM’s console (serial or graphical).
  • vm configure <name> – Opens the VM’s config file in an editor.
  • vm rename <old> <new> – Renames the VM.
  • vm add <name> – Adds a disk or NIC to the VM.

🚀 Batch and Power Controls

  • vm startall – Starts all VMs listed in vm_list=" " in /etc/rc.conf.
  • vm stopall – Stops all running VMs.
  • vm reset <name> – Forcefully resets a VM (like pressing reset).
  • vm poweroff <name> – Forcefully powers off a VM.
  • vm destroy <name> – Deletes the VM and its resources.

🧩 Advanced / Other

  • vm passthru – Lists available PCI devices for passthrough.
  • vm clone <name> <new> – Clones a VM (optionally from snapshot).
  • vm snapshot <name> – Creates a snapshot of the VM.
  • vm rollback <name@snapshot> – Rolls the VM back to a snapshot.

💿 Images / ISOs

  • vm iso [url] – Lists or downloads ISO images.
  • vm img [url] – Lists or downloads raw image files.
  • vm image list – Lists registered VM images.
  • vm image create <name> – Creates a reusable image from a VM.
  • vm image destroy <uuid> – Deletes an image.
  • vm image provision <uuid> <newname> – Creates a new VM from an image.
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️