summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-11-10 20:39:39 +0100
committerChristian Poessinger <christian@poessinger.com>2020-11-10 20:39:39 +0100
commita3b5c8083e6ab28378ba187ec9aa0f3ce3d101df (patch)
tree100ddfabf52ce625d2cb2f8b5c67edc2ec70ee1f
parentbe6c3c1624174c5762a1349e31111d34db642767 (diff)
downloadvyos-documentation-a3b5c8083e6ab28378ba187ec9aa0f3ce3d101df.tar.gz
vyos-documentation-a3b5c8083e6ab28378ba187ec9aa0f3ce3d101df.zip
interfaces: introduce new common-with|without-dhcp include
Now we have one single include dealing with all the common interface stuff which is present on every interface.
-rw-r--r--docs/_include/interface-common-with-dhcp.txt7
-rw-r--r--docs/_include/interface-common-without-dhcp.txt7
-rw-r--r--docs/_include/interface-common.txt11
-rw-r--r--docs/interfaces/bond.rst16
-rw-r--r--docs/interfaces/bridge.rst15
-rw-r--r--docs/interfaces/ethernet.rst14
-rw-r--r--docs/interfaces/geneve.rst6
-rw-r--r--docs/interfaces/macsec.rst14
-rw-r--r--docs/interfaces/pseudo-ethernet.rst14
-rw-r--r--docs/interfaces/vxlan.rst14
10 files changed, 33 insertions, 85 deletions
diff --git a/docs/_include/interface-common-with-dhcp.txt b/docs/_include/interface-common-with-dhcp.txt
new file mode 100644
index 00000000..34eef941
--- /dev/null
+++ b/docs/_include/interface-common-with-dhcp.txt
@@ -0,0 +1,7 @@
+.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+
+.. cmdinclude:: ../_include/interface-common.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
diff --git a/docs/_include/interface-common-without-dhcp.txt b/docs/_include/interface-common-without-dhcp.txt
new file mode 100644
index 00000000..8e995ee1
--- /dev/null
+++ b/docs/_include/interface-common-without-dhcp.txt
@@ -0,0 +1,7 @@
+.. cmdinclude:: ../_include/interface-address.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+
+.. cmdinclude:: ../_include/interface-common.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
diff --git a/docs/_include/interface-common.txt b/docs/_include/interface-common.txt
new file mode 100644
index 00000000..56d4a22e
--- /dev/null
+++ b/docs/_include/interface-common.txt
@@ -0,0 +1,11 @@
+.. cmdinclude:: ../_include/interface-description.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+
+.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
+
+.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
+ :var0: {{ var0 }}
+ :var1: {{ var1 }}
diff --git a/docs/interfaces/bond.rst b/docs/interfaces/bond.rst
index e23d2c52..6cdc08ea 100644
--- a/docs/interfaces/bond.rst
+++ b/docs/interfaces/bond.rst
@@ -16,20 +16,8 @@ Configuration
Common interface configuration
------------------------------
-.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
- :var0: bonding
- :var1: bond0
-
-.. cmdinclude:: ../_include/interface-description.txt
- :var0: bonding
- :var1: bond0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
- :var0: bonding
- :var1: bond0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
- :var0: bonding
+.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
+ :var0: bond
:var1: bond0
Link Administration
diff --git a/docs/interfaces/bridge.rst b/docs/interfaces/bridge.rst
index ec946041..a880c023 100644
--- a/docs/interfaces/bridge.rst
+++ b/docs/interfaces/bridge.rst
@@ -20,19 +20,7 @@ Configuration
Common interface configuration
------------------------------
-.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
- :var0: bridge
- :var1: br0
-
-.. cmdinclude:: ../_include/interface-description.txt
- :var0: bridge
- :var1: br0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
- :var0: bridge
- :var1: br0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
+.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
:var0: bridge
:var1: br0
@@ -40,7 +28,6 @@ Common interface configuration
MAC address aging `<time`> in seconds (default: 300).
-
.. cfgcmd:: set interfaces bridge <interface> max-age <time>
Bridge maximum aging `<time>` in seconds (default: 20).
diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst
index 424f2766..09c72ec8 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/interfaces/ethernet.rst
@@ -10,19 +10,7 @@ Configuration
Common interface configuration
------------------------------
-.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
- :var0: ethernet
- :var1: eth0
-
-.. cmdinclude:: ../_include/interface-description.txt
- :var0: ethernet
- :var1: eth0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
- :var0: ethernet
- :var1: eth0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
+.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
:var0: ethernet
:var1: eth0
diff --git a/docs/interfaces/geneve.rst b/docs/interfaces/geneve.rst
index acd22c84..8518fcf0 100644
--- a/docs/interfaces/geneve.rst
+++ b/docs/interfaces/geneve.rst
@@ -38,11 +38,7 @@ Configuration
Common interface configuration
------------------------------
-.. cmdinclude:: ../_include/interface-address.txt
- :var0: geneve
- :var1: gnv0
-
-.. cmdinclude:: ../_include/interface-description.txt
+.. cmdinclude:: ../_include/interface-common-without-dhcp.txt
:var0: geneve
:var1: gnv0
diff --git a/docs/interfaces/macsec.rst b/docs/interfaces/macsec.rst
index 8a613709..242636f1 100644
--- a/docs/interfaces/macsec.rst
+++ b/docs/interfaces/macsec.rst
@@ -19,19 +19,7 @@ Configuration
Common interface configuration
------------------------------
-.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
- :var0: macsec
- :var1: macsec0
-
-.. cmdinclude:: ../_include/interface-description.txt
- :var0: macsec
- :var1: macsec0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
- :var0: macsec
- :var1: macsec0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
+.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
:var0: macsec
:var1: macsec0
diff --git a/docs/interfaces/pseudo-ethernet.rst b/docs/interfaces/pseudo-ethernet.rst
index 7564ce76..4244284b 100644
--- a/docs/interfaces/pseudo-ethernet.rst
+++ b/docs/interfaces/pseudo-ethernet.rst
@@ -44,19 +44,7 @@ Configuration
Common interface configuration
------------------------------
-.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
- :var0: pseudo-ethernet
- :var1: peth0
-
-.. cmdinclude:: ../_include/interface-description.txt
- :var0: pseudo-ethernet
- :var1: peth0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
- :var0: pseudo-ethernet
- :var1: peth0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
+.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
:var0: pseudo-ethernet
:var1: peth0
diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst
index 5229f81c..742485dd 100644
--- a/docs/interfaces/vxlan.rst
+++ b/docs/interfaces/vxlan.rst
@@ -39,19 +39,7 @@ Configuration
Common interface configuration
------------------------------
-.. cmdinclude:: ../_include/interface-address.txt
- :var0: vxlan
- :var1: vxlan0
-
-.. cmdinclude:: ../_include/interface-description.txt
- :var0: vxlan
- :var1: vxlan0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
- :var0: vxlan
- :var1: vxlan0
-
-.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
+.. cmdinclude:: ../_include/interface-common-without-dhcp.txt
:var0: vxlan
:var1: vxlan0