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