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 January 12, 2016
  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 .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-state
  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 .El
  76 .Sh EXIT STATUS
  77 .Ex -std
  78 .Sh EXAMPLES
  79 Destroy the VM called fbsd10:
  80 .Pp
  81 .Dl "bhyvectl --vm=fbsd10 --destroy"
  82 .Sh SEE ALSO
  83 .Xr bhyve 8 ,
  84 .Xr bhyveload 8
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 command first appeared in
  89 .Fx 10.1 .
  90 .Sh AUTHORS
  91 .An -nosplit
  92 The
  93 .Nm
  94 utility was written by
  95 .An Peter Grehan
  96 and
  97 .An Neel Natu .