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