1.\" SPDX-License-Identifier: BSD-2-Clause 2.\" 3.\" Copyright (c) 2021 John H. Baldwin <jhb@FreeBSD.org> 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.Dd August 19, 2022 27.Dt BHYVE_CONFIG 5 28.Os 29.Sh NAME 30.Nm bhyve_config 31.Nd "bhyve configuration variables" 32.Sh DESCRIPTION 33.Xr bhyve 8 34uses a hierarchical tree of configuration variables to describe global and 35per-device settings. 36Internal nodes in this tree do not have a value, 37only leaf nodes have values. 38This manual describes the configuration variables understood by 39.Xr bhyve 8 . 40If additional variables are defined, 41.Xr bhyve 8 42will ignore them and will not emit errors for unknown variables. 43However, these additional variables can be referenced by other 44variables as described below. 45.Sh VARIABLE VALUES 46Configuration variable values are stored as strings. 47A configuration variable value may refer to one or more other 48configuration values by name. 49Instances of the pattern 50.Sq % Ns Pq Ar var 51are replaced by the value of the configuration variable 52.Va var . 53To avoid unwanted expansion, 54.Sq % 55characters can be escaped by a leading 56.Sq % . 57For example, 58if a configuration variable 59.Va disk 60uses the value 61.Pa /dev/zvol/bhyve/%(name) , 62then the final value of the 63.Va disk 64variable will be set to the path of a ZFS volume whose name matches 65the name of the virtual machine on the pool 66.Pa bhyve . 67.Pp 68Some configuration variables may be interpreted as a boolean value. 69For those variables the following case-insensitive values may be used to 70indicate true: 71.Pp 72.Bl -bullet -offset indent -compact 73.It 74true 75.It 76on 77.It 78yes 79.It 801 81.El 82.Pp 83The following values may be used to indicate false: 84.Pp 85.Bl -bullet -offset indent -compact 86.It 87false 88.It 89off 90.It 91no 92.It 930 94.El 95.Pp 96Some configuration variables may be interperted as an integer. 97For those variables, 98any syntax supported by 99.Xr strtol 3 100may be used. 101.Sh GLOBAL SETTINGS 102.Ss Architecture Neutral Settings 103.Bl -column "memory.guest_in_core" "integer" "Default" 104.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 105.It Va name Ta string Ta Ta 106The name of the VM. 107.It Va cpus Ta integer Ta 1 Ta 108The total number of virtual CPUs. 109.It Va cores Ta integer Ta 1 Ta 110The number of virtual cores in each virtual socket. 111.It Va threads Ta integer Ta 1 Ta 112The number of virtual CPUs in each virtual core. 113.It Va sockets Ta integer Ta 1 Ta 114The number of virtual sockets. 115.It Va memory.guest_in_core Ta bool Ta false Ta 116Include guest memory in core file. 117.It Va memory.size Ta string Ta 256M Ta 118Guest physical memory size in bytes. 119The value must be formatted as described in 120.Xr expand_number 3 . 121.It Va memory.wired Ta bool Ta false Ta 122Wire guest memory. 123.It Va acpi_tables Ta bool Ta true Ta 124Generate ACPI tables. 125.It Va acpi_tables_in_memory Ta bool Ta true Ta 126.Xr bhyve 8 127always exposes ACPI tables by FwCfg. 128For backward compatibility bhyve copies them into the guest memory as well. 129This can cause problems if the guest uses the in-memory version, since certain 130advanced features, such as TPM emulation, are exposed only via FwCfg. 131Therefore, it is recommended to set this flag to false when running Windows guests. 132.It Va destroy_on_poweroff Ta bool Ta false Ta 133Destroy the VM on guest-initiated power-off. 134.It Va gdb.address Ta string Ta localhost Ta 135Hostname, IP address, or IPv6 address for the debug server. 136.It Va gdb.port Ta integer Ta 0 Ta 137TCP port number for the debug server. 138If this is set to a non-zero value, a debug server 139will listen for connections on this port. 140.It Va gdb.wait Ta bool Ta false Ta 141If the debug server is enabled, wait for a debugger to connect 142before starting the guest. 143.It Va keyboard.layout Ta string Ta Ta 144Specify the keyboard layout name with the file name in 145.Ar /usr/share/bhyve/kbdlayout . 146This value only works when loaded with UEFI mode for VNC, and 147used a VNC client that don't support QEMU Extended Key Event 148Message (e.g. TightVNC). 149.It Va tpm.path Ta string Ta Ta 150Path to the host TPM device. 151This is typically /dev/tpm0. 152.It Va tpm.type Ta string Ta Ta 153Type of the TPM device passed to the guest. 154Currently, only "passthru" is supported. 155.It Va tpm.version Ta string Ta 2.0 Ta 156Version of the TPM device according to the TCG specification. 157Currently, only version 2.0 is supported. 158.It Va rtc.use_localtime Ta bool Ta true Ta 159The real time clock uses the local time of the host. 160If this is set to false, the real time clock uses UTC. 161.It Va uuid Ta string Ta Ta 162The universally unique identifier (UUID) to use in the guest's 163System Management BIOS System Information structure. 164If an explicit value is not set, a valid UUID is generated from 165the host's hostname and the VM name. 166.It Va virtio_msix Ta bool Ta true Ta 167Use MSI-X interrupts for PCI VirtIO devices. 168If set to false, MSI interrupts are used instead. 169.It Va config.dump Ta bool Ta false Ta 170If this value is set to true after 171.Xr bhyve 8 172has finished parsing command line options, 173then 174.Xr bhyve 8 175will write all of its configuration variables to stdout and exit. 176No VM will be started. 177.It Va bios.vendor Ta string Ta BHYVE Ta 178This value is used for the guest's System Management BIOS System Information structure. 179.It Va bios.version Ta string Ta 14.0 Ta 180This value is used for the guest's System Management BIOS System Information structure. 181.It Va bios.release_date Ta string Ta 10/17/2021 Ta 182This value is used for the guest's System Management BIOS System Information structure. 183.It Va system.family_name Ta string Ta Virtual Machine Ta 184Family the computer belongs to. 185This value is used for the guest's System Management BIOS System Information structure. 186.It Va system.manufacturer Ta string Ta FreeBSD Ta 187This value is used for the guest's System Management BIOS System Information structure. 188.It Va system.product_name Ta string Ta BHYVE Ta 189This value is used for the guest's System Management BIOS System Information structure. 190.It Va system.serial_number Ta string Ta None Ta 191This value is used for the guest's System Management BIOS System Information structure. 192.It Va system.sku Ta string Ta None Ta 193Stock keeping unit of the computer. 194It's also called product ID or purchase order number. 195This value is used for the guest's System Management BIOS System Information structure. 196.It Va system.version Ta string Ta 1.0 Ta 197This value is used for the guest's System Management BIOS System Information structure. 198.It Va board.manufacturer Ta string Ta FreeBSD Ta 199This value is used for the guest's System Management BIOS System Information structure. 200.It Va board.product_name Ta string Ta BHYVE Ta 201This value is used for the guest's System Management BIOS System Information structure. 202.It Va board.version Ta string Ta 1.0 Ta 203This value is used for the guest's System Management BIOS System Information structure. 204.It Va board.serial_number Ta string Ta None Ta 205This value is used for the guest's System Management BIOS System Information structure. 206.It Va board.asset_tag Ta string Ta None Ta 207This value is used for the guest's System Management BIOS System Information structure. 208.It Va board.location Ta string Ta None Ta 209Describes the board's location within the chassis. 210This value is used for the guest's System Management BIOS System Information structure. 211.It Va chassis.manufacturer Ta string Ta FreeBSD Ta 212This value is used for the guest's System Management BIOS System Information structure. 213.It Va chassis.version Ta string Ta 1.0 Ta 214This value is used for the guest's System Management BIOS System Information structure. 215.It Va chassis.serial_number Ta string Ta None Ta 216This value is used for the guest's System Management BIOS System Information structure. 217.It Va chassis.asset_tag Ta string Ta None Ta 218This value is used for the guest's System Management BIOS System Information structure. 219.It Va chassis.sku Ta string Ta None Ta 220Stock keeping unit of the chassis. 221It's also called product ID or purchase order number. 222This value is used for the guest's System Management BIOS System Information structure. 223.El 224.Ss x86-Specific Settings 225.Bl -column "x86.vmexit_on_pause" "integer" "Default" 226.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 227.It Va x86.mptable Ta bool Ta true Ta 228Generate an MPTable. 229.It Va x86.x2apic Ta bool Ta false Ta 230Configure guest's local APICs in x2APIC mode. 231.It Va x86.strictio Ta bool Ta false Ta 232Exit if a guest accesses an I/O port that is not emulated. 233By default, writes are ignored and reads return all bits set. 234.It Va x86.strictmsr Ta bool Ta true Ta 235Inject a general protection fault if a guest accesses a Model Specific 236Register (MSR) that is not emulated. 237If this is false, writes are ignored and reads return zero. 238.It Va x86.vmexit_on_hlt Ta bool Ta false Ta 239Force a VM exit when a guest CPU executes the 240.Dv HLT 241instruction. 242This allows idle guest CPUs to yield the host CPU. 243.It Va x86.vmexit_on_pause Ta bool Ta false Ta 244Force a VM exit when a guest CPU executes the 245.Dv PAUSE 246instruction. 247.El 248.Sh DEVICE SETTINGS 249Device settings are stored under a device node. 250The device node's name is set by the parent bus of the device. 251.Ss PCI Device Settings 252PCI devices are described by a device node named 253.Dq pci . Ns Ar bus . Ns Ar slot . Ns Ar function 254where each of 255.Ar bus , 256.Ar slot , 257and 258.Ar function 259are formatted as decimal values with no padding. 260All PCI device nodes must contain a configuration variable named 261.Dq device 262which specifies the device model to use. 263The following PCI device models are supported: 264.Bl -tag -indent 265.It Li hostbridge 266Provide a simple PCI-Host bridge device. 267This is usually configured at pci0:0:0 and is required by most guest 268operating systems. 269.It Li ahci 270AHCI storage controller. 271.It Li e1000 272Intel e82545 network interface. 273.It Li fbuf 274VGA framebuffer device attached to VNC server. 275.It Li lpc 276LPC PCI-ISA bridge with COM1-COM4 16550 serial ports, 277a boot ROM, 278an optional fwcfg type, 279and an optional debug/test device. 280This device must be configured on bus 0. 281.It Li hda 282High Definition audio controller. 283.It Li nvme 284NVM Express (NVMe) controller. 285.It Li passthru 286PCI pass-through device. 287.It Li uart 288PCI 16550 serial device. 289.It Li virtio-9p 290VirtIO 9p (VirtFS) interface. 291.It Li virtio-blk 292VirtIO block storage interface. 293.It Li virtio-console 294VirtIO console interface. 295.It Li virtio-input 296VirtIO input interface. 297.It Li virtio-net 298VirtIO network interface. 299.It Li virtio-rnd 300VirtIO RNG interface. 301.It Li virtio-scsi 302VirtIO SCSI interface. 303.It Li xhci 304Extensible Host Controller Interface (XHCI) USB controller. 305.El 306.Ss USB Device Settings 307USB controller devices contain zero or more child USB devices 308attached to slots. 309Each USB device stores its settings in a node named 310.Dq slot. Ns Va N 311under the controller's device node. 312.Va N 313is the number of the slot to which the USB device is attached. 314Note that USB slot numbers begin at 1. 315All USB device nodes must contain a configuration variable named 316.Dq device 317which specifies the device model to use. 318The following USB device models are supported: 319.Bl -tag -indent 320.It Li tablet 321A USB tablet device which provides precise cursor synchronization 322when using VNC. 323.El 324.Ss Block Device Settings 325Block devices use the following settings to configure their backing store. 326These settings are stored in the configuration node of the respective device. 327.Bl -column "sectorsize" "logical[/physical]" "Default" 328.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 329.It path Ta string Ta Ta 330The path of the file or disk device to use as the backing store. 331.It nocache Ta bool Ta false Ta 332Disable caching on the backing file by opening the backing file with 333.Dv O_DIRECT . 334.It nodelete Ta bool Ta false Ta 335Disable emulation of guest trim requests via 336.Dv DIOCGDELETE 337requests. 338.It sync Ta bool Ta false Ta 339Write changes to the backing file with synchronous writes. 340.It direct Ta bool Ta false Ta 341An alias for 342.Va sync . 343.It ro Ta bool Ta false Ta 344Disable writes to the backing file. 345.It sectorsize Ta Va logical Ns Op / Ns Va physical Ta Ta 346Specify the logical and physical sector size of the emulated disk. 347If the physical size is not specified, 348it is equal to the logical size. 349.El 350.Ss Network Backend Settings 351Network devices use the following settings to configure their backend. 352The backend is responsible for passing packets between the device model 353and a desired destination. 354Configuring a backend requires setting the 355.Va backend 356variable. 357The type of a backend can either be set explicitly via the 358.Va type 359variable 360or it can be inferred from the value of 361.Va backend . 362.Pp 363The following types of backends are supported: 364.Bl -tag -width "netgraph" 365.It tap 366Use the 367.Xr tap 4 368interface named in 369.Va backend 370as the backend. 371.It netgraph 372Use a 373.Xr netgraph 4 374socket hook as the backend. 375This backend uses the following additional variables: 376.Bl -column "peerhook" "Format" "Default" 377.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 378.It Va path Ta string Ta Ta 379The name of the 380.Xr netgraph 4 381destination node. 382.It Va peerhook Ta string Ta Ta 383The name of the destination hook. 384.It Va socket Ta string Ta Ta 385The name of the created 386.Xr ng_socket 4 387node. 388.It Va hook Ta string Ta vmlink Ta 389The name of the source hook on the created 390.Xr ng_socket 4 391node. 392.El 393.It netmap 394Use 395.Xr netmap 4 396either on a network interface or a port on a 397.Xr vale 4 398bridge as the backend. 399The value of 400.Va backend 401is passed to 402.Xr nm_open 403to connect to a netmap port. 404.El 405.Pp 406If 407.Va type 408is not specified explicitly, then it is inferred from 409.Va backend 410based on the following patterns: 411.Bl -column -offset indent "valuebridge:port" 412.It Sy Pattern Ta Sy Type 413.It tap Ns Va N Ta tap 414.It vmnet Ns Va N Ta tap 415.It netgraph Ta netgraph 416.It netmap: Ns Va interface Ta netmap 417.It vale Ns Va bridge : Ns Va port Ta netmap 418.El 419.Ss UART Device Settings 420.Bl -column "Name" "Format" "Default" 421.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 422.It Va path Ta path Ta Ta 423Backend device for the serial port. 424Either the pathname of a character device or 425.Dq stdio 426to use standard input and output of the 427.Xr bhyve 8 428process. 429.El 430.Ss Host Bridge Settings 431.Bl -column "pcireg.*" "integer" "Default" 432.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 433.It Va pcireg.* Ta integer Ta Ta 434Values of PCI register. 435.Bl -column "device" "Default" 436.It Sy Name Ta Sy Default 437.It Va vendor Ta integer Ta 0x1275 Ta 438.It Va device Ta integer Ta 0x1275 Ta 439.El 440.El 441.Ss AHCI Controller Settings 442AHCI controller devices contain zero or more ports each of which 443provides a storage device. 444Each port stores its settings in a node named 445.Dq port. Ns Va N 446under the controller's device node. 447The 448.Va N 449values are formatted as successive decimal values starting with 0. 450In addition to the block device settings described above, each 451port supports the following settings: 452.Bl -column "model" "integer" "generated" 453.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 454.It Va type Ta string Ta Ta 455The type of storage device to emulate. 456Must be set to either 457.Dq cd 458or 459.Dq hd . 460.It Va nmrr Ta integer Ta 0 Ta 461Nominal Media Rotation Rate, also known as RPM. 462A value 1 of indicates a device with no rate such as a Solid State Disk. 463.It Va ser Ta string Ta generated Ta 464Serial number of up to twenty characters. 465A default serial number is generated using a hash of the backing 466store's pathname. 467.It Va rev Ta string Ta 001 Ta 468Revision number of up to eight characters. 469.It Va model Ta string Ta Ta 470Model number of up to forty characters. 471Separate default model strings are used for 472.Dq cd 473and 474.Dq hd 475device types. 476.El 477.Ss e1000 Settings 478In addition to the network backend settings, 479Intel e82545 network interfaces support the following variables: 480.Bl -column "Name" "MAC address" "generated" 481.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 482.It Va mac Ta MAC address Ta generated Ta 483MAC address. 484If an explicit address is not provided, 485a MAC address is generated from a hash of the device's PCI address. 486.El 487.Ss Frame Buffer Settings 488.Bl -column "password" "[IP:]port" "127.0.0.1:5900" 489.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 490.It Va wait Ta bool Ta false Ta 491Wait for a remote connection before starting the VM. 492.It Va rfb Ta Oo Ar IP Ns : Oc Ns Ar port Ta 127.0.0.1:5900 Ta 493TCP address to listen on for remote connections. 494The IP address must be given as a numeric address. 495IPv6 addresses must be enclosed in square brackets and 496support scoped identifiers as described in 497.Xr getaddrinfo 3 . 498A bare port number may be given in which case the IPv4 499localhost address is used. 500.It Va vga Ta string Ta io Ta 501VGA configuration. 502More details are provided in 503.Xr bhyve 8 . 504.It Va w Ta integer Ta 1024 Ta 505Frame buffer width in pixels. 506.It Va h Ta integer Ta 768 Ta 507Frame buffer height in pixels. 508.It Va password Ta string Ta Ta 509Password to use for VNC authentication. 510This type of authentication is known to be cryptographically weak and is not 511intended for use on untrusted networks. 512.El 513.Ss High Definition Audio Settings 514.Bl -column "Name" "Format" "Default" 515.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 516.It Va play Ta path Ta Ta 517Host playback device, 518typically 519.Pa /dev/dsp0 . 520.It Va rec Ta path Ta Ta 521Host recording device, 522typically 523.Pa /dev/dsp0 . 524.El 525.Ss LPC Device Settings 526The LPC bridge stores its configuration under a top-level 527.Va lpc 528node rather than under the PCI LPC device's node. 529The following nodes are available under 530.Va lpc : 531.Bl -column "pc-testdev" "Format" "Default" 532.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 533.It Va bootrom Ta path Ta Ta 534Path to a boot ROM. 535The contents of this file are copied into the guest's 536memory ending just before the 4GB physical address. 537If a boot ROM is present, a firmware interface device is 538also enabled for use by the boot ROM. 539.It Va bootvars Ta path Ta Ta 540Path to boot VARS. 541The contents of this file are copied beneath the boot ROM. 542Firmware can write to it to save variables. 543All variables will be persistent even on reboots of the guest. 544.It Va com1 Ta node Ta Ta 545Settings for the COM1 serial port device. 546.It Va com2 Ta node Ta Ta 547Settings for the COM2 serial port device. 548.It Va com3 Ta node Ta Ta 549Settings for the COM3 serial port device. 550.It Va com4 Ta node Ta Ta 551Settings for the COM4 serial port device. 552.It Va fwcfg Ta string Ta bhyve Ta 553The fwcfg type to be used. 554Supported values are 555.Dq bhyve 556for fwctl and 557.Dq qemu 558for fwcfg. 559.It Va pc-testdev Ta bool Ta false Ta 560Enable the PC debug/test device. 561.It Va pcireg.* Ta integer Ta Ta 562Values of PCI register. 563It also accepts the value 564.Ar host 565to use the pci id of the host system. 566This value is required for the Intel GOP driver to work properly. 567.Bl -column "subvendor" "Default" 568.It Sy Name Ta Sy Default 569.It Va vendor Ta 0x8086 570.It Va device Ta 0x7000 571.It Va revid Ta 0 572.It Va subvendor Ta 0 573.It Va subdevice Ta 0 574.El 575.El 576.Ss NVMe Controller Settings 577Each NVMe controller supports a single storage device. 578The device can be backed either by a memory disk described by the 579.Va ram 580variable, or a block device using the block device settings described above. 581In addition, each controller supports the following settings: 582.Bl -column "ioslots" "Format" "Default" 583.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 584.It Va maxq Ta integer Ta 16 Ta 585Maximum number of I/O submission and completion queue pairs. 586.It Va qsz Ta integer Ta 2058 Ta 587Number of elements in each I/O queue. 588.It Va ioslots Ta integer Ta 8 Ta 589Maximum number of concurrent I/O requests. 590.It Va sectsz Ta integer Ta Ta 591Sector size. 592Can be one of 512, 4096, or 8192. 593Devices backed by a memory disk use 4096 as the default. 594Devices backed by a block device use the block device's sector size 595as the default. 596.It Va ser Ta string Ta Ta 597Serial number of up to twenty characters. 598A default serial number is generated using a hash of the device's PCI address. 599.It Va eui64 Ta integer Ta Ta 600IEEE Extended Unique Identifier. 601If an EUI is not provided, a default is generated using a checksum of the 602device's PCI address. 603.It Va dsm Ta string Ta auto Ta 604Whether or not to advertise DataSet Management support. 605One of 606.Dq auto , 607.Dq enable , 608or 609.Dq disable . 610The 611.Dq auto 612setting only advertises support if the backing store supports 613resource freeing, for example via TRIM. 614.It Va ram Ta integer Ta Ta 615If set, allocate a memory disk as the backing store. 616The value of this variable is the size of the memory disk in megabytes. 617.El 618.Ss PCI Passthrough Settings 619The 620.Xr ppt 4 621device driver must be attached to the 622PCI device being passed through. 623The device to pass through can be identified either by name or its 624host PCI bus location. 625.Bl -column "Name" "integer" "Default" 626.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 627.It Va bus Ta integer Ta Ta 628Host PCI bus address of device to pass through. 629.It Va slot Ta integer Ta Ta 630Host PCI slot address of device to pass through. 631.It Va func Ta integer Ta Ta 632Host PCI function address of device to pass through. 633.It Va pptdev Ta string Ta Ta 634Name of a 635.Xr ppt 4 636device to pass through. 637.It Va rom Ta path Ta Ta 638ROM file of the device which will be executed by OVMF to init the device. 639.El 640.Ss VirtIO 9p Settings 641Each VirtIO 9p device exposes a single filesystem from a host path. 642.Bl -column "sharename" "Format" "Default" 643.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 644.It Va sharename Ta string Ta Ta 645The share name exposed to the guest. 646.It Va path Ta path Ta Ta 647The path of a directory on the host to export to the guest. 648.It Va ro Ta bool Ta false Ta 649If true, the guest filesystem is read-only. 650.El 651.Ss VirtIO Block Device Settings 652In addition to the block device settings described above, each 653VirtIO block device supports the following settings: 654.Bl -column "model" "integer" "generated" 655.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 656.It Va ser Ta string Ta generated Ta 657Serial number of up to twenty characters. 658A default serial number is generated using a hash of the backing 659store's pathname. 660.El 661.Ss VirtIO Console Device Settings 662Each VirtIO Console device contains one or more console ports. 663Each port stores its settings in a node named 664.Dq port. Ns Va N 665under the controller's device node. 666The 667.Va N 668values are formatted as successive decimal values starting with 0. 669Each port supports the following settings: 670.Bl -column "Name" "Format" "Default" 671.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 672.It Va name Ta string Ta Ta 673The name of the port exposed to the guest. 674.It Va path Ta path Ta Ta 675The path of a UNIX domain socket providing the host connection for the port. 676.El 677.Ss VirtIO Input Interface Settings 678Each VirtIO Input device contains one input event device. 679All input events of the input event device are send to the guest by VirtIO Input interface. 680VirtIO Input Interfaces support the following variables: 681.Bl -column "Name" "Format" "Default" 682.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 683.It Va path Ta path Ta Ta 684The path of the input event device exposed to the guest 685.El 686.Ss VirtIO Network Interface Settings 687In addition to the network backend settings, 688VirtIO network interfaces support the following variables: 689.Bl -column "Name" "MAC address" "generated" 690.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 691.It Va mac Ta MAC address Ta generated Ta 692MAC address. 693If an explicit address is not provided, 694a MAC address is generated from a hash of the device's PCI address. 695.It Va mtu Ta integer Ta 1500 Ta 696The largest supported MTU advertised to the guest. 697.El 698.Ss VirtIO SCSI Settings 699.Bl -column "Name" "integer" "Default" 700.It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description 701.It Va dev Ta path Ta Ta 702The path of a CAM target layer (CTL) device to export: 703.Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc . 704.It Va iid Ta integer Ta 0 Ta 705Initiator ID to use when sending requests to the CTL port. 706.El 707.Sh SEE ALSO 708.Xr expand_number 3 , 709.Xr getaddrinfo 3 , 710.Xr strtol 3 , 711.Xr netgraph 4 , 712.Xr netmap 4 , 713.Xr ng_socket 4 , 714.Xr tap 4 , 715.Xr vale 4 , 716.Xr vmnet 4 , 717.Xr bhyve 8 718