summaryrefslogtreecommitdiff
path: root/docs/configuration/service
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/service')
-rw-r--r--docs/configuration/service/dhcp-server.rst38
-rw-r--r--docs/configuration/service/router-advert.rst63
2 files changed, 77 insertions, 24 deletions
diff --git a/docs/configuration/service/dhcp-server.rst b/docs/configuration/service/dhcp-server.rst
index 6813d2c0..43b5d20c 100644
--- a/docs/configuration/service/dhcp-server.rst
+++ b/docs/configuration/service/dhcp-server.rst
@@ -49,10 +49,26 @@ Configuration
Inform client that the DNS server can be found at `<address>`.
This is the configuration parameter for the entire shared network definition.
- All subnets will inherit this configuration item if not specified locally.
-
+ All subnets will inherit this configuration item if not specified locally.
Multiple DNS servers can be defined.
+.. cfgcmd:: set service dhcp-server shared-network-name <name> option
+ vendor-option <option-name>
+
+ This configuration parameter lets you specify a vendor-option for the
+ entire shared network definition. All subnets will inherit this
+ configuration item if not specified locally. An example for Ubiquiti is
+ shown below:
+
+**Example:**
+
+Pass address of Unifi controller at ``172.16.100.1`` to all clients of ``NET1``
+
+.. code-block:: none
+
+ set service dhcp-server shared-network-name 'NET1' option vendor-option
+ ubiquiti '172.16.100.1'
+
.. cfgcmd:: set service dhcp-server listen-address <address>
This configuration parameter lets the DHCP server to listen for DHCP
@@ -132,6 +148,24 @@ Individual Client Subnet
request where no full FQDN is passed. This option can be given multiple times
if you need multiple search domains (DHCP Option 119).
+.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet <subnet>
+ option vendor-option <option-name>
+
+ This configuration parameter lets you specify a vendor-option for the
+ subnet specified within the shared network definition. An example for
+ Ubiquiti is shown below:
+
+**Example:**
+
+Create ``172.18.201.0/24`` as a subnet within ``NET1`` and pass address of
+Unifi controller at ``172.16.100.1`` to clients of that subnet.
+
+.. code-block:: none
+
+ set service dhcp-server shared-network-name 'NET1' subnet
+ '172.18.201.0/24' option vendor-option ubiquiti '172.16.100.1'
+
+
Failover
--------
diff --git a/docs/configuration/service/router-advert.rst b/docs/configuration/service/router-advert.rst
index f179153a..ca558b6a 100644
--- a/docs/configuration/service/router-advert.rst
+++ b/docs/configuration/service/router-advert.rst
@@ -13,6 +13,7 @@ Supported interface types:
* bonding
* bridge
* ethernet
+ * geneve
* l2tpv3
* openvpn
* pseudo-ethernet
@@ -22,9 +23,9 @@ Supported interface types:
* wireless
* wwan
-
-Enabling Advertisments
-~~~~~~~~~~~~~~~~~~~~~~~
+*************
+Configuration
+*************
.. cfgcmd:: set service router-advert interface <interface> ...
@@ -50,7 +51,7 @@ Enabling Advertisments
Advertising a Prefix
-''''''''''''''''''''
+--------------------
.. cfgcmd:: set service router-advert interface <interface> prefix <prefix/mask>
@@ -73,30 +74,48 @@ Advertising a Prefix
.. start_vyoslinter
+Advertising a NAT64 Prefix
+--------------------------
+
+.. cfgcmd:: set service router-advert interface <interface> nat64prefix <prefix/mask>
+
+ Enable PREF64 option as outlined in :rfc:`8781`.
+
+ NAT64 prefix mask must be one of: /32, /40, /48, /56, /64 or 96.
+
+ .. note:: The well known NAT64 prefix is ``64:ff9b::/96``
+
+.. stop_vyoslinter
+
+.. csv-table::
+ :header: "VyOS Field", "Description"
+ :widths: 10,30
+
+ "valid-lifetime","Time in seconds that the prefix will remain valid (default: 65528 seconds)"
+
+.. start_vyoslinter
+
Disabling Advertisements
-~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------
To disable advertisements without deleting the configuration:
.. cfgcmd:: set service router-advert interface <interface> no-send-advert
-Example Configuration
-~~~~~~~~~~~~~~~~~~~~~
+
+*******
+Example
+*******
+
+Your LAN connected on eth0 uses prefix ``2001:db8:beef:2::/64`` with the router
+beeing ``2001:db8:beef:2::1``
.. code-block:: none
- interface eth0.2 {
- default-preference high
- hop-limit 64
- interval {
- max 600
- }
- name-server 2001:db8::1
- name-server 2001:db8::2
- other-config-flag
- prefix 2001:db8:beef:2::/64 {
- valid-lifetime 2592000
- }
- reachable-time 0
- retrans-timer 0
- }
+ set interfaces ethernet eth0 address 2001:db8:beef:2::1/64
+
+ set service router-advert interface eth0 default-preference 'high'
+ set service router-advert interface eth0 name-server '2001:db8::1'
+ set service router-advert interface eth0 name-server '2001:db8::2'
+ set service router-advert interface eth0 other-config-flag
+ set service router-advert interface eth0 prefix 2001:db8:beef:2::/64