diff --git a/docs/add_net.md b/docs/add_net.md index 3c326e8..0dec2a9 100644 --- a/docs/add_net.md +++ b/docs/add_net.md @@ -2,12 +2,12 @@ ## Name - `add_net` +`add_net` ## Synopsis ``` - add_net ${card} ${vlan} ${group} [{no_ula|isp=abc|no_isp}...] +add_net ${card} ${vlan} ${group} [{no_ula|isp=abc|no_isp}...] ``` ## Description @@ -37,3 +37,12 @@ at this time.) The `isp=...` flag can be used to assign the specified subnet to be part of the `IA_PD` list for the specified ISP. The `no_isp` flag can be used to skip provisioning the specified network with any ISP's DHCPv6 `IA_PD` request. + +This calls [`add_v4_net`](add_v4_net.md) and [`add_v6_net`](add_v6_net.md) and +passes all of its arguments. + +## See Also + + - [`add_v4_net`](add_v4_net.md) + - [`add_v6_net`](add_v6_net.md) + - [`add_vlan`](add_vlan.md) diff --git a/docs/add_v4_net.md b/docs/add_v4_net.md new file mode 100644 index 0000000..28a7c4b --- /dev/null +++ b/docs/add_v4_net.md @@ -0,0 +1,34 @@ +# `add_v4_net` Command + +## Name + +`add_v4_net` + +## Synopsis + +``` +add_v4_net ${card} ${vlan} ${group} [{no_ula|isp=abc|no_isp}...] +``` + +## Description + +Adds an internal network segment with the specified vlan on the specified +card. The created vlan-adaptor is put into the specified group. It is setup +for IPv4. + +The IPv4 network will be a `/24` under `${v4_net_xy0}` if `${card}` is +`xy0`, for example. If `${v4_net_xy0}` is not set, then `${v4_net}` is +used by default. The 3rd octet will be `$(( ${vlan}/10 + ${vlan}%10 ))`. For +example, if `${vlan}` is `102` and `${v4_net}` is `172.18`, then the configured +v4 network will be `172.18.12.0/24` and the router will hold address +`172.18.12.1`. By default, IPv4 network DHCP configuration is enabled and +the range `.100` to `.200` will be used as a dynamic allocation pool. + +Internally, this will call [`add_vlan`](add_vlan.md), passing it `${card}` and +`${vlan}`. + +## See Also + + - [`add_net`](add_net.md) + - [`add_v6_net`](add_v6_net.md) + - [`add_vlan`](add_vlan.md) diff --git a/docs/add_v6_net.md b/docs/add_v6_net.md index f54cedc..00084c8 100644 --- a/docs/add_v6_net.md +++ b/docs/add_v6_net.md @@ -2,7 +2,7 @@ ## Name - `add_v6_net` +`add_v6_net` ## Synopsis @@ -33,3 +33,12 @@ skip provisioning the specified network with any ISP's DHCPv6 `IA_PD` request. Any desired explicit `/64` static prefixes can be configured on this network segment, after all other options. The router will provision itself as `...::1` on those prefixes. + +Internally, this will call [`add_vlan`](add_vlan.md), passing it `${card}` and +`${vlan}`. + +## See Also + + - [`add_net`](add_net.md) + - [`add_v4_net`](add_v4_net.md) + - [`add_vlan`](add_vlan.md) diff --git a/docs/add_vlan.md b/docs/add_vlan.md new file mode 100644 index 0000000..401dae4 --- /dev/null +++ b/docs/add_vlan.md @@ -0,0 +1,26 @@ +# `add_vlan` Command + +## Name + +`add_vlan` + +## Synopsis + +``` +add_vlan ${card} ${vlan} +``` + +## Description + +Adds an internal network segment with the specified vlan on the specified +card. For example, `add_vlan xy0 123` has the effect of +`vlans_xy0="${vlans_xy0} 123"`. + +The internal implementation prevents adding duplicate VLAN ID's to the same +adaptor, by checking for their presence before adding. It can safely be +used alongside manual changes to `rc.conf` changes to these variables. + +## See Also + - [`add_net`](add_net.md) + - [`add_v4_net`](add_v4_net.md) + - [`add_v6_net`](add_v6_net.md)