1.\" Copyright (c) 2015 Christian Brueffer 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" Portions Copyright 2021 OmniOS Community Edition (OmniOSce) Association. 26.\" 27.Dd May 4, 2020 28.Dt BHYVECTL 8 29.Os 30.Sh NAME 31.Nm bhyvectl 32.Nd "control utility for bhyve instances" 33.Sh SYNOPSIS 34.Nm 35.Fl -vm= Ns Ar <vmname> 36.Op Fl -create 37.Op Fl -destroy 38.Op Fl -get-stats 39.Op Fl -inject-nmi 40.Op Fl -force-reset 41.Op Fl -force-poweroff 42.Op Fl -checkpoint= Ns Ar <filename> 43.Op Fl -suspend= Ns Ar <filename> 44.Sh DESCRIPTION 45The 46.Nm 47command is a control utility for active 48.Xr bhyve 8 49virtual machine instances. 50.Pp 51.Em Note : 52Most 53.Nm 54flags are intended for querying and setting the state of an active instance. 55These commands are intended for development purposes, and are not documented here. 56A complete list can be obtained by executing 57.Nm 58without any arguments. 59.Pp 60The user-facing options are as follows: 61.Bl -tag -width ".Fl d Ar argument" 62.It Fl -vm= Ns Ar <vmname> 63Operate on the virtual machine 64.Ar <vmname> . 65.It Fl -create 66Create the specified VM. 67.It Fl -destroy 68Destroy the specified VM. 69.It Fl -get-stats 70Retrieve statistics for the specified VM. 71.It Fl -inject-nmi 72Inject a non-maskable interrupt (NMI) into the VM. 73.It Fl -force-reset 74Force the VM to reset. 75.It Fl -force-poweroff 76Force the VM to power off. 77.El 78.Sh EXIT STATUS 79.Ex -std 80.Sh EXAMPLES 81Destroy the VM called fbsd10: 82.Pp 83.Dl "bhyvectl --vm=fbsd10 --destroy" 84.Sh SEE ALSO 85.Xr bhyve 8 86