vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

interface: move mac and mtu documentation to common file

Browse Source
This commit is contained in:
Christian Poessinger 2020-11-10 21:42:38 +01:00
parent ab3552884e
commit f6ee81e582
12 changed files with 42 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/_include/interface-common.txt
View File

@ -2,6 +2,18 @@
:var0: {{ var0 }} :var0: {{ var0 }}
:var1: {{ var1 }} :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 .. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
:var0: {{ var0 }} :var0: {{ var0 }}
:var1: {{ var1 }} :var1: {{ var1 }}

10
docs/_include/interface-disable.txt Normal file
View File

@ -0,0 +1,10 @@
.. cfgcmd:: set interfaces {{ var0 }} <interface> disable
Disable given `<interface>`. It will be placed in administratively down
(``A/D``) state.
Example:
.. code-block:: none
set interfaces {{ var0 }} {{ var1 }} disable

10
docs/_include/interface-mac.txt Normal file
View File

@ -0,0 +1,10 @@
.. cfgcmd:: set interfaces {{ var0 }} <interface> mac <xx:xx:xx:xx:xx:xx>
Configure user defined :abbr:`MAC (Media Access Control)` address on given
`<interface>`.
Example:
.. code-block:: none
set interfaces {{ var0 }} {{ var1 }} mac '00:01:02:03:04:05'

10
docs/_include/interface-mtu.txt Normal file
View File

@ -0,0 +1,10 @@
.. cfgcmd:: set interfaces {{ var0 }} <interface> mtu <mtu>
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. 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

16
docs/interfaces/bond.rst
View File

@ -23,22 +23,6 @@ Common interface configuration
Link Administration Link Administration
------------------- -------------------
.. cfgcmd:: set interfaces bonding <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
.. cfgcmd:: set interfaces bonding <interface> disable
Disable given `<interface>`. It will be placed in administratively down
(``A/D``) state.
.. cfgcmd:: set interfaces bonding <interface> mac <mac-address>
Configure user defined :abbr:`MAC (Media Access Control)` address on given
`<interface>`.
.. cfgcmd:: set interfaces bonding <interface> mode <mode> .. cfgcmd:: set interfaces bonding <interface> mode <mode>
Specifies one of the bonding policies. The default is 802.3ad. Possible Specifies one of the bonding policies. The default is 802.3ad. Possible

21
docs/interfaces/bridge.rst
View File

@ -39,35 +39,14 @@ Common interface configuration
Link Administration Link Administration
------------------- -------------------
.. cfgcmd:: set interfaces bridge <interface> description <description>
Assign given `<description>` to interface. Description will also be
passed to SNMP monitoring systems.
.. cfgcmd:: set interfaces bridge <interface> disable
Disable given `<interface>`. It will be placed in administratively
down (``A/D``) state.
.. cfgcmd:: set interfaces bridge <interface> disable-flow-control .. cfgcmd:: set interfaces bridge <interface> disable-flow-control
Disable Ethernet flow control (pause frames). Disable Ethernet flow control (pause frames).
.. cfgcmd:: set interfaces bridge <interface> mac <mac-address>
Configure user defined :abbr:`MAC (Media Access Control)` address on
given `<interface>`.
.. cfgcmd:: set interfaces bridge <interface> igmp querier .. cfgcmd:: set interfaces bridge <interface> igmp querier
Enable IGMP querier Enable IGMP querier
Member Interfaces Member Interfaces
----------------- -----------------

13
docs/interfaces/dummy.rst
View File

@ -33,19 +33,6 @@ Common interface configuration
:var0: dummy :var0: dummy
:var1: dum0 :var1: dum0
Link Administration
-------------------
.. cfgcmd:: set interfaces dummy <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
.. cfgcmd:: set interfaces dummy <interface> disable
Disable given `<interface>`. It will be placed in administratively down
state.
Operation Operation
========= =========

21
docs/interfaces/ethernet.rst
View File

@ -48,32 +48,11 @@ Speed/Duplex
Link Administration Link Administration
------------------- -------------------
.. cfgcmd:: set interfaces ethernet <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
.. cfgcmd:: set interfaces ethernet <interface> disable
Disable given `<interface>`. It will be placed in administratively down
(``A/D``) state.
.. cfgcmd:: set interfaces ethernet <interface> disable-flow-control .. cfgcmd:: set interfaces ethernet <interface> disable-flow-control
Disable Ethernet flow control (pause frames). Disable Ethernet flow control (pause frames).
.. cfgcmd:: set interfaces ethernet <interface> mac <mac-address>
Configure user defined :abbr:`MAC (Media Access Control)` address on given
`<interface>`.
.. cfgcmd:: set interfaces ethernet <interface> mtu <mtu>
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
is the size (in bytes) of the largest ethernet frame sent on this link.
Operation Operation
========= =========

8
docs/interfaces/loopback.rst
View File

@ -33,14 +33,6 @@ Common interface configuration
:var0: loopback :var0: loopback
:var1: lo :var1: lo
Link Administration
-------------------
.. cfgcmd:: set interfaces loopback lo description <description>
Assign given `<description>` to interface `lo`. Description will also be
passed to SNMP monitoring systems.
Operation Operation
========= =========

19
docs/interfaces/pseudo-ethernet.rst
View File

@ -55,22 +55,3 @@ Physical Asignment
Specifies the physical `<ethX>` Ethernet interface associated with a Pseudo Specifies the physical `<ethX>` Ethernet interface associated with a Pseudo
Ethernet `<interface>`. Ethernet `<interface>`.
Link Administration
-------------------
.. cfgcmd:: set interfaces pseudo-ethernet <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
.. cfgcmd:: set interfaces pseudo-ethernet <interface> disable
Disable given `<interface>`. It will be placed in administratively down
(``A/D``) state.
.. cfgcmd:: set interfaces pseudo-ethernet <interface> mac <mac-address>
Configure user defined :abbr:`MAC (Media Access Control)` address on given
`<interface>`.

21
docs/interfaces/vxlan.rst
View File

@ -90,27 +90,6 @@ L2VVPN / EVPN
Source IP address used for VXLAN underlay. This is mandatory when using Source IP address used for VXLAN underlay. This is mandatory when using
VXLAN via L2VPN/EVPN. VXLAN via L2VPN/EVPN.
Link Administration
-------------------
.. cfgcmd:: set interfaces vxlan <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
.. cfgcmd:: set interfaces vxlan <interface> disable
Disable given `<interface>`. It will be placed in administratively down
(``A/D``) state.
.. cfgcmd:: set interfaces vxlan <interface> mtu <mtu>
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. 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 Multicast VXLAN
=============== ===============

18
docs/interfaces/wirelessmodem.rst
View File

@ -51,24 +51,6 @@ Address
connection is established at boot time and remains up. If the link fails for connection is established at boot time and remains up. If the link fails for
any reason, the link is brought back up immediately. any reason, the link is brought back up immediately.
Link Administration
-------------------
.. cfgcmd:: set interfaces wirelessmodem <interface> description <description>
Assign given `<description>` to interface. Description will also be passed
to SNMP monitoring systems.
.. cfgcmd:: set interfaces wirelessmodem <interface> disable
Disable given `<interface>`. It will be placed in administratively down
state.
.. cfgcmd:: set interfaces wirelessmodem <interface> mtu <mtu>
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
is the size (in bytes) of the largest ethernet frame sent on this link.
Example Example
======= =======