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 m Ar mem-size
  39 .Op Fl d Ar disk-path
  40 .Op Fl h Ar host-path
  41 .Op Fl e Ar name=value
  42 .Ar vmname
  43 .Sh DESCRIPTION
  44 .Nm
  45 is used to load a
  46 .Fx
  47 guest inside a
  48 .Xr bhyve 4
  49 virtual machine.
  50 .Pp
  51 .Nm
  52 is based on
  53 .Xr loader 8
  54 and will present an interface identical to the
  55 .Fx
  56 loader on the user's terminal.
  57 .Pp
  58 The virtual machine is identified as
  59 .Ar vmname
  60 and will be created if it does not already exist.
  61 .Sh OPTIONS
  62 The following options are available:
  63 .Bl -tag -width indent
  64 .It Fl m Ar mem-size Xo
  65 .Sm off
  66 .Op Cm K | k | M | m | G | g | T | t
  67 .Xc
  68 .Sm on
  69 .Ar mem-size
  70 is the amount of memory allocated to the guest.
  71 .Pp
  72 The
  73 .Ar mem-size
  74 argument may be suffixed with one of
  75 .Cm K ,
  76 .Cm M ,
  77 .Cm G
  78 or
  79 .Cm T
  80 (either upper or lower case) to indicate a multiple of
  81 Kilobytes, Megabytes, Gigabytes or Terabytes
  82 respectively.
  83 .Pp
  84 The default value of
  85 .Ar mem-size
  86 is 256M.
  87 .It Fl d Ar disk-path
  88 The
  89 .Ar disk-path
  90 is the pathname of the guest's boot disk image.
  91 .It Fl h Ar host-path
  92 The
  93 .Ar host-path
  94 is the directory at the top of the guest's boot filesystem.
  95 .It Fl e Ar name=value
  96 Set the FreeBSD loader environment variable
  97 .Ar name
  98 to
  99 .Ar value .
 100 .Pp
 101 The option may be used more than once to set more than one environment
 102 variable.
 103 .El
 104 .Sh EXAMPLES
 105 To create a virtual machine named
 106 .Ar freebsd-vm
 107 that boots off the ISO image
 108 .Pa /freebsd/release.iso
 109 and has 1GB memory allocated to it:
 110 .Pp
 111 .Dl "bhyveload -m 1G -d /freebsd/release.iso freebsd-vm"
 112 .Sh SEE ALSO
 113 .Xr bhyve 4 ,
 114 .Xr bhyve 8 ,
 115 .Xr loader 8 ,
 116 .Xr vmm 4
 117 .Sh HISTORY
 118 .Nm
 119 first appeared in
 120 .Fx 10.0 ,
 121 and was developed at NetApp Inc.
 122 .Sh AUTHORS
 123 .Nm
 124 was developed by
 125 .An -nosplit
 126 .An "Neel Natu" Aq neel@FreeBSD.org
 127 at NetApp Inc with a lot of help from
 128 .An Doug Rabson Aq dfr@FreeBSD.org
 129 .Sh BUGS
 130 .Nm
 131 can only load
 132 .Fx
 133 as a guest.