diff options
| -rw-r--r-- | docs/_include/common-references.txt | 5 | ||||
| -rw-r--r-- | docs/_include/interface-dhcpv6-prefix-delegation.txt | 11 | ||||
| -rw-r--r-- | docs/_include/interface-disable-flow-control.txt | 9 | ||||
| -rw-r--r-- | docs/_include/interface-mirror.txt | 25 | ||||
| -rw-r--r-- | docs/_include/interface-vlan-8021q.txt | 24 |
5 files changed, 46 insertions, 28 deletions
diff --git a/docs/_include/common-references.txt b/docs/_include/common-references.txt index 79881972..de4f76e7 100644 --- a/docs/_include/common-references.txt +++ b/docs/_include/common-references.txt @@ -1,6 +1,9 @@ +.. stop_vyoslinter + .. _`accel-ppp`: https://accel-ppp.org/ .. _`Secure Socket Tunneling Protocol`: https://en.wikipedia.org/wiki/Secure_Socket_Tunneling_Protocol .. _Phabricator: https://phabricator.vyos.net/ - .. _802.1ad: https://en.wikipedia.org/wiki/IEEE_802.1ad .. _802.1q: https://en.wikipedia.org/wiki/IEEE_802.1Q + +.. start_vyoslinter
\ No newline at end of file diff --git a/docs/_include/interface-dhcpv6-prefix-delegation.txt b/docs/_include/interface-dhcpv6-prefix-delegation.txt index 6a001949..1ef94c14 100644 --- a/docs/_include/interface-dhcpv6-prefix-delegation.txt +++ b/docs/_include/interface-dhcpv6-prefix-delegation.txt @@ -1,7 +1,8 @@ **DHCPv6 Prefix Delegation (PD)** VyOS 1.3 (equuleus) supports DHCPv6-PD (:rfc:`3633`). DHCPv6 Prefix Delegation -is supported by most ISPs who provide native IPv6 for consumers on fixed networks. +is supported by most ISPs who provide native IPv6 for consumers on fixed +networks. .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var5 }} {{ var6 }} dhcpv6-options pd <id> length <length> @@ -20,7 +21,8 @@ is supported by most ISPs who provide native IPv6 for consumers on fixed network set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options pd 0 length 56 .. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} - {{ var5 }} {{ var6 }} dhcpv6-options pd <id> interface <delegatee> address <address> + {{ var5 }} {{ var6 }} dhcpv6-options pd <id> interface <delegatee> + address <address> Specify the interface address used locally on the interfcae where the prefix has been delegated to. ID must be a decimal integer. @@ -29,10 +31,15 @@ is supported by most ISPs who provide native IPv6 for consumers on fixed network complete interface address. The default is to use the EUI-64 address of the interface. + .. stop_vyoslinter + Example: Delegate a /64 prefix to interface eth8 which will use a local address on this router of ``<prefix>::ffff``, as the address 65534 will correspond to ``ffff`` in hexadecimal notation. + .. start_vyoslinter + + .. code-block:: none set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options pd 0 interface eth8 address 65534 diff --git a/docs/_include/interface-disable-flow-control.txt b/docs/_include/interface-disable-flow-control.txt index 2b319b22..347f1145 100644 --- a/docs/_include/interface-disable-flow-control.txt +++ b/docs/_include/interface-disable-flow-control.txt @@ -1,4 +1,5 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} disable-flow-control +.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} + disable-flow-control Ethernet flow control is a mechanism for temporarily stopping the transmission of data on Ethernet family computer networks. The goal of this mechanism is to @@ -8,9 +9,9 @@ 802.3x standard. A sending station (computer or network switch) may be transmitting data faster - than the other end of the link can accept it. Using flow control, the receiving - station can signal the sender requesting suspension of transmissions until the - receiver catches up. + than the other end of the link can accept it. Using flow control, the + receiving station can signal the sender requesting suspension of + transmissions until the receiver catches up. Use this command to disable the generation of Ethernet flow control (pause frames). diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt index 8cdbf77d..a3d12220 100644 --- a/docs/_include/interface-mirror.txt +++ b/docs/_include/interface-mirror.txt @@ -1,17 +1,22 @@ -SPAN port mirroring can copy the inbound/outbound traffic of the interface to the -specified interface, usually the interface can be connected to some special equipment, -such as behavior control system, intrusion detection system and traffic collector, -and can copy all related traffic from this port +SPAN port mirroring can copy the inbound/outbound traffic of the interface to +the specified interface, usually the interface can be connected to some special +equipment, such as behavior control system, intrusion detection system and +traffic collector, and can copy all related traffic from this port -VyOS uses the `mirror` option to configure port mirroring. The configuration is divided -into 2 different directions. Destination ports should be configured for different traffic directions. +VyOS uses the `mirror` option to configure port mirroring. The configuration +is divided into 2 different directions. Destination ports should be configured +for different traffic directions. -.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror ingress <monitor-interface> +.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror + ingress <monitor-interface> - Configure port mirroring for `interface` inbound traffic and copy the traffic to `monitor-interface` + Configure port mirroring for `interface` inbound traffic and copy the + traffic to `monitor-interface` -.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror egress <monitor-interface> +.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror egress + <monitor-interface> - Configure port mirroring for `interface` outbound traffic and copy the traffic to `monitor-interface` + Configure port mirroring for `interface` outbound traffic and copy the + traffic to `monitor-interface` diff --git a/docs/_include/interface-vlan-8021q.txt b/docs/_include/interface-vlan-8021q.txt index 63f4433f..1a527590 100644 --- a/docs/_include/interface-vlan-8021q.txt +++ b/docs/_include/interface-vlan-8021q.txt @@ -1,20 +1,22 @@ -IEEE 802.1q_, often referred to as Dot1q, is the networking standard that supports -virtual LANs (VLANs) on an IEEE 802.3 Ethernet network. The standard defines a -system of VLAN tagging for Ethernet frames and the accompanying procedures to be -used by bridges and switches in handling such frames. The standard also contains -provisions for a quality-of-service prioritization scheme commonly known as IEEE -802.1p and defines the Generic Attribute Registration Protocol. +IEEE 802.1q_, often referred to as Dot1q, is the networking standard that +supports virtual LANs (VLANs) on an IEEE 802.3 Ethernet network. The standard +defines a system of VLAN tagging for Ethernet frames and the accompanying +procedures to be used by bridges and switches in handling such frames. +The standard also contains provisions for a quality-of-service prioritization +scheme commonly known as IEEE 802.1p and defines the +Generic Attribute Registration Protocol. Portions of the network which are VLAN-aware (i.e., IEEE 802.1q_ conformant) can include VLAN tags. When a frame enters the VLAN-aware portion of the network, a -tag is added to represent the VLAN membership. Each frame must be distinguishable -as being within exactly one VLAN. A frame in the VLAN-aware portion of the network -that does not contain a VLAN tag is assumed to be flowing on the native VLAN. +tag is added to represent the VLAN membership. Each frame must be +distinguishable as being within exactly one VLAN. A frame in the VLAN-aware +portion of the network that does not contain a VLAN tag is assumed to be +flowing on the native VLAN. The standard was developed by IEEE 802.1, a working group of the IEEE 802 standards committee, and continues to be actively revised. One of the notable -revisions is 802.1Q-2014 which incorporated IEEE 802.1aq (Shortest Path Bridging) -and much of the IEEE 802.1d standard. +revisions is 802.1Q-2014 which incorporated IEEE 802.1aq +(Shortest Path Bridging) and much of the IEEE 802.1d standard. 802.1q VLAN interfaces are represented as virtual sub-interfaces in VyOS. The term used for this is ``vif``. |