xref: /freebsd/usr.sbin/bhyveload/bhyveload.8 (revision edccda4d08c03c9a020e0f750a08ab6cde5f8425)
183994ddcSNeel Natu.\"
283994ddcSNeel Natu.\" Copyright (c) 2012 NetApp Inc
383994ddcSNeel Natu.\" All rights reserved.
483994ddcSNeel Natu.\"
583994ddcSNeel Natu.\" Redistribution and use in source and binary forms, with or without
683994ddcSNeel Natu.\" modification, are permitted provided that the following conditions
783994ddcSNeel Natu.\" are met:
883994ddcSNeel Natu.\" 1. Redistributions of source code must retain the above copyright
983994ddcSNeel Natu.\"    notice, this list of conditions and the following disclaimer.
1083994ddcSNeel Natu.\" 2. Redistributions in binary form must reproduce the above copyright
1183994ddcSNeel Natu.\"    notice, this list of conditions and the following disclaimer in the
1283994ddcSNeel Natu.\"    documentation and/or other materials provided with the distribution.
1383994ddcSNeel Natu.\"
1483994ddcSNeel Natu.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1583994ddcSNeel Natu.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1683994ddcSNeel Natu.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1783994ddcSNeel Natu.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1883994ddcSNeel Natu.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1983994ddcSNeel Natu.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2083994ddcSNeel Natu.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2183994ddcSNeel Natu.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2283994ddcSNeel Natu.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2383994ddcSNeel Natu.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2483994ddcSNeel Natu.\" SUCH DAMAGE.
2583994ddcSNeel Natu.\"
2683994ddcSNeel Natu.\" $FreeBSD$
2783994ddcSNeel Natu.\"
2883994ddcSNeel Natu.Dd January 7, 2012
2983994ddcSNeel Natu.Dt BHYVELOAD 8
3083994ddcSNeel Natu.Os
3183994ddcSNeel Natu.Sh NAME
3283994ddcSNeel Natu.Nm bhyveload
3383994ddcSNeel Natu.Nd load a
3483994ddcSNeel Natu.Fx
3583994ddcSNeel Natuguest inside a bhyve virtual machine
3683994ddcSNeel Natu.Sh SYNOPSIS
3783994ddcSNeel Natu.Nm
3883994ddcSNeel Natu.Op Fl m Ar lowmem
3983994ddcSNeel Natu.Op Fl M Ar highmem
4083994ddcSNeel Natu.Op Fl d Ar disk-path
4183994ddcSNeel Natu.Op Fl h Ar host-path
4283994ddcSNeel Natu.Ar vmname
4383994ddcSNeel Natu.Sh DESCRIPTION
4483994ddcSNeel Natu.Nm
4583994ddcSNeel Natuis used to load a
4683994ddcSNeel Natu.Fx
4783994ddcSNeel Natuguest inside a
4883994ddcSNeel Natu.Xr bhyve 4
4983994ddcSNeel Natuvirtual machine.
5083994ddcSNeel Natu.Pp
5183994ddcSNeel Natu.Nm
5283994ddcSNeel Natuis based on
5383994ddcSNeel Natu.Xr loader 8
54*edccda4dSJoel Dahland will present an interface identical to the
5583994ddcSNeel Natu.Fx
5683994ddcSNeel Natuloader on the user's terminal.
5783994ddcSNeel Natu.Pp
5883994ddcSNeel NatuThe virtual machine is identified as
5983994ddcSNeel Natu.Ar vmname
6083994ddcSNeel Natuand will be created if it does not already exist.
6183994ddcSNeel Natu.Sh OPTIONS
6283994ddcSNeel NatuThe following options are available:
6383994ddcSNeel Natu.Bl -tag -width indent
6483994ddcSNeel Natu.It Fl m Ar lowmem
6583994ddcSNeel Natu.Ar lowmem
6683994ddcSNeel Natuis the amount of memory allocated below 4GB in the guest's physical address
6783994ddcSNeel Natuspace.
6883994ddcSNeel Natu.Pp
6983994ddcSNeel NatuThe default value of
7083994ddcSNeel Natu.Ar lowmem
7183994ddcSNeel Natuis 256MB.
7283994ddcSNeel Natu.It Fl M Ar highmem
7383994ddcSNeel Natu.Ar highmem
7483994ddcSNeel Natuis the amount of memory allocated above 4GB in the guest's physical address
7583994ddcSNeel Natuspace.
7683994ddcSNeel Natu.Pp
7783994ddcSNeel NatuThe default value of
7883994ddcSNeel Natu.Ar highmem
7983994ddcSNeel Natuis 0MB.
8083994ddcSNeel Natu.It Fl d Ar disk-path
8183994ddcSNeel NatuThe
8283994ddcSNeel Natu.Ar disk-path
8383994ddcSNeel Natuis the pathname of the guest's boot disk image.
8483994ddcSNeel Natu.It Fl h Ar host-path
8583994ddcSNeel NatuThe
8683994ddcSNeel Natu.Ar host-path
8783994ddcSNeel Natuis the directory at the top of the guest's boot filesystem.
88*edccda4dSJoel Dahl.El
8983994ddcSNeel Natu.Sh EXAMPLES
9083994ddcSNeel NatuTo create a virtual machine named
9183994ddcSNeel Natu.Ar freebsd-vm
9283994ddcSNeel Natuthat boots off the ISO image
9383994ddcSNeel Natu.Pa /freebsd/release.iso
9483994ddcSNeel Natuand has 1GB memory allocated to it:
95*edccda4dSJoel Dahl.Pp
96*edccda4dSJoel Dahl.Dl "bhyveload -m 256 -M 768 -d /freebsd/release.iso freebsd-vm"
97*edccda4dSJoel Dahl.Pp
9883994ddcSNeel NatuIn the example above the 1GB allocation is split in two segments:
99*edccda4dSJoel Dahl.Pp
10083994ddcSNeel Natu.Bl -dash -compact
10183994ddcSNeel Natu.It
10283994ddcSNeel Natu256MB below the 4GB boundary (0MB - 256MB)
10383994ddcSNeel Natu.It
10483994ddcSNeel Natu768MB above the 4GB boundary (4096MB - 4864MB)
10583994ddcSNeel Natu.El
10683994ddcSNeel Natu.Sh SEE ALSO
10783994ddcSNeel Natu.Xr bhyve 4 ,
10883994ddcSNeel Natu.Xr bhyve 8 ,
10983994ddcSNeel Natu.Xr loader 8 ,
11083994ddcSNeel Natu.Xr vmm 4
11183994ddcSNeel Natu.Sh HISTORY
11283994ddcSNeel Natu.Nm
11383994ddcSNeel Natufirst appeared in
11483994ddcSNeel Natu.Fx 10.0 ,
11583994ddcSNeel Natuand was developed at NetApp Inc.
11683994ddcSNeel Natu.Sh AUTHORS
11783994ddcSNeel Natu.Nm
11883994ddcSNeel Natuwas developed by
11983994ddcSNeel Natu.An -nosplit
12083994ddcSNeel Natu.An "Neel Natu" Aq neel@FreeBSD.org
12183994ddcSNeel Natuat NetApp Inc with a lot of help from
12283994ddcSNeel Natu.An Doug Rabson Aq dfr@FreeBSD.org
12383994ddcSNeel Natu.Sh BUGS
12483994ddcSNeel Natu.Nm
125*edccda4dSJoel Dahlcan only load
12683994ddcSNeel Natu.Fx
12783994ddcSNeel Natuas a guest.
128