Few changes to the manpage

This commit is contained in:
Matt Churchyard
2018-06-18 08:31:44 +00:00
parent ca3ff477b7
commit 15c383fa9c

47
vm.8
View File

@@ -43,6 +43,9 @@
.Cm switch nat
.Ar name on|off
.Nm
.Cm switch address
.Ar name a.b.c.d/xx|none
.Nm
.Cm switch private
.Ar name on|off
.Nm
@@ -250,7 +253,7 @@ child dataset created for each one, specify the dataset to use in
.Pa /etc/rc.conf
as follows:
.Bd -literal -offset indent
$vm_dir="zfs:pool/dataset"
vm_dir="zfs:pool/dataset"
.Ed
.Pp
In contrast to earlier versions, if
@@ -550,40 +553,16 @@ removed from the bridge, reconfigured, then re-added.
To remove the VLAN configuration from a virtual switch, specify a
.Ar vlan-id
of 0.
.It Cm switch nat Ar name Ar on|off
Enable or disable NAT functionality on the specified switch.
Please note that
.Xr pf 4
is required for this functionality and must be enabled in
.Pa /etc/rc.conf .
If DHCP is desired, please install the
.Xr dnsmasq 8
package.
vm-bhyve will generate a sample dnsmasq configuration in
.Pa /usr/local/etc/dnsmasq.conf.bhyve ,
but it is up to the user to either use this configuration directly, or merge
with any existing dnsmasq settings you have configured.
.It Cm switch address Ar a.b.c.d/xx|none
Configure an IP address for the specified virtual switch. The address should
be specified in CIDR notation. To remove an address, specify
.Pa none
in place of the address.
.Pp
The switch should have no host ports assigned, as these will end up on the
private side of the NAT network.
.Nm
automatically detects the hosts default gateway, which is used as the
forwarding interface for NAT connections.
.Pp
Once enabled, a 172.16.X.0/24 network is assigned to the switch (bridge)
interface.
.Ar X
is chosen based on the ID of the bridge interface.
For example, if the switch is using bridge10, the network will be
172.16.10.0/24.
.Xr dnsmasq 8
can be used to provide DHCP to the guests, and
.Xr pf 4
rules are inserted to provide the NAT translation.
.Pp
.Pa /etc/pf.conf
is created if it doesn't exist, and a single include statement is added.
This include statement can be moved within the file if required.
If NAT funtionality is required, please configure an address on the switch to
become the gateway address for guests. Source NAT rules can then be created
using your choice of firewall or NAT daemon. If DHCP is desired, we recommend
using a manual switch and configuring this by hand.
.It Cm switch private Ar on|off
Enable of disable private mode for a virtual switch.
In private mode, guests will only be able to communicate with the physical