path: root/doc/user/isisd.rst

.. _isis:

****
ISIS
****

:abbr:`ISIS (Intermediate System to Intermediate System)` is a routing protocol
which is described in :t:`ISO10589`, :rfc:`1195`, :rfc:`5308`. ISIS is an
:abbr:`IGP (Interior Gateway Protocol)`. Compared with :abbr:`RIP`,
:abbr:`ISIS` can provide scalable network support and faster convergence times
like :abbr:`OSPF`. ISIS is widely used in large networks such as :abbr:`ISP
(Internet Service Provider)` and carrier backbone networks.

.. _configuring-isisd:

Configuring isisd
=================

There are no *isisd* specific options. Common options can be specified
(:ref:`common-invocation-options`) to *isisd*. *isisd* needs to acquire
interface information from *zebra* in order to function. Therefore *zebra* must
be running before invoking *isisd*. Also, if *zebra* is restarted then *isisd*
must be too.

Like other daemons, *isisd* configuration is done in :abbr:`ISIS` specific
configuration file :file:`isisd.conf`.

.. _isis-router:

ISIS router
===========

To start the ISIS process you have to specify the ISIS router. As of this
writing, *isisd* does not support multiple ISIS processes.

.. clicmd:: router isis WORD [vrf NAME]

   Enable or disable the ISIS process by specifying the ISIS domain with
   'WORD'.  *isisd* does not yet support multiple ISIS processes but you must
   specify the name of ISIS process. The ISIS process name 'WORD' is then used
   for interface (see command :clicmd:`ip router isis WORD`).

.. clicmd:: net XX.XXXX. ... .XXX.XX

   Set/Unset network entity title (NET) provided in ISO format.

.. clicmd:: hostname dynamic

   Enable support for dynamic hostname.

.. clicmd:: area-password [clear | md5] <password>

.. clicmd:: domain-password [clear | md5] <password>

   Configure the authentication password for an area, respectively a domain, as
   clear text or md5 one.

.. clicmd:: attached-bit [receive ignore | send]

   Set attached bit for inter-area traffic:

   - receive
     If LSP received with attached bit set, create default route to neighbor
   - send
     If L1|L2 router, set attached bit in LSP sent to L1 router

.. clicmd:: log-adjacency-changes

   Log changes in adjacency state.

.. clicmd:: metric-style [narrow | transition | wide]

   Set 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. FRR uses this as a default value

.. clicmd:: set-overload-bit

   Set overload bit to avoid any transit traffic.

.. clicmd:: set-overload-bit on-startup (0-86400)

   Set overload bit on startup for the specified duration, in seconds.

.. clicmd:: purge-originator

   Enable or disable :rfc:`6232` purge originator identification.

.. clicmd:: lsp-mtu (128-4352)

   Configure the maximum size of generated LSPs, in bytes.


.. _isis-timer:

ISIS Timer
==========

.. clicmd:: lsp-gen-interval [level-1 | level-2] (1-120)

   Set minimum interval in seconds between regenerating same LSP,
   globally, for an area (level-1) or a domain (level-2).

.. clicmd:: lsp-refresh-interval [level-1 | level-2] (1-65235)

   Set LSP refresh interval in seconds, globally, for an area (level-1) or a
   domain (level-2).

.. clicmd:: max-lsp-lifetime [level-1 | level-2] (360-65535)

   Set LSP maximum LSP lifetime in seconds, globally, for an area (level-1) or
   a domain (level-2).

.. clicmd:: spf-interval [level-1 | level-2] (1-120)

   Set minimum interval between consecutive SPF calculations in seconds.

.. _isis-fast-reroute:

ISIS Fast-Reroute
=================

Unless stated otherwise, commands in this section apply to all LFA
flavors (local LFA, Remote LFA and TI-LFA).

.. clicmd:: spf prefix-priority [critical | high | medium] WORD

   Assign a priority to the prefixes that match the specified access-list.

   By default loopback prefixes have medium priority and non-loopback prefixes
   have low priority.

.. clicmd:: fast-reroute priority-limit [critical | high | medium] [level-1 | level-2]

   Limit LFA backup computation up to the specified prefix priority.

.. clicmd:: fast-reroute lfa tiebreaker [downstream | lowest-backup-metric | node-protecting] index (1-255) [level-1 | level-2]

   Configure a tie-breaker for multiple local LFA backups. Lower indexes are
   processed first.

