bhyve: Document the "type" config variable for network device models.

This commit is contained in:
John Baldwin 2022-06-30 15:14:36 -07:00
parent f0880ab791
commit e5ed417bb4

View File

@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd March 2, 2022
.Dd June 30, 2022
.Dt BHYVE_CONFIG 5
.Os
.Sh NAME
@ -336,16 +336,21 @@ The backend is responsible for passing packets between the device model
and a desired destination.
Configuring a backend requires setting the
.Va backend
variable to one of the following values:
.Bl -tag
.It tap Ns Va N
Use the named
variable.
The type of a backend can either be set explicitly via the
.Va type
variable
or it can be inferred from the value of
.Va backend .
.Pp
The following types of backends are supported:
.Bl -tag -width "netgraph"
.It tap
Use the
.Xr tap 4
interface as the backend.
.It vmnet Ns Va N
Use the named
.Xr vmnet 4
interface as the backend.
interface named in
.Va backend
as the backend.
.It netgraph
Use a
.Xr netgraph 4
@ -368,14 +373,31 @@ The name of the source hook on the created
.Xr ng_socket 4
node.
.El
.It netmap: Ns Va interface
.It netmap
Use
.Xr netmap 4
on a network interface as the backend.
.It vale Ns Va bridge : Ns Va port
Use a port on a
either on a network interface or a port on a
.Xr vale 4
bridge as the backend.
The value of
.Va backend
is passed to
.Xr nm_open
to connect to a netmap port.
.El
.Pp
If
.Va type
is not specified explicitly, then it is inferred from
.Va backend
based on the following patterns:
.Bl -column -offset indent "valuebridge:port"
.It Sy Pattern Ta Sy Type
.It tap Ns Va N Ta tap
.It vmnet Ns Va N Ta tap
.It netgraph Ta netgraph
.It netmap: Ns Va interface Ta netmap
.It vale Ns Va bridge : Ns Va port Ta netmap
.El
.Ss UART Device Settings
.Bl -column "Name" "Format" "Default"