usr.sbin/bhyvectl/bhyvectl.8

   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 .Dd May 4, 2020
  26 .Dt BHYVECTL 8
  27 .Os
  28 .Sh NAME
  29 .Nm bhyvectl
  30 .Nd "control utility for bhyve instances"
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Fl -vm= Ns Ar <vmname>
  34 .Op Fl -create
  35 .Op Fl -destroy
  36 .Op Fl -get-stats
  37 .Op Fl -inject-nmi
  38 .Op Fl -force-reset
  39 .Op Fl -force-poweroff
  40 .Op Fl -checkpoint= Ns Ar <filename>
  41 .Op Fl -suspend= Ns Ar <filename>
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 command is a control utility for active
  46 .Xr bhyve 8
  47 virtual machine instances.
  48 .Pp
  49 .Em Note :
  50 Most
  51 .Nm
  52 flags are intended for querying and setting the state of an active instance.
  53 These commands are intended for development purposes, and are not documented here.
  54 A complete list can be obtained by executing
  55 .Nm
  56 without any arguments.
  57 .Pp
  58 The user-facing options are as follows:
  59 .Bl -tag -width ".Fl d Ar argument"
  60 .It Fl -vm= Ns Ar <vmname>
  61 Operate on the virtual machine
  62 .Ar <vmname> .
  63 .It Fl -create
  64 Create the specified VM.
  65 .It Fl -destroy
  66 Destroy the specified VM.
  67 .It Fl -get-stats
  68 Retrieve statistics for the specified VM.
  69 .It Fl -inject-nmi
  70 Inject a non-maskable interrupt (NMI) into the VM.
  71 .It Fl -force-reset
  72 Force the VM to reset.
  73 .It Fl -force-poweroff
  74 Force the VM to power off.
  75 .It Fl -checkpoint= Ns Ar <filename>
  76 Save a snapshot of a virtual machine.
  77 The guest memory contents are saved in the file given in
  78 .Ar <filename> .
  79 The guest device and vCPU state are saved in the file
  80 .Ar <filename>.kern .
  81 .It Fl -suspend= Ns Ar <filename>
  82 Save a snapshot of a virtual machine similar to
  83 .Fl -checkpoint .
  84 The virtual machine will terminate after the snapshot has been
  85 saved.
  86 .El
  87 .Sh EXIT STATUS
  88 .Ex -std
  89 .Sh EXAMPLES
  90 Destroy the VM called fbsd10:
  91 .Pp
  92 .Dl "bhyvectl --vm=fbsd10 --destroy"
  93 .Sh COMPATIBILITY
  94 The snapshot file format is not yet stable and is subject to future changes.
  95 Backwards compatibility support for the current snapshot file format is not
  96 guaranteed when future changes are made.
  97 .Sh SEE ALSO
  98 .Xr bhyve 8 ,
  99 .Xr bhyveload 8
 100 .Sh HISTORY
 101 The
 102 .Nm
 103 command first appeared in
 104 .Fx 10.1 .
 105 .Sh AUTHORS
 106 .An -nosplit
 107 The
 108 .Nm
 109 utility was written by
 110 .An Peter Grehan
 111 and
 112 .An Neel Natu .