.. clicmd:: fast-reroute load-sharing disable [level-1 | level-2]

   Disable load sharing across multiple LFA backups.

.. clicmd:: fast-reroute remote-lfa prefix-list [WORD] [level-1 | level-2]

   Configure a prefix-list to select eligible PQ nodes for remote LFA
   backups (valid for all protected interfaces).

.. _isis-region:

ISIS region
===========

.. clicmd:: is-type [level-1 | level-1-2 | level-2-only]

   Define 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

.. _isis-interface:

ISIS interface
==============

.. _ip-router-isis-word:

.. clicmd:: <ip|ipv6> router isis WORD

   Activate 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 (see
   command :clicmd:`router isis WORD`). To enable IPv4, issue ``ip router isis
   WORD``; to enable IPv6, issue ``ipv6 router isis WORD``.

.. clicmd:: isis circuit-type [level-1 | level-1-2 | level-2]

   Configure 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

.. clicmd:: isis csnp-interval (1-600) [level-1 | level-2]

   Set CSNP interval in seconds globally, for an area (level-1) or a domain
   (level-2).

.. clicmd:: isis hello padding

   Add padding to IS-IS hello packets.

.. clicmd:: isis hello-interval (1-600) [level-1 | level-2]

   Set Hello interval in seconds globally, for an area (level-1) or a domain
   (level-2).

.. clicmd:: isis hello-multiplier (2-100) [level-1 | level-2]

   Set multiplier for Hello holding time globally, for an area (level-1) or a
   domain (level-2).

.. clicmd:: isis metric [(0-255) | (0-16777215)] [level-1 | level-2]

   Set default metric value globally, for an area (level-1) or a domain
   (level-2).  Max value depend if metric support narrow or wide value (see
   command :clicmd:`metric-style [narrow | transition | wide]`).

.. clicmd:: isis network point-to-point

   Set network type to 'Point-to-Point' (broadcast by default).

.. clicmd:: isis passive

   Configure the passive mode for this interface.

.. clicmd:: isis password [clear | md5] <password>

   Configure the authentication password (clear or encoded text) for the
   interface.

.. clicmd:: isis priority (0-127) [level-1 | level-2]

   Set priority for Designated Router election, globally, for the area
   (level-1) or the domain (level-2).

.. clicmd:: isis psnp-interval (1-120) [level-1 | level-2]

   Set PSNP interval in seconds globally, for an area (level-1) or a domain
   (level-2).

.. clicmd:: isis three-way-handshake

   Enable or disable :rfc:`5303` Three-Way Handshake for P2P adjacencies.
   Three-Way Handshake is enabled by default.

.. clicmd:: isis fast-reroute lfa [level-1 | level-2]

   Enable per-prefix local LFA fast reroute link protection.

.. clicmd:: isis fast-reroute lfa [level-1 | level-2] exclude interface IFNAME

   Exclude an interface from the local LFA backup nexthop computation.

.. clicmd:: isis fast-reroute remote-lfa tunnel mpls-ldp [level-1 | level-2]

   Enable per-prefix Remote LFA fast reroute link protection. Note that other
   routers in the network need to be configured to accept LDP targeted hello
   messages in order for RLFA to work.

.. clicmd:: isis fast-reroute remote-lfa maximum-metric (1-16777215) [level-1 | level-2]

   Limit Remote LFA PQ node selection within the specified metric.

.. clicmd:: isis fast-reroute ti-lfa [level-1|level-2] [node-protection [link-fallback]]

   Enable per-prefix TI-LFA fast reroute link or node protection.
   When node protection is used, option link-fallback enables the computation and use of
   link-protecting LFAs for destinations unprotected by node protection.

.. _showing-isis-information:

Showing ISIS information
========================

.. clicmd:: show isis [vrf <NAME|all>] summary [json]

   Show summary information about ISIS.

.. clicmd:: show isis hostname

   Show information about ISIS node.

.. clicmd:: show isis [vrf <NAME|all>] interface [detail] [IFNAME] [json]

   Show state and configuration of ISIS specified interface, or all interfaces
   if no interface is given with or without details.

.. clicmd:: show isis [vrf <NAME|all>] neighbor [detail] [SYSTEMID] [json]

   Show state and information of ISIS specified neighbor, or all neighbors if
   no system id is given with or without details.

.. clicmd:: show isis [vrf <NAME|all>] database [detail] [LSPID] [json]

   Show the ISIS database globally, for a specific LSP id without or with
   details.

