From: Carmine Scarpitta <carmine.scarpitta@uniroma2.it>
Date: Thu, 3 Nov 2022 11:44:50 +0000 (+0100)
Subject: doc: Add doc for `show segment-routing srv6 manager`
X-Git-Tag: base_10.0~163^2~1
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=fcf17cc05d9a86b3a4135fd6febd046f9930da2e;p=matthieu%2Ffrr.git

doc: Add doc for `show segment-routing srv6 manager`

The `show segment-routing srv6 manager` CLI command allows users to
print the SRv6 information. Currently, the SRv6 information includes
only the SRv6 encapsulation source address.

In this commit, we add the documentation for the
`show segment-routing srv6` command.

Signed-off-by: Carmine Scarpitta <carmine.scarpitta@uniroma2.it>
---

diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index f65c33fd67..2b737c1a2f 100644
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -838,6 +838,35 @@ FRR's cli or frr.conf or zebra.conf. This section shows how
 to configure SRv6 on FRR. Of course SRv6 can be used as standalone,
 and this section also helps that case.
 
+.. clicmd:: show segment-routing srv6 manager [json]
+
+   This command dumps the SRv6 information configured on zebra, including
+   the encapsulation parameters (e.g., the IPv6 source address used for
+   the encapsulated packets).
+
+   Example::
+
+      router# sh segment-routing srv6 manager
+      Parameters:
+      Encapsulation:
+         Source Address:
+            Configured: fc00:0:1::1
+
+
+   To get the same information in json format, you can use the ``json`` keyword::
+
+      rose-srv6# sh segment-routing srv6 manager json
+      {
+        "parameters":{
+          "encapsulation":{
+            "sourceAddress":{
+              "configured":"fc00:0:1::1"
+            }
+          }
+        }
+      }
+
+
 .. clicmd:: show segment-routing srv6 locator [json]
 
    This command dump SRv6-locator configured on zebra.  SRv6-locator is used