Add some documentation starting points.

2026-05-09 17:19:48 -04:00
parent ec7ecb3dc2
commit 936c153c0c
3 changed files with 81 additions and 0 deletions
@@ -0,0 +1,39 @@
+# `add_net` Command
+
+## Name
+
+	`add_net`
+
+## Synopsis
+
+```
+	add_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 both IPv4 and (where the ISP provides for it) IPv6.
+
+	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.
+
+	The IPv6 network will make `$(( ${vlan}/10 + ${vlan}%10 ))` into hex digits
+to be appended to the ISP's IPv6 prefix.  This makes it compatible with the
+most common case of `/56` for most ISPs.  If `no_ula` is specified in the
+optional arguments, then a ULA for this network segment will not be created.
+Otherwise, the `${rc_router_network_name}` variable will be hashed and an
+ISP-like prefix of `/48` will be created to which the SLA for the specified
+network will be appended.  The `${rc_router_ula_prefix_size}` can be set to
+`/56` to specify a ULA prefix length of 56.  (No other lengths are supported
+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.