.. clicmd:: show isis topology [level-1|level-2]

   Show topology IS-IS paths to Intermediate Systems, globally, in area
   (level-1) or domain (level-2).

.. clicmd:: show isis route [level-1|level-2] [prefix-sid|backup]

   Show the ISIS routing table, as determined by the most recent SPF
   calculation.

.. clicmd:: show isis fast-reroute summary [level-1|level-2]

   Show information about the number of prefixes having LFA protection,
   and network-wide LFA coverage.


.. _isis-traffic-engineering:

Traffic Engineering
===================

.. note::

   IS-IS-TE supports RFC 5305 (base TE), RFC 6119 (IPv6) and RFC 7810 / 8570
   (Extended Metric) with or without Multi-Topology. All Traffic Engineering
   information are stored in a database formally named TED. However, best
   acccuracy is provided without Multi-Topology due to inconsistency of Traffic
   Engineering Advertisement of 3rd party commercial routers when MT is enabled.
   At this time, FRR offers partial support for some of the routing protocol
   extensions that can be used with MPLS-TE. FRR does not currently support a
   complete RSVP-TE solution.

.. clicmd:: mpls-te on

   Enable Traffic Engineering LSP flooding.

.. clicmd:: mpls-te router-address <A.B.C.D>

   Configure stable IP address for MPLS-TE.

.. clicmd:: mpls-te router-address ipv6 <X:X::X:X>

   Configure stable IPv6 address for MPLS-TE.

.. clicmd:: mpls-te export

   Export Traffic Engineering DataBase to other daemons through the ZAPI
   Opaque Link State messages.

.. clicmd:: show isis mpls-te interface

.. clicmd:: show isis mpls-te interface INTERFACE

   Show MPLS Traffic Engineering parameters for all or specified interface.

.. clicmd:: show isis mpls-te router

   Show Traffic Engineering router parameters.

.. clicmd:: show isis [vrf <NAME|all>] mpls-te database [detail|json]

.. clicmd:: show isis [vrf <NAME|all>] mpls-te database vertex [WORD] [detail|json]

.. clicmd:: show isis [vrf <NAME|all>] mpls-te database edge [A.B.C.D|X:X::X:X] [detail|json]

.. clicmd:: show isis [vrf <NAME|all>] mpls-te database subnet [A.B.C.D/M|X:X::X:X/M] [detail|json]

   Show Traffic Engineering Database

.. seealso::

   :ref:`ospf-traffic-engineering`


.. _debugging-isis:

Segment Routing
===============

This is an EXPERIMENTAL support of Segment Routing as per RFC8667
for MPLS dataplane. It supports IPv4, IPv6 and ECMP and has been
tested against Cisco & Juniper routers.

Known limitations:
 - No support for level redistribution (L1 to L2 or L2 to L1)
 - No support for binding SID
 - No support for SRMS
 - No support for SRLB
 - Only one SRGB and default SPF Algorithm is supported

.. clicmd:: segment-routing on

   Enable Segment Routing.

.. clicmd:: segment-routing global-block (16-1048575) (16-1048575) [local-block (16-1048575) (16-1048575)]

   Set the Segment Routing Global Block i.e. the label range used by MPLS
   to store label in the MPLS FIB for Prefix SID. Note that the block size
   may not exceed 65535. Optionally sets also the Segment Routing Local Block.
   The negative command always unsets both.

.. clicmd:: segment-routing node-msd (1-16)

   Set the Maximum Stack Depth supported by the router. The value depend of the
   MPLS dataplane. E.g. for Linux kernel, since version 4.13 the maximum value
   is 32.

.. clicmd:: segment-routing prefix <A.B.C.D/M|X:X::X:X/M> <absolute (16-1048575)|index (0-65535) [no-php-flag|explicit-null] [n-flag-clear]

   prefix. The 'no-php-flag' means NO Penultimate Hop Popping that allows SR
   node to request to its neighbor to not pop the label. The 'explicit-null'
   flag allows SR node to request to its neighbor to send IP packet with the
   EXPLICIT-NULL label. The 'n-flag-clear' option can be used to explicitly
   clear the Node flag that is set by default for Prefix-SIDs associated to
   loopback addresses. This option is necessary to configure Anycast-SIDs.

.. clicmd:: show isis segment-routing node

   Show detailed information about all learned Segment Routing Nodes.

Debugging ISIS
==============

