Update git submodules

[docs.git] / docs / user-guide / pcep-user-guide.rst

diff --git a/docs/user-guide/pcep-user-guide.rst b/docs/user-guide/pcep-user-guide.rst
index 2ca543e43ea567fbe2f1955162604a51bdedc179..69ec767bc46052ec224dfd55dc350a5ca63524de 100644 (file)
--- a/docs/user-guide/pcep-user-guide.rst
+++ b/docs/user-guide/pcep-user-guide.rst
@@ -128,11 +128,41 @@ Configuration
 ^^^^^^^^^^^^^
 This capability is enabled by default. No additional configuration is required.
 
+Speaker Entity identifier
+'''''''''''''''''''''''''
+The Speaker Entity Identifier is an optional
+TLV that may be included in the OPEN Object when a PCEP speaker
+wishes to determine if state synchronization can be skipped when a
+PCEP session is restarted.
+
+**URL:** ``/restconf/config/network-topology:network-topology/topology/pcep-topology/node/43.43.43.43``
+
+**Method:** ``PUT``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+   :linenos:
+   :emphasize-lines: 2,4
+
+
+    <node xmlns="urn:TBD:params:xml:ns:yang:network-topology">
+        <node-id>43.43.43.43</node-id>
+        <session-config xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep:config">
+            <speaker-entity-id-value xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep:sync:optimizations:config">AQIDBA==</speaker-entity-id-value>
+        </session-config>
+    </node>
+
+@line 2: **address** - A PCC IP address.
+
+@line 4: **Speaker Entity Identifier** - The Speaker Entity identifier assigned to PCEP Node.
+
 MD5 authentication configuration
 ''''''''''''''''''''''''''''''''
-The OpenDaylight PCEP implementation is supporting TCP MD5 for authentication.
-Sample configuration below shows how to set authentication password for a particular PCC.
-It is required to install ``odl-netconf-connector-ssh`` feature first.
+The OpenDaylight PCEP implementation supports TCP MD5 for authentication.
+The sample configuration below shows how to set authentication password for a particular PCC.
 
 **URL:** ``/restconf/config/network-topology:network-topology/topology/pcep-topology/node/43.43.43.43``
 
@@ -146,7 +176,8 @@ It is required to install ``odl-netconf-connector-ssh`` feature first.
    :linenos:
    :emphasize-lines: 2,4
 
-    <node>
+
+    <node xmlns="urn:TBD:params:xml:ns:yang:network-topology">
         <node-id>43.43.43.43</node-id>
         <session-config xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep:config">
             <password>topsecret</password>
@@ -917,9 +948,7 @@ Segment Identifier (SID) is encoded as a MPLS label.
 
 Configuration
 '''''''''''''
-This capability is enabled by default.
-In PCEP-SR draft version 6, SR Explicit Route Object/Record Route Object subobjects IANA code points change was proposed.
-In order to use the latest code points, a configuration should be changed in following way:
+This capability is enabled by default. In order to disable it, a configuration should be changed as follows:
 
 **URL:** ``/restconf/config/pcep-segment-routing-app-config:pcep-segment-routing-app-config``
 
@@ -931,11 +960,38 @@ In order to use the latest code points, a configuration should be changed in fol
 
 .. code-block:: xml
    :linenos:
+   :emphasize-lines: 2
+
+   <pcep-segment-routing-config xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:segment-routing-app-config">
+      <sr-capable>false</sr-capable>
+   </pcep-segment-routing-config>
+
+@line 2: **sr-capable** - True if capability is supported.
+
+IANA code points
+''''''''''''''''
+
+In PCEP-SR draft version 6, SR Explicit Route Object/Record Route Object subobjects IANA code points change was proposed.
+In order to use the latest code points, a configuration should be changed as follows:
+
+**URL:** ``/restconf/config/pcep-segment-routing-app-config:pcep-segment-routing-config``
+
+**Method:** ``PUT``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+   :linenos:
+   :emphasize-lines: 2
 
    <pcep-segment-routing-config xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:segment-routing-app-config">
       <iana-sr-subobjects-type>true</iana-sr-subobjects-type>
    </pcep-segment-routing-config>
 
+@line 2: **iana-sr-subobjects-type** - True if IANA code points should be used.
+
 LSP Operations for PCEP SR
 ''''''''''''''''''''''''''
 The PCEP SR extension defines new ERO subobject - *SR-ERO subobject* capable of carrying a SID.
@@ -1159,7 +1215,7 @@ Following RPC example illustrates a request for the LSP re-synchronization:
 Node session statistics
 ----------------------------
 
-The PCEP statistics provides information about PCE <-> PCC session and it's stateful listener (topology-provider).
+The PCEP statistics provides information about PCE <-> PCC session and its stateful listener (topology-provider).
 
 Usage
 '''''
@@ -1467,7 +1523,7 @@ PCEP is not working...
 
 Bug reporting
 ^^^^^^^^^^^^^
-Before you report a bug, check `BGPCEP Bugzilla <https://bugs.opendaylight.org/buglist.cgi?list_id=65849&product=bgpcep&resolution=--->`_ to ensure same/similar bug is not already filed there.
+Before you report a bug, check `BGPCEP Jira <https://jira.opendaylight.org/projects/BGPCEP/issues/BGPCEP-589?filter=allopenissues>`_ to ensure same/similar bug is not already filed there.
 
 Write an e-mail to bgpcep-users@lists.opendaylight.org and provide following information: