summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-03-24 21:19:22 +0100
committerChristian Poessinger <christian@poessinger.com>2020-03-24 21:19:22 +0100
commit1992aededa71b3985a7e65d0eb7556adc4f10c57 (patch)
treec1f962fe65def07a950ed0d9a5c9e34d1346a587 /docs
parent88bfcb031aa9e0361733c89fe29ae02b12c9ed9a (diff)
downloadvyos-documentation-1992aededa71b3985a7e65d0eb7556adc4f10c57.tar.gz
vyos-documentation-1992aededa71b3985a7e65d0eb7556adc4f10c57.zip
router-advert: adjust to new CLI syntax
Diffstat (limited to 'docs')
-rw-r--r--docs/appendix/examples/tunnelbroker-ipv6.rst40
-rw-r--r--docs/interfaces/ethernet.rst14
-rw-r--r--docs/services/index.rst1
-rw-r--r--docs/services/router-advert.rst14
4 files changed, 35 insertions, 34 deletions
diff --git a/docs/appendix/examples/tunnelbroker-ipv6.rst b/docs/appendix/examples/tunnelbroker-ipv6.rst
index e66c09b9..72828292 100644
--- a/docs/appendix/examples/tunnelbroker-ipv6.rst
+++ b/docs/appendix/examples/tunnelbroker-ipv6.rst
@@ -106,11 +106,11 @@ should be replaced with the information from your `Routed /64` tunnel):
.. code-block:: none
set interfaces ethernet eth1 address '2001:470:xxxx:xxxx::1/64'
- set interfaces ethernet eth1 ipv6 router-advert name-server '2001:4860:4860::8888'
- set interfaces ethernet eth1 ipv6 router-advert name-server '2001:4860:4860::8844'
- set interfaces ethernet eth1 ipv6 router-advert prefix 2001:470:xxxx:xxxx::/64 autonomous-flag 'true'
- set interfaces ethernet eth1 ipv6 router-advert prefix 2001:470:xxxx:xxxx::/64 on-link-flag 'true'
- set interfaces ethernet eth1 ipv6 router-advert prefix 2001:470:xxxx:xxxx::/64 valid-lifetime '2592000'
+ set service router-advert interface eth1 name-server '2001:4860:4860::8888'
+ set service router-advert interface eth1 name-server '2001:4860:4860::8844'
+ set service router-advert interface eth1 prefix 2001:470:xxxx:xxxx::/64 autonomous-flag
+ set service router-advert interface eth1 prefix 2001:470:xxxx:xxxx::/64 on-link-flag
+ set service router-advert interface eth1 prefix 2001:470:xxxx:xxxx::/64 valid-lifetime '2592000'
This accomplishes a few things:
@@ -141,25 +141,25 @@ So, when your LAN is eth1, your DMZ is eth2, your cameras live on eth3, etc:
.. code-block:: none
set interfaces ethernet eth1 address '2001:470:xxxx:1::1/64'
- set interfaces ethernet eth1 ipv6 router-advert name-server '2001:4860:4860::8888'
- set interfaces ethernet eth1 ipv6 router-advert name-server '2001:4860:4860::8844'
- set interfaces ethernet eth1 ipv6 router-advert prefix 2001:470:xxxx:1::/64 autonomous-flag 'true'
- set interfaces ethernet eth1 ipv6 router-advert prefix 2001:470:xxxx:1::/64 on-link-flag 'true'
- set interfaces ethernet eth1 ipv6 router-advert prefix 2001:470:xxxx:1::/64 valid-lifetime '2592000'
+ set service router-advert interface eth1 name-server '2001:4860:4860::8888'
+ set service router-advert interface eth1 name-server '2001:4860:4860::8844'
+ set service router-advert interface eth1 prefix 2001:470:xxxx:1::/64 autonomous-flag 'true'
+ set service router-advert interface eth1 prefix 2001:470:xxxx:1::/64 on-link-flag 'true'
+ set service router-advert interface eth1 prefix 2001:470:xxxx:1::/64 valid-lifetime '2592000'
set interfaces ethernet eth2 address '2001:470:xxxx:2::1/64'
- set interfaces ethernet eth2 ipv6 router-advert name-server '2001:4860:4860::8888'
- set interfaces ethernet eth2 ipv6 router-advert name-server '2001:4860:4860::8844'
- set interfaces ethernet eth2 ipv6 router-advert prefix 2001:470:xxxx:2::/64 autonomous-flag 'true'
- set interfaces ethernet eth2 ipv6 router-advert prefix 2001:470:xxxx:2::/64 on-link-flag 'true'
- set interfaces ethernet eth2 ipv6 router-advert prefix 2001:470:xxxx:2::/64 valid-lifetime '2592000'
+ set service router-advert interface eth2 name-server '2001:4860:4860::8888'
+ set service router-advert interface eth2 name-server '2001:4860:4860::8844'
+ set service router-advert interface eth2 prefix 2001:470:xxxx:2::/64 autonomous-flag 'true'
+ set service router-advert interface eth2 prefix 2001:470:xxxx:2::/64 on-link-flag 'true'
+ set service router-advert interface eth2 prefix 2001:470:xxxx:2::/64 valid-lifetime '2592000'
set interfaces ethernet eth3 address '2001:470:xxxx:3::1/64'
- set interfaces ethernet eth3 ipv6 router-advert name-server '2001:4860:4860::8888'
- set interfaces ethernet eth3 ipv6 router-advert name-server '2001:4860:4860::8844'
- set interfaces ethernet eth3 ipv6 router-advert prefix 2001:470:xxxx:3::/64 autonomous-flag 'true'
- set interfaces ethernet eth3 ipv6 router-advert prefix 2001:470:xxxx:3::/64 on-link-flag 'true'
- set interfaces ethernet eth3 ipv6 router-advert prefix 2001:470:xxxx:3::/64 valid-lifetime '2592000'
+ set service router-advert interface eth3 name-server '2001:4860:4860::8888'
+ set service router-advert interface eth3 name-server '2001:4860:4860::8844'
+ set service router-advert interface eth3 prefix 2001:470:xxxx:3::/64 autonomous-flag 'true'
+ set service router-advert interface eth3 prefix 2001:470:xxxx:3::/64 on-link-flag 'true'
+ set service router-advert interface eth3 prefix 2001:470:xxxx:3::/64 valid-lifetime '2592000'
Firewall
========
diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst
index 295a6404..580f1914 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/interfaces/ethernet.rst
@@ -95,20 +95,6 @@ Link Administration
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
is the size (in bytes) of the largest ethernet frame sent on this link.
-Router Advertisements
----------------------
-
-Router advertisements are described in :rfc:`4861#section-4.6.2`. They are part
-of what is known as :abbr:`SLAAC (Stateless Address Autoconfiguration)`.
-
-.. cfgcmd:: set interfaces ethernet <interface> ipv6 router-advert send-advert <true | false>
-
- Enable or disable router advertisements in this `<interface>`.
-
-.. cfgcmd:: set interfaces ethernet <interface> ipv6 router-advert prefix <prefix>
-
- Prefix information is described in :rfc:`4861#section-4.6.2`.
-
Operation
=========
diff --git a/docs/services/index.rst b/docs/services/index.rst
index ed00a29b..cc6b96ae 100644
--- a/docs/services/index.rst
+++ b/docs/services/index.rst
@@ -18,6 +18,7 @@ This chapter describes the available system/network services provided by VyOS.
ipoe-server
pppoe-server
udp-broadcast-relay
+ router-advert
snmp
ssh
tftp
diff --git a/docs/services/router-advert.rst b/docs/services/router-advert.rst
new file mode 100644
index 00000000..95bd429c
--- /dev/null
+++ b/docs/services/router-advert.rst
@@ -0,0 +1,14 @@
+.. _router-advert:
+
+#####################
+Router Advertisements
+#####################
+
+:abbr:`RAs (Router advertisements)` are described in :rfc:`4861#section-4.6.2`.
+They are part of what is known as :abbr:`SLAAC (Stateless Address
+Autoconfiguration)`.
+
+.. note:: placeholder section - fill me with content.
+
+.. cfgcmd:: set service router-advert interface <interface> ....
+