12b948146SAndy Fiddaman.\" SPDX-License-Identifier: BSD-2-Clause 22b948146SAndy Fiddaman.\" 32b948146SAndy Fiddaman.\" Copyright (c) 2021 John H. Baldwin <jhb@FreeBSD.org> 42b948146SAndy Fiddaman.\" 52b948146SAndy Fiddaman.\" Redistribution and use in source and binary forms, with or without 62b948146SAndy Fiddaman.\" modification, are permitted provided that the following conditions 72b948146SAndy Fiddaman.\" are met: 82b948146SAndy Fiddaman.\" 1. Redistributions of source code must retain the above copyright 92b948146SAndy Fiddaman.\" notice, this list of conditions and the following disclaimer. 102b948146SAndy Fiddaman.\" 2. Redistributions in binary form must reproduce the above copyright 112b948146SAndy Fiddaman.\" notice, this list of conditions and the following disclaimer in the 122b948146SAndy Fiddaman.\" documentation and/or other materials provided with the distribution. 132b948146SAndy Fiddaman.\" 142b948146SAndy Fiddaman.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 152b948146SAndy Fiddaman.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 162b948146SAndy Fiddaman.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 172b948146SAndy Fiddaman.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 182b948146SAndy Fiddaman.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 192b948146SAndy Fiddaman.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 202b948146SAndy Fiddaman.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 212b948146SAndy Fiddaman.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 222b948146SAndy Fiddaman.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 232b948146SAndy Fiddaman.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 242b948146SAndy Fiddaman.\" SUCH DAMAGE. 252b948146SAndy Fiddaman.\" 26*32640292SAndy Fiddaman.\" Portions Copyright 2023 OmniOS Community Edition (OmniOSce) Association. 272b948146SAndy Fiddaman.\" 28d1d478f3SJorge Schrauwen.Dd July 29, 2023 29bbf21555SRichard Lowe.Dt BHYVE_CONFIG 5 302b948146SAndy Fiddaman.Os 312b948146SAndy Fiddaman.Sh NAME 322b948146SAndy Fiddaman.Nm bhyve_config 332b948146SAndy Fiddaman.Nd "bhyve configuration variables" 342b948146SAndy Fiddaman.Sh DESCRIPTION 35bbf21555SRichard Lowe.Xr bhyve 8 362b948146SAndy Fiddamanuses a hierarchical tree of configuration variables to describe global and 372b948146SAndy Fiddamanper-device settings. 382b948146SAndy FiddamanInternal nodes in this tree do not have a value, 392b948146SAndy Fiddamanonly leaf nodes have values. 402b948146SAndy FiddamanThis manual describes the configuration variables understood by 41bbf21555SRichard Lowe.Xr bhyve 8 . 422b948146SAndy FiddamanIf additional variables are defined, 43bbf21555SRichard Lowe.Xr bhyve 8 442b948146SAndy Fiddamanwill ignore them and will not emit errors for unknown variables. 452b948146SAndy FiddamanHowever, these additional variables can be referenced by other 462b948146SAndy Fiddamanvariables as described below. 472b948146SAndy Fiddaman.Sh VARIABLE VALUES 482b948146SAndy FiddamanConfiguration variable values are stored as strings. 492b948146SAndy FiddamanA configuration variable value may refer to one or more other 502b948146SAndy Fiddamanconfiguration values by name. 512b948146SAndy FiddamanInstances of the pattern 522b948146SAndy Fiddaman.Sq % Ns Pq Ar var 532b948146SAndy Fiddamanare replaced by the value of the configuration variable 542b948146SAndy Fiddaman.Va var . 552b948146SAndy FiddamanTo avoid unwanted expansion, 562b948146SAndy Fiddaman.Sq % 572b948146SAndy Fiddamancharacters can be escaped by a leading 582b948146SAndy Fiddaman.Sq % . 592b948146SAndy FiddamanFor example, 602b948146SAndy Fiddamanif a configuration variable 612b948146SAndy Fiddaman.Va disk 622b948146SAndy Fiddamanuses the value 632b948146SAndy Fiddaman.Pa /dev/zvol/bhyve/%(name) , 642b948146SAndy Fiddamanthen the final value of the 652b948146SAndy Fiddaman.Va disk 662b948146SAndy Fiddamanvariable will be set to the path of a ZFS volume whose name matches 672b948146SAndy Fiddamanthe name of the virtual machine on the pool 682b948146SAndy Fiddaman.Pa bhyve . 692b948146SAndy Fiddaman.Pp 702b948146SAndy FiddamanSome configuration variables may be interpreted as a boolean value. 712b948146SAndy FiddamanFor those variables the following case-insensitive values may be used to 722b948146SAndy Fiddamanindicate true: 732b948146SAndy Fiddaman.Pp 742b948146SAndy Fiddaman.Bl -bullet -offset indent -compact 752b948146SAndy Fiddaman.It 762b948146SAndy Fiddamantrue 772b948146SAndy Fiddaman.It 782b948146SAndy Fiddamanon 792b948146SAndy Fiddaman.It 802b948146SAndy Fiddamanyes 812b948146SAndy Fiddaman.It 822b948146SAndy Fiddaman1 832b948146SAndy Fiddaman.El 842b948146SAndy Fiddaman.Pp 852b948146SAndy FiddamanThe following values may be used to indicate false: 862b948146SAndy Fiddaman.Pp 872b948146SAndy Fiddaman.Bl -bullet -offset indent -compact 882b948146SAndy Fiddaman.It 892b948146SAndy Fiddamanfalse 902b948146SAndy Fiddaman.It 912b948146SAndy Fiddamanoff 922b948146SAndy Fiddaman.It 932b948146SAndy Fiddamanno 942b948146SAndy Fiddaman.It 952b948146SAndy Fiddaman0 962b948146SAndy Fiddaman.El 972b948146SAndy Fiddaman.Pp 982b948146SAndy FiddamanSome configuration variables may be interpreted as an integer. 992b948146SAndy FiddamanFor those variables, 1002b948146SAndy Fiddamanany syntax supported by 1012b948146SAndy Fiddaman.Xr strtoul 3C 1022b948146SAndy Fiddamanmay be used. 1032b948146SAndy Fiddaman.Sh GLOBAL SETTINGS 1042b948146SAndy Fiddaman.Ss Architecture Neutral Settings 1052b948146SAndy Fiddaman.Bl -column "memory.guest_in_core" "integer" "Default" 1062b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 1072b948146SAndy Fiddaman.It Va name Ta string Ta Ta 1082b948146SAndy FiddamanThe name of the VM. 1092b948146SAndy Fiddaman.It Va cpus Ta integer Ta 1 Ta 1102b948146SAndy FiddamanThe total number of virtual CPUs. 1112b948146SAndy Fiddaman.It Va cores Ta integer Ta 1 Ta 1122b948146SAndy FiddamanThe number of virtual cores in each virtual socket. 1132b948146SAndy Fiddaman.It Va threads Ta integer Ta 1 Ta 1142b948146SAndy FiddamanThe number of virtual CPUs in each virtual core. 1152b948146SAndy Fiddaman.It Va sockets Ta integer Ta 1 Ta 1162b948146SAndy FiddamanThe number of virtual sockets. 1172b948146SAndy Fiddaman.It Va memory.size Ta string Ta 256M Ta 1182b948146SAndy FiddamanGuest physical memory size. 1192b948146SAndy FiddamanThe size argument may be suffixed with one of K, M, G or T (either upper 1202b948146SAndy Fiddamanor lower case) to indicate a multiple of kibibytes, mebibytes, gibibytes, 1212b948146SAndy Fiddamanor tebibytes. 1222b948146SAndy FiddamanIf no suffix is given, the value is assumed to be in mebibytes. 1232b948146SAndy Fiddaman.It Va memory.wired Ta bool Ta false Ta 1242b948146SAndy FiddamanWire guest memory. 1252b948146SAndy Fiddaman.It Va acpi_tables Ta bool Ta false Ta 126*32640292SAndy FiddamanGenerate ACPI tables. 127*32640292SAndy Fiddaman.It Va acpi_tables_in_memory Ta bool Ta true Ta 128*32640292SAndy Fiddaman.Xr bhyve 8 129*32640292SAndy Fiddamanalways exposes ACPI tables by FwCfg. 130*32640292SAndy FiddamanFor backward compatibility bhyve copies them into the guest memory as well. 131*32640292SAndy FiddamanThis can cause problems if the guest uses the in-memory version, since certain 132*32640292SAndy Fiddamanadvanced features, such as TPM emulation, are exposed only via FwCfg. 133*32640292SAndy FiddamanTherefore, it is recommended to set this flag to false when running Windows 134*32640292SAndy Fiddamanguests. 1352b948146SAndy Fiddaman.It Va destroy_on_poweroff Ta bool Ta false Ta 1362b948146SAndy FiddamanDestroy the VM on guest-initiated power-off. 1376dc98349SAndy Fiddaman.It Va gdb.address Ta string Ta localhost Ta 1386dc98349SAndy FiddamanHostname, IP address, or IPv6 address for the debug server. 1392b948146SAndy Fiddaman.It Va gdb.port Ta integer Ta 0 Ta 1402b948146SAndy FiddamanTCP port number for the debug server. 1412b948146SAndy FiddamanIf this is set to a non-zero value, a debug server 1422b948146SAndy Fiddamanwill listen for connections on this port. 1432b948146SAndy Fiddaman.It Va gdb.wait Ta bool Ta false Ta 1442b948146SAndy FiddamanIf the debug server is enabled, wait for a debugger to connect 1452b948146SAndy Fiddamanbefore starting the guest. 146d7b72f7bSAndy Fiddaman.It Va keyboard.layout Ta string Ta Ta 147d7b72f7bSAndy FiddamanSpecify the keyboard layout name with the file name in 148d7b72f7bSAndy Fiddaman.Pa /usr/share/bhyve/kbdlayout . 149d7b72f7bSAndy FiddamanThis value only works when loaded with UEFI mode for VNC, and when a VNC client 150d7b72f7bSAndy Fiddamanthat doesn't support the QEMU Extended Key Event Message us used. 151*32640292SAndy Fiddaman.It Va tpm.path Ta string Ta Ta 152*32640292SAndy FiddamanPath to the host TPM device. 153*32640292SAndy FiddamanThis is typically /dev/tpm0. 154*32640292SAndy Fiddaman.It Va tpm.type Ta string Ta Ta 155*32640292SAndy FiddamanType of the TPM device passed to the guest. 156*32640292SAndy FiddamanCurrently, only "passthru" is supported. 157*32640292SAndy Fiddaman.It Va tpm.version Ta string Ta 2.0 Ta 158*32640292SAndy FiddamanVersion of the TPM device according to the TCG specification. 159*32640292SAndy FiddamanCurrently, only version 2.0 is supported. 1602b948146SAndy Fiddaman.It Va rtc.use_localtime Ta bool Ta true Ta 1612b948146SAndy FiddamanThe real time clock uses the local time of the host. 1622b948146SAndy FiddamanIf this is set to false, the real time clock uses UTC. 1632b948146SAndy Fiddaman.It Va uuid Ta string Ta Ta 1642b948146SAndy FiddamanThe universally unique identifier (UUID) to use in the guest's 1652b948146SAndy FiddamanSystem Management BIOS System Information structure. 1662b948146SAndy FiddamanIf an explicit value is not set, a valid UUID is generated from 1672b948146SAndy Fiddamanthe host's hostname and the VM name. 1682b948146SAndy Fiddaman.It Va virtio_msix Ta bool Ta true Ta 1692b948146SAndy FiddamanUse MSI-X interrupts for PCI VirtIO devices. 1702b948146SAndy FiddamanIf set to false, MSI interrupts are used instead. 1712b948146SAndy Fiddaman.It Va config.dump Ta bool Ta false Ta 172b0de25cbSAndy FiddamanIf this value is set to true then, after parsing command line options, 173bbf21555SRichard Lowe.Xr bhyve 8 1742817ebc2SAndy Fiddamanwill write all of its configuration variables to 1752817ebc2SAndy Fiddaman.Dv stdout 176b0de25cbSAndy Fiddamanand exit. 177b0de25cbSAndy FiddamanNo VM will be started. 1782817ebc2SAndy Fiddaman.It Va privileges.debug Ta bool Ta false Ta 1792817ebc2SAndy FiddamanEnable debug messages relating to privilege management. 1802817ebc2SAndy FiddamanThese messages are sent to 1812817ebc2SAndy Fiddaman.Dv stdout . 1821aa1f41fSAndy Fiddaman.It Va rfb.debug Ta bool Ta false Ta 1831aa1f41fSAndy FiddamanEnable debug messages relating to the RFB 1841aa1f41fSAndy Fiddaman.Pq VNC 1851aa1f41fSAndy Fiddamanserver. 186d4221574SAndy Fiddaman.It Va viona.debug Ta bool Ta false Ta 187d4221574SAndy FiddamanEnable debug messages relating to the accelerated virtio network device. 188d4221574SAndy FiddamanThese messages are sent to 189d4221574SAndy Fiddaman.Dv stdout . 190104fd295SAndy Fiddaman.It Va xhci.debug Ta bool Ta false Ta 191104fd295SAndy FiddamanEnable debug messages relating to the emulated XHCI 192104fd295SAndy Fiddaman.Pq USB 193104fd295SAndy Fiddamancontroller. 1941aa1f41fSAndy FiddamanThese messages are sent to 1951aa1f41fSAndy Fiddaman.Dv stderr . 1964f3f3e9aSAndy Fiddaman.It Va bios.vendor Ta string Ta BHYVE Ta 1974f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 1984f3f3e9aSAndy Fiddamanstructure. 1994f3f3e9aSAndy Fiddaman.It Va bios.version Ta string Ta 14.0 Ta 2004f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2014f3f3e9aSAndy Fiddamanstructure. 2024f3f3e9aSAndy Fiddaman.It Va bios.release_date Ta string Ta 10/17/2021 Ta 2034f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2044f3f3e9aSAndy Fiddamanstructure. 2054f3f3e9aSAndy Fiddaman.It Va system.family_name Ta string Ta Virtual Machine Ta 2064f3f3e9aSAndy FiddamanFamily the computer belongs to. 2074f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2084f3f3e9aSAndy Fiddamanstructure. 2094f3f3e9aSAndy Fiddaman.It Va system.manufacturer Ta string Ta illumos Ta 2104f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2114f3f3e9aSAndy Fiddamanstructure. 2124f3f3e9aSAndy Fiddaman.It Va system.product_name Ta string Ta BHYVE Ta 2134f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2144f3f3e9aSAndy Fiddamanstructure. 2154f3f3e9aSAndy Fiddaman.It Va system.serial_number Ta string Ta None Ta 2164f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2174f3f3e9aSAndy Fiddamanstructure. 2184f3f3e9aSAndy Fiddaman.It Va system.sku Ta string Ta None Ta 2194f3f3e9aSAndy FiddamanStock keeping unit of the computer. 2204f3f3e9aSAndy FiddamanIt's also called product ID or purchase order number. 2214f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2224f3f3e9aSAndy Fiddamanstructure. 2234f3f3e9aSAndy Fiddaman.It Va system.version Ta string Ta 1.0 Ta 2244f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2254f3f3e9aSAndy Fiddamanstructure. 2264f3f3e9aSAndy Fiddaman.It Va board.manufacturer Ta string Ta illumos Ta 2274f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2284f3f3e9aSAndy Fiddamanstructure. 2294f3f3e9aSAndy Fiddaman.It Va board.product_name Ta string Ta BHYVE Ta 2304f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2314f3f3e9aSAndy Fiddamanstructure. 2324f3f3e9aSAndy Fiddaman.It Va board.version Ta string Ta 1.0 Ta 2334f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2344f3f3e9aSAndy Fiddamanstructure. 2354f3f3e9aSAndy Fiddaman.It Va board.serial_number Ta string Ta None Ta 2364f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2374f3f3e9aSAndy Fiddamanstructure. 2384f3f3e9aSAndy Fiddaman.It Va board.asset_tag Ta string Ta None Ta 2394f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2404f3f3e9aSAndy Fiddamanstructure. 2414f3f3e9aSAndy Fiddaman.It Va board.location Ta string Ta None Ta 2424f3f3e9aSAndy FiddamanDescribes the board's location within the chassis. 2434f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2444f3f3e9aSAndy Fiddamanstructure. 2454f3f3e9aSAndy Fiddaman.It Va chassis.manufacturer Ta string Ta illumos Ta 2464f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2474f3f3e9aSAndy Fiddamanstructure. 2484f3f3e9aSAndy Fiddaman.It Va chassis.version Ta string Ta 1.0 Ta 2494f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2504f3f3e9aSAndy Fiddamanstructure. 2514f3f3e9aSAndy Fiddaman.It Va chassis.serial_number Ta string Ta None Ta 2524f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2534f3f3e9aSAndy Fiddamanstructure. 2544f3f3e9aSAndy Fiddaman.It Va chassis.asset_tag Ta string Ta None Ta 2554f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2564f3f3e9aSAndy Fiddamanstructure. 2574f3f3e9aSAndy Fiddaman.It Va chassis.sku Ta string Ta None Ta 2584f3f3e9aSAndy FiddamanStock keeping unit of the chassis. 2594f3f3e9aSAndy FiddamanIt's also called product ID or purchase order number. 2604f3f3e9aSAndy FiddamanThis value is used for the guest's System Management BIOS System Information 2614f3f3e9aSAndy Fiddamanstructure. 2624f3f3e9aSAndy Fiddaman.It Va smbios.family Ta string Ta Virtual Machine Ta 2634f3f3e9aSAndy FiddamanLegacy alias for 2644f3f3e9aSAndy Fiddaman.Va system.family_name , 2654f3f3e9aSAndy Fiddamando not use in new configurations. 2664f3f3e9aSAndy Fiddaman.It Va smbios.manufacturer Ta string Ta illumos Ta 2674f3f3e9aSAndy FiddamanLegacy alias for 2684f3f3e9aSAndy Fiddaman.Va system.manufacturer , 2694f3f3e9aSAndy Fiddamando not use in new configurations. 2704f3f3e9aSAndy Fiddaman.It Va smbios.product Ta string Ta BHYVE Ta 2714f3f3e9aSAndy FiddamanLegacy alias for 2724f3f3e9aSAndy Fiddaman.Va system.product_name , 2734f3f3e9aSAndy Fiddamando not use in new configurations. 2744f3f3e9aSAndy Fiddaman.It Va smbios.serial Ta string Ta None Ta 2754f3f3e9aSAndy FiddamanLegacy alias for 2764f3f3e9aSAndy Fiddaman.Va system.serial_number , 2774f3f3e9aSAndy Fiddamando not use in new configurations. 2784f3f3e9aSAndy Fiddaman.It Va smbios.sku Ta string Ta None Ta 2794f3f3e9aSAndy FiddamanLegacy alias for 2804f3f3e9aSAndy Fiddaman.Va system.sku , 2814f3f3e9aSAndy Fiddamando not use in new configurations. 2824f3f3e9aSAndy Fiddaman.It Va smbios.version Ta string Ta 1.0 Ta 2834f3f3e9aSAndy FiddamanLegacy alias for 2844f3f3e9aSAndy Fiddaman.Va system.version , 2854f3f3e9aSAndy Fiddamando not use in new configurations. 2862b948146SAndy Fiddaman.El 2872b948146SAndy Fiddaman.Ss x86-Specific Settings 2882b948146SAndy Fiddaman.Bl -column "x86.vmexit_on_pause" "integer" "Default" 2892b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 2902b948146SAndy Fiddaman.It Va x86.mptable Ta bool Ta true Ta 2912b948146SAndy FiddamanGenerate an MPTable. 2922b948146SAndy Fiddaman.It Va x86.x2apic Ta bool Ta false Ta 2932b948146SAndy FiddamanConfigure guest's local APICs in x2APIC mode. 2942b948146SAndy Fiddaman.It Va x86.strictio Ta bool Ta false Ta 2952b948146SAndy FiddamanExit if a guest accesses an I/O port that is not emulated. 2962b948146SAndy FiddamanBy default, writes are ignored and reads return all bits set. 2972b948146SAndy Fiddaman.It Va x86.strictmsr Ta bool Ta true Ta 2982b948146SAndy FiddamanInject a general protection fault if a guest accesses a Model Specific 2992b948146SAndy FiddamanRegister (MSR) that is not emulated. 3002b948146SAndy FiddamanIf this is false, writes are ignored and reads return zero. 3012b948146SAndy Fiddaman.It Va x86.vmexit_on_hlt Ta bool Ta false Ta 3022b948146SAndy FiddamanForce a VM exit when a guest CPU executes the 3032b948146SAndy Fiddaman.Dv HLT 3042b948146SAndy Fiddamaninstruction. 3052b948146SAndy FiddamanThis allows idle guest CPUs to yield the host CPU. 3062b948146SAndy Fiddaman.It Va x86.vmexit_on_pause Ta bool Ta false Ta 3072b948146SAndy FiddamanForce a VM exit when a guest CPU executes the 3082b948146SAndy Fiddaman.Dv PAUSE 3092b948146SAndy Fiddamaninstruction. 3102b948146SAndy Fiddaman.El 3112b948146SAndy Fiddaman.Sh DEVICE SETTINGS 3122b948146SAndy FiddamanDevice settings are stored under a device node. 3132b948146SAndy FiddamanThe device node's name is set by the parent bus of the device. 3142b948146SAndy Fiddaman.Ss PCI Device Settings 3152b948146SAndy FiddamanPCI devices are described by a device node named 316b0de25cbSAndy Fiddaman.Dq pci . Ns Ar bus . Ns Ar slot . Ns Ar function 3172b948146SAndy Fiddamanwhere each of 3182b948146SAndy Fiddaman.Ar bus , 3192b948146SAndy Fiddaman.Ar slot , 3202b948146SAndy Fiddamanand 3212b948146SAndy Fiddaman.Ar function 3222b948146SAndy Fiddamanare formatted as decimal values with no padding. 3232b948146SAndy FiddamanAll PCI device nodes must contain a configuration variable named 3242b948146SAndy Fiddaman.Dq device 3252b948146SAndy Fiddamanwhich specifies the device model to use. 3262b948146SAndy FiddamanThe following PCI device models are supported: 3272b948146SAndy Fiddaman.Bl -tag -width indent 3282b948146SAndy Fiddaman.It Li hostbridge 3292b948146SAndy FiddamanProvide a simple PCI-Host bridge device. 3302b948146SAndy FiddamanThis is usually configured at pci0:0:0 and is required by most guest 3312b948146SAndy Fiddamanoperating systems. 3322b948146SAndy Fiddaman.It Li ahci 3332b948146SAndy FiddamanAHCI storage controller. 3342b948146SAndy Fiddaman.It Li e1000 3352b948146SAndy FiddamanIntel e82545 network interface. 3362b948146SAndy Fiddaman.It Li fbuf 3372b948146SAndy FiddamanVGA framebuffer device attached to VNC server. 3382b948146SAndy Fiddaman.It Li lpc 3392b948146SAndy FiddamanLPC PCI-ISA bridge with COM1-COM4 16550 serial ports, 3402b948146SAndy Fiddamana boot ROM, 341*32640292SAndy Fiddamanan optional fwcfg type, 3422b948146SAndy Fiddamanand an optional debug/test device. 3432b948146SAndy FiddamanThis device must be configured on bus 0. 3442b948146SAndy Fiddaman.It Li nvme 3452b948146SAndy FiddamanNVM Express (NVMe) controller. 3462b948146SAndy Fiddaman.It Li passthru 3472b948146SAndy FiddamanPCI pass-through device. 3482b948146SAndy Fiddaman.It Li uart 3492b948146SAndy FiddamanPCI 16550 serial device. 350aa693e99SJason King.It Li virtio-9p 351aa693e99SJason KingVirtIO 9p (VirtFS) interface. 3522b948146SAndy Fiddaman.It Li virtio-blk 3532b948146SAndy FiddamanVirtIO block storage interface. 3542b948146SAndy Fiddaman.It Li virtio-console 3552b948146SAndy FiddamanVirtIO console interface. 3562b948146SAndy Fiddaman.It Li virtio-net-viona 357069b2ef0SAndy FiddamanAccelerated VirtIO network interface. 358069b2ef0SAndy Fiddaman.It Li net-viona 359069b2ef0SAndy FiddamanLegacy VirtIO network interface. 3602b948146SAndy Fiddaman.It Li virtio-rnd 3612b948146SAndy FiddamanVirtIO random number generator interface. 3622b948146SAndy Fiddaman.It Li xhci 3632b948146SAndy FiddamanExtensible Host Controller Interface (XHCI) USB controller. 3642b948146SAndy Fiddaman.El 3652b948146SAndy Fiddaman.Ss USB Device Settings 3662b948146SAndy FiddamanUSB controller devices contain zero or more child USB devices 3672b948146SAndy Fiddamanattached to slots. 3682b948146SAndy FiddamanEach USB device stores its settings in a node named 3692b948146SAndy Fiddaman.Dq slot. Ns Va N 3702b948146SAndy Fiddamanunder the controller's device node. 3712b948146SAndy Fiddaman.Va N 3722b948146SAndy Fiddamanis the number of the slot to which the USB device is attached. 3732b948146SAndy FiddamanNote that USB slot numbers begin at 1. 3742b948146SAndy FiddamanAll USB device nodes must contain a configuration variable named 3752b948146SAndy Fiddaman.Dq device 3762b948146SAndy Fiddamanwhich specifies the device model to use. 3772b948146SAndy FiddamanThe following USB device models are supported: 3782b948146SAndy Fiddaman.Bl -tag -width indent 3792b948146SAndy Fiddaman.It Li tablet 3802b948146SAndy FiddamanA USB tablet device which provides precise cursor synchronization 3812b948146SAndy Fiddamanwhen using VNC. 3822b948146SAndy Fiddaman.El 3832b948146SAndy Fiddaman.Ss Block Device Settings 3842b948146SAndy FiddamanBlock devices use the following settings to configure their backing store. 3852b948146SAndy FiddamanThese settings are stored in the configuration node of the respective device. 3862b948146SAndy Fiddaman.Bl -column "sectorsize" "logical[/physical]" "Default" 3872b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 3882b948146SAndy Fiddaman.It path Ta string Ta Ta 3892b948146SAndy FiddamanThe path of the file or disk device to use as the backing store. 3902b948146SAndy Fiddaman.It nocache Ta bool Ta false Ta 3912b948146SAndy FiddamanDisable caching on the backing file by opening the backing file with 3922b948146SAndy Fiddaman.Dv O_DIRECT . 3932b948146SAndy Fiddaman.It nodelete Ta bool Ta false Ta 3942b948146SAndy FiddamanDisable emulation of guest trim requests via 3952b948146SAndy Fiddaman.Dv DIOCGDELETE 3962b948146SAndy Fiddamanrequests. 3972b948146SAndy Fiddaman.It sync Ta bool Ta false Ta 3982b948146SAndy FiddamanWrite changes to the backing file with synchronous writes. 3992b948146SAndy Fiddaman.It direct Ta bool Ta false Ta 4002b948146SAndy FiddamanAn alias for 4012b948146SAndy Fiddaman.Va sync . 4022b948146SAndy Fiddaman.It ro Ta bool Ta false Ta 4032b948146SAndy FiddamanDisable writes to the backing file. 4042b948146SAndy Fiddaman.It sectorsize Ta Va logical Ns Op / Ns Va physical Ta Ta 4052b948146SAndy FiddamanSpecify the logical and physical sector size of the emulated disk. 4062b948146SAndy FiddamanIf the physical size is not specified, it is set to be equal to the logical 4072b948146SAndy Fiddamansize. 4082b948146SAndy Fiddaman.El 409069b2ef0SAndy Fiddaman.Ss virtio-net-viona Network Backend Settings 4102b948146SAndy FiddamanViona network devices use the following settings to configure their backend. 4112b948146SAndy Fiddaman.Bl -column "feature_flags" "string" "Default" 4122b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 4132b948146SAndy Fiddaman.It vnic Ta string Ta Ta 4142b948146SAndy FiddamanThe VNIC to use for the network connection. 4152b948146SAndy Fiddaman.It feature_mask Ta integer Ta 0 Ta 4162b948146SAndy FiddamanSpecify a mask to apply to the virtio features advertised to the guest. 4172b948146SAndy Fiddaman.El 418d1d478f3SJorge Schrauwen.Pp 419d1d478f3SJorge SchrauwenViona network devices have the ability to lend out their TX buffers, which 420d1d478f3SJorge Schrauwencan occasionally cause issues if they are not returned. 421d1d478f3SJorge SchrauwenThis will result in the guest not being able to send any network packets, 422d1d478f3SJorge Schrauwenincluding TCP ACKs, resulting in the guest becoming completely unreachable. 423d1d478f3SJorge SchrauwenThe default has changed to now always copy TX buffers. 424d1d478f3SJorge SchrauwenA temporary tunable has been added 425d1d478f3SJorge Schrauwen.Pq which will be removed when this has been properly addressed 426d1d478f3SJorge Schrauwento restore the ability for the driver to loan out TX buffers, which is enabled 427d1d478f3SJorge Schrauwenby setting the variable 428d1d478f3SJorge Schrauwen.Sy viona:viona_default_tx_copy 429d1d478f3SJorge Schrauwento 0 in 430d1d478f3SJorge Schrauwen.Xr system 5 . 431069b2ef0SAndy Fiddaman.Ss Other Network Backend Settings 432069b2ef0SAndy FiddamanOther network devices use the following settings to configure their backend. 433069b2ef0SAndy Fiddaman.Bl -column "feature_flags" "string" "Default" 434069b2ef0SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 435069b2ef0SAndy Fiddaman.It vnic Ta string Ta Ta 436069b2ef0SAndy FiddamanThe VNIC to use for the network connection. 437069b2ef0SAndy Fiddaman.It promiscphys Ta bool Ta false Ta 438069b2ef0SAndy FiddamanEnable promiscuous mode at the physical level. 439069b2ef0SAndy Fiddaman.It promiscsap Ta bool Ta true Ta 440069b2ef0SAndy FiddamanEnable promiscuous mode at the SAP level. 441069b2ef0SAndy Fiddaman.It promiscmulti Ta bool Ta true Ta 442069b2ef0SAndy FiddamanEnable promiscuous mode for all multicast addresses. 443069b2ef0SAndy Fiddaman.It promiscrxonly Ta bool Ta true Ta 444069b2ef0SAndy FiddamanThe selected promiscuous modes are only enabled for received traffic. 445069b2ef0SAndy Fiddaman.El 4462b948146SAndy Fiddaman.Ss UART Device Settings 4472b948146SAndy Fiddaman.Bl -column "Name" "Format" "Default" 4482b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 4492b948146SAndy Fiddaman.It Va path Ta path Ta Ta 4502b948146SAndy FiddamanBackend device for the serial port. 4512b948146SAndy FiddamanEither the pathname of a character device or 4522b948146SAndy Fiddaman.Dq stdio 4532b948146SAndy Fiddamanto use standard input and output of the 454bbf21555SRichard Lowe.Xr bhyve 8 4552b948146SAndy Fiddamanprocess. 4562b948146SAndy Fiddaman.El 4572b948146SAndy Fiddaman.Ss Host Bridge Settings 4582b948146SAndy FiddamanHost Bridge devices use the following settings. 4592b948146SAndy FiddamanWhen configuring parameters, either the 4602b948146SAndy Fiddaman.Va model 4612b948146SAndy Fiddamanby itself, or both of 4622b948146SAndy Fiddaman.Va vendor 4632b948146SAndy Fiddamanand 4642b948146SAndy Fiddaman.Va devid 4652b948146SAndy Fiddamanmust be specified. 466*32640292SAndy FiddamanThe vendor and device IDs can be specified using the legacy 467*32640292SAndy Fiddaman.Va vendor 468*32640292SAndy Fiddamanand 469*32640292SAndy Fiddaman.Va devid , 470*32640292SAndy Fiddamanor via the new 471*32640292SAndy Fiddaman.Va pcireg.vendor 472*32640292SAndy Fiddamanand 473*32640292SAndy Fiddaman.Va pcireg.device 474*32640292SAndy Fiddamanproperties. 475*32640292SAndy Fiddaman.Bl -column "pcireg.*" "integer" "Default" 4762b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 4772b948146SAndy Fiddaman.It Va model Ta string Ta netapp Ta 4782b948146SAndy FiddamanSpecify a hostbridge model to emulate. 4792b948146SAndy FiddamanValid model strings, and their associated vendor and device IDs are: 4802b948146SAndy Fiddaman.Sy amd Pq 0x1022/0x7432 , 4812b948146SAndy Fiddaman.Sy netapp Pq 0x1275/0x1275 , 4822b948146SAndy Fiddaman.Sy i440fx Pq 0x8086/0x1237 4832b948146SAndy Fiddamanand 4842b948146SAndy Fiddaman.Sy q35 Pq 0x8086/0x29b0 . 4852b948146SAndy Fiddaman.It Va vendor Ta integer Ta 0x1275 Ta 4862b948146SAndy FiddamanPCI vendor ID. 4872b948146SAndy Fiddaman.It Va devid Ta integer Ta 0x1275 Ta 4882b948146SAndy FiddamanPCI device ID. 489*32640292SAndy Fiddaman.It Va pcireg.* Ta integer Ta Ta 490*32640292SAndy FiddamanValues of PCI register. 491*32640292SAndy Fiddaman.Bl -column "device" "Default" 492*32640292SAndy Fiddaman.It Sy Name Ta Sy Type Ta Sy Default 493*32640292SAndy Fiddaman.It Va vendor Ta integer Ta 0x1275 494*32640292SAndy Fiddaman.It Va device Ta integer Ta 0x1275 495*32640292SAndy Fiddaman.El 4962b948146SAndy Fiddaman.El 4972b948146SAndy Fiddaman.Ss AHCI Controller Settings 4982b948146SAndy FiddamanAHCI controller devices contain zero or more ports each of which 4992b948146SAndy Fiddamanprovides a storage device. 5002b948146SAndy FiddamanEach port stores its settings in a node named 5012b948146SAndy Fiddaman.Dq port. Ns Va N 5022b948146SAndy Fiddamanunder the controller's device node. 5032b948146SAndy FiddamanThe 5042b948146SAndy Fiddaman.Va N 5052b948146SAndy Fiddamanvalues are formatted as successive decimal values starting with 0. 5062b948146SAndy FiddamanIn addition to the block device settings described above, each 5072b948146SAndy Fiddamanport supports the following settings: 5082b948146SAndy Fiddaman.Bl -column "model" "integer" "generated" 5092b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 5102b948146SAndy Fiddaman.It Va type Ta string Ta Ta 5112b948146SAndy FiddamanThe type of storage device to emulate. 5122b948146SAndy FiddamanMust be set to either 5132b948146SAndy Fiddaman.Dq cd 5142b948146SAndy Fiddamanor 5152b948146SAndy Fiddaman.Dq hd . 5162b948146SAndy Fiddaman.It Va nmrr Ta integer Ta 0 Ta 5172b948146SAndy FiddamanNominal Media Rotation Rate, also known as RPM. 5182b948146SAndy FiddamanA value 1 of indicates a device with no rate such as a Solid State Disk. 5192b948146SAndy Fiddaman.It Va ser Ta string Ta generated Ta 5202b948146SAndy FiddamanSerial number of up to twenty characters. 5212b948146SAndy FiddamanA default serial number is generated using a hash of the backing 5222b948146SAndy Fiddamanstore's pathname. 5232b948146SAndy Fiddaman.It Va rev Ta string Ta 001 Ta 5242b948146SAndy FiddamanRevision number of up to eight characters. 5252b948146SAndy Fiddaman.It Va model Ta string Ta Ta 5262b948146SAndy FiddamanModel number of up to forty characters. 5272b948146SAndy FiddamanSeparate default model strings are used for 5282b948146SAndy Fiddaman.Dq cd 5292b948146SAndy Fiddamanand 5302b948146SAndy Fiddaman.Dq hd 5312b948146SAndy Fiddamandevice types. 5322b948146SAndy Fiddaman.El 5332b948146SAndy Fiddaman.Ss Frame Buffer Settings 5342b948146SAndy Fiddaman.Bl -column "password" "[IP:]port" "127.0.0.1:5900" 5352b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 5362b948146SAndy Fiddaman.It Va wait Ta bool Ta false Ta 5372b948146SAndy FiddamanWait for a remote connection before starting the VM. 5382b948146SAndy Fiddaman.It Va rfb Ta Oo Ar IP Ns \&: Oc Ns Ar port Ta 127.0.0.1:5900 Ta 5392b948146SAndy FiddamanTCP address to listen on for remote connections. 5402b948146SAndy FiddamanThe IP address must be given as a numeric address. 5412b948146SAndy FiddamanIPv6 addresses must be enclosed in square brackets and 5422b948146SAndy Fiddamansupport scoped identifiers as described in 5432817ebc2SAndy Fiddaman.Xr getaddrinfo 3SOCKET . 5442b948146SAndy FiddamanA bare port number may be given in which case the IPv4 5452b948146SAndy Fiddamanlocalhost address is used. 5462b948146SAndy Fiddaman.It Va unix Ta string Ta Ta 5472b948146SAndy FiddamanUNIX socket to listen on for VNC connections. 5482b948146SAndy Fiddaman.It Va vga Ta string Ta io Ta 5492b948146SAndy FiddamanVGA configuration. 5502b948146SAndy FiddamanMore details are provided in 551bbf21555SRichard Lowe.Xr bhyve 8 . 5522b948146SAndy Fiddaman.It Va w Ta integer Ta 1024 Ta 5532b948146SAndy FiddamanFrame buffer width in pixels. 5542b948146SAndy Fiddaman.It Va h Ta integer Ta 768 Ta 5552b948146SAndy FiddamanFrame buffer height in pixels. 5562b948146SAndy Fiddaman.It Va password Ta string Ta Ta 5572b948146SAndy FiddamanPassword to use for VNC authentication. 5582b948146SAndy FiddamanThis type of authentication is known to be cryptographically weak and is not 5592b948146SAndy Fiddamanintended for use on untrusted networks. 5602b948146SAndy Fiddaman.El 5612b948146SAndy Fiddaman.Ss LPC Device Settings 5622b948146SAndy FiddamanThe LPC bridge stores its configuration under a top-level 5632b948146SAndy Fiddaman.Va lpc 5642b948146SAndy Fiddamannode rather than under the PCI LPC device's node. 5652b948146SAndy FiddamanThe following nodes are available under 5662b948146SAndy Fiddaman.Va lpc : 5672b948146SAndy Fiddaman.Bl -column "pc-testdev" "Format" "Default" 5682b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 5692b948146SAndy Fiddaman.It Va bootrom Ta path Ta Ta 5702b948146SAndy FiddamanPath to a boot ROM. 5712b948146SAndy FiddamanThe contents of this file are copied into the guest's 5722b948146SAndy Fiddamanmemory ending just before the 4GB physical address. 5732b948146SAndy FiddamanIf a boot ROM is present, a firmware interface device is 5742b948146SAndy Fiddamanalso enabled for use by the boot ROM. 575d7b72f7bSAndy Fiddaman.It Va bootvars Ta path Ta Ta 576d7b72f7bSAndy FiddamanPath to boot variables file. 577d7b72f7bSAndy FiddamanThe contents of this file are copied beneath the boot ROM. 578d7b72f7bSAndy FiddamanFirmware can write to it to save variables. 579d7b72f7bSAndy FiddamanVariables will be persistent across guest reboots. 5802b948146SAndy Fiddaman.It Va com1 Ta node Ta Ta 5812b948146SAndy FiddamanSettings for the COM1 serial port device. 5822b948146SAndy Fiddaman.It Va com2 Ta node Ta Ta 5832b948146SAndy FiddamanSettings for the COM2 serial port device. 5842b948146SAndy Fiddaman.It Va com3 Ta node Ta Ta 5852b948146SAndy FiddamanSettings for the COM3 serial port device. 5862b948146SAndy Fiddaman.It Va com4 Ta node Ta Ta 5872b948146SAndy FiddamanSettings for the COM4 serial port device. 588*32640292SAndy Fiddaman.It Va fwcfg Ta string Ta bhyve Ta 589*32640292SAndy FiddamanThe fwcfg type to be used. 590*32640292SAndy FiddamanSupported values are 591*32640292SAndy Fiddaman.Dq bhyve 592*32640292SAndy Fiddamanfor fwctl and 593*32640292SAndy Fiddaman.Dq qemu 594*32640292SAndy Fiddamanfor fwcfg. 5952b948146SAndy Fiddaman.It Va pc-testdev Ta bool Ta false Ta 5962b948146SAndy FiddamanEnable the PC debug/test device. 597*32640292SAndy Fiddaman.It Va pcireg.* Ta integer Ta Ta 598*32640292SAndy FiddamanValues of PCI register. 599*32640292SAndy FiddamanThis value is required for the Intel GOP driver to work properly. 600*32640292SAndy Fiddaman.Bl -column "subvendor" "Default" 601*32640292SAndy Fiddaman.It Sy Name Ta Sy Default 602*32640292SAndy Fiddaman.It Va vendor Ta 0x8086 603*32640292SAndy Fiddaman.It Va device Ta 0x7000 604*32640292SAndy Fiddaman.It Va revid Ta 0 605*32640292SAndy Fiddaman.It Va subvendor Ta 0 606*32640292SAndy Fiddaman.It Va subdevice Ta 0 607*32640292SAndy Fiddaman.El 6082b948146SAndy Fiddaman.El 6092b948146SAndy Fiddaman.Ss NVMe Controller Settings 6102b948146SAndy FiddamanEach NVMe controller supports a single storage device. 6112b948146SAndy FiddamanThe device can be backed either by a memory disk described by the 6122b948146SAndy Fiddaman.Va ram 6132b948146SAndy Fiddamanvariable, or a block device using the block device settings described above. 6142b948146SAndy FiddamanIn addition, each controller supports the following settings: 6152b948146SAndy Fiddaman.Bl -column "ioslots" "Format" "Default" 6162b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 6172b948146SAndy Fiddaman.It Va maxq Ta integer Ta 16 Ta 6182b948146SAndy FiddamanMaximum number of I/O submission and completion queue pairs. 6192b948146SAndy Fiddaman.It Va qsz Ta integer Ta 2058 Ta 6202b948146SAndy FiddamanNumber of elements in each I/O queue. 6212b948146SAndy Fiddaman.It Va ioslots Ta integer Ta 8 Ta 6222b948146SAndy FiddamanMaximum number of concurrent I/O requests. 6232b948146SAndy Fiddaman.It Va sectsz Ta integer Ta Ta 6242b948146SAndy FiddamanSector size. 6252b948146SAndy FiddamanCan be one of 512, 4096, or 8192. 6262b948146SAndy FiddamanDevices backed by a memory disk use 4096 as the default. 6272b948146SAndy FiddamanDevices backed by a block device use the block device's sector size 6282b948146SAndy Fiddamanas the default. 6292b948146SAndy Fiddaman.It Va ser Ta string Ta Ta 6302b948146SAndy FiddamanSerial number of up to twenty characters. 6312b948146SAndy FiddamanA default serial number is generated using a hash of the device's PCI address. 6322b948146SAndy Fiddaman.It Va eui64 Ta integer Ta Ta 6332b948146SAndy FiddamanIEEE Extended Unique Identifier. 6342b948146SAndy FiddamanIf an EUI is not provided, a default is generated using a checksum of the 6352b948146SAndy Fiddamandevice's PCI address. 6362b948146SAndy Fiddaman.It Va dsm Ta string Ta auto Ta 6372b948146SAndy FiddamanWhether or not to advertise Dataset Management (DSM) support. 6382b948146SAndy FiddamanOne of 6392b948146SAndy Fiddaman.Dq auto , 6402b948146SAndy Fiddaman.Dq enable , 6412b948146SAndy Fiddamanor 6422b948146SAndy Fiddaman.Dq disable . 6432b948146SAndy FiddamanThe 6442b948146SAndy Fiddaman.Dq auto 6452b948146SAndy Fiddamansetting only advertises support if the backing store supports 6462b948146SAndy Fiddamanresource freeing, for example via TRIM. 6472b948146SAndy Fiddaman.It Va ram Ta integer Ta Ta 6482b948146SAndy FiddamanIf set, allocate a memory disk as the backing store. 6492b948146SAndy FiddamanThe value of this variable is the size of the memory disk in megabytes. 6502b948146SAndy Fiddaman.El 6512b948146SAndy Fiddaman.Ss PCI Passthrough Settings 6522b948146SAndy Fiddaman.Bl -column "Name" "integer" "Default" 6532b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 6542b948146SAndy Fiddaman.It Va path Ta string Ta Ta 6552b948146SAndy FiddamanPath to a PCI passthrough device in the form 6562b948146SAndy Fiddaman.Pa /dev/ppt Ns Ar N 6572b948146SAndy Fiddamanwhere 6582b948146SAndy Fiddaman.Ar N 6592b948146SAndy Fiddamanis the device number. 660d7b72f7bSAndy Fiddaman.It Va rom Ta path Ta Ta 661d7b72f7bSAndy FiddamanROM file of the device which will be executed by OVMF to initialise the device. 6622b948146SAndy Fiddaman.El 663aa693e99SJason King.Ss VirtIO 9p Settings 664aa693e99SJason KingEach VirtIO 9p device exposes a single filesystem from a host path. 665aa693e99SJason King.Bl -column "sharename" "Format" "Default" 666aa693e99SJason King.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 667aa693e99SJason King.It Va sharename Ta string Ta Ta 668aa693e99SJason KingThe share name exposed to the guest. 669aa693e99SJason King.It Va path Ta path Ta Ta 670aa693e99SJason KingThe path of a directory on the host to export to the guest. 671aa693e99SJason King.It Va ro Ta bool Ta false Ta 672aa693e99SJason KingIf true, the guest filesystem is read-only. 673aa693e99SJason King.El 674b0de25cbSAndy Fiddaman.Ss VirtIO Block Device Settings 675b0de25cbSAndy FiddamanIn addition to the block device settings described above, each 676b0de25cbSAndy FiddamanVirtIO block device supports the following settings: 677b0de25cbSAndy Fiddaman.Bl -column "model" "integer" "generated" 678b0de25cbSAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 679b0de25cbSAndy Fiddaman.It Va ser Ta string Ta generated Ta 680b0de25cbSAndy FiddamanSerial number of up to twenty characters. 681b0de25cbSAndy FiddamanA default serial number is generated using a hash of the backing 682b0de25cbSAndy Fiddamanstore's pathname. 683b0de25cbSAndy Fiddaman.El 6842b948146SAndy Fiddaman.Ss VirtIO Console Device Settings 6852b948146SAndy FiddamanEach VirtIO Console device contains one or more console ports. 6862b948146SAndy FiddamanEach port stores its settings in a node named 6872b948146SAndy Fiddaman.Dq port. Ns Va N 6882b948146SAndy Fiddamanunder the controller's device node. 6892b948146SAndy FiddamanThe 6902b948146SAndy Fiddaman.Va N 6912b948146SAndy Fiddamanvalues are formatted as successive decimal values starting with 0. 6922b948146SAndy FiddamanEach port supports the following settings: 6932b948146SAndy Fiddaman.Bl -column "Name" "Format" "Default" 6942b948146SAndy Fiddaman.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 6952b948146SAndy Fiddaman.It Va name Ta string Ta Ta 6962b948146SAndy FiddamanThe name of the port exposed to the guest. 6972b948146SAndy Fiddaman.It Va path Ta path Ta Ta 6982b948146SAndy FiddamanThe path of a UNIX domain socket providing the host connection for the port. 6992b948146SAndy Fiddaman.El 7002b948146SAndy Fiddaman.Sh SEE ALSO 7012817ebc2SAndy Fiddaman.Xr strtoul 3C , 702bbf21555SRichard Lowe.Xr getaddrinfo 3SOCKET , 703bbf21555SRichard Lowe.Xr bhyve 8 704