xref: /freebsd/usr.sbin/bhyveload/bhyveload.8 (revision 83994ddc7cb54222673e09de59357c04de1cec3f)
1*83994ddcSNeel Natu.\"
2*83994ddcSNeel Natu.\" Copyright (c) 2012 NetApp Inc
3*83994ddcSNeel Natu.\" All rights reserved.
4*83994ddcSNeel Natu.\"
5*83994ddcSNeel Natu.\" Redistribution and use in source and binary forms, with or without
6*83994ddcSNeel Natu.\" modification, are permitted provided that the following conditions
7*83994ddcSNeel Natu.\" are met:
8*83994ddcSNeel Natu.\" 1. Redistributions of source code must retain the above copyright
9*83994ddcSNeel Natu.\"    notice, this list of conditions and the following disclaimer.
10*83994ddcSNeel Natu.\" 2. Redistributions in binary form must reproduce the above copyright
11*83994ddcSNeel Natu.\"    notice, this list of conditions and the following disclaimer in the
12*83994ddcSNeel Natu.\"    documentation and/or other materials provided with the distribution.
13*83994ddcSNeel Natu.\"
14*83994ddcSNeel Natu.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*83994ddcSNeel Natu.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*83994ddcSNeel Natu.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*83994ddcSNeel Natu.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*83994ddcSNeel Natu.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*83994ddcSNeel Natu.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*83994ddcSNeel Natu.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*83994ddcSNeel Natu.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*83994ddcSNeel Natu.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*83994ddcSNeel Natu.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*83994ddcSNeel Natu.\" SUCH DAMAGE.
25*83994ddcSNeel Natu.\"
26*83994ddcSNeel Natu.\" $FreeBSD$
27*83994ddcSNeel Natu.\"
28*83994ddcSNeel Natu.Dd January 7, 2012
29*83994ddcSNeel Natu.Dt BHYVELOAD 8
30*83994ddcSNeel Natu.Os
31*83994ddcSNeel Natu.Sh NAME
32*83994ddcSNeel Natu.Nm bhyveload
33*83994ddcSNeel Natu.Nd load a
34*83994ddcSNeel Natu.Fx
35*83994ddcSNeel Natuguest inside a bhyve virtual machine
36*83994ddcSNeel Natu.Sh SYNOPSIS
37*83994ddcSNeel Natu.Nm
38*83994ddcSNeel Natu.Op Fl m Ar lowmem
39*83994ddcSNeel Natu.Op Fl M Ar highmem
40*83994ddcSNeel Natu.Op Fl d Ar disk-path
41*83994ddcSNeel Natu.Op Fl h Ar host-path
42*83994ddcSNeel Natu.Ar vmname
43*83994ddcSNeel Natu.Sh DESCRIPTION
44*83994ddcSNeel Natu.Nm
45*83994ddcSNeel Natuis used to load a
46*83994ddcSNeel Natu.Fx
47*83994ddcSNeel Natuguest inside a
48*83994ddcSNeel Natu.Xr bhyve 4
49*83994ddcSNeel Natuvirtual machine.
50*83994ddcSNeel Natu.Pp
51*83994ddcSNeel Natu.Nm
52*83994ddcSNeel Natuis based on
53*83994ddcSNeel Natu.Xr loader 8
54*83994ddcSNeel Natuand will present an interface identical to
55*83994ddcSNeel Natu.Fx
56*83994ddcSNeel Natuloader on the user's terminal.
57*83994ddcSNeel Natu.Pp
58*83994ddcSNeel NatuThe virtual machine is identified as
59*83994ddcSNeel Natu.Ar vmname
60*83994ddcSNeel Natuand will be created if it does not already exist.
61*83994ddcSNeel Natu.Sh OPTIONS
62*83994ddcSNeel NatuThe following options are available:
63*83994ddcSNeel Natu.Bl -tag -width indent
64*83994ddcSNeel Natu.It Fl m Ar lowmem
65*83994ddcSNeel Natu.Ar lowmem
66*83994ddcSNeel Natuis the amount of memory allocated below 4GB in the guest's physical address
67*83994ddcSNeel Natuspace.
68*83994ddcSNeel Natu.Pp
69*83994ddcSNeel NatuThe default value of
70*83994ddcSNeel Natu.Ar lowmem
71*83994ddcSNeel Natuis 256MB.
72*83994ddcSNeel Natu.It Fl M Ar highmem
73*83994ddcSNeel Natu.Ar highmem
74*83994ddcSNeel Natuis the amount of memory allocated above 4GB in the guest's physical address
75*83994ddcSNeel Natuspace.
76*83994ddcSNeel Natu.Pp
77*83994ddcSNeel NatuThe default value of
78*83994ddcSNeel Natu.Ar highmem
79*83994ddcSNeel Natuis 0MB.
80*83994ddcSNeel Natu.It Fl d Ar disk-path
81*83994ddcSNeel NatuThe
82*83994ddcSNeel Natu.Ar disk-path
83*83994ddcSNeel Natuis the pathname of the guest's boot disk image.
84*83994ddcSNeel Natu.It Fl h Ar host-path
85*83994ddcSNeel NatuThe
86*83994ddcSNeel Natu.Ar host-path
87*83994ddcSNeel Natuis the directory at the top of the guest's boot filesystem.
88*83994ddcSNeel Natu
89*83994ddcSNeel Natu.Sh EXAMPLES
90*83994ddcSNeel NatuTo create a virtual machine named
91*83994ddcSNeel Natu.Ar freebsd-vm
92*83994ddcSNeel Natuthat boots off the ISO image
93*83994ddcSNeel Natu.Pa /freebsd/release.iso
94*83994ddcSNeel Natuand has 1GB memory allocated to it:
95*83994ddcSNeel Natu
96*83994ddcSNeel Natu.Dl "bhyveload -m 256 -M 768 -d /freebsd/release.iso freebsd-vm
97*83994ddcSNeel Natu
98*83994ddcSNeel NatuIn the example above the 1GB allocation is split in two segments:
99*83994ddcSNeel Natu.Bl -dash -compact
100*83994ddcSNeel Natu.It
101*83994ddcSNeel Natu256MB below the 4GB boundary (0MB - 256MB)
102*83994ddcSNeel Natu.It
103*83994ddcSNeel Natu768MB above the 4GB boundary (4096MB - 4864MB)
104*83994ddcSNeel Natu.El
105*83994ddcSNeel Natu
106*83994ddcSNeel Natu.Sh SEE ALSO
107*83994ddcSNeel Natu.Xr bhyve 4 ,
108*83994ddcSNeel Natu.Xr bhyve 8 ,
109*83994ddcSNeel Natu.Xr loader 8 ,
110*83994ddcSNeel Natu.Xr vmm 4
111*83994ddcSNeel Natu
112*83994ddcSNeel Natu.Sh HISTORY
113*83994ddcSNeel Natu.Nm
114*83994ddcSNeel Natufirst appeared in
115*83994ddcSNeel Natu.Fx 10.0 ,
116*83994ddcSNeel Natuand was developed at NetApp Inc.
117*83994ddcSNeel Natu
118*83994ddcSNeel Natu.Sh AUTHORS
119*83994ddcSNeel Natu.Nm
120*83994ddcSNeel Natuwas developed by
121*83994ddcSNeel Natu.An -nosplit
122*83994ddcSNeel Natu.An "Neel Natu" Aq neel@FreeBSD.org
123*83994ddcSNeel Natuat NetApp Inc with a lot of help from
124*83994ddcSNeel Natu.An Doug Rabson Aq dfr@FreeBSD.org
125*83994ddcSNeel Natu
126*83994ddcSNeel Natu.Sh BUGS
127*83994ddcSNeel Natu.Nm
128*83994ddcSNeel Natucan load only
129*83994ddcSNeel Natu.Fx
130*83994ddcSNeel Natuas a guest.
131