diff options
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | docs/contributing/build-vyos.rst | 2 | ||||
| -rw-r--r-- | docs/routing/arp.rst | 2 | ||||
| -rw-r--r-- | docs/services/router-advert.rst | 77 |
4 files changed, 79 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ebc233b..8d769212 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ # Documentation Contribution -Please follow the guid in our documentation. It can be found here: +Please follow the guide in our documentation. It can be found here: https://docs.vyos.io/en/latest/contributing/documentation.html diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 63a45c21..5c7f5205 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -149,7 +149,7 @@ for whatever reason and you supect its a problem with APT dependencies or installation you can add this small patch which increases the APT verbosity during ISO build. -.. code-block:: Python +.. code-block:: diff diff --git i/scripts/live-build-config w/scripts/live-build-config index 1b3b454..3696e4e 100755 diff --git a/docs/routing/arp.rst b/docs/routing/arp.rst index ceecc10e..5f3115ab 100644 --- a/docs/routing/arp.rst +++ b/docs/routing/arp.rst @@ -26,7 +26,7 @@ Configure Example: - .. code-block:: + .. code-block:: none set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa diff --git a/docs/services/router-advert.rst b/docs/services/router-advert.rst index 95bd429c..ca11548f 100644 --- a/docs/services/router-advert.rst +++ b/docs/services/router-advert.rst @@ -8,7 +8,82 @@ Router Advertisements They are part of what is known as :abbr:`SLAAC (Stateless Address Autoconfiguration)`. -.. note:: placeholder section - fill me with content. + +Supported interface types: + + * bonding + * bridge + * ethernet + * l2tpv3 + * openvpn + * psuedo-ethernet + * tunnel + * vxlan + * wireguard + * wireless + * wirelessmodem + + +Enabling Advertisments +~~~~~~~~~~~~~~~~~~~~~~~ .. cfgcmd:: set service router-advert interface <interface> .... +.. csv-table:: + :header: "Field", "VyOS Option", "Description" + :widths: 10, 10, 20 + + "Cur Hop Limit", "hop-limit", "Hop count field of the outgoing RA packets" + """Managed address configuration"" flag", "managed-flag", "Tell hosts to use the administered stateful protocol (i.e. DHCP) for autoconfiguration" + """Other configuration"" flag", "other-config-flag", "Tell hosts to use the administered (stateful) protocol (i.e. DHCP) for autoconfiguration of other (non-address) information" + "MTU","link-mtu","Link MTU value placed in RAs, exluded in RAs if unset" + "Router Lifetime","default-lifetime","Lifetime associated with the default router in units of seconds" + "Reachable Time","reachable-time","Time, in milliseconds, that a node assumes a neighbor is reachable after having received a reachability confirmation" + "Retransmit Timer","retrans-timer","Time in milliseconds between retransmitted Neighbor Solicitation messages" + "Default Router Preference","default-preference","Preference associated with the default router" + "Interval", "interval", "Min and max intervals between unsolicited multicast RAs" + "DNSSL", "dnssl", "DNS search list to advertise" + "Name Server", "name-server", "Advertise DNS server per https://tools.ietf.org/html/rfc6106" + +Advertising a Prefix +'''''''''''''''''''' + +.. cfgcmd:: set service router-advert interface <interface> prefix 2001:DB8::/32 + +.. csv-table:: + :header: "VyOS Field", "Description" + :widths: 10,30 + + "no-autonomous-flag","Prefix can not be used for stateless address auto-configuration" + "no-on-link-flag","Prefix can not be used for on-link determination" + "preferred-lifetime","Time in seconds that the prefix will remain preferred (default 4 hours)" + "valid-lifetime","Time in seconds that the prefix will remain valid (default: 30 days)" + + +Disabling Advertisements +~~~~~~~~~~~~~~~~~~~~~~~~ + +To disable advertisements without deleting the configuration: + +.. cfgcmd:: set service router-advert interface <interface> no-send-advert + +Example Configuration +~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: none + + interface eth0.2 { + default-preference high + hop-limit 64 + interval { + max 600 + } + name-server 2001:4860:4860::8888 + name-server 2001:4860:4860::8844 + other-config-flag + prefix 2001:DB8:beef:2::/64 { + valid-lifetime 2592000 + } + reachable-time 0 + retrans-timer 0 + }
\ No newline at end of file |