Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/bhyve/bhyve.8
| .\" Copyright (c) 2013 Peter Grehan | .\" Copyright (c) 2013 Peter Grehan | ||||||||
| .\" Copyright 2025 Hans Rosenfeld | |||||||||
| .\" All rights reserved. | .\" All rights reserved. | ||||||||
| .\" | .\" | ||||||||
| .\" 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 AUTHORS AND CONTRIBUTORS ``AS IS'' AND | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS OR CONTRIBUTORS BE LIABLE | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS 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 8 | .Dt BHYVE 8 | ||||||||
| .Os | .Os | ||||||||
| .Sh NAME | .Sh NAME | ||||||||
| .Nm bhyve | .Nm bhyve | ||||||||
| .Nd "run a guest operating system inside a virtual machine" | .Nd "run a guest operating system inside a virtual machine" | ||||||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||||||
| .Nm | .Nm | ||||||||
| .Op Fl aCDeHhPSuWwxY | .Op Fl aCDeHhPSuWwxY | ||||||||
| ▲ Show 20 Lines • Show All 587 Lines • ▼ Show 20 Lines | |||||||||
| A fwcfg file is used to specify the bootorder. | A fwcfg file is used to specify the bootorder. | ||||||||
| The guest firmware may ignore or doesn't support this fwcfg file. | The guest firmware may ignore or doesn't support this fwcfg file. | ||||||||
| In that case, this feature doesn't work as expected. | In that case, this feature doesn't work as expected. | ||||||||
| .El | .El | ||||||||
| .Ss SCSI device backends | .Ss SCSI device backends | ||||||||
| .Bl -bullet | .Bl -bullet | ||||||||
| .Sm off | .Sm off | ||||||||
| .It | .It | ||||||||
| .Pa /dev/cam/ctl Oo Ar pp Cm \&. Ar vp Oc Oo Cm \&, Ar scsi-device-options Oc | .Oo Cm target Ns = Ns Oo ID : Oc Ar /dev/cam/ctl Oo Ar pp Cm \&. Ar vp Oc Oc | ||||||||
| .Oo Cm \&, Ar scsi-device-options Oc | |||||||||
| .Sm on | .Sm on | ||||||||
| .El | .El | ||||||||
| .Pp | |||||||||
| Multiple | |||||||||
| .Pa target | |||||||||
| parameters may be specified, each configuring a different | |||||||||
| .Ar path | |||||||||
| as distinct SCSI target. | |||||||||
markjUnsubmitted Not Done Inline Actions
markj: | |||||||||
| If the | |||||||||
| .Pa target | |||||||||
| .Ar ID | |||||||||
| is not explicitly configured for a | |||||||||
| .Pa target , | |||||||||
| the | |||||||||
| .Pa target | |||||||||
| will be assigned the next sequential | |||||||||
| .Ar ID | |||||||||
| following the highest | |||||||||
| .Pa target | |||||||||
| .Ar ID | |||||||||
| used at that point, or 0 if it is the first target configured. | |||||||||
| All | |||||||||
| .Pa target | |||||||||
| .Ar ID Ns s | |||||||||
| must be unique per instance. | |||||||||
| The | |||||||||
| .Ar path | |||||||||
| must point to a valid CAM target layer | |||||||||
| .Po CTL | |||||||||
| .Pc | |||||||||
| device node. | |||||||||
| If no | |||||||||
| .Pa target | |||||||||
| is configured, a single default target backed by | |||||||||
| .Sy /dev/cam/ctl | |||||||||
| will be created. | |||||||||
| .Pp | .Pp | ||||||||
| The | The | ||||||||
| .Ar scsi-device-options | .Ar scsi-device-options | ||||||||
| are: | are: | ||||||||
| .Bl -tag -width 10n | .Bl -tag -width 10n | ||||||||
| .It Cm iid= Ns Ar IID | .It Cm iid= Ns Ar IID | ||||||||
| Initiator ID to use when sending requests to specified CTL port. | Initiator ID to use when sending requests to specified CTL port. | ||||||||
| The default value is 0. | The default value is 0. | ||||||||
| ▲ Show 20 Lines • Show All 664 Lines • Show Last 20 Lines | |||||||||