xref: /freebsd/usr.sbin/bhyveload/bhyveload.8 (revision d241a0e67ff3a44947931bf8c841d9786c59efd7)
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 lowmem
39.Op Fl M Ar highmem
40.Op Fl d Ar disk-path
41.Op Fl h Ar host-path
42.Ar vmname
43.Sh DESCRIPTION
44.Nm
45is used to load a
46.Fx
47guest inside a
48.Xr bhyve 4
49virtual machine.
50.Pp
51.Nm
52is based on
53.Xr loader 8
54and will present an interface identical to the
55.Fx
56loader on the user's terminal.
57.Pp
58The virtual machine is identified as
59.Ar vmname
60and will be created if it does not already exist.
61.Sh OPTIONS
62The following options are available:
63.Bl -tag -width indent
64.It Fl m Ar lowmem
65.Ar lowmem
66is the amount of memory allocated below 4GB in the guest's physical address
67space.
68.Pp
69The default value of
70.Ar lowmem
71is 256MB.
72.It Fl M Ar highmem
73.Ar highmem
74is the amount of memory allocated above 4GB in the guest's physical address
75space.
76.Pp
77The default value of
78.Ar highmem
79is 0MB.
80.It Fl d Ar disk-path
81The
82.Ar disk-path
83is the pathname of the guest's boot disk image.
84.It Fl h Ar host-path
85The
86.Ar host-path
87is the directory at the top of the guest's boot filesystem.
88.El
89.Sh EXAMPLES
90To create a virtual machine named
91.Ar freebsd-vm
92that boots off the ISO image
93.Pa /freebsd/release.iso
94and has 1GB memory allocated to it:
95.Pp
96.Dl "bhyveload -m 256 -M 768 -d /freebsd/release.iso freebsd-vm"
97.Pp
98In the example above the 1GB allocation is split in two segments:
99.Pp
100.Bl -dash -compact
101.It
102256MB below the 4GB boundary (0MB - 256MB)
103.It
104768MB above the 4GB boundary (4096MB - 4864MB)
105.El
106.Sh SEE ALSO
107.Xr bhyve 4 ,
108.Xr bhyve 8 ,
109.Xr loader 8 ,
110.Xr vmm 4
111.Sh HISTORY
112.Nm
113first appeared in
114.Fx 10.0 ,
115and was developed at NetApp Inc.
116.Sh AUTHORS
117.Nm
118was developed by
119.An -nosplit
120.An "Neel Natu" Aq neel@FreeBSD.org
121at NetApp Inc with a lot of help from
122.An Doug Rabson Aq dfr@FreeBSD.org
123.Sh BUGS
124.Nm
125can only load
126.Fx
127as a guest.
128