Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/bhyvectl/bhyvectl.8
| Show All 33 Lines | |||||
| .Nm | .Nm | ||||
| .Fl -vm= Ns Ar <vmname> | .Fl -vm= Ns Ar <vmname> | ||||
| .Op Fl -create | .Op Fl -create | ||||
| .Op Fl -destroy | .Op Fl -destroy | ||||
| .Op Fl -get-stats | .Op Fl -get-stats | ||||
| .Op Fl -inject-nmi | .Op Fl -inject-nmi | ||||
| .Op Fl -force-reset | .Op Fl -force-reset | ||||
| .Op Fl -force-poweroff | .Op Fl -force-poweroff | ||||
| .Op Fl -checkpoint= Ns Ar <filename> | |||||
| .Op Fl -suspend= Ns Ar <filename> | |||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| command is a control utility for active | command is a control utility for active | ||||
| .Xr bhyve 8 | .Xr bhyve 8 | ||||
| virtual machine instances. | virtual machine instances. | ||||
| .Pp | .Pp | ||||
| .Em Note : | .Em Note : | ||||
| Show All 17 Lines | |||||
| .It Fl -get-stats | .It Fl -get-stats | ||||
| Retrieve statistics for the specified VM. | Retrieve statistics for the specified VM. | ||||
| .It Fl -inject-nmi | .It Fl -inject-nmi | ||||
| Inject a non-maskable interrupt (NMI) into the VM. | Inject a non-maskable interrupt (NMI) into the VM. | ||||
| .It Fl -force-reset | .It Fl -force-reset | ||||
| Force the VM to reset. | Force the VM to reset. | ||||
| .It Fl -force-poweroff | .It Fl -force-poweroff | ||||
| Force the VM to power off. | Force the VM to power off. | ||||
| .It Fl -checkpoint= Ns Ar <filename> | |||||
| Save a snapshot of a virtual machine. | |||||
| The guest memory contents are saved in the file given in | |||||
| .Ar <filename> . | |||||
| The guest device and vCPU state are saved in the file | |||||
| .Ar <filename>.kern . | |||||
| .It Fl -suspend= Ns Ar <filename> | |||||
| Save a snapshot of a virtual machine similar to | |||||
| .Fl -checkpoint . | |||||
| The virtual machine will terminate after the snapshot has been | |||||
| saved. | |||||
| .El | .El | ||||
| .Sh EXIT STATUS | .Sh EXIT STATUS | ||||
| .Ex -std | .Ex -std | ||||
| .Sh EXAMPLES | .Sh EXAMPLES | ||||
| Destroy the VM called fbsd10: | Destroy the VM called fbsd10: | ||||
| .Pp | .Pp | ||||
| .Dl "bhyvectl --vm=fbsd10 --destroy" | .Dl "bhyvectl --vm=fbsd10 --destroy" | ||||
| .Sh COMPATIBILITY | |||||
| 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. | |||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr bhyve 8 , | .Xr bhyve 8 , | ||||
| .Xr bhyveload 8 | .Xr bhyveload 8 | ||||
| .Sh HISTORY | .Sh HISTORY | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| command first appeared in | command first appeared in | ||||
| .Fx 10.1 . | .Fx 10.1 . | ||||
| .Sh AUTHORS | .Sh AUTHORS | ||||
| .An -nosplit | .An -nosplit | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| utility was written by | utility was written by | ||||
| .An Peter Grehan | .An Peter Grehan | ||||
| and | and | ||||
| .An Neel Natu . | .An Neel Natu . | ||||