freebsd-dev/usr.sbin/bhyveload/bhyveload.8

.\"
.\" Copyright (c) 2012 NetApp Inc
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd January 7, 2012
.Dt BHYVELOAD 8
.Os
.Sh NAME
.Nm bhyveload
.Nd load a
.Fx
guest inside a bhyve virtual machine
.Sh SYNOPSIS
.Nm
.Op Fl c Ar cons-dev
.Op Fl d Ar disk-path
.Op Fl e Ar name=value
.Op Fl h Ar host-path
.Op Fl m Ar mem-size
.Ar vmname
.Sh DESCRIPTION
.Nm
is used to load a
.Fx
guest inside a
.Xr bhyve 4
virtual machine.
.Pp
.Nm
is based on
.Xr loader 8
and will present an interface identical to the
.Fx
loader on the user's terminal.
.Pp
The virtual machine is identified as
.Ar vmname
and will be created if it does not already exist.
.Sh OPTIONS
The following options are available:
.Bl -tag -width indent
.It Fl c Ar cons-dev
.Ar cons-dev
is a
.Xr tty 4
device to use for
.Nm
terminal I/O.
.Pp
The text string "stdio" is also accepted and selects the use of
unbuffered standard I/O. This is the default value.
.It Fl d Ar disk-path
The
.Ar disk-path
is the pathname of the guest's boot disk image.
.It Fl e Ar name=value
Set the FreeBSD loader environment variable
.Ar name
to
.Ar value .
.Pp
The option may be used more than once to set more than one environment
variable.
.It Fl h Ar host-path
The
.Ar host-path
is the directory at the top of the guest's boot filesystem.
.It Fl m Ar mem-size Xo
.Sm off
.Op Cm K | k | M | m | G | g | T | t
.Xc
.Sm on
.Ar mem-size
is the amount of memory allocated to the guest.
.Pp
The
.Ar mem-size
argument may be suffixed with one of
.Cm K ,
.Cm M ,
.Cm G
or
.Cm T
(either upper or lower case) to indicate a multiple of
Kilobytes, Megabytes, Gigabytes or Terabytes
respectively.
.Pp
The default value of
.Ar mem-size
is 256M.
.El
.Sh EXAMPLES
To create a virtual machine named
.Ar freebsd-vm
that boots off the ISO image
.Pa /freebsd/release.iso
and has 1GB memory allocated to it:
.Pp
.Dl "bhyveload -m 1G -d /freebsd/release.iso freebsd-vm"
.Pp
To create a virtual machine named
.Ar test-vm
with 256MB of memory allocated, the guest root filesystem under the host
directory
.Pa /user/images/test
and terminal I/O sent to the
.Xr nmdm 4
device
.Pa /dev/nmdm1B
.Pp
.Dl "bhyveload -m 256MB -h /usr/images/test -c /dev/nmdm1B test-vm"
.Sh SEE ALSO
.Xr bhyve 4 ,
.Xr nmdm 4 ,
.Xr vmm 4 ,
.Xr bhyve 8 ,
.Xr loader 8
.Sh HISTORY
.Nm
first appeared in
.Fx 10.0 ,
and was developed at NetApp Inc.
.Sh AUTHORS
.Nm
was developed by
.An -nosplit
.An Neel Natu Aq Mt neel@FreeBSD.org
at NetApp Inc with a lot of help from
.An Doug Rabson Aq Mt dfr@FreeBSD.org .
.Sh BUGS
.Nm
can only load
.Fx
as a guest.
Fix missing . Approved by: re (blanket) 2013-10-09 20:00:04 +00:00			`.\"`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.\" Copyright (c) 2012 NetApp Inc`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
			`.Dd January 7, 2012`
			`.Dt BHYVELOAD 8`
			`.Os`
			`.Sh NAME`
			`.Nm bhyveload`
			`.Nd load a`
			`.Fx`
			`guest inside a bhyve virtual machine`
			`.Sh SYNOPSIS`
			`.Nm`
