Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/bhyve/bhyve_config.5
| .\" SPDX-License-Identifier: BSD-2-Clause | .\" SPDX-License-Identifier: BSD-2-Clause | ||||
| .\" | .\" | ||||
| .\" Copyright (c) 2021 John H. Baldwin <jhb@FreeBSD.org> | .\" Copyright (c) 2021 John H. Baldwin <jhb@FreeBSD.org> | ||||
| .\" Copyright 2025 Hans Rosenfeld | |||||
| .\" | .\" | ||||
| .\" Redistribution and use in source and binary forms, with or without | .\" Redistribution and use in source and binary forms, with or without | ||||
| .\" modification, are permitted provided that the following conditions | .\" modification, are permitted provided that the following conditions | ||||
| .\" are met: | .\" are met: | ||||
| .\" 1. Redistributions of source code must retain the above copyright | .\" 1. Redistributions of source code must retain the above copyright | ||||
| .\" notice, this list of conditions and the following disclaimer. | .\" notice, this list of conditions and the following disclaimer. | ||||
| .\" 2. Redistributions in binary form must reproduce the above copyright | .\" 2. Redistributions in binary form must reproduce the above copyright | ||||
| .\" notice, this list of conditions and the following disclaimer in the | .\" notice, this list of conditions and the following disclaimer in the | ||||
| .\" documentation and/or other materials provided with the distribution. | .\" documentation and/or other materials provided with the distribution. | ||||
| .\" | .\" | ||||
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | ||||
| .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||||
| .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||||
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | ||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .Dd August 21, 2024 | .Dd October 20, 2025 | ||||
| .Dt BHYVE_CONFIG 5 | .Dt BHYVE_CONFIG 5 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm bhyve_config | .Nm bhyve_config | ||||
| .Nd "bhyve configuration variables" | .Nd "bhyve configuration variables" | ||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| .Xr bhyve 8 | .Xr bhyve 8 | ||||
| uses a hierarchical tree of configuration variables to describe global and | uses a hierarchical tree of configuration variables to describe global and | ||||
| ▲ Show 20 Lines • Show All 711 Lines • ▼ Show 20 Lines | |||||
| .It Va mac Ta MAC address Ta generated Ta | .It Va mac Ta MAC address Ta generated Ta | ||||
| MAC address. | MAC address. | ||||
| If an explicit address is not provided, | If an explicit address is not provided, | ||||
| a MAC address is generated from a hash of the device's PCI address. | a MAC address is generated from a hash of the device's PCI address. | ||||
| .It Va mtu Ta integer Ta 1500 Ta | .It Va mtu Ta integer Ta 1500 Ta | ||||
| The largest supported MTU advertised to the guest. | The largest supported MTU advertised to the guest. | ||||
| .El | .El | ||||
| .Ss VirtIO SCSI Settings | .Ss VirtIO SCSI Settings | ||||
| .Bl -column "Name" "integer" "Default" | .Bl -column "target" "integer" "/dev/cam/ctl" | ||||
| .It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description | .It Sy Name Ta Sy Format Ta Sy Default Ta Sy Description | ||||
| .It Va dev Ta path Ta Ta | |||||
| The path of a CAM target layer (CTL) device to export: | |||||
| .Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc . | |||||
| .It Va iid Ta integer Ta 0 Ta | .It Va iid Ta integer Ta 0 Ta | ||||
| Initiator ID to use when sending requests to the CTL port. | Initiator ID to use when sending requests to the CTL port. | ||||
| .It Va target Ta Oo Va ID : Oc Ns path Ta Sy /dev/cam/ctl Ta | |||||
| The path of a CAM target layer (CTL) device to use: | |||||
| .Pa /dev/cam/ctl Ns Oo Ar pp . Ns Ar vp Oc | |||||
| Optionally, a numeric target | |||||
| .Ar ID | |||||
| in the range from 0 to 255 may be specified before the | |||||
| .Ar path , | |||||
| separated by a colon. | |||||
| .El | .El | ||||
| .Pp | |||||
| The | |||||
| .Va target | |||||
| variable may be specified multiple times with different | |||||
| .Ar path | |||||
| arguments to configure multiple distinct SCSI targets. | |||||
| If not explicitly configured, the target | |||||
| .Ar ID Ns s | |||||
| will be assigned sequentially beginning with the highest target | |||||
| .Ar ID | |||||
| configured so far, or 0 for the first target configured. | |||||
| The target | |||||
| .Ar ID Ns s | |||||
| must be unique within each virtio-scsi instance. | |||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr expand_number 3 , | .Xr expand_number 3 , | ||||
| .Xr getaddrinfo 3 , | .Xr getaddrinfo 3 , | ||||
| .Xr strtol 3 , | .Xr strtol 3 , | ||||
| .Xr netgraph 4 , | .Xr netgraph 4 , | ||||
| .Xr netmap 4 , | .Xr netmap 4 , | ||||
| .Xr ng_socket 4 , | .Xr ng_socket 4 , | ||||
| .Xr tap 4 , | .Xr tap 4 , | ||||
| .Xr vale 4 , | .Xr vale 4 , | ||||
| .Xr vmnet 4 , | .Xr vmnet 4 , | ||||
| .Xr bhyve 8 | .Xr bhyve 8 | ||||