From 7b04596343a1894a638ff1de030fb0a179980194 Mon Sep 17 00:00:00 2001 From: rebortg Date: Fri, 11 Dec 2020 22:41:24 +0100 Subject: protocols: fix lint errors --- docs/configuration/protocols/bfd.rst | 9 ++++++--- docs/configuration/protocols/igmp.rst | 12 ++++++++---- docs/configuration/protocols/isis.rst | 20 ++++++++++++-------- docs/configuration/protocols/mpls.rst | 4 ++++ docs/configuration/protocols/rpki.rst | 6 +++++- docs/configuration/protocols/static.rst | 24 ++++++++++++++++-------- 6 files changed, 51 insertions(+), 24 deletions(-) diff --git a/docs/configuration/protocols/bfd.rst b/docs/configuration/protocols/bfd.rst index b8fdf489..20ff3b8a 100644 --- a/docs/configuration/protocols/bfd.rst +++ b/docs/configuration/protocols/bfd.rst @@ -25,19 +25,22 @@ Configure BFD Allow this BFD peer to not be directly connected -.. cfgcmd:: set protocols bfd peer
source [address
| interface ] +.. cfgcmd:: set protocols bfd peer
source + [address
| interface ] Bind listener to specifid interface/address, mandatory for IPv6 .. cfgcmd:: set protocols bfd peer
interval echo-interval <10-60000> - The minimal echo receive transmission interval that this system is capable of handling + The minimal echo receive transmission interval that this system is + capable of handling .. cfgcmd:: set protocols bfd peer
interval multiplier <2-255> Remote transmission interval will be multiplied by this value -.. cfgcmd:: set protocols bfd peer
interval [receive | transmit] <10-60000> +.. cfgcmd:: set protocols bfd peer
interval + [receive | transmit] <10-60000> Interval in milliseconds diff --git a/docs/configuration/protocols/igmp.rst b/docs/configuration/protocols/igmp.rst index 9104b0c9..7109deb6 100644 --- a/docs/configuration/protocols/igmp.rst +++ b/docs/configuration/protocols/igmp.rst @@ -96,7 +96,8 @@ These are the commands for a basic setup. can communicate with PIM neighbors. -.. cfgcmd:: set protocols pim rp address
group +.. cfgcmd:: set protocols pim rp address
group + Use this comand to manually configure a Rendevouz Point for PIM so that join messages can be sent there. Set the Rendevouz Point address @@ -140,7 +141,8 @@ You can also tune multicast with the following commands. platforms cannot see data flowing in better than 30 second chunks. -.. cfgcmd:: set protocols igmp interface join source +.. cfgcmd:: set protocols igmp interface join + source Use this command to allow the selected interface join a multicast group defining the multicast address you want to join and the source @@ -153,7 +155,8 @@ You can also tune multicast with the following commands. host query interval (1-1800) in seconds that PIM will use. -.. cfgcmd:: set protocols igmp interface +.. cfgcmd:: set protocols igmp interface Use this command to configure in the selected interface the IGMP query response timeout value (10-250) in deciseconds. If a report is @@ -180,7 +183,8 @@ upstream interface, and one or more downstream interfaces. Configuration ============= -.. cfgcmd:: set protocols igmp-proxy interface role +.. cfgcmd:: set protocols igmp-proxy interface role + * **upstream:** The upstream network interface is the outgoing interface which is responsible for communicating to available multicast data sources. diff --git a/docs/configuration/protocols/isis.rst b/docs/configuration/protocols/isis.rst index 64cc2535..753637f9 100644 --- a/docs/configuration/protocols/isis.rst +++ b/docs/configuration/protocols/isis.rst @@ -6,12 +6,14 @@ IS-IS ##### -:abbr:`IS-IS (Intermediate System to Intermediate System)` is a link-state interior gateway routing protocol. -Like OSPF, IS-IS runs the Dijkstra shortest-path first (SPF) algorithm to create a database of the network’s -topology and, from that database, to determine the best (that is, shortest) path to a destination. -The routers exchange topology information with their nearest neighbors. -IS-IS runs directly on the data link layer (Layer 2). -IS-IS addresses are called :abbr:`NETs (Network Entity Titles)` and can be 8 to 20 bytes long, but are generally 10 bytes long. +:abbr:`IS-IS (Intermediate System to Intermediate System)` is a link-state +interior gateway routing protocol. Like OSPF, IS-IS runs the Dijkstra +shortest-path first (SPF) algorithm to create a database of the network’s +topology and, from that database, to determine the best (that is, shortest) +path to a destination. The routers exchange topology information with their +nearest neighbors. IS-IS runs directly on the data link layer (Layer 2). +IS-IS addresses are called :abbr:`NETs (Network Entity Titles)` and can be +8 to 20 bytes long, but are generally 10 bytes long. For example :abbr:`NET (Network Entity Title)` @@ -28,12 +30,14 @@ The IS-IS address consists of three parts: ``0001`` IS-IS area number (Area1) System identifier: - ``1921.6800.1002`` For system idetifier we recommend to use IP address or MAC address of the router. + ``1921.6800.1002`` For system idetifier we recommend to use IP address or + MAC address of the router. NET selector: ``00`` Must always be 00, to indicate "this system". -Simple IS-IS configuration using 2 nodes and redistributing connected interfaces. +Simple IS-IS configuration using 2 nodes and redistributing connected +interfaces. **Node 1:** diff --git a/docs/configuration/protocols/mpls.rst b/docs/configuration/protocols/mpls.rst index 863e7f62..3b59d8ea 100644 --- a/docs/configuration/protocols/mpls.rst +++ b/docs/configuration/protocols/mpls.rst @@ -240,4 +240,8 @@ Reset Use this command to reset an LDP neighbor/TCP session that is established +.. stop_vyoslinter + .. _`Wikipedia (MPLS)`: https://en.wikipedia.org/wiki/Multiprotocol_Label_Switching + +.. start_vyoslinter \ No newline at end of file diff --git a/docs/configuration/protocols/rpki.rst b/docs/configuration/protocols/rpki.rst index 9813b1b6..c3ff442b 100644 --- a/docs/configuration/protocols/rpki.rst +++ b/docs/configuration/protocols/rpki.rst @@ -100,6 +100,8 @@ Once your routers are configured to reject RPKI-invalid prefixes, you can test whether the configuration is working correctly using the `RIPE Labs RPKI Test`_ experimental tool. +.. stop_vyoslinter + .. _tweet by EvilMog: https://twitter.com/Evil_Mog/status/1230924170508169216 .. _Routinator: https://www.nlnetlabs.nl/projects/rpki/routinator/ .. _GoRTR: https://github.com/cloudflare/gortr @@ -110,4 +112,6 @@ Test`_ experimental tool. .. _RPKI analytics: https://www.nlnetlabs.nl/projects/rpki/rpki-analytics/ .. _RIPE Labs RPKI Test: https://sg-pub.ripe.net/jasper/rpki-web-test/ .. _excellent guide to RPKI: https://rpki.readthedocs.io/ -.. _help and operational guidance: https://rpki.readthedocs.io/en/latest/about/help.html +.. _help and operational guidance: https://rpki.readthedocs.io/en/latest/about/help.htm + +.. start_vyoslinter diff --git a/docs/configuration/protocols/static.rst b/docs/configuration/protocols/static.rst index 43b77c41..42c0c4b7 100644 --- a/docs/configuration/protocols/static.rst +++ b/docs/configuration/protocols/static.rst @@ -28,7 +28,8 @@ Static Routes Disable this IPv4 static route entry. -.. cfgcmd:: set protocols static route next-hop
distance +.. cfgcmd:: set protocols static route next-hop
+ distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. @@ -47,7 +48,8 @@ Static Routes Disable this IPv6 static route entry. -.. cfgcmd:: set protocols static route6 next-hop
distance +.. cfgcmd:: set protocols static route6 next-hop
+ distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. @@ -61,34 +63,40 @@ Static Routes Interface Routes ================ -.. cfgcmd:: set protocols static interface-route next-hop-interface +.. cfgcmd:: set protocols static interface-route next-hop-interface + Allows you to configure the next-hop interface for an interface-based IPv4 static route. `` will be the next-hop interface where trafic is routed for the given ``. -.. cfgcmd:: set protocols static interface-route next-hop-interface disable +.. cfgcmd:: set protocols static interface-route next-hop-interface + disable Disables interface-based IPv4 static route. -.. cfgcmd:: set protocols static interface-route next-hop-interface distance +.. cfgcmd:: set protocols static interface-route next-hop-interface + distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. Range is 1 to 255, default is 1. -.. cfgcmd:: set protocols static interface-route6 next-hop-interface +.. cfgcmd:: set protocols static interface-route6 next-hop-interface + Allows you to configure the next-hop interface for an interface-based IPv6 static route. `` will be the next-hop interface where trafic is routed for the given ``. -.. cfgcmd:: set protocols static interface-route6 next-hop-interface disable +.. cfgcmd:: set protocols static interface-route6 next-hop-interface + disable Disables interface-based IPv6 static route. -.. cfgcmd:: set protocols static interface-route6 next-hop-interface distance +.. cfgcmd:: set protocols static interface-route6 next-hop-interface + distance Defines next-hop distance for this route, routes with smaller administrative distance are elected prior those with a higher distance. -- cgit v1.2.3