usr.sbin/bhyveload/bhyveload.8

   1 .\"
   2 .\" Copyright (c) 2012 NetApp Inc
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd January 7, 2012
  29 .Dt BHYVELOAD 8
  30 .Os
  31 .Sh NAME
  32 .Nm bhyveload
  33 .Nd load a
  34 .Fx
  35 guest inside a bhyve virtual machine
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl c Ar cons-dev
  39 .Op Fl d Ar disk-path
  40 .Op Fl e Ar name=value
  41 .Op Fl h Ar host-path
  42 .Op Fl m Ar mem-size
  43 .Ar vmname
  44 .Sh DESCRIPTION
  45 .Nm
  46 is used to load a
  47 .Fx
  48 guest inside a
  49 .Xr bhyve 4
  50 virtual machine.
  51 .Pp
  52 .Nm
  53 is based on
  54 .Xr loader 8
  55 and will present an interface identical to the
  56 .Fx
  57 loader on the user's terminal.
  58 .Pp
  59 The virtual machine is identified as
  60 .Ar vmname
  61 and will be created if it does not already exist.
  62 .Sh OPTIONS
  63 The following options are available:
  64 .Bl -tag -width indent
  65 .It Fl c Ar cons-dev
  66 .Ar cons-dev
  67 is a
  68 .Xr tty 4
  69 device to use for
  70 .Nm
  71 terminal I/O.
  72 .Pp
  73 The text string "stdio" is also accepted and selects the use of
  74 unbuffered standard I/O. This is the default value.
  75 .It Fl d Ar disk-path
  76 The
  77 .Ar disk-path
  78 is the pathname of the guest's boot disk image.
  79 .It Fl e Ar name=value
  80 Set the FreeBSD loader environment variable
  81 .Ar name
  82 to
  83 .Ar value .
  84 .Pp
  85 The option may be used more than once to set more than one environment
  86 variable.
  87 .It Fl h Ar host-path
  88 The
  89 .Ar host-path
  90 is the directory at the top of the guest's boot filesystem.
  91 .It Fl m Ar mem-size Xo
  92 .Sm off
  93 .Op Cm K | k | M | m | G | g | T | t
  94 .Xc
  95 .Sm on
  96 .Ar mem-size
  97 is the amount of memory allocated to the guest.
  98 .Pp
  99 The
 100 .Ar mem-size
 101 argument may be suffixed with one of
 102 .Cm K ,
 103 .Cm M ,
 104 .Cm G
 105 or
 106 .Cm T
 107 (either upper or lower case) to indicate a multiple of
 108 Kilobytes, Megabytes, Gigabytes or Terabytes
 109 respectively.
 110 .Pp
 111 The default value of
 112 .Ar mem-size
 113 is 256M.
 114 .El
 115 .Sh EXAMPLES
 116 To create a virtual machine named
 117 .Ar freebsd-vm
 118 that boots off the ISO image
 119 .Pa /freebsd/release.iso
 120 and has 1GB memory allocated to it:
 121 .Pp
 122 .Dl "bhyveload -m 1G -d /freebsd/release.iso freebsd-vm"
 123 .Pp
 124 To create a virtual machine named
 125 .Ar test-vm
 126 with 256MB of memory allocated, the guest root filesystem under the host
 127 directory
 128 .Pa /user/images/test
 129 and terminal I/O sent to the
 130 .Xr nmdm 4
 131 device
 132 .Pa /dev/nmdm1B
 133 .Pp
 134 .Dl "bhyveload -m 256MB -h /usr/images/test -c /dev/nmdm1B test-vm"
 135 .Sh SEE ALSO
 136 .Xr bhyve 4 ,
 137 .Xr nmdm 4 ,
 138 .Xr vmm 4 ,
 139 .Xr bhyve 8 ,
 140 .Xr loader 8
 141 .Sh HISTORY
 142 .Nm
 143 first appeared in
 144 .Fx 10.0 ,
 145 and was developed at NetApp Inc.
 146 .Sh AUTHORS
 147 .Nm
 148 was developed by
 149 .An -nosplit
 150 .An "Neel Natu" Aq neel@FreeBSD.org
 151 at NetApp Inc with a lot of help from
 152 .An Doug Rabson Aq dfr@FreeBSD.org
 153 .Sh BUGS
 154 .Nm
 155 can only load
 156 .Fx
 157 as a guest.