Sort command flags in usage output and the manpages. 2014-06-27 15:20:34 +00:00			`.Op Fl c Ar cons-dev`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Op Fl d Ar disk-path`
Add an option to bhyveload(8) that allows setting a loader environment variable from the command line. The option syntax is "-e <name=value>". It may be used multiple times to set multiple environment variables. Reviewed by: grehan Requested by: alfred 2013-10-17 00:28:35 +00:00			`.Op Fl e Ar name=value`
Sort command flags in usage output and the manpages. 2014-06-27 15:20:34 +00:00			`.Op Fl h Ar host-path`
			`.Op Fl m Ar mem-size`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Ar vmname`
			`.Sh DESCRIPTION`
			`.Nm`
			`is used to load a`
			`.Fx`
			`guest inside a`
			`.Xr bhyve 4`
			`virtual machine.`
			`.Pp`
			`.Nm`
			`is based on`
			`.Xr loader 8`
Minor mdoc fixes. 2013-01-19 07:04:30 +00:00			`and will present an interface identical to the`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Fx`
			`loader on the user's terminal.`
			`.Pp`
			`The virtual machine is identified as`
			`.Ar vmname`
			`and will be created if it does not already exist.`
			`.Sh OPTIONS`
			`The following options are available:`
			`.Bl -tag -width indent`
Sort command flags in usage output and the manpages. 2014-06-27 15:20:34 +00:00			`.It Fl c Ar cons-dev`
			`.Ar cons-dev`
			`is a`
			`.Xr tty 4`
			`device to use for`
			`.Nm`
			`terminal I/O.`
			`.Pp`
			`The text string "stdio" is also accepted and selects the use of`
			`unbuffered standard I/O. This is the default value.`
			`.It Fl d Ar disk-path`
			`The`
			`.Ar disk-path`
			`is the pathname of the guest's boot disk image.`
			`.It Fl e Ar name=value`
			`Set the FreeBSD loader environment variable`
			`.Ar name`
			`to`
			`.Ar value .`
			`.Pp`
			`The option may be used more than once to set more than one environment`
			`variable.`
			`.It Fl h Ar host-path`
			`The`
			`.Ar host-path`
			`is the directory at the top of the guest's boot filesystem.`
Parse the memory size parameter using expand_number() to allow specifying the memory size more intuitively (e.g. 512M, 4G etc). Submitted by: rodrigc Reviewed by: grehan Approved by: re (blanket) 2013-10-09 03:56:07 +00:00			`.It Fl m Ar mem-size Xo`
			`.Sm off`
			`.Op Cm K \| k \| M \| m \| G \| g \| T \| t`
			`.Xc`
			`.Sm on`
			`.Ar mem-size`
			`is the amount of memory allocated to the guest.`
			`.Pp`
			`The`
Simplify the assignment of memory to virtual machines by requiring a single command line option "-m <memsize in MB>" to specify the memory size. Prior to this change the user needed to explicitly specify the amount of memory allocated below 4G (-m <lowmem>) and the amount above 4G (-M <highmem>). The "-M" option is no longer supported by 'bhyveload' and 'bhyve'. The start of the PCI hole is fixed at 3GB and cannot be directly changed using command line options. However it is still possible to change this in special circumstances via the 'vm_set_lowmem_limit()' API provided by libvmmapi. Submitted by: Dinakar Medavaram (initial version) Reviewed by: grehan Obtained from: NetApp 2013-03-18 22:38:30 +00:00			`.Ar mem-size`
Parse the memory size parameter using expand_number() to allow specifying the memory size more intuitively (e.g. 512M, 4G etc). Submitted by: rodrigc Reviewed by: grehan Approved by: re (blanket) 2013-10-09 03:56:07 +00:00			`argument may be suffixed with one of`
			`.Cm K ,`
			`.Cm M ,`
			`.Cm G`
			`or`
			`.Cm T`
			`(either upper or lower case) to indicate a multiple of`
			`Kilobytes, Megabytes, Gigabytes or Terabytes`
			`respectively.`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Pp`
			`The default value of`
Simplify the assignment of memory to virtual machines by requiring a single command line option "-m <memsize in MB>" to specify the memory size. Prior to this change the user needed to explicitly specify the amount of memory allocated below 4G (-m <lowmem>) and the amount above 4G (-M <highmem>). The "-M" option is no longer supported by 'bhyveload' and 'bhyve'. The start of the PCI hole is fixed at 3GB and cannot be directly changed using command line options. However it is still possible to change this in special circumstances via the 'vm_set_lowmem_limit()' API provided by libvmmapi. Submitted by: Dinakar Medavaram (initial version) Reviewed by: grehan Obtained from: NetApp 2013-03-18 22:38:30 +00:00			`.Ar mem-size`
Parse the memory size parameter using expand_number() to allow specifying the memory size more intuitively (e.g. 512M, 4G etc). Submitted by: rodrigc Reviewed by: grehan Approved by: re (blanket) 2013-10-09 03:56:07 +00:00			`is 256M.`
Minor mdoc fixes. 2013-01-19 07:04:30 +00:00			`.El`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Sh EXAMPLES`
			`To create a virtual machine named`
Remove EOL whitespace. 2013-01-19 07:07:05 +00:00			`.Ar freebsd-vm`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`that boots off the ISO image`
Remove EOL whitespace. 2013-01-19 07:07:05 +00:00			`.Pa /freebsd/release.iso`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`and has 1GB memory allocated to it:`
Minor mdoc fixes. 2013-01-19 07:04:30 +00:00			`.Pp`
Parse the memory size parameter using expand_number() to allow specifying the memory size more intuitively (e.g. 512M, 4G etc). Submitted by: rodrigc Reviewed by: grehan Approved by: re (blanket) 2013-10-09 03:56:07 +00:00			`.Dl "bhyveload -m 1G -d /freebsd/release.iso freebsd-vm"`
Allow bhyve and bhyveload to attach to tty devices. bhyveload: introduce the -c <device> parameter to select a tty for output (or "stdio") bhyve: allow the puc and lpc-com backends to accept a tty in addition to "stdio" When used in conjunction with the null-modem device, nmdm(4), this allows attach/detach to the guest console and multiple concurrent serial ports. kgdb on a serial port is now functional. Reviewed by: neel Requested by: Almost everyone that has used bhyve MFC after: 10.0 2013-11-27 00:21:37 +00:00			`.Pp`
			`To create a virtual machine named`
			`.Ar test-vm`
			`with 256MB of memory allocated, the guest root filesystem under the host`
			`directory`
			`.Pa /user/images/test`
			`and terminal I/O sent to the`
			`.Xr nmdm 4`
			`device`
			`.Pa /dev/nmdm1B`
			`.Pp`
mdoc: quote string properly. 2013-12-02 19:49:52 +00:00			`.Dl "bhyveload -m 256MB -h /usr/images/test -c /dev/nmdm1B test-vm"`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Sh SEE ALSO`
			`.Xr bhyve 4 ,`
o Fix typo, sort .Xrs. PR: docs/186191 Submitted by: Andrew (typo fix) MFC after: 1 week 2014-01-28 12:26:38 +00:00			`.Xr nmdm 4 ,`
			`.Xr vmm 4 ,`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Xr bhyve 8 ,`
o Fix typo, sort .Xrs. PR: docs/186191 Submitted by: Andrew (typo fix) MFC after: 1 week 2014-01-28 12:26:38 +00:00			`.Xr loader 8`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Sh HISTORY`
			`.Nm`
			`first appeared in`
			`.Fx 10.0 ,`
			`and was developed at NetApp Inc.`
			`.Sh AUTHORS`
			`.Nm`
			`was developed by`
			`.An -nosplit`
use .Mt to mark up email addresses consistently (part2) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> 2014-06-20 09:57:27 +00:00			`.An Neel Natu Aq Mt neel@FreeBSD.org`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`at NetApp Inc with a lot of help from`
use .Mt to mark up email addresses consistently (part2) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de> 2014-06-20 09:57:27 +00:00			`.An Doug Rabson Aq Mt dfr@FreeBSD.org .`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Sh BUGS`
			`.Nm`
Minor mdoc fixes. 2013-01-19 07:04:30 +00:00			`can only load`
Add the 'bhyveload(8)' man page. Obtained from: NetApp Reviewed by: grehan 2013-01-08 06:00:32 +00:00			`.Fx`
			`as a guest.`