Merge branch 'master' into docuser

[mirror_frr.git] / doc / user / ospfd.rst

diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst
index 574d9254956819e5ff7c5124d292d4ae57e012d1..e7ea9c52e4e6fe1d88c5a29c078945dee5fef07e 100644 (file)
--- a/doc/user/ospfd.rst
+++ b/doc/user/ospfd.rst
@@ -1000,6 +1000,45 @@ Router Information
 
 .. _debugging-ospf:
 
+Segment Routing
+===============
+
+This is an EXPERIMENTAL support of Segment Routing as per draft
+`draft-ietf-ospf-segment-routing-extensions-24.txt` for MPLS dataplane.
+
+.. index:: [no] segment-routing on
+.. clicmd:: [no] segment-routing on
+
+   Enable Segment Routing. Even if this also activate routing information
+   support, it is preferable to also activate routing information, and set
+   accordingly the Area or AS flooding.
+
+.. index:: [no] segment-routing global-block (0-1048575) (0-1048575)
+.. clicmd:: [no] segment-routing global-block (0-1048575) (0-1048575)
+
+   Fix the Segment Routing Global Block i.e. the label range used by MPLS to
+   store label in the MPLS FIB.
+
+.. index:: [no] segment-routing node-msd (1-16)
+.. clicmd:: [no] segment-routing node-msd (1-16)
+
+   Fix the Maximum Stack Depth supported by the router. The value depend of the
+   MPLS dataplane. E.g. for Linux kernel, since version 4.13 it is 32.
+
+.. index:: [no] segment-routing prefix A.B.C.D/M index (0-65535) [no-php-flag]
+.. clicmd:: [no] segment-routing prefix A.B.C.D/M index (0-65535) [no-php-flag]
+
+   Set the Segment Rounting index for the specifyed prefix. Note
+   that, only prefix with /32 corresponding to a loopback interface are
+   currently supported. The 'no-php-flag' means NO Penultimate Hop Popping that
+   allows SR node to request to its neighbor to not pop the label.
+
+.. index:: show ip ospf database segment-routing <adv-router ADVROUTER|self-originate>
+.. clicmd:: show ip ospf database segment-routing <adv-router ADVROUTER|self-originate>
+
+   Show Segment Routing Data Base, all SR nodes, specific advertized router or
+   self router.
+
 Debugging OSPF
 ==============
 
@@ -1190,36 +1229,37 @@ First, the 'zebra.conf' part:::
       !
       interface eth0
        ip address 198.168.1.1/24
-       mpls-te on
-       mpls-te link metric 10
-       mpls-te link max-bw 1.25e+06
-       mpls-te link max-rsv-bw 1.25e+06
-       mpls-te link unrsv-bw 0 1.25e+06
-       mpls-te link unrsv-bw 1 1.25e+06
-       mpls-te link unrsv-bw 2 1.25e+06
-       mpls-te link unrsv-bw 3 1.25e+06
-       mpls-te link unrsv-bw 4 1.25e+06
-       mpls-te link unrsv-bw 5 1.25e+06
-       mpls-te link unrsv-bw 6 1.25e+06
-       mpls-te link unrsv-bw 7 1.25e+06
-       mpls-te link rsc-clsclr 0xab
+       link-params
+        enable
+        admin-grp 0xa1
+        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
       !
       interface eth1
        ip address 192.168.2.1/24
-       mpls-te on
-       mpls-te link metric 10
-       mpls-te link max-bw 1.25e+06
-       mpls-te link max-rsv-bw 1.25e+06
-       mpls-te link unrsv-bw 0 1.25e+06
-       mpls-te link unrsv-bw 1 1.25e+06
-       mpls-te link unrsv-bw 2 1.25e+06
-       mpls-te link unrsv-bw 3 1.25e+06
-       mpls-te link unrsv-bw 4 1.25e+06
-       mpls-te link unrsv-bw 5 1.25e+06
-       mpls-te link unrsv-bw 6 1.25e+06
-       mpls-te link unrsv-bw 7 1.25e+06
-       mpls-te link rsc-clsclr 0xab
-       mpls-te neighbor 192.168.2.2 as 65000
+       link-params
+        enable
+        metric 10
+        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 192.168.2.2 as 65000
 
 Then the 'ospfd.conf' itself:::