xref: /freebsd/usr.sbin/bhyve/bhyve_config.5 (revision a27328ea392714f2bc106f138191fd465157aafb)
1621b5090SJohn Baldwin.\" SPDX-License-Identifier: BSD-2-Clause
2621b5090SJohn Baldwin.\"
3621b5090SJohn Baldwin.\" Copyright (c) 2021 John H. Baldwin <jhb@FreeBSD.org>
4621b5090SJohn Baldwin.\"
5621b5090SJohn Baldwin.\" Redistribution and use in source and binary forms, with or without
6621b5090SJohn Baldwin.\" modification, are permitted provided that the following conditions
7621b5090SJohn Baldwin.\" are met:
8621b5090SJohn Baldwin.\" 1. Redistributions of source code must retain the above copyright
9621b5090SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer.
10621b5090SJohn Baldwin.\" 2. Redistributions in binary form must reproduce the above copyright
11621b5090SJohn Baldwin.\"    notice, this list of conditions and the following disclaimer in the
12621b5090SJohn Baldwin.\"    documentation and/or other materials provided with the distribution.
13621b5090SJohn Baldwin.\"
14621b5090SJohn Baldwin.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15621b5090SJohn Baldwin.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16621b5090SJohn Baldwin.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17621b5090SJohn Baldwin.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18621b5090SJohn Baldwin.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19621b5090SJohn Baldwin.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20621b5090SJohn Baldwin.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21621b5090SJohn Baldwin.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22621b5090SJohn Baldwin.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23621b5090SJohn Baldwin.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24621b5090SJohn Baldwin.\" SUCH DAMAGE.
25621b5090SJohn Baldwin.\"
261f903953SSHENG-YI HONG.Dd August 21, 2024
27621b5090SJohn Baldwin.Dt BHYVE_CONFIG 5
28621b5090SJohn Baldwin.Os
29621b5090SJohn Baldwin.Sh NAME
30621b5090SJohn Baldwin.Nm bhyve_config
31621b5090SJohn Baldwin.Nd "bhyve configuration variables"
32621b5090SJohn Baldwin.Sh DESCRIPTION
33621b5090SJohn Baldwin.Xr bhyve 8
34621b5090SJohn Baldwinuses a hierarchical tree of configuration variables to describe global and
35621b5090SJohn Baldwinper-device settings.
36621b5090SJohn BaldwinInternal nodes in this tree do not have a value,
37621b5090SJohn Baldwinonly leaf nodes have values.
38621b5090SJohn BaldwinThis manual describes the configuration variables understood by
39621b5090SJohn Baldwin.Xr bhyve 8 .
40621b5090SJohn BaldwinIf additional variables are defined,
41621b5090SJohn Baldwin.Xr bhyve 8
42621b5090SJohn Baldwinwill ignore them and will not emit errors for unknown variables.
43621b5090SJohn BaldwinHowever, these additional variables can be referenced by other
44621b5090SJohn Baldwinvariables as described below.
45621b5090SJohn Baldwin.Sh VARIABLE VALUES
46621b5090SJohn BaldwinConfiguration variable values are stored as strings.
47621b5090SJohn BaldwinA configuration variable value may refer to one or more other
48621b5090SJohn Baldwinconfiguration values by name.
49621b5090SJohn BaldwinInstances of the pattern
50621b5090SJohn Baldwin.Sq % Ns Pq Ar var
51621b5090SJohn Baldwinare replaced by the value of the configuration variable
52621b5090SJohn Baldwin.Va var .
53621b5090SJohn BaldwinTo avoid unwanted expansion,
54621b5090SJohn Baldwin.Sq %
55621b5090SJohn Baldwincharacters can be escaped by a leading
56621b5090SJohn Baldwin.Sq % .
57621b5090SJohn BaldwinFor example,
58621b5090SJohn Baldwinif a configuration variable
59621b5090SJohn Baldwin.Va disk
60621b5090SJohn Baldwinuses the value
61621b5090SJohn Baldwin.Pa /dev/zvol/bhyve/%(name) ,
62621b5090SJohn Baldwinthen the final value of the
63621b5090SJohn Baldwin.Va disk
64621b5090SJohn Baldwinvariable will be set to the path of a ZFS volume whose name matches
65621b5090SJohn Baldwinthe name of the virtual machine on the pool
66621b5090SJohn Baldwin.Pa bhyve .
67621b5090SJohn Baldwin.Pp
68621b5090SJohn BaldwinSome configuration variables may be interpreted as a boolean value.
69621b5090SJohn BaldwinFor those variables the following case-insensitive values may be used to
70621b5090SJohn Baldwinindicate true:
71621b5090SJohn Baldwin.Pp
72621b5090SJohn Baldwin.Bl -bullet -offset indent -compact
73621b5090SJohn Baldwin.It
74621b5090SJohn Baldwintrue
75621b5090SJohn Baldwin.It
76621b5090SJohn Baldwinon
77621b5090SJohn Baldwin.It
78621b5090SJohn Baldwinyes
79621b5090SJohn Baldwin.It
80621b5090SJohn Baldwin1
81621b5090SJohn Baldwin.El
82621b5090SJohn Baldwin.Pp
83621b5090SJohn BaldwinThe following values may be used to indicate false:
84621b5090SJohn Baldwin.Pp
85621b5090SJohn Baldwin.Bl -bullet -offset indent -compact
86621b5090SJohn Baldwin.It
87621b5090SJohn Baldwinfalse
88621b5090SJohn Baldwin.It
89621b5090SJohn Baldwinoff
90621b5090SJohn Baldwin.It
91621b5090SJohn Baldwinno
92621b5090SJohn Baldwin.It
93621b5090SJohn Baldwin0
94621b5090SJohn Baldwin.El
95621b5090SJohn Baldwin.Pp
96621b5090SJohn BaldwinSome configuration variables may be interperted as an integer.
97621b5090SJohn BaldwinFor those variables,
98621b5090SJohn Baldwinany syntax supported by
99621b5090SJohn Baldwin.Xr strtol 3
100621b5090SJohn Baldwinmay be used.
101621b5090SJohn Baldwin.Sh GLOBAL SETTINGS
102621b5090SJohn Baldwin.Ss Architecture Neutral Settings
103621b5090SJohn Baldwin.Bl -column "memory.guest_in_core" "integer" "Default"
104621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
105621b5090SJohn Baldwin.It Va name Ta string Ta Ta
106621b5090SJohn BaldwinThe name of the VM.
107621b5090SJohn Baldwin.It Va cpus Ta integer Ta 1 Ta
108621b5090SJohn BaldwinThe total number of virtual CPUs.
109621b5090SJohn Baldwin.It Va cores Ta integer Ta 1 Ta
110621b5090SJohn BaldwinThe number of virtual cores in each virtual socket.
111621b5090SJohn Baldwin.It Va threads Ta integer Ta 1 Ta
112621b5090SJohn BaldwinThe number of virtual CPUs in each virtual core.
113621b5090SJohn Baldwin.It Va sockets Ta integer Ta 1 Ta
114621b5090SJohn BaldwinThe number of virtual sockets.
115621b5090SJohn Baldwin.It Va memory.guest_in_core Ta bool Ta false Ta
116621b5090SJohn BaldwinInclude guest memory in core file.
117621b5090SJohn Baldwin.It Va memory.size Ta string Ta 256M Ta
118621b5090SJohn BaldwinGuest physical memory size in bytes.
119621b5090SJohn BaldwinThe value must be formatted as described in
120621b5090SJohn Baldwin.Xr expand_number 3 .
121621b5090SJohn Baldwin.It Va memory.wired Ta bool Ta false Ta
122621b5090SJohn BaldwinWire guest memory.
12343caa2e8SMark Johnston.It Va bootrom Ta path Ta Ta
12443caa2e8SMark JohnstonPath to a boot ROM.
12543caa2e8SMark JohnstonDuring initialization of the guest, the contents of this file are copied into
12643caa2e8SMark Johnstonthe guest's memory.
12743caa2e8SMark JohnstonIf a boot ROM is present, a firmware interface device is
12843caa2e8SMark Johnstonalso enabled for use by the boot ROM.
12943caa2e8SMark Johnston.It Va bootvars Ta path Ta Ta
13043caa2e8SMark JohnstonPath to boot VARS.
13143caa2e8SMark JohnstonThe contents of this file are copied beneath the boot ROM.
13243caa2e8SMark JohnstonFirmware can write to it to save variables.
13343caa2e8SMark JohnstonAll variables will be persistent even on reboots of the guest.
1346a0e7f90SCorvin Köhne.It Va acpi_tables Ta bool Ta true Ta
135621b5090SJohn BaldwinGenerate ACPI tables.
1366f7e9779SCorvin Köhne.It Va acpi_tables_in_memory Ta bool Ta true Ta
1376f7e9779SCorvin Köhne.Xr bhyve 8
1386f7e9779SCorvin Köhnealways exposes ACPI tables by FwCfg.
1396f7e9779SCorvin KöhneFor backward compatibility bhyve copies them into the guest memory as well.
1406f7e9779SCorvin KöhneThis can cause problems if the guest uses the in-memory version, since certain
1416f7e9779SCorvin Köhneadvanced features, such as TPM emulation, are exposed only via FwCfg.
1426f7e9779SCorvin KöhneTherefore, it is recommended to set this flag to false when running Windows guests.
143621b5090SJohn Baldwin.It Va destroy_on_poweroff Ta bool Ta false Ta
144621b5090SJohn BaldwinDestroy the VM on guest-initiated power-off.
14548759c4eSJohn Baldwin.It Va gdb.address Ta string Ta localhost Ta
14648759c4eSJohn BaldwinHostname, IP address, or IPv6 address for the debug server.
147621b5090SJohn Baldwin.It Va gdb.port Ta integer Ta 0 Ta
148621b5090SJohn BaldwinTCP port number for the debug server.
149621b5090SJohn BaldwinIf this is set to a non-zero value, a debug server
150621b5090SJohn Baldwinwill listen for connections on this port.
151621b5090SJohn Baldwin.It Va gdb.wait Ta bool Ta false Ta
152621b5090SJohn BaldwinIf the debug server is enabled, wait for a debugger to connect
153621b5090SJohn Baldwinbefore starting the guest.
15419eaa01bSMichael Reifenberger.It Va keyboard.layout Ta string Ta Ta
15519eaa01bSMichael ReifenbergerSpecify the keyboard layout name with the file name in
15619eaa01bSMichael Reifenberger.Ar /usr/share/bhyve/kbdlayout .
15719eaa01bSMichael ReifenbergerThis value only works when loaded with UEFI mode for VNC, and
15819eaa01bSMichael Reifenbergerused a VNC client that don't support QEMU Extended Key Event
15919eaa01bSMichael ReifenbergerMessage (e.g. TightVNC).
160e962b37bSMark Johnston.It Va pci.enable_bars Ta bool Ta Ta
161e962b37bSMark JohnstonEnable and map PCI BARs before executing any guest code.
162e962b37bSMark JohnstonThis setting is false by default when using a boot ROM and true otherwise.
163621b5090SJohn Baldwin.It Va rtc.use_localtime Ta bool Ta true Ta
164621b5090SJohn BaldwinThe real time clock uses the local time of the host.
165621b5090SJohn BaldwinIf this is set to false, the real time clock uses UTC.
166621b5090SJohn Baldwin.It Va uuid Ta string Ta Ta
167621b5090SJohn BaldwinThe universally unique identifier (UUID) to use in the guest's
168621b5090SJohn BaldwinSystem Management BIOS System Information structure.
169621b5090SJohn BaldwinIf an explicit value is not set, a valid UUID is generated from
170621b5090SJohn Baldwinthe host's hostname and the VM name.
171621b5090SJohn Baldwin.It Va virtio_msix Ta bool Ta true Ta
172621b5090SJohn BaldwinUse MSI-X interrupts for PCI VirtIO devices.
173621b5090SJohn BaldwinIf set to false, MSI interrupts are used instead.
174621b5090SJohn Baldwin.It Va config.dump Ta bool Ta false Ta
175e15bf05eSJohn BaldwinIf this value is set to true after
176e15bf05eSJohn Baldwin.Xr bhyve 8
177e15bf05eSJohn Baldwinhas finished parsing command line options,
178621b5090SJohn Baldwinthen
179621b5090SJohn Baldwin.Xr bhyve 8
180e15bf05eSJohn Baldwinwill write all of its configuration variables to stdout and exit.
181e15bf05eSJohn BaldwinNo VM will be started.
1828284799aSCorvin Köhne.It Va bios.vendor Ta string Ta BHYVE Ta
1838284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
1848284799aSCorvin Köhne.It Va bios.version Ta string Ta 14.0 Ta
1858284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
1868284799aSCorvin Köhne.It Va bios.release_date Ta string Ta 10/17/2021 Ta
1878284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
1888284799aSCorvin Köhne.It Va system.family_name Ta string Ta Virtual Machine Ta
1898284799aSCorvin KöhneFamily the computer belongs to.
1908284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
1918284799aSCorvin Köhne.It Va system.manufacturer Ta string Ta FreeBSD Ta
1928284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
1938284799aSCorvin Köhne.It Va system.product_name Ta string Ta BHYVE Ta
1948284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
1958284799aSCorvin Köhne.It Va system.serial_number Ta string Ta None Ta
1968284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
1978284799aSCorvin Köhne.It Va system.sku Ta string Ta None Ta
1988284799aSCorvin KöhneStock keeping unit of the computer.
1998284799aSCorvin KöhneIt's also called product ID or purchase order number.
2008284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2018284799aSCorvin Köhne.It Va system.version Ta string Ta 1.0 Ta
2028284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2038284799aSCorvin Köhne.It Va board.manufacturer Ta string Ta FreeBSD Ta
2048284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2058284799aSCorvin Köhne.It Va board.product_name Ta string Ta BHYVE Ta
2068284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2078284799aSCorvin Köhne.It Va board.version Ta string Ta 1.0 Ta
2088284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2098284799aSCorvin Köhne.It Va board.serial_number Ta string Ta None Ta
2108284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2118284799aSCorvin Köhne.It Va board.asset_tag Ta string Ta None Ta
2128284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2138284799aSCorvin Köhne.It Va board.location Ta string Ta None Ta
2148284799aSCorvin KöhneDescribes the board's location within the chassis.
2158284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2168284799aSCorvin Köhne.It Va chassis.manufacturer Ta string Ta FreeBSD Ta
2178284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2188284799aSCorvin Köhne.It Va chassis.version Ta string Ta 1.0 Ta
2198284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2208284799aSCorvin Köhne.It Va chassis.serial_number Ta string Ta None Ta
2218284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2228284799aSCorvin Köhne.It Va chassis.asset_tag Ta string Ta None Ta
2238284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
2248284799aSCorvin Köhne.It Va chassis.sku Ta string Ta None Ta
2258284799aSCorvin KöhneStock keeping unit of the chassis.
2268284799aSCorvin KöhneIt's also called product ID or purchase order number.
2278284799aSCorvin KöhneThis value is used for the guest's System Management BIOS System Information structure.
228621b5090SJohn Baldwin.El
229621b5090SJohn Baldwin.Ss x86-Specific Settings
230621b5090SJohn Baldwin.Bl -column "x86.vmexit_on_pause" "integer" "Default"
231621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
232621b5090SJohn Baldwin.It Va x86.mptable Ta bool Ta true Ta
233621b5090SJohn BaldwinGenerate an MPTable.
234621b5090SJohn Baldwin.It Va x86.x2apic Ta bool Ta false Ta
235621b5090SJohn BaldwinConfigure guest's local APICs in x2APIC mode.
236621b5090SJohn Baldwin.It Va x86.strictio Ta bool Ta false Ta
237621b5090SJohn BaldwinExit if a guest accesses an I/O port that is not emulated.
238621b5090SJohn BaldwinBy default, writes are ignored and reads return all bits set.
239621b5090SJohn Baldwin.It Va x86.strictmsr Ta bool Ta true Ta
240621b5090SJohn BaldwinInject a general protection fault if a guest accesses a Model Specific
241621b5090SJohn BaldwinRegister (MSR) that is not emulated.
242621b5090SJohn BaldwinIf this is false, writes are ignored and reads return zero.
243*a27328eaSbrendabrandy.It Va x86.verbosemsr Ta bool Ta false Ta
244*a27328eaSbrendabrandyEnable verbose MSR print out. When this option is true,
245*a27328eaSbrendabrandymessages related to reading from (rdmsr) and writing to (wrmsr)
246*a27328eaSbrendabrandyMSRs on virtual CPUs will be printed out. This can be useful for
247*a27328eaSbrendabrandydebugging purposes.
248621b5090SJohn Baldwin.It Va x86.vmexit_on_hlt Ta bool Ta false Ta
249621b5090SJohn BaldwinForce a VM exit when a guest CPU executes the
250621b5090SJohn Baldwin.Dv HLT
251621b5090SJohn Baldwininstruction.
252621b5090SJohn BaldwinThis allows idle guest CPUs to yield the host CPU.
253621b5090SJohn Baldwin.It Va x86.vmexit_on_pause Ta bool Ta false Ta
254621b5090SJohn BaldwinForce a VM exit when a guest CPU executes the
255621b5090SJohn Baldwin.Dv PAUSE
256621b5090SJohn Baldwininstruction.
257621b5090SJohn Baldwin.El
258621b5090SJohn Baldwin.Sh DEVICE SETTINGS
259621b5090SJohn BaldwinDevice settings are stored under a device node.
260621b5090SJohn BaldwinThe device node's name is set by the parent bus of the device.
261621b5090SJohn Baldwin.Ss PCI Device Settings
262621b5090SJohn BaldwinPCI devices are described by a device node named
263e31cc1d5SKa Ho Ng.Dq pci . Ns Ar bus . Ns Ar slot . Ns Ar function
264621b5090SJohn Baldwinwhere each of
265621b5090SJohn Baldwin.Ar bus ,
266621b5090SJohn Baldwin.Ar slot ,
267621b5090SJohn Baldwinand
268621b5090SJohn Baldwin.Ar function
269621b5090SJohn Baldwinare formatted as decimal values with no padding.
270621b5090SJohn BaldwinAll PCI device nodes must contain a configuration variable named
271621b5090SJohn Baldwin.Dq device
272621b5090SJohn Baldwinwhich specifies the device model to use.
273621b5090SJohn BaldwinThe following PCI device models are supported:
274229381deSGraham Percival.Bl -tag -width indent
275621b5090SJohn Baldwin.It Li hostbridge
276621b5090SJohn BaldwinProvide a simple PCI-Host bridge device.
277621b5090SJohn BaldwinThis is usually configured at pci0:0:0 and is required by most guest
278621b5090SJohn Baldwinoperating systems.
279621b5090SJohn Baldwin.It Li ahci
280621b5090SJohn BaldwinAHCI storage controller.
281621b5090SJohn Baldwin.It Li e1000
282621b5090SJohn BaldwinIntel e82545 network interface.
283621b5090SJohn Baldwin.It Li fbuf
284621b5090SJohn BaldwinVGA framebuffer device attached to VNC server.
285621b5090SJohn Baldwin.It Li lpc
286621b5090SJohn BaldwinLPC PCI-ISA bridge with COM1-COM4 16550 serial ports,
287d93fbcf0SHans Rosenfelda boot ROM, and, optionally, a TPM module, a fwcfg type,
288d93fbcf0SHans Rosenfeldand a debug/test device.
289621b5090SJohn BaldwinThis device must be configured on bus 0.
290621b5090SJohn Baldwin.It Li hda
291621b5090SJohn BaldwinHigh Definition audio controller.
292621b5090SJohn Baldwin.It Li nvme
293621b5090SJohn BaldwinNVM Express (NVMe) controller.
294621b5090SJohn Baldwin.It Li passthru
295621b5090SJohn BaldwinPCI pass-through device.
296621b5090SJohn Baldwin.It Li uart
297621b5090SJohn BaldwinPCI 16550 serial device.
298621b5090SJohn Baldwin.It Li virtio-9p
299621b5090SJohn BaldwinVirtIO 9p (VirtFS) interface.
300621b5090SJohn Baldwin.It Li virtio-blk
301621b5090SJohn BaldwinVirtIO block storage interface.
302621b5090SJohn Baldwin.It Li virtio-console
303621b5090SJohn BaldwinVirtIO console interface.
304054accacSCorvin Köhne.It Li virtio-input
305054accacSCorvin KöhneVirtIO input interface.
306621b5090SJohn Baldwin.It Li virtio-net
307621b5090SJohn BaldwinVirtIO network interface.
308621b5090SJohn Baldwin.It Li virtio-rnd
309621b5090SJohn BaldwinVirtIO RNG interface.
310621b5090SJohn Baldwin.It Li virtio-scsi
311621b5090SJohn BaldwinVirtIO SCSI interface.
312621b5090SJohn Baldwin.It Li xhci
313621b5090SJohn BaldwinExtensible Host Controller Interface (XHCI) USB controller.
314621b5090SJohn Baldwin.El
315621b5090SJohn Baldwin.Ss USB Device Settings
316621b5090SJohn BaldwinUSB controller devices contain zero or more child USB devices
317621b5090SJohn Baldwinattached to slots.
318621b5090SJohn BaldwinEach USB device stores its settings in a node named
319621b5090SJohn Baldwin.Dq slot. Ns Va N
320621b5090SJohn Baldwinunder the controller's device node.
321621b5090SJohn Baldwin.Va N
322621b5090SJohn Baldwinis the number of the slot to which the USB device is attached.
323621b5090SJohn BaldwinNote that USB slot numbers begin at 1.
324621b5090SJohn BaldwinAll USB device nodes must contain a configuration variable named
325621b5090SJohn Baldwin.Dq device
326621b5090SJohn Baldwinwhich specifies the device model to use.
327621b5090SJohn BaldwinThe following USB device models are supported:
328229381deSGraham Percival.Bl -tag -width indent
329621b5090SJohn Baldwin.It Li tablet
330621b5090SJohn BaldwinA USB tablet device which provides precise cursor synchronization
331621b5090SJohn Baldwinwhen using VNC.
332621b5090SJohn Baldwin.El
333621b5090SJohn Baldwin.Ss Block Device Settings
334621b5090SJohn BaldwinBlock devices use the following settings to configure their backing store.
335621b5090SJohn BaldwinThese settings are stored in the configuration node of the respective device.
336621b5090SJohn Baldwin.Bl -column "sectorsize" "logical[/physical]" "Default"
337621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
338621b5090SJohn Baldwin.It path Ta string Ta Ta
339621b5090SJohn BaldwinThe path of the file or disk device to use as the backing store.
340621b5090SJohn Baldwin.It nocache Ta bool Ta false Ta
341621b5090SJohn BaldwinDisable caching on the backing file by opening the backing file with
342621b5090SJohn Baldwin.Dv O_DIRECT .
343621b5090SJohn Baldwin.It nodelete Ta bool Ta false Ta
344621b5090SJohn BaldwinDisable emulation of guest trim requests via
345621b5090SJohn Baldwin.Dv DIOCGDELETE
346621b5090SJohn Baldwinrequests.
347621b5090SJohn Baldwin.It sync Ta bool Ta false Ta
348621b5090SJohn BaldwinWrite changes to the backing file with synchronous writes.
349621b5090SJohn Baldwin.It direct Ta bool Ta false Ta
350621b5090SJohn BaldwinAn alias for
351621b5090SJohn Baldwin.Va sync .
352621b5090SJohn Baldwin.It ro Ta bool Ta false Ta
353621b5090SJohn BaldwinDisable writes to the backing file.
354621b5090SJohn Baldwin.It sectorsize Ta Va logical Ns Op / Ns Va physical Ta Ta
355621b5090SJohn BaldwinSpecify the logical and physical sector size of the emulated disk.
356621b5090SJohn BaldwinIf the physical size is not specified,
357621b5090SJohn Baldwinit is equal to the logical size.
358621b5090SJohn Baldwin.El
359621b5090SJohn Baldwin.Ss Network Backend Settings
360621b5090SJohn BaldwinNetwork devices use the following settings to configure their backend.
361621b5090SJohn BaldwinThe backend is responsible for passing packets between the device model
362621b5090SJohn Baldwinand a desired destination.
363621b5090SJohn BaldwinConfiguring a backend requires setting the
364621b5090SJohn Baldwin.Va backend
365e5ed417bSJohn Baldwinvariable.
366e5ed417bSJohn BaldwinThe type of a backend can either be set explicitly via the
367e5ed417bSJohn Baldwin.Va type
368e5ed417bSJohn Baldwinvariable
369e5ed417bSJohn Baldwinor it can be inferred from the value of
370e5ed417bSJohn Baldwin.Va backend .
371e5ed417bSJohn Baldwin.Pp
372e5ed417bSJohn BaldwinThe following types of backends are supported:
373e5ed417bSJohn Baldwin.Bl -tag -width "netgraph"
374e5ed417bSJohn Baldwin.It tap
375e5ed417bSJohn BaldwinUse the
376621b5090SJohn Baldwin.Xr tap 4
377e5ed417bSJohn Baldwininterface named in
378e5ed417bSJohn Baldwin.Va backend
379e5ed417bSJohn Baldwinas the backend.
380621b5090SJohn Baldwin.It netgraph
381621b5090SJohn BaldwinUse a
382621b5090SJohn Baldwin.Xr netgraph 4
383621b5090SJohn Baldwinsocket hook as the backend.
384621b5090SJohn BaldwinThis backend uses the following additional variables:
385621b5090SJohn Baldwin.Bl -column "peerhook" "Format" "Default"
386621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
387621b5090SJohn Baldwin.It Va path Ta string Ta Ta
388621b5090SJohn BaldwinThe name of the
389621b5090SJohn Baldwin.Xr netgraph 4
390621b5090SJohn Baldwindestination node.
391621b5090SJohn Baldwin.It Va peerhook Ta string Ta Ta
392621b5090SJohn BaldwinThe name of the destination hook.
393621b5090SJohn Baldwin.It Va socket Ta string Ta Ta
394621b5090SJohn BaldwinThe name of the created
395621b5090SJohn Baldwin.Xr ng_socket 4
396621b5090SJohn Baldwinnode.
397621b5090SJohn Baldwin.It Va hook Ta string Ta vmlink Ta
398621b5090SJohn BaldwinThe name of the source hook on the created
399621b5090SJohn Baldwin.Xr ng_socket 4
400621b5090SJohn Baldwinnode.
401621b5090SJohn Baldwin.El
402e5ed417bSJohn Baldwin.It netmap
403621b5090SJohn BaldwinUse
404621b5090SJohn Baldwin.Xr netmap 4
405e5ed417bSJohn Baldwineither on a network interface or a port on a
406621b5090SJohn Baldwin.Xr vale 4
407621b5090SJohn Baldwinbridge as the backend.
408e5ed417bSJohn BaldwinThe value of
409e5ed417bSJohn Baldwin.Va backend
410e5ed417bSJohn Baldwinis passed to
411e5ed417bSJohn Baldwin.Xr nm_open
412e5ed417bSJohn Baldwinto connect to a netmap port.
413c5359e2aSMark Johnston.It slirp
414c5359e2aSMark JohnstonUse the slirp backend to provide a userspace network stack.
415c5359e2aSMark JohnstonThe
416c5359e2aSMark Johnston.Va hostfwd
417c5359e2aSMark Johnstonvariable is used to configure how packets from the host are translated
418c5359e2aSMark Johnstonbefore being sent to the guest.
419c5359e2aSMark Johnston.Bl -column "peerhook" "Format" "Default"
420c5359e2aSMark Johnston.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
421c5359e2aSMark Johnston.It Va hostfwd Ta string Ta Ta
422c5359e2aSMark JohnstonA semicolon-separated list of host forwarding rules, each of the form
423c5359e2aSMark Johnston.Ar proto:haddr:hport-gaddr:gport ,
424c5359e2aSMark Johnstonwhere
425c5359e2aSMark Johnston.Ar proto
426c5359e2aSMark Johnstonis either
427c5359e2aSMark Johnston.Ql tcp
428c5359e2aSMark Johnstonor
429c5359e2aSMark Johnston.Ql udp .
430c5359e2aSMark JohnstonIf the guest address is equal to the empty string, packets will be
431c5359e2aSMark Johnstonforwarded to the first DHCP-assigned address in the guest.
432c5359e2aSMark Johnston.El
433e5ed417bSJohn Baldwin.El
434e5ed417bSJohn Baldwin.Pp
435e5ed417bSJohn BaldwinIf
436e5ed417bSJohn Baldwin.Va type
437e5ed417bSJohn Baldwinis not specified explicitly, then it is inferred from
438e5ed417bSJohn Baldwin.Va backend
439e5ed417bSJohn Baldwinbased on the following patterns:
440e5ed417bSJohn Baldwin.Bl -column -offset indent "valuebridge:port"
441e5ed417bSJohn Baldwin.It Sy Pattern Ta Sy Type
442e5ed417bSJohn Baldwin.It tap Ns Va N Ta tap
443e5ed417bSJohn Baldwin.It vmnet Ns Va N Ta tap
444e5ed417bSJohn Baldwin.It netgraph Ta netgraph
445e5ed417bSJohn Baldwin.It netmap: Ns Va interface Ta netmap
446e5ed417bSJohn Baldwin.It vale Ns Va bridge : Ns Va port Ta netmap
447621b5090SJohn Baldwin.El
448621b5090SJohn Baldwin.Ss UART Device Settings
449621b5090SJohn Baldwin.Bl -column "Name" "Format" "Default"
450621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
451621b5090SJohn Baldwin.It Va path Ta path Ta Ta
452621b5090SJohn BaldwinBackend device for the serial port.
453621b5090SJohn BaldwinEither the pathname of a character device or
454621b5090SJohn Baldwin.Dq stdio
455621b5090SJohn Baldwinto use standard input and output of the
456621b5090SJohn Baldwin.Xr bhyve 8
457621b5090SJohn Baldwinprocess.
4581f903953SSHENG-YI HONG.It Va tcp Ta Oo Ar IP Ns : Oc Ns Ar port Ta Ta
4591f903953SSHENG-YI HONGTCP address to listen on for remote connections.
4601f903953SSHENG-YI HONGThe IP address must be given as a numeric address.
4611f903953SSHENG-YI HONGIPv6 addresses must be enclosed in square brackets and
4621f903953SSHENG-YI HONGsupports scoped identifiers as described in
4631f903953SSHENG-YI HONG.Xr getaddrinfo 3 .
464621b5090SJohn Baldwin.El
465621b5090SJohn Baldwin.Ss Host Bridge Settings
466b72e06b1SCorvin Köhne.Bl -column "pcireg.*" "integer" "Default"
467621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
468b72e06b1SCorvin Köhne.It Va pcireg.* Ta integer Ta Ta
469b72e06b1SCorvin KöhneValues of PCI register.
470b72e06b1SCorvin Köhne.Bl -column "device" "Default"
471b72e06b1SCorvin Köhne.It Sy Name Ta Sy Default
472621b5090SJohn Baldwin.It Va vendor Ta integer Ta 0x1275 Ta
473b72e06b1SCorvin Köhne.It Va device Ta integer Ta 0x1275 Ta
474b72e06b1SCorvin Köhne.El
475621b5090SJohn Baldwin.El
476621b5090SJohn Baldwin.Ss AHCI Controller Settings
477621b5090SJohn BaldwinAHCI controller devices contain zero or more ports each of which
478621b5090SJohn Baldwinprovides a storage device.
479621b5090SJohn BaldwinEach port stores its settings in a node named
480621b5090SJohn Baldwin.Dq port. Ns Va N
481621b5090SJohn Baldwinunder the controller's device node.
482621b5090SJohn BaldwinThe
483621b5090SJohn Baldwin.Va N
484621b5090SJohn Baldwinvalues are formatted as successive decimal values starting with 0.
485621b5090SJohn BaldwinIn addition to the block device settings described above, each
486621b5090SJohn Baldwinport supports the following settings:
487621b5090SJohn Baldwin.Bl -column "model" "integer" "generated"
488621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
489621b5090SJohn Baldwin.It Va type Ta string Ta Ta
490621b5090SJohn BaldwinThe type of storage device to emulate.
491621b5090SJohn BaldwinMust be set to either
492621b5090SJohn Baldwin.Dq cd
493621b5090SJohn Baldwinor
494621b5090SJohn Baldwin.Dq hd .
495621b5090SJohn Baldwin.It Va nmrr Ta integer Ta 0 Ta
496621b5090SJohn BaldwinNominal Media Rotation Rate, also known as RPM.
497621b5090SJohn BaldwinA value 1 of indicates a device with no rate such as a Solid State Disk.
498621b5090SJohn Baldwin.It Va ser Ta string Ta generated Ta
499621b5090SJohn BaldwinSerial number of up to twenty characters.
500621b5090SJohn BaldwinA default serial number is generated using a hash of the backing
501621b5090SJohn Baldwinstore's pathname.
502621b5090SJohn Baldwin.It Va rev Ta string Ta 001 Ta
503621b5090SJohn BaldwinRevision number of up to eight characters.
504621b5090SJohn Baldwin.It Va model Ta string Ta Ta
505621b5090SJohn BaldwinModel number of up to forty characters.
506621b5090SJohn BaldwinSeparate default model strings are used for
507621b5090SJohn Baldwin.Dq cd
508621b5090SJohn Baldwinand
509621b5090SJohn Baldwin.Dq hd
510621b5090SJohn Baldwindevice types.
511621b5090SJohn Baldwin.El
512621b5090SJohn Baldwin.Ss e1000 Settings
513621b5090SJohn BaldwinIn addition to the network backend settings,
514621b5090SJohn BaldwinIntel e82545 network interfaces support the following variables:
515621b5090SJohn Baldwin.Bl -column "Name" "MAC address" "generated"
516621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
517621b5090SJohn Baldwin.It Va mac Ta MAC address Ta generated Ta
518621b5090SJohn BaldwinMAC address.
519621b5090SJohn BaldwinIf an explicit address is not provided,
520621b5090SJohn Baldwina MAC address is generated from a hash of the device's PCI address.
521621b5090SJohn Baldwin.El
522621b5090SJohn Baldwin.Ss Frame Buffer Settings
523621b5090SJohn Baldwin.Bl -column "password" "[IP:]port" "127.0.0.1:5900"
524621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
525621b5090SJohn Baldwin.It Va wait Ta bool Ta false Ta
526621b5090SJohn BaldwinWait for a remote connection before starting the VM.
527621b5090SJohn Baldwin.It Va rfb Ta Oo Ar IP Ns : Oc Ns Ar port Ta 127.0.0.1:5900 Ta
528621b5090SJohn BaldwinTCP address to listen on for remote connections.
529621b5090SJohn BaldwinThe IP address must be given as a numeric address.
530621b5090SJohn BaldwinIPv6 addresses must be enclosed in square brackets and
531621b5090SJohn Baldwinsupport scoped identifiers as described in
532621b5090SJohn Baldwin.Xr getaddrinfo 3 .
533621b5090SJohn BaldwinA bare port number may be given in which case the IPv4
534621b5090SJohn Baldwinlocalhost address is used.
535621b5090SJohn Baldwin.It Va vga Ta string Ta io Ta
536621b5090SJohn BaldwinVGA configuration.
537621b5090SJohn BaldwinMore details are provided in
538621b5090SJohn Baldwin.Xr bhyve 8 .
539621b5090SJohn Baldwin.It Va w Ta integer Ta 1024 Ta
540621b5090SJohn BaldwinFrame buffer width in pixels.
541621b5090SJohn Baldwin.It Va h Ta integer Ta 768 Ta
542621b5090SJohn BaldwinFrame buffer height in pixels.
543621b5090SJohn Baldwin.It Va password Ta string Ta Ta
544621b5090SJohn BaldwinPassword to use for VNC authentication.
545621b5090SJohn BaldwinThis type of authentication is known to be cryptographically weak and is not
546621b5090SJohn Baldwinintended for use on untrusted networks.
547621b5090SJohn Baldwin.El
548621b5090SJohn Baldwin.Ss High Definition Audio Settings
549621b5090SJohn Baldwin.Bl -column "Name" "Format" "Default"
550621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
551621b5090SJohn Baldwin.It Va play Ta path Ta Ta
552621b5090SJohn BaldwinHost playback device,
553621b5090SJohn Baldwintypically
554621b5090SJohn Baldwin.Pa /dev/dsp0 .
555621b5090SJohn Baldwin.It Va rec Ta path Ta Ta
556621b5090SJohn BaldwinHost recording device,
557621b5090SJohn Baldwintypically
558621b5090SJohn Baldwin.Pa /dev/dsp0 .
559621b5090SJohn Baldwin.El
560621b5090SJohn Baldwin.Ss LPC Device Settings
561621b5090SJohn BaldwinThe LPC bridge stores its configuration under a top-level
562621b5090SJohn Baldwin.Va lpc
563621b5090SJohn Baldwinnode rather than under the PCI LPC device's node.
564621b5090SJohn BaldwinThe following nodes are available under
565621b5090SJohn Baldwin.Va lpc :
566621b5090SJohn Baldwin.Bl -column "pc-testdev" "Format" "Default"
567621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
568621b5090SJohn Baldwin.It Va com1 Ta node Ta Ta
569621b5090SJohn BaldwinSettings for the COM1 serial port device.
570621b5090SJohn Baldwin.It Va com2 Ta node Ta Ta
571621b5090SJohn BaldwinSettings for the COM2 serial port device.
572621b5090SJohn Baldwin.It Va com3 Ta node Ta Ta
573621b5090SJohn BaldwinSettings for the COM3 serial port device.
574621b5090SJohn Baldwin.It Va com4 Ta node Ta Ta
575621b5090SJohn BaldwinSettings for the COM4 serial port device.
576d85147f3SCorvin Köhne.It Va fwcfg Ta string Ta bhyve Ta
577d85147f3SCorvin KöhneThe fwcfg type to be used.
578d85147f3SCorvin KöhneSupported values are
579d85147f3SCorvin Köhne.Dq bhyve
580d85147f3SCorvin Köhnefor fwctl and
581d85147f3SCorvin Köhne.Dq qemu
582d85147f3SCorvin Köhnefor fwcfg.
583621b5090SJohn Baldwin.It Va pc-testdev Ta bool Ta false Ta
584621b5090SJohn BaldwinEnable the PC debug/test device.
585c98d13fbSCorvin Köhne.It Va pcireg.* Ta integer Ta Ta
586f4ceaff5SCorvin KöhneValues of PCI register.
587f4ceaff5SCorvin KöhneIt also accepts the value
588f4ceaff5SCorvin Köhne.Ar host
589f4ceaff5SCorvin Köhneto use the pci id of the host system.
590f4ceaff5SCorvin KöhneThis value is required for the Intel GOP driver to work properly.
591f4ceaff5SCorvin Köhne.Bl -column "subvendor" "Default"
592f4ceaff5SCorvin Köhne.It Sy Name Ta Sy Default
593f4ceaff5SCorvin Köhne.It Va vendor Ta 0x8086
594f4ceaff5SCorvin Köhne.It Va device Ta 0x7000
595f4ceaff5SCorvin Köhne.It Va revid Ta 0
596f4ceaff5SCorvin Köhne.It Va subvendor Ta 0
597f4ceaff5SCorvin Köhne.It Va subdevice Ta 0
598f4ceaff5SCorvin Köhne.El
599621b5090SJohn Baldwin.El
600d93fbcf0SHans Rosenfeld.Ss TPM Device Settings
601d93fbcf0SHans RosenfeldThe TPM device stores its configuration under a top-level
602d93fbcf0SHans Rosenfeld.Va tpm
603d93fbcf0SHans Rosenfeldnode rather than under the LPC TPM device's node.
604d93fbcf0SHans RosenfeldOnly one TPM device is supported.
605d93fbcf0SHans RosenfeldThe following nodes are available under
606d93fbcf0SHans Rosenfeld.Va tpm :
607d93fbcf0SHans Rosenfeld.Bl -column "tpm.version" "Format" "Default"
608d93fbcf0SHans Rosenfeld.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
609d93fbcf0SHans Rosenfeld.It Va tpm.path Ta string Ta Ta
610d93fbcf0SHans RosenfeldPath to the TPM backend.
611d93fbcf0SHans RosenfeldDepending on the
612d93fbcf0SHans Rosenfeld.Va tpm.type ,
613d93fbcf0SHans Rosenfeldthis is either the host TPM device, typically
614d93fbcf0SHans Rosenfeld.Pa /dev/tpm0 ,
615d93fbcf0SHans Rosenfeldor any UNIX domain socket on which a
616d93fbcf0SHans Rosenfeld.Cm swtpm
617d93fbcf0SHans Rosenfeldprocess is listening.
618d93fbcf0SHans Rosenfeld.It Va tpm.type Ta string Ta Ta
619d93fbcf0SHans RosenfeldType of the TPM device passed to the guest.
620d93fbcf0SHans RosenfeldThis can be either
621d93fbcf0SHans Rosenfeld.Dq passthru
622d93fbcf0SHans Rosenfeldto use the host TPM devices, or
623d93fbcf0SHans Rosenfeld.Dq swtpm
624d93fbcf0SHans Rosenfeldto connect to a running
625d93fbcf0SHans Rosenfeld.Cm swtpm
626d93fbcf0SHans Rosenfeldprocess.
627d93fbcf0SHans Rosenfeld.It Va tpm.version Ta string Ta 2.0 Ta
628d93fbcf0SHans RosenfeldVersion of the TPM device according to the TCG specification.
629d93fbcf0SHans RosenfeldCurrently, only version 2.0 is supported.
630d93fbcf0SHans Rosenfeld.El
631621b5090SJohn Baldwin.Ss NVMe Controller Settings
632621b5090SJohn BaldwinEach NVMe controller supports a single storage device.
633621b5090SJohn BaldwinThe device can be backed either by a memory disk described by the
634621b5090SJohn Baldwin.Va ram
63581d1214eSChristian Weisgerbervariable, or a block device using the block device settings described above.
636621b5090SJohn BaldwinIn addition, each controller supports the following settings:
637621b5090SJohn Baldwin.Bl -column "ioslots" "Format" "Default"
638621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
639621b5090SJohn Baldwin.It Va maxq Ta integer Ta 16 Ta
640621b5090SJohn BaldwinMaximum number of I/O submission and completion queue pairs.
641621b5090SJohn Baldwin.It Va qsz Ta integer Ta 2058 Ta
642621b5090SJohn BaldwinNumber of elements in each I/O queue.
643621b5090SJohn Baldwin.It Va ioslots Ta integer Ta 8 Ta
644621b5090SJohn BaldwinMaximum number of concurrent I/O requests.
645621b5090SJohn Baldwin.It Va sectsz Ta integer Ta Ta
646621b5090SJohn BaldwinSector size.
647621b5090SJohn BaldwinCan be one of 512, 4096, or 8192.
648621b5090SJohn BaldwinDevices backed by a memory disk use 4096 as the default.
649621b5090SJohn BaldwinDevices backed by a block device use the block device's sector size
650621b5090SJohn Baldwinas the default.
651621b5090SJohn Baldwin.It Va ser Ta string Ta Ta
652621b5090SJohn BaldwinSerial number of up to twenty characters.
653621b5090SJohn BaldwinA default serial number is generated using a hash of the device's PCI address.
654621b5090SJohn Baldwin.It Va eui64 Ta integer Ta Ta
655621b5090SJohn BaldwinIEEE Extended Unique Identifier.
656621b5090SJohn BaldwinIf an EUI is not provided, a default is generated using a checksum of the
657621b5090SJohn Baldwindevice's PCI address.
658621b5090SJohn Baldwin.It Va dsm Ta string Ta auto Ta
659621b5090SJohn BaldwinWhether or not to advertise DataSet Management support.
660621b5090SJohn BaldwinOne of
661621b5090SJohn Baldwin.Dq auto ,
662621b5090SJohn Baldwin.Dq enable ,
663621b5090SJohn Baldwinor
664621b5090SJohn Baldwin.Dq disable .
665621b5090SJohn BaldwinThe
666621b5090SJohn Baldwin.Dq auto
667621b5090SJohn Baldwinsetting only advertises support if the backing store supports
668621b5090SJohn Baldwinresource freeing, for example via TRIM.
669621b5090SJohn Baldwin.It Va ram Ta integer Ta Ta
670621b5090SJohn BaldwinIf set, allocate a memory disk as the backing store.
671621b5090SJohn BaldwinThe value of this variable is the size of the memory disk in megabytes.
672621b5090SJohn Baldwin.El
673621b5090SJohn Baldwin.Ss PCI Passthrough Settings
674baf753ccSJohn BaldwinThe
675baf753ccSJohn Baldwin.Xr ppt 4
676baf753ccSJohn Baldwindevice driver must be attached to the
677baf753ccSJohn BaldwinPCI device being passed through.
678baf753ccSJohn BaldwinThe device to pass through can be identified either by name or its
679baf753ccSJohn Baldwinhost PCI bus location.
680621b5090SJohn Baldwin.Bl -column "Name" "integer" "Default"
681621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
682621b5090SJohn Baldwin.It Va bus Ta integer Ta Ta
683621b5090SJohn BaldwinHost PCI bus address of device to pass through.
684621b5090SJohn Baldwin.It Va slot Ta integer Ta Ta
685621b5090SJohn BaldwinHost PCI slot address of device to pass through.
686621b5090SJohn Baldwin.It Va func Ta integer Ta Ta
687621b5090SJohn BaldwinHost PCI function address of device to pass through.
688baf753ccSJohn Baldwin.It Va pptdev Ta string Ta Ta
689baf753ccSJohn BaldwinName of a
690baf753ccSJohn Baldwin.Xr ppt 4
691baf753ccSJohn Baldwindevice to pass through.
692e47fe318SCorvin Köhne.It Va rom Ta path Ta Ta
693e47fe318SCorvin KöhneROM file of the device which will be executed by OVMF to init the device.
694621b5090SJohn Baldwin.El
695621b5090SJohn Baldwin.Ss VirtIO 9p Settings
696621b5090SJohn BaldwinEach VirtIO 9p device exposes a single filesystem from a host path.
697621b5090SJohn Baldwin.Bl -column "sharename" "Format" "Default"
698621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
699621b5090SJohn Baldwin.It Va sharename Ta string Ta Ta
700621b5090SJohn BaldwinThe share name exposed to the guest.
701621b5090SJohn Baldwin.It Va path Ta path Ta Ta
702621b5090SJohn BaldwinThe path of a directory on the host to export to the guest.
703621b5090SJohn Baldwin.It Va ro Ta bool Ta false Ta
704621b5090SJohn BaldwinIf true, the guest filesystem is read-only.
705621b5090SJohn Baldwin.El
706c6efcb12SJohn Baldwin.Ss VirtIO Block Device Settings
707c6efcb12SJohn BaldwinIn addition to the block device settings described above, each
708c6efcb12SJohn BaldwinVirtIO block device supports the following settings:
709c6efcb12SJohn Baldwin.Bl -column "model" "integer" "generated"
710c6efcb12SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
711c6efcb12SJohn Baldwin.It Va ser Ta string Ta generated Ta
712c6efcb12SJohn BaldwinSerial number of up to twenty characters.
713c6efcb12SJohn BaldwinA default serial number is generated using a hash of the backing
714c6efcb12SJohn Baldwinstore's pathname.
715c6efcb12SJohn Baldwin.El
716621b5090SJohn Baldwin.Ss VirtIO Console Device Settings
717621b5090SJohn BaldwinEach VirtIO Console device contains one or more console ports.
718621b5090SJohn BaldwinEach port stores its settings in a node named
719621b5090SJohn Baldwin.Dq port. Ns Va N
720621b5090SJohn Baldwinunder the controller's device node.
721621b5090SJohn BaldwinThe
722621b5090SJohn Baldwin.Va N
723621b5090SJohn Baldwinvalues are formatted as successive decimal values starting with 0.
724621b5090SJohn BaldwinEach port supports the following settings:
725621b5090SJohn Baldwin.Bl -column "Name" "Format" "Default"
726621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
727621b5090SJohn Baldwin.It Va name Ta string Ta Ta
728621b5090SJohn BaldwinThe name of the port exposed to the guest.
729621b5090SJohn Baldwin.It Va path Ta path Ta Ta
730621b5090SJohn BaldwinThe path of a UNIX domain socket providing the host connection for the port.
731621b5090SJohn Baldwin.El
732054accacSCorvin Köhne.Ss VirtIO Input Interface Settings
733054accacSCorvin KöhneEach VirtIO Input device contains one input event device.
734054accacSCorvin KöhneAll input events of the input event device are send to the guest by VirtIO Input interface.
735054accacSCorvin KöhneVirtIO Input Interfaces support the following variables:
736054accacSCorvin Köhne.Bl -column "Name" "Format" "Default"
737054accacSCorvin Köhne.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
738054accacSCorvin Köhne.It Va path Ta path Ta Ta
739054accacSCorvin KöhneThe path of the input event device exposed to the guest
740054accacSCorvin Köhne.El
741621b5090SJohn Baldwin.Ss VirtIO Network Interface Settings
742621b5090SJohn BaldwinIn addition to the network backend settings,
743621b5090SJohn BaldwinVirtIO network interfaces support the following variables:
744621b5090SJohn Baldwin.Bl -column "Name" "MAC address" "generated"
745621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
746621b5090SJohn Baldwin.It Va mac Ta MAC address Ta generated Ta
747621b5090SJohn BaldwinMAC address.
748621b5090SJohn BaldwinIf an explicit address is not provided,
749621b5090SJohn Baldwina MAC address is generated from a hash of the device's PCI address.
750621b5090SJohn Baldwin.It Va mtu Ta integer Ta 1500 Ta
751621b5090SJohn BaldwinThe largest supported MTU advertised to the guest.
752621b5090SJohn Baldwin.El
753621b5090SJohn Baldwin.Ss VirtIO SCSI Settings
754621b5090SJohn Baldwin.Bl -column "Name" "integer" "Default"
755621b5090SJohn Baldwin.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description
756621b5090SJohn Baldwin.It Va dev Ta path Ta Ta
757621b5090SJohn BaldwinThe path of a CAM target layer (CTL) device to export:
758621b5090SJohn Baldwin.Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc .
759621b5090SJohn Baldwin.It Va iid Ta integer Ta 0 Ta
760621b5090SJohn BaldwinInitiator ID to use when sending requests to the CTL port.
761621b5090SJohn Baldwin.El
762621b5090SJohn Baldwin.Sh SEE ALSO
763621b5090SJohn Baldwin.Xr expand_number 3 ,
764621b5090SJohn Baldwin.Xr getaddrinfo 3 ,
765621b5090SJohn Baldwin.Xr strtol 3 ,
766621b5090SJohn Baldwin.Xr netgraph 4 ,
767621b5090SJohn Baldwin.Xr netmap 4 ,
768621b5090SJohn Baldwin.Xr ng_socket 4 ,
769621b5090SJohn Baldwin.Xr tap 4 ,
770621b5090SJohn Baldwin.Xr vale 4 ,
771621b5090SJohn Baldwin.Xr vmnet 4 ,
772621b5090SJohn Baldwin.Xr bhyve 8
773