.. clicmd:: debug isis adj-packets

   IS-IS Adjacency related packets.

.. clicmd:: debug isis checksum-errors

   IS-IS LSP checksum errors.

.. clicmd:: debug isis events

   IS-IS Events.

.. clicmd:: debug isis local-updates

   IS-IS local update packets.

.. clicmd:: debug isis packet-dump

   IS-IS packet dump.

.. clicmd:: debug isis protocol-errors

   IS-IS LSP protocol errors.

.. clicmd:: debug isis route-events

   IS-IS Route related events.

.. clicmd:: debug isis snp-packets

   IS-IS CSNP/PSNP packets.

.. clicmd:: debug isis spf-events
.. clicmd:: debug isis spf-statistics
.. clicmd:: debug isis spf-triggers

   IS-IS Shortest Path First Events, Timing and Statistic Data and triggering
   events.

.. clicmd:: debug isis update-packets


   Update related packets.

.. clicmd:: debug isis te-events

   IS-IS Traffic Engineering events

.. clicmd:: debug isis sr-events


   IS-IS Segment Routing events.

.. clicmd:: debug isis lfa


   IS-IS LFA events.

.. clicmd:: show debugging isis

   Print which ISIS debug level is activate.

.. _isis-config-examples:

ISIS Configuration Examples
===========================

A simple example, with MD5 authentication enabled:

.. code-block:: frr

   !
   interface eth0
    ip router isis FOO
    isis network point-to-point
    isis circuit-type level-2-only
   !
   router isis FOO
   net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
    metric-style wide
    is-type level-2-only


A Traffic Engineering configuration, with Inter-ASv2 support.

First, the :file:`zebra.conf` part:

.. code-block:: frr

   hostname HOSTNAME
   password PASSWORD
   log file /var/log/zebra.log
   !
   interface eth0
    ip address 10.2.2.2/24
    link-params
     max-bw 1.25e+07
     max-rsv-bw 1.25e+06
     unrsv-bw 0 1.25e+06
     unrsv-bw 1 1.25e+06
     unrsv-bw 2 1.25e+06
     unrsv-bw 3 1.25e+06
     unrsv-bw 4 1.25e+06
     unrsv-bw 5 1.25e+06
     unrsv-bw 6 1.25e+06
     unrsv-bw 7 1.25e+06
     admin-grp 0xab
   !
   interface eth1
    ip address 10.1.1.1/24
    link-params
     enable
     metric 100
     max-bw 1.25e+07
     max-rsv-bw 1.25e+06
     unrsv-bw 0 1.25e+06
     unrsv-bw 1 1.25e+06
     unrsv-bw 2 1.25e+06
     unrsv-bw 3 1.25e+06
     unrsv-bw 4 1.25e+06
     unrsv-bw 5 1.25e+06
     unrsv-bw 6 1.25e+06
     unrsv-bw 7 1.25e+06
     neighbor 10.1.1.2 as 65000


Then the :file:`isisd.conf` itself:

.. code-block:: frr

   hostname HOSTNAME
   password PASSWORD
   log file /var/log/isisd.log
   !
   !
   interface eth0
    ip router isis FOO
   !
   interface eth1
    ip router isis FOO
   !
   !
   router isis FOO
    isis net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
     mpls-te on
     mpls-te router-address 10.1.1.1
   !
   line vty

A Segment Routing configuration, with IPv4, IPv6, SRGB and MSD configuration.

.. code-block:: frr

   hostname HOSTNAME
   password PASSWORD
   log file /var/log/isisd.log
   !
   !
   interface eth0
    ip router isis SR
    isis network point-to-point
   !
   interface eth1
    ip router isis SR
   !
   !
   router isis SR
    net 49.0000.0000.0000.0001.00
    is-type level-1
    topology ipv6-unicast
    lsp-gen-interval 2
    segment-routing on
    segment-routing node-msd 8
    segment-routing prefix 10.1.1.1/32 index 100 explicit-null
    segment-routing prefix 2001:db8:1000::1/128 index 101 explicit-null
   !


.. _isis-vrf-config-examples:

ISIS Vrf Configuration Examples
===============================

A simple vrf example:

.. code-block:: frr

   !
   interface eth0 vrf RED
    ip router isis FOO vrf RED
    isis network point-to-point
    isis circuit-type level-2-only
   !
   router isis FOO vrf RED
    net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
    metric-style wide
    is-type level-2-only