From f6ee81e58268ce1a666f68504f327f49c4402130 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Tue, 10 Nov 2020 21:42:38 +0100 Subject: interface: move mac and mtu documentation to common file --- docs/_include/interface-common.txt | 12 ++++++++++++ docs/_include/interface-disable.txt | 10 ++++++++++ docs/_include/interface-mac.txt | 10 ++++++++++ docs/_include/interface-mtu.txt | 10 ++++++++++ docs/interfaces/bond.rst | 16 ---------------- docs/interfaces/bridge.rst | 21 --------------------- docs/interfaces/dummy.rst | 13 ------------- docs/interfaces/ethernet.rst | 21 --------------------- docs/interfaces/loopback.rst | 8 -------- docs/interfaces/pseudo-ethernet.rst | 19 ------------------- docs/interfaces/vxlan.rst | 21 --------------------- docs/interfaces/wirelessmodem.rst | 18 ------------------ 12 files changed, 42 insertions(+), 137 deletions(-) create mode 100644 docs/_include/interface-disable.txt create mode 100644 docs/_include/interface-mac.txt create mode 100644 docs/_include/interface-mtu.txt (limited to 'docs') diff --git a/docs/_include/interface-common.txt b/docs/_include/interface-common.txt index 56d4a22e..052088df 100644 --- a/docs/_include/interface-common.txt +++ b/docs/_include/interface-common.txt @@ -2,6 +2,18 @@ :var0: {{ var0 }} :var1: {{ var1 }} +.. cmdinclude:: ../_include/interface-disable.txt + :var0: {{ var0 }} + :var1: {{ var1 }} + +.. cmdinclude:: ../_include/interface-mac.txt + :var0: {{ var0 }} + :var1: {{ var1 }} + +.. cmdinclude:: ../_include/interface-mtu.txt + :var0: {{ var0 }} + :var1: {{ var1 }} + .. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt :var0: {{ var0 }} :var1: {{ var1 }} diff --git a/docs/_include/interface-disable.txt b/docs/_include/interface-disable.txt new file mode 100644 index 00000000..83ef3e53 --- /dev/null +++ b/docs/_include/interface-disable.txt @@ -0,0 +1,10 @@ +.. cfgcmd:: set interfaces {{ var0 }} disable + + Disable given ``. It will be placed in administratively down + (``A/D``) state. + + Example: + + .. code-block:: none + + set interfaces {{ var0 }} {{ var1 }} disable \ No newline at end of file diff --git a/docs/_include/interface-mac.txt b/docs/_include/interface-mac.txt new file mode 100644 index 00000000..29157555 --- /dev/null +++ b/docs/_include/interface-mac.txt @@ -0,0 +1,10 @@ +.. cfgcmd:: set interfaces {{ var0 }} mac + + Configure user defined :abbr:`MAC (Media Access Control)` address on given + ``. + + Example: + + .. code-block:: none + + set interfaces {{ var0 }} {{ var1 }} mac '00:01:02:03:04:05' \ No newline at end of file diff --git a/docs/_include/interface-mtu.txt b/docs/_include/interface-mtu.txt new file mode 100644 index 00000000..e727c3e9 --- /dev/null +++ b/docs/_include/interface-mtu.txt @@ -0,0 +1,10 @@ +.. cfgcmd:: set interfaces {{ var0 }} mtu + + Configure :abbr:`MTU (Maximum Transmission Unit)` on given ``. It + is the size (in bytes) of the largest ethernet frame sent on this link. + + Example: + + .. code-block:: none + + set interfaces {{ var0 }} {{ var1 }} mtu 1450 \ No newline at end of file diff --git a/docs/interfaces/bond.rst b/docs/interfaces/bond.rst index 6cdc08ea..4565eafc 100644 --- a/docs/interfaces/bond.rst +++ b/docs/interfaces/bond.rst @@ -23,22 +23,6 @@ Common interface configuration Link Administration ------------------- -.. cfgcmd:: set interfaces bonding description - - Assign given `` to interface. Description will also be passed - to SNMP monitoring systems. - - -.. cfgcmd:: set interfaces bonding disable - - Disable given ``. It will be placed in administratively down - (``A/D``) state. - -.. cfgcmd:: set interfaces bonding mac - - Configure user defined :abbr:`MAC (Media Access Control)` address on given - ``. - .. cfgcmd:: set interfaces bonding mode Specifies one of the bonding policies. The default is 802.3ad. Possible diff --git a/docs/interfaces/bridge.rst b/docs/interfaces/bridge.rst index a880c023..8704d334 100644 --- a/docs/interfaces/bridge.rst +++ b/docs/interfaces/bridge.rst @@ -39,35 +39,14 @@ Common interface configuration Link Administration ------------------- -.. cfgcmd:: set interfaces bridge description - - Assign given `` to interface. Description will also be - passed to SNMP monitoring systems. - - -.. cfgcmd:: set interfaces bridge disable - - Disable given ``. It will be placed in administratively - down (``A/D``) state. - - .. cfgcmd:: set interfaces bridge disable-flow-control Disable Ethernet flow control (pause frames). - -.. cfgcmd:: set interfaces bridge mac - - Configure user defined :abbr:`MAC (Media Access Control)` address on - given ``. - - .. cfgcmd:: set interfaces bridge igmp querier Enable IGMP querier - - Member Interfaces ----------------- diff --git a/docs/interfaces/dummy.rst b/docs/interfaces/dummy.rst index 02680f90..a3989138 100644 --- a/docs/interfaces/dummy.rst +++ b/docs/interfaces/dummy.rst @@ -33,19 +33,6 @@ Common interface configuration :var0: dummy :var1: dum0 -Link Administration -------------------- - -.. cfgcmd:: set interfaces dummy description - - Assign given `` to interface. Description will also be passed - to SNMP monitoring systems. - -.. cfgcmd:: set interfaces dummy disable - - Disable given ``. It will be placed in administratively down - state. - Operation ========= diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst index cdf3622c..578ac517 100644 --- a/docs/interfaces/ethernet.rst +++ b/docs/interfaces/ethernet.rst @@ -48,32 +48,11 @@ Speed/Duplex Link Administration ------------------- -.. cfgcmd:: set interfaces ethernet description - - Assign given `` to interface. Description will also be passed - to SNMP monitoring systems. - -.. cfgcmd:: set interfaces ethernet disable - - Disable given ``. It will be placed in administratively down - (``A/D``) state. - .. cfgcmd:: set interfaces ethernet disable-flow-control Disable Ethernet flow control (pause frames). -.. cfgcmd:: set interfaces ethernet mac - - Configure user defined :abbr:`MAC (Media Access Control)` address on given - ``. - -.. cfgcmd:: set interfaces ethernet mtu - - Configure :abbr:`MTU (Maximum Transmission Unit)` on given ``. It - is the size (in bytes) of the largest ethernet frame sent on this link. - - Operation ========= diff --git a/docs/interfaces/loopback.rst b/docs/interfaces/loopback.rst index 06486faa..ed241eb2 100644 --- a/docs/interfaces/loopback.rst +++ b/docs/interfaces/loopback.rst @@ -33,14 +33,6 @@ Common interface configuration :var0: loopback :var1: lo -Link Administration -------------------- - -.. cfgcmd:: set interfaces loopback lo description - - Assign given `` to interface `lo`. Description will also be - passed to SNMP monitoring systems. - Operation ========= diff --git a/docs/interfaces/pseudo-ethernet.rst b/docs/interfaces/pseudo-ethernet.rst index 4244284b..52ba789b 100644 --- a/docs/interfaces/pseudo-ethernet.rst +++ b/docs/interfaces/pseudo-ethernet.rst @@ -55,22 +55,3 @@ Physical Asignment Specifies the physical `` Ethernet interface associated with a Pseudo Ethernet ``. - -Link Administration -------------------- - -.. cfgcmd:: set interfaces pseudo-ethernet description - - Assign given `` to interface. Description will also be passed - to SNMP monitoring systems. - -.. cfgcmd:: set interfaces pseudo-ethernet disable - - Disable given ``. It will be placed in administratively down - (``A/D``) state. - -.. cfgcmd:: set interfaces pseudo-ethernet mac - - Configure user defined :abbr:`MAC (Media Access Control)` address on given - ``. - diff --git a/docs/interfaces/vxlan.rst b/docs/interfaces/vxlan.rst index 742485dd..5ecfeb0a 100644 --- a/docs/interfaces/vxlan.rst +++ b/docs/interfaces/vxlan.rst @@ -90,27 +90,6 @@ L2VVPN / EVPN Source IP address used for VXLAN underlay. This is mandatory when using VXLAN via L2VPN/EVPN. - -Link Administration -------------------- - -.. cfgcmd:: set interfaces vxlan description - - Assign given `` to interface. Description will also be passed - to SNMP monitoring systems. - -.. cfgcmd:: set interfaces vxlan disable - - Disable given ``. It will be placed in administratively down - (``A/D``) state. - -.. cfgcmd:: set interfaces vxlan mtu - - Configure :abbr:`MTU (Maximum Transmission Unit)` on given ``. It - is the size (in bytes) of the largest ethernet frame sent on this link. - MTU ranges from 1450 to 9000 bytes. For best performance you should have - a MTU > 1550 bytes on your underlay. - Multicast VXLAN =============== diff --git a/docs/interfaces/wirelessmodem.rst b/docs/interfaces/wirelessmodem.rst index 5e2eac40..eabb17b9 100644 --- a/docs/interfaces/wirelessmodem.rst +++ b/docs/interfaces/wirelessmodem.rst @@ -51,24 +51,6 @@ Address connection is established at boot time and remains up. If the link fails for any reason, the link is brought back up immediately. -Link Administration -------------------- - -.. cfgcmd:: set interfaces wirelessmodem description - - Assign given `` to interface. Description will also be passed - to SNMP monitoring systems. - -.. cfgcmd:: set interfaces wirelessmodem disable - - Disable given ``. It will be placed in administratively down - state. - -.. cfgcmd:: set interfaces wirelessmodem mtu - - Configure :abbr:`MTU (Maximum Transmission Unit)` on given ``. It - is the size (in bytes) of the largest ethernet frame sent on this link. - Example ======= -- cgit v1.2.3