From b8a2fd5e578f200928a457b9f967ed92619bda88 Mon Sep 17 00:00:00 2001 From: rebortg Date: Tue, 8 Dec 2020 15:12:56 +0100 Subject: fix build error after merge --- docs/configuration/protocols/isis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/configuration/protocols/isis.rst') diff --git a/docs/configuration/protocols/isis.rst b/docs/configuration/protocols/isis.rst index 807dca83..64cc2535 100644 --- a/docs/configuration/protocols/isis.rst +++ b/docs/configuration/protocols/isis.rst @@ -1,4 +1,4 @@ -.. include:: ../_include/need_improvement.txt +.. include:: /_include/need_improvement.txt .. _isis: -- cgit v1.2.3 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(-) (limited to 'docs/configuration/protocols/isis.rst') 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 From 3ab0c2e760941d910f82758f524b025bda6b5478 Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Wed, 13 Jan 2021 00:30:41 +0400 Subject: isis: add configuration commands and their explanations --- docs/configuration/protocols/isis.rst | 239 +++++++++++++++++++++++++++++++++- 1 file changed, 233 insertions(+), 6 deletions(-) (limited to 'docs/configuration/protocols/isis.rst') diff --git a/docs/configuration/protocols/isis.rst b/docs/configuration/protocols/isis.rst index 753637f9..71ddc856 100644 --- a/docs/configuration/protocols/isis.rst +++ b/docs/configuration/protocols/isis.rst @@ -7,12 +7,13 @@ 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 +interior gateway routing protocol which is described in ISO10589, +:rfc:`1195`, :rfc:`5308`. 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)` @@ -36,6 +37,232 @@ The IS-IS address consists of three parts: NET selector: ``00`` Must always be 00, to indicate "this system". + +General Configuration +--------------------- + +.. cfgcmd:: set protocols isis net + + This command enables the ISIS process by specifying the ISIS domain with + ‘name’. ISIS implementation does not yet support multiple ISIS processes + but you must specify the name of ISIS process. This commad also sets + network entity title (NET) provided in ISO format. + +.. cfgcmd:: set protocols isis interface + + This command activates ISIS adjacency on this interface. Note that the name + of ISIS instance must be the same as the one used to configure the ISIS + process. + +.. cfgcmd:: set protocols isis dynamic-hostname + + This command enables support for dynamic hostname. Dynamic hostname mapping + determined as described in :rfc:`2763`, Dynamic Hostname Exchange Mechanism + for IS-IS. + +.. cfgcmd:: set protocols isis level + + This command defines the ISIS router behavior: + + **level-1** Act as a station router only. + **level-1-2** Act as both a station router and an area router. + **level-2-only** Act as an area router only. + +.. cfgcmd:: set protocols isis lsp-mtu + + This command configures the maximum size of generated LSPs, in bytes. The + size range is 128 to 4352. + +.. cfgcmd:: set protocols isis metric-style + + This command sets old-style (ISO 10589) or new-style packet formats: + + **narrow** Use old style of TLVs with narrow metric. + **transition** Send and accept both styles of TLVs during transition. + **wide** Use new style of TLVs to carry wider metric. + +.. cfgcmd:: set protocols isis purge-originator + + This command enables :rfc:`6232` purge originator identification. Enable + purge originator identification (POI) by adding the type, length and value + (TLV) with the Intermediate System (IS) identification to the LSPs that do + not contain POI information. If an IS generates a purge, VyOS adds this TLV + with the system ID of the IS to the purge. + +.. cfgcmd:: set protocols isis set-attached-bit + + This command sets ATT bit to 1 in Level1 LSPs. It is described in :rfc:`3787`. + +.. cfgcmd:: set protocols isis set-overload-bit + + This command sets overload bit to avoid any transit traffic through this + router. It is described in :rfc:`3787`. + +.. cfgcmd:: set protocols isis name default-information originate + level-1 + + This command will generate a default-route in L1 database. + +.. cfgcmd:: set protocols isis name default-information originate + level-2 + + This command will generate a default-route in L2 database. + + +Interfaces Configuration +------------------------ + +.. cfgcmd:: set protocols isis interface circuit-type + + + This command specifies circuit type for interface: + + **level-1** Level-1 only adjacencies are formed. + **level-1-2** Level-1-2 adjacencies are formed + **level-2-only** Level-2 only adjacencies are formed + +.. cfgcmd:: set protocols isis interface hello-interval + + + This command sets hello interval in seconds on a given interface. + The range is 1 to 600. + +.. cfgcmd:: set protocols isis interface hello-multiplier + + + This command sets multiplier for hello holding time on a given + interface. The range is 2 to 100. + +.. cfgcmd:: set protocols isis interface hello-padding + + This command configures padding on hello packets to accommodate asymmetrical + maximum transfer units (MTUs) from different hosts as described in + :rfc:`3719`. This helps to prevent a premature adjacency Up state when one + routing device’s MTU does not meet the requirements to establish the + adjacency. + +.. cfgcmd:: set protocols isis interface metric + + This command set default metric for circuit. The metric range is 1 to + 16777215 (Max value depend if metric support narrow or wide value). + +.. cfgcmd:: set protocols isis interface network + point-to-point + + This command specifies network type to ‘Point-to-Point’. The default network + type is broadcast. + +.. cfgcmd:: set protocols isis interface passive + + This command configures the passive mode for this interface. + +.. cfgcmd:: set protocols isis interface password + plaintext-password + + This command configures the authentication password for the interface. + +.. cfgcmd:: set protocols isis interface priority + + This command sets priority for the interface for + :abbr:`DIS (Designated Intermediate System)` election. The priority + range is 0 to 127. + +.. cfgcmd:: set protocols isis interface psnp-interval + + + This command sets PSNP interval in seconds. The interval range is 0 + to 127. + +.. cfgcmd:: set protocols isis interface + three-way-handshake + + This command enables :rfc:`5303` Three-Way Handshake for P2P adjacencies. + Three-Way Handshake is enabled by default. + + +Redistribution Configuration +---------------------------- + +.. cfgcmd:: set protocols isis redistribute ipv4 level-1 + + This command redistributes routing information from the given route source + into the ISIS database as Level-1. There are six modes available for route + source: bgp, connected, kernel, ospf, rip, static. + +.. cfgcmd:: set protocols isis redistribute ipv4 level-2 + + This command redistributes routing information from the given route source + into the ISIS database as Level-2. There are six modes available for route + source: bgp, connected, kernel, ospf, rip, static. + +.. cfgcmd:: set protocols isis redistribute ipv4 + metric + + This command specifies metric for redistributed routes from the given route + source. There are six modes available for route source: bgp, connected, + kernel, ospf, rip, static. The metric range is 1 to 16777215. + +.. cfgcmd:: set protocols isis redistribute ipv4 + route-map + + This command allows to use route map to filter redistributed routes from + the given route source. There are six modes available for route source: + bgp, connected, kernel, ospf, rip, static. + + +Timers Configuration +-------------------- + +.. cfgcmd:: set protocols isis lsp-gen-interval + + This command sets minimum interval in seconds between regenerating same + LSP. The interval range is 1 to 120. + +.. cfgcmd:: set protocols isis lsp-refresh-interval + + This command sets LSP refresh interval in seconds. IS-IS generates LSPs + when the state of a link changes. However, to ensure that routing + databases on all routers remain converged, LSPs in stable networks are + generated on a regular basis even though there has been no change to + the state of the links. The interval range is 1 to 65235. The default + value is 900 seconds. + +.. cfgcmd:: set protocols isis max-lsp-lifetime + + This command sets LSP maximum LSP lifetime in seconds. The interval range + is 350 to 65535. LSPs remain in a database for 1200 seconds by default. + If they are not refreshed by that time, they are deleted. You can change + the LSP refresh interval or the LSP lifetime. The LSP refresh interval + should be less than the LSP lifetime or else LSPs will time out before + they are refreshed. + +.. cfgcmd:: set protocols isis spf-interval + + This command sets minimum interval between consecutive SPF calculations in + seconds.The interval range is 1 to 120. + +.. cfgcmd:: set protocols isis spf-delay-ietf holddown + +.. cfgcmd:: set protocols isis spf-delay-ietf init-delay + + +.. cfgcmd:: set protocols isis spf-delay-ietf long-delay + + +.. cfgcmd:: set protocols isis spf-delay-ietf short-delay + + +.. cfgcmd:: set protocols isis spf-delay-ietf time-to-learn + + + This commands specifies the Finite State Machine (FSM) intended to + control the timing of the execution of SPF calculations in response + to IGP events. The process described in :rfc:`8405`. + + +Configuration Example +--------------------- + Simple IS-IS configuration using 2 nodes and redistributing connected interfaces. -- cgit v1.2.3 From 636dadd81729cad6bb50f2f89a97a4a70c51b4df Mon Sep 17 00:00:00 2001 From: Leonid Voronkin Date: Fri, 15 Jan 2021 23:13:27 +0400 Subject: isis: T3210: rename command to no-three-way-handshake --- docs/configuration/protocols/isis.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/configuration/protocols/isis.rst') diff --git a/docs/configuration/protocols/isis.rst b/docs/configuration/protocols/isis.rst index 71ddc856..05a851f1 100644 --- a/docs/configuration/protocols/isis.rst +++ b/docs/configuration/protocols/isis.rst @@ -174,10 +174,10 @@ Interfaces Configuration to 127. .. cfgcmd:: set protocols isis interface - three-way-handshake + no-three-way-handshake - This command enables :rfc:`5303` Three-Way Handshake for P2P adjacencies. - Three-Way Handshake is enabled by default. + This command disables Three-Way Handshake for P2P adjacencies which + described in :rfc:`5303`. Three-Way Handshake is enabled by default. Redistribution Configuration -- cgit v1.2.3