OSPFD: Add Experimental Segment Routing support

[mirror_frr.git] / doc / ospfd.texi

diff --git a/doc/ospfd.texi b/doc/ospfd.texi
index cc33211510378103ea51473b8510ea47cdd68311..c013412b94c0c540a02a45cd0523fa46ff80e436 100644 (file)
--- a/doc/ospfd.texi
+++ b/doc/ospfd.texi
@@ -22,6 +22,7 @@ networks.
 * Opaque LSA::
 * OSPF Traffic Engineering::
 * Router Information::
+* Segment Routing::
 * Debugging OSPF::              
 * OSPF Configuration Examples::
 @end menu
@@ -724,6 +725,44 @@ Show Router Capabilities flag.
 Show Router Capabilities PCE parameters.
 @end deffn
 
+@node Segment Routing
+@section Segment Routing
+
+This is an EXPERIMENTAL support of Segment Routing as per draft
+ draft-ietf-ospf-segment-routing-extensions-24i for MPLS dataplane.
+
+@deffn {OSPF Command} {segment-routing on} {}
+@deffnx {OSPF Command} {no segment-routing} {}
+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.
+@end deffn
+
+@deffn {OSPF Command} {segment-routing global-block (0-1048575) (0-1048575)} {}
+@deffnx {OSPF Command} {no segment-routing global-block} {}
+Fix the Segment Routing Global Block i.e. the label range used by MPLS to store
+label in the MPLS FIB.
+@end deffn
+
+@deffn {OSPF Command} {segment-routing node-msd (1-16)} {}
+@deffnx {OSPF Command} {no segment-routing node-msd} {}
+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.
+@end deffn
+
+@deffn {OSPF Command} {segment-routing prefix A.B.C.D/M index (0-65535)} {}
+@deffnx {OSPF Command} {no segment-routing prefix A.B.C.D/M} {}
+Set the Segment Rounting index for the specifyed prefix. Note
+that, only prefix with /32 corresponding to a loopback interface are  
+currently supported.
+@end deffn
+
+@deffn {Command} {show ip ospf database segment-routing} {}
+@deffnx {Command} {show ip ospf database segment-routing adv-router @var{adv-router}} {}
+@deffnx {Command} {show ip ospf database segment-routing self-originate} {}
+Show Segment Routing Data Base, all SR nodes, specific advertized router or self router.
+@end deffn
+
 @node Debugging OSPF
 @section Debugging OSPF