xref: /freebsd/usr.sbin/bhyveload/bhyveload.8 (revision e14ddd1f16e7e5788392c50de21ea7c927e0690c)
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
64.Ar mem-size
65is the amount of memory allocated to the guest in units of megabytes.
66.Pp
67The default value of
68.Ar mem-size
69is 256.
70.It Fl d Ar disk-path
71The
72.Ar disk-path
73is the pathname of the guest's boot disk image.
74.It Fl h Ar host-path
75The
76.Ar host-path
77is the directory at the top of the guest's boot filesystem.
78.El
79.Sh EXAMPLES
80To create a virtual machine named
81.Ar freebsd-vm
82that boots off the ISO image
83.Pa /freebsd/release.iso
84and has 1GB memory allocated to it:
85.Pp
86.Dl "bhyveload -m 1024 -d /freebsd/release.iso freebsd-vm"
87.Sh SEE ALSO
88.Xr bhyve 4 ,
89.Xr bhyve 8 ,
90.Xr loader 8 ,
91.Xr vmm 4
92.Sh HISTORY
93.Nm
94first appeared in
95.Fx 10.0 ,
96and was developed at NetApp Inc.
97.Sh AUTHORS
98.Nm
99was developed by
100.An -nosplit
101.An "Neel Natu" Aq neel@FreeBSD.org
102at NetApp Inc with a lot of help from
103.An Doug Rabson Aq dfr@FreeBSD.org
104.Sh BUGS
105.Nm
106can only load
107.Fx
108as a guest.
109