12b948146SAndy Fiddaman.\" Copyright (c) 2015 Christian Brueffer 22b948146SAndy Fiddaman.\" All rights reserved. 32b948146SAndy Fiddaman.\" 42b948146SAndy Fiddaman.\" Redistribution and use in source and binary forms, with or without 52b948146SAndy Fiddaman.\" modification, are permitted provided that the following conditions 62b948146SAndy Fiddaman.\" are met: 72b948146SAndy Fiddaman.\" 1. Redistributions of source code must retain the above copyright 82b948146SAndy Fiddaman.\" notice, this list of conditions and the following disclaimer. 92b948146SAndy Fiddaman.\" 2. Redistributions in binary form must reproduce the above copyright 102b948146SAndy Fiddaman.\" notice, this list of conditions and the following disclaimer in the 112b948146SAndy Fiddaman.\" documentation and/or other materials provided with the distribution. 122b948146SAndy Fiddaman.\" 132b948146SAndy Fiddaman.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 142b948146SAndy Fiddaman.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 152b948146SAndy Fiddaman.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 162b948146SAndy Fiddaman.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 172b948146SAndy Fiddaman.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 182b948146SAndy Fiddaman.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 192b948146SAndy Fiddaman.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 202b948146SAndy Fiddaman.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 212b948146SAndy Fiddaman.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 222b948146SAndy Fiddaman.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 232b948146SAndy Fiddaman.\" SUCH DAMAGE. 242b948146SAndy Fiddaman.\" 252b948146SAndy Fiddaman.\" Portions Copyright 2021 OmniOS Community Edition (OmniOSce) Association. 262b948146SAndy Fiddaman.\" 272b948146SAndy Fiddaman.Dd May 4, 2020 28*bbf21555SRichard Lowe.Dt BHYVECTL 8 292b948146SAndy Fiddaman.Os 302b948146SAndy Fiddaman.Sh NAME 312b948146SAndy Fiddaman.Nm bhyvectl 322b948146SAndy Fiddaman.Nd "control utility for bhyve instances" 332b948146SAndy Fiddaman.Sh SYNOPSIS 342b948146SAndy Fiddaman.Nm 352b948146SAndy Fiddaman.Fl -vm= Ns Ar <vmname> 362b948146SAndy Fiddaman.Op Fl -create 372b948146SAndy Fiddaman.Op Fl -destroy 382b948146SAndy Fiddaman.Op Fl -get-stats 392b948146SAndy Fiddaman.Op Fl -inject-nmi 402b948146SAndy Fiddaman.Op Fl -force-reset 412b948146SAndy Fiddaman.Op Fl -force-poweroff 422b948146SAndy Fiddaman.Op Fl -checkpoint= Ns Ar <filename> 432b948146SAndy Fiddaman.Op Fl -suspend= Ns Ar <filename> 442b948146SAndy Fiddaman.Sh DESCRIPTION 452b948146SAndy FiddamanThe 462b948146SAndy Fiddaman.Nm 472b948146SAndy Fiddamancommand is a control utility for active 48*bbf21555SRichard Lowe.Xr bhyve 8 492b948146SAndy Fiddamanvirtual machine instances. 502b948146SAndy Fiddaman.Pp 512b948146SAndy Fiddaman.Em Note : 522b948146SAndy FiddamanMost 532b948146SAndy Fiddaman.Nm 542b948146SAndy Fiddamanflags are intended for querying and setting the state of an active instance. 552b948146SAndy FiddamanThese commands are intended for development purposes, and are not documented here. 562b948146SAndy FiddamanA complete list can be obtained by executing 572b948146SAndy Fiddaman.Nm 582b948146SAndy Fiddamanwithout any arguments. 592b948146SAndy Fiddaman.Pp 602b948146SAndy FiddamanThe user-facing options are as follows: 612b948146SAndy Fiddaman.Bl -tag -width ".Fl d Ar argument" 622b948146SAndy Fiddaman.It Fl -vm= Ns Ar <vmname> 632b948146SAndy FiddamanOperate on the virtual machine 642b948146SAndy Fiddaman.Ar <vmname> . 652b948146SAndy Fiddaman.It Fl -create 662b948146SAndy FiddamanCreate the specified VM. 672b948146SAndy Fiddaman.It Fl -destroy 682b948146SAndy FiddamanDestroy the specified VM. 692b948146SAndy Fiddaman.It Fl -get-stats 702b948146SAndy FiddamanRetrieve statistics for the specified VM. 712b948146SAndy Fiddaman.It Fl -inject-nmi 722b948146SAndy FiddamanInject a non-maskable interrupt (NMI) into the VM. 732b948146SAndy Fiddaman.It Fl -force-reset 742b948146SAndy FiddamanForce the VM to reset. 752b948146SAndy Fiddaman.It Fl -force-poweroff 762b948146SAndy FiddamanForce the VM to power off. 772b948146SAndy Fiddaman.El 782b948146SAndy Fiddaman.Sh EXIT STATUS 792b948146SAndy Fiddaman.Ex -std 802b948146SAndy Fiddaman.Sh EXAMPLES 812b948146SAndy FiddamanDestroy the VM called fbsd10: 822b948146SAndy Fiddaman.Pp 832b948146SAndy Fiddaman.Dl "bhyvectl --vm=fbsd10 --destroy" 842b948146SAndy Fiddaman.Sh SEE ALSO 85*bbf21555SRichard Lowe.Xr bhyve 8 86