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