Differential D24846 Diff 71931 head/usr.sbin/bhyve/bhyve.8

Changeset View

Standalone View

head/usr.sbin/bhyve/bhyve.8

Show All 18 Lines
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)		.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT		.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY		.\" 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		.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.		.\" SUCH DAMAGE.
.\"		.\"
.\" $FreeBSD$		.\" $FreeBSD$
.\"		.\"
.Dd May 5, 2020		.Dd May 18, 2020
.Dt BHYVE 8		.Dt BHYVE 8
.Os		.Os
.Sh NAME		.Sh NAME
.Nm bhyve		.Nm bhyve
.Nd "run a guest operating system inside a virtual machine"		.Nd "run a guest operating system inside a virtual machine"
.Sh SYNOPSIS		.Sh SYNOPSIS
.Nm		.Nm
.Op Fl AabCeHhPSuWwxY		.Op Fl AabCeHhPSuWwxY
▲ Show 20 Lines • Show All 250 Lines • ▼ Show 20 Lines
.El		.El
.It Op Ar conf		.It Op Ar conf
This optional parameter describes the backend for device emulations.		This optional parameter describes the backend for device emulations.
If		If
.Ar conf		.Ar conf
is not specified, the device emulation has no backend and can be		is not specified, the device emulation has no backend and can be
considered unconnected.		considered unconnected.
.Pp		.Pp
Network devices:		Network backends:
.Bl -tag -width 10n		.Bl -tag -width 10n
.It Ar tapN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc		.It Ar tapN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
.It Ar vmnetN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc		.It Ar vmnetN Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
		.It Ar netgraph,path=ADDRESS,peerhook=HOOK Ns Oo , Ns Ar socket=NAME Oc Ns Oo , Ns Ar hook=HOOK Oc Ns Oo , Ns Ar mac=xx:xx:xx:xx:xx:xx Oc Ns Oo , Ns Ar mtu=N Oc
.Pp		.Pp
If		If
.Ar mac		.Ar mac
is not specified, the MAC address is derived from a fixed OUI and the		is not specified, the MAC address is derived from a fixed OUI and the
remaining bytes from an MD5 hash of the slot and function numbers and		remaining bytes from an MD5 hash of the slot and function numbers and
the device name.		the device name.
.Pp		.Pp
The MAC address is an ASCII string in		The MAC address is an ASCII string in
.Xr ethers 5		.Xr ethers 5
format.		format.
.Pp		.Pp
With virtio-net devices, the		With virtio-net devices, the
.Ar mtu		.Ar mtu
parameter can be specified to inform the guest about the largest MTU		parameter can be specified to inform the guest about the largest MTU
that should be allowed, expressed in bytes.		that should be allowed, expressed in bytes.
		.Pp
		With netgraph backend, the
		.Ar path
		and
		.Ar peerhook
		parameters must be specified to set the destination node and corresponding hook.
		The optional parameters
		.Ar socket
		and
		.Ar hook
		may be used to set the
		.Xr ng_socket 4
		node name and source hook.
		The
		.Ar ADDRESS ,
		.Ar HOOK
		and
		.Ar NAME
		must comply with
		.Xr netgraph 4
		addressing rules.
.El		.El
.Pp		.Pp
Block storage devices:		Block storage devices:
.Bl -tag -width 10n		.Bl -tag -width 10n
.It Pa /filename Ns Oo , Ns Ar block-device-options Oc		.It Pa /filename Ns Oo , Ns Ar block-device-options Oc
.It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc		.It Pa /dev/xxx Ns Oo , Ns Ar block-device-options Oc
.El		.El
.Pp		.Pp
▲ Show 20 Lines • Show All 344 Lines • ▼ Show 20 Lines	bhyve -c 2 -m 4G -w -H \\
-s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\		-s 29,fbuf,tcp=[::]:5900,w=800,h=600 \\
-s 30,xhci,tablet \\		-s 30,xhci,tablet \\
-s 31,lpc -l com1,stdio \\		-s 31,lpc -l com1,stdio \\
-l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\		-l bootrom,/usr/local/share/uefi-firmware/BHYVE_UEFI.fd \\
uefivm		uefivm
.Ed		.Ed
.Sh SEE ALSO		.Sh SEE ALSO
.Xr bhyve 4 ,		.Xr bhyve 4 ,
		.Xr netgraph 4 ,
		.Xr ng_socket 4 ,
.Xr nmdm 4 ,		.Xr nmdm 4 ,
.Xr vmm 4 ,		.Xr vmm 4 ,
.Xr ethers 5 ,		.Xr ethers 5 ,
.Xr bhyvectl 8 ,		.Xr bhyvectl 8 ,
.Xr bhyveload 8		.Xr bhyveload 8
.Pp		.Pp
.Rs		.Rs
.%A Intel		.%A Intel
Show All 10 Lines