+.. _pcep-user-guide:
PCEP User Guide
===============
+This guide contains information on how to use the OpenDaylight Path Computation Element Configuration Protocol (PCEP) plugin.
+The user should learn about PCEP basic concepts, supported capabilities, configuration and operations.
+
+.. contents:: Contents
+ :depth: 1
+ :local:
Overview
--------
+This section provides a high-level overview of the PCEP, SDN use-cases and OpenDaylight implementation.
-The OpenDaylight Karaf distribution comes preconfigured with baseline
-PCEP configuration.
+.. contents:: Contents
+ :depth: 2
+ :local:
-- **32-pcep.xml** (basic PCEP configuration, including session
- parameters)
+Path Computation Element Communication Protocol
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The Path Computation Element (PCE) Communication Protocol (PCEP) is used for communication between a Path Computation Client (PCC) and a PCE in context of MPLS and GMPLS Traffic Engineering (TE) Label Switched Paths (LSPs).
+This interaction include path computation requests and computation replies.
+The PCE operates on a network graph, built from the (Traffic Engineering Database) TED, in order to compute paths based on the path computation request issued by the PCC.
+The path computation request includes the source and destination of the path and set of constrains to be applied during the computation.
+The PCE response contains the computed path or the computation failure reason.
+The PCEP operates on top the TCP, which provides reliable communication.
-- **39-pcep-provider.xml** (configuring for PCEP provider)
+.. figure:: ./images/bgpcep/pcep.png
+ :align: center
+ :alt: PCEP
-Configuring PCEP
-----------------
+ PCE-based architecture.
+
+PCEP in SDN
+^^^^^^^^^^^
+The Path Computation Element perfectly fits into the centralized SDN controller architecture.
+The PCE's knowledge of the availability of network resources (i.e. TED) and active LSPs awareness (LSP-DB) allows to perform automated application-driven network operations:
-The default shipped configuration will start a PCE server on
-0.0.0.0:4189. You can change this behavior in **39-pcep-provider.xml**:
+* LSP Re-optimization
+* Resource defragmentation
+* Link failure restoration
+* Auto-bandwidth adjustment
+* Bandwidth scheduling
+* Shared Risk Link Group (SRLG) diversity maintenance
-.. code:: xml
+OpenDaylight PCEP plugin
+^^^^^^^^^^^^^^^^^^^^^^^^
+The OpenDaylight PCEP plugin provides all basic service units necessary to build-up a PCE-based controller.
+In addition, it offers LSP management functionality for Active Stateful PCE - the cornerstone for majority of PCE-enabled SDN solutions.
+It consists of the following components:
- <module>
- <type xmlns:prefix="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">prefix:pcep-topology-provider</type>
- <name>pcep-topology</name>
- <listen-address>192.168.122.55</listen-address>
- <listen-port>4189</listen-port>
- ...
+* Protocol library
+* PCEP session handling
+* Stateful PCE LSP-DB
+* Active Stateful PCE LSP Operations
+
+.. figure:: ./images/bgpcep/pcep-plugin.png
+ :align: center
+ :alt: PCEP plugin
+
+ OpenDaylight PCEP plugin overview.
+
+.. important:: The PCEP plugin does not provide path computational functionality and does not build TED.
+
+List of supported capabilities
+''''''''''''''''''''''''''''''
+
+* `RFC5440 <https://tools.ietf.org/html/rfc5440>`_ - Path Computation Element (PCE) Communication Protocol (PCEP)
+* `RFC5455 <https://tools.ietf.org/html/rfc5455>`_ - Diffserv-Aware Class-Type Object for the Path Computation Element Communication Protocol
+* `RFC5520 <https://tools.ietf.org/html/rfc5520>`_ - Preserving Topology Confidentiality in Inter-Domain Path Computation Using a Path-Key-Based Mechanism
+* `RFC5521 <https://tools.ietf.org/html/rfc5521>`_ - Extensions to the Path Computation Element Communication Protocol (PCEP) for Route Exclusions
+* `RFC5541 <https://tools.ietf.org/html/rfc5541>`_ - Encoding of Objective Functions in the Path Computation Element Communication Protocol (PCEP)
+* `RFC5557 <https://tools.ietf.org/html/rfc5557>`_ - Path Computation Element Communication Protocol (PCEP) Requirements and Protocol Extensions in Support of Global Concurrent Optimization
+* `RFC5886 <https://tools.ietf.org/html/rfc5886>`_ - A Set of Monitoring Tools for Path Computation Element (PCE)-Based Architecture
+* `RFC7470 <https://tools.ietf.org/html/rfc7470>`_ - Conveying Vendor-Specific Constraints in the Path Computation Element Communication Protocol
+* `RFC7896 <https://tools.ietf.org/html/rfc7896>`_ - Update to the Include Route Object (IRO) Specification in the Path Computation Element Communication Protocol (PCEP)
+* `draft-ietf-pce-stateful-pce <https://tools.ietf.org/html/draft-ietf-pce-stateful-pce-16>`_ - PCEP Extensions for Stateful PCE
+
+ * `draft-ietf-pce-pce-initiated-lsp <https://tools.ietf.org/html/draft-ietf-pce-pce-initiated-lsp-07>`_ - PCEP Extensions for PCE-initiated LSP Setup in a Stateful PCE Model
+ * `draft-ietf-pce-segment-routing <https://tools.ietf.org/html/draft-ietf-pce-segment-routing-07>`_ - PCEP Extension for segment routing
+ * `draft-ietf-pce-lsp-setup-type <https://tools.ietf.org/html/draft-ietf-pce-lsp-setup-type-03>`_ - PCEP Extension for path setup type
+ * `draft-ietf-pce-stateful-sync-optimizations <https://tools.ietf.org/html/draft-ietf-pce-stateful-sync-optimizations-05>`_ - Optimizations of Label Switched Path State Synchronization Procedures for a Stateful PCE
+ * `draft-sivabalan-pce-binding-label-sid <https://tools.ietf.org/html/draft-sivabalan-pce-binding-label-sid-01>`_ - Carrying Binding Label/Segment-ID in PCE-based Networks
+
+* `draft-ietf-pce-pceps <https://tools.ietf.org/html/draft-ietf-pce-pceps-10>`_ - Secure Transport for PCEP
+
+Running PCEP
+------------
+This section explains how to install PCEP plugin.
+
+1. Install PCEP feature - ``odl-bgpcep-pcep``.
+ Also, for sake of this sample, it is required to install RESTCONF.
+ In the Karaf console, type command:
+
+ .. code-block:: console
+
+ feature:install odl-restconf odl-bgpcep-pcep
+
+2. The PCEP plugin contains a default configuration, which is applied after the feature starts up.
+ One instance of PCEP plugin is created (named *pcep-topology*), and its presence can be verified via REST:
+
+ **URL:** ``restconf/operational/network-topology:network-topology/topology/pcep-topology``
+
+ **Method:** ``GET``
+
+ **Response Body:**
+
+ .. code-block:: xml
+
+ <topology xmlns="urn:TBD:params:xml:ns:yang:network-topology">
+ <topology-id>pcep-topology</topology-id>
+ <topology-types>
+ <topology-pcep xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep"></topology-pcep>
+ </topology-types>
+ </topology>
+
+Active Stateful PCE
+-------------------
+The PCEP extension for Stateful PCE brings a visibility of active LSPs to PCE, in order to optimize path computation, while considering individual LSPs and their interactions.
+This requires state synchronization mechanism between PCE and PCC.
+Moreover, Active Stateful PCE is capable to address LSP parameter changes to the PCC.
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+
+Configuration
+^^^^^^^^^^^^^
+This capability is enabled by default. No additional configuration is required.
+
+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.
+
+**URL:** ``/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/module/odl-pcep-topology-provider-cfg:pcep-topology-provider/pcep-topology``
+
+**Method:** ``PUT``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 26,27
+
+ <module xmlns="urn:opendaylight:params:xml:ns:yang:controller:config">
+ <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">x:pcep-topology-provider</type>
+ <name>pcep-topology</name>
+ <data-provider xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">
+ <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-async-data-broker</type>
+ <name>pingpong-binding-data-broker</name>
+ </data-provider>
+ <dispatcher xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">
+ <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:pcep">x:pcep-dispatcher</type>
+ <name>global-pcep-dispatcher</name>
+ </dispatcher>
+ <rpc-registry xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">
+ <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">x:binding-rpc-registry</type>
+ <name>binding-rpc-broker</name>
+ </rpc-registry>
+ <scheduler xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">
+ <type xmlns:x="urn:opendaylight:params:xml:ns:yang:controller:programming:spi">x:instruction-scheduler</type>
+ <name>global-instruction-scheduler</name>
+ </scheduler>
+ <stateful-plugin xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">
+ <type>pcep-topology-stateful</type>
+ <name>stateful07</name>
+ </stateful-plugin>
+ <topology-id xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">pcep-topology</topology-id>
+ <client xmlns="urn:opendaylight:params:xml:ns:yang:controller:pcep:topology:provider">
+ <address>43.43.43.43</address>
+ <password>topsecret</password>
+ </client>
</module>
-- **listen-address** - adress on which PCE will be started and listen
-
-- **listen-port** - port on which the address will be started and
- listen
-
-PCEP default configuration is set to conform stateful PCEP extensions:
-
-- `draft-ietf-pce-stateful-pce-07 <http://tools.ietf.org/html/draft-ietf-pce-stateful-pce-07>`__
- - PCEP Extensions for Stateful PCE
-
-- `draft-ietf-pce-pce-initiated-lsp-00 <https://tools.ietf.org/html/draft-ietf-pce-pce-initiated-lsp-00>`__
- - PCEP Extensions for PCE-initiated LSP Setup in a Stateful PCE Model
-
-- `draft-ietf-pce-stateful-sync-optimizations-03 <https://tools.ietf.org/html/draft-ietf-pce-stateful-sync-optimizations-03>`__
- - Optimizations of Label Switched Path State Synchronization
- Procedures for a Stateful PCE
-
-PCEP Segment Routing
-~~~~~~~~~~~~~~~~~~~~
-
-Conforms
-`draft-ietf-pce-segment-routing <http://tools.ietf.org/html/draft-ietf-pce-segment-routing-01>`__
-- PCEP extension for Segment Routing
-
-The default configuration file is located in etc/opendaylight/karaf.
-
-- **33-pcep-segment-routing.xml** - You don’t need to edit this file.
-
-Tunnel Management
------------------
-
-Programming tunnels through PCEP is one of the key features of PCEP
-implementation in OpenDaylight. User can create, update and delete
-tunnel via RESTCONF calls. Tunnel (LSP - Label Switched Path) arguments
-are passed through RESTCONF and generate a PCEP message that is sent to
-PCC (which is also specified via RESTCONF call). PCC sends a response
-back to OpenDaylight. The response is then interpreted and sent to
-RESTCONF, where, in case of success, the new LSP is displayed.
-
-The PCE Segment Routing Extends draft-ietf-pce-stateful-pce-07 and
-draft-ietf-pce-pce-initiated-lsp-00, brings new Segment Routing Explicit
-Route Object (SR-ERO) subobject composed of SID (Segment Identifier)
-and/or NAI (Node or Adjacency Identifier). Segment Routing path is
-carried in the ERO object, as a list of SR-ERO subobjects ordered by
-user. The draft redefines format of messages (PCUpd, PCRpt, PCInitiate)
-- along with common header, they can hold SPR, LSP and SR-ERO
-(containing only SR-ERO subobjects) objects.
-
-Creating LSP
-~~~~~~~~~~~~
-
-An LSP in PCEP can be created in one or two steps. Making an add-lsp
-operation will trigger a PcInitiate message to PCC.
-
-**URL:**
-http://localhost:8181/restconf/operations/network-topology-pcep:add-lsp
-
-**Method:** POST
-
-**Content-Type:** application/xml
-
-**Body:**
-
-**PCE Active Stateful:**
-
-.. code:: xml
-
- <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
- <node>pcc://43.43.43.43</node>
- <name>update-tunel</name>
- <arguments>
- <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
- <delegate>true</delegate>
- <administrative>true</administrative>
- </lsp>
- <endpoints-obj>
- <ipv4>
- <source-ipv4-address>43.43.43.43</source-ipv4-address>
- <destination-ipv4-address>39.39.39.39</destination-ipv4-address>
- </ipv4>
- </endpoints-obj>
- <ero>
- <subobject>
- <loose>false</loose>
- <ip-prefix><ip-prefix>201.20.160.40/32</ip-prefix></ip-prefix>
- </subobject>
- <subobject>
- <loose>false</loose>
- <ip-prefix><ip-prefix>195.20.160.39/32</ip-prefix></ip-prefix>
- </subobject>
- <subobject>
- <loose>false</loose>
- <ip-prefix><ip-prefix>39.39.39.39/32</ip-prefix></ip-prefix>
- </subobject>
- </ero>
- </arguments>
- <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
- </input>
-
-**PCE Segment Routing:**
-
-.. code:: xml
-
- <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
- <node>pcc://43.43.43.43</node>
- <name>update-tunnel</name>
- <arguments>
- <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
- <delegate>true</delegate>
- <administrative>true</administrative>
- </lsp>
- <endpoints-obj>
- <ipv4>
- <source-ipv4-address>43.43.43.43</source-ipv4-address>
- <destination-ipv4-address>39.39.39.39</destination-ipv4-address>
- </ipv4>
- </endpoints-obj>
- <path-setup-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
- <pst>1</pst>
- </path-setup-type>
- <ero>
- <subobject>
- <loose>false</loose>
- <sid-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">ipv4-node-id</sid-type>
- <m-flag xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">true</m-flag>
- <sid xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">12</sid>
- <ip-address xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">39.39.39.39</ip-address>
- </subobject>
- </ero>
- </arguments>
- <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
- </input>
-
-Updating LSP
-~~~~~~~~~~~~
-
-Making an update-lsp operation will trigger a PCUpd message to PCC.
-Updating can be used to change or add additional information to the LSP.
-
-You can only successfully update an LSP if you own the delegation. You
-automatically own the delegation, if you’ve created the LSP. You don’t
-own it, if another PCE created this LSP. In this case PCC is only
-reporting this LSP for you, as read-only (you’ll see
-``<delegate>false</delegate>``). However OpenDaylight won’t restrict you
-from trying to modify the LSP, but you will be stopped by receiving a
-PCErr message from PCC.
-
-To revoke delegation, don’t forget to set ``<delegate>`` to true.
-
-**URL:**
-http://localhost:8181/restconf/operations/network-topology-pcep:update-lsp
-
-**Method:** POST
-
-**Content-Type:** application/xml
-
-**Body:**
-
-**PCE Active Stateful:**
-
-.. code:: xml
-
- <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
- <node>pcc://43.43.43.43</node>
- <name>update-tunel</name>
- <arguments>
- <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
- <delegate>true</delegate>
- <administrative>true</administrative>
- </lsp>
- <ero>
- <subobject>
- <loose>false</loose>
- <ip-prefix><ip-prefix>200.20.160.41/32</ip-prefix></ip-prefix>
- </subobject>
- <subobject>
- <loose>false</loose>
- <ip-prefix><ip-prefix>196.20.160.39/32</ip-prefix></ip-prefix>
- </subobject>
- <subobject>
- <loose>false</loose>
- <ip-prefix><ip-prefix>39.39.39.39/32</ip-prefix></ip-prefix>
- </subobject>
- </ero>
- </arguments>
- <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
- </input>
-
-**PCE Segment Routing:**
-
-.. code:: xml
-
- <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
- <node>pcc://43.43.43.43</node>
- <name>update-tunnel</name>
- <arguments>
- <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
- <delegate>true</delegate>
- <administrative>true</administrative>
- </lsp>
- <path-setup-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
- <pst>1</pst>
- </path-setup-type>
- <ero>
- <subobject>
- <loose>false</loose>
- <sid-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">ipv4-node-id</sid-type>
- <m-flag xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">true</m-flag>
- <sid xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">11</sid>
- <ip-address xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">200.20.160.41</ip-address>
- </subobject>
- <subobject>
- <loose>false</loose>
- <sid-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">ipv4-node-id</sid-type>
- <m-flag xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">true</m-flag>
- <sid xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">12</sid>
- <ip-address xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">39.39.39.39</ip-address>
- </subobject>
- </ero>
- </arguments>
- <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
- </input>
-
-Removing LSP
-~~~~~~~~~~~~
-
-Removing LSP from PCC is done via following RESTCONF URL. Making a
-remove-lsp operation will trigger a PCInitiate message to PCC, with
-remove-flag in SRP set to true.
-
-You can only successfully remove an LSP if you own the delegation. You
-automatically own the delegation, if you’ve created the LSP. You don’t
-own it, if another PCE created this LSP. In this case PCC is only
-reporting this LSP for you, as read-only (you’ll see
-``<delegate>false</delegate>``). However OpenDaylight won’t restrict you
-from trying to remove the LSP, but you will be stopped by receiving a
-PCErr message from PCC.
-
-To revoke delegation, don’t forget to set ``<delegate>`` to true.
-
-**URL:**
-http://localhost:8181/restconf/operations/network-topology-pcep:remove-lsp
-
-**Method:** POST
-
-**Content-Type:** application/xml
-
-**Body:**
-
-.. code:: xml
-
- <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
- <node>pcc://43.43.43.43</node>
- <name>update-tunel</name>
- <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
- </input>
+@line 26: **address** - A PCC IP address.
+
+@line 27: **password** - MD5 authentication phrase.
+
+.. warning:: The PCE (*pcep-topology-provider*) configuration is going to be changed in Carbon release - moving to configuration datastore.
+
+LSP State Database
+^^^^^^^^^^^^^^^^^^
+The *LSP State Database* (LSP-DB) contains an information about all LSPs and their attributes.
+The LSP state is synchronized between the PCC and PCE.
+First, initial LSP state synchronization is performed once the session between PCC and PCE is established in order to learn PCC's LPSs.
+This step is a prerequisite to following LSPs manipulation operations.
+
+
+.. figure:: ./images/bgpcep/pcep-sync.png
+ :align: center
+ :alt: LSP State synchronization
+
+ LSP State Synchronization.
+
+LSP-DB API
+''''''''''
+
+.. code-block:: console
+
+ path-computation-client
+ +--ro reported-lsp* [name]
+ +--ro name string
+ +--ro path* [lsp-id]
+ | +--ro lsp-id rsvp:lsp-id
+ | +--ro ero
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro subobject*
+ | | +--ro loose boolean
+ | | +--ro (subobject-type)?
+ | | +--:(as-number-case)
+ | | | +--ro as-number
+ | | | +--ro as-number inet:as-number
+ | | +--:(ip-prefix-case)
+ | | | +--ro ip-prefix
+ | | | +--ro ip-prefix inet:ip-prefix
+ | | +--:(label-case)
+ | | | +--ro label
+ | | | +--ro uni-directional boolean
+ | | | +--ro (label-type)?
+ | | | +--:(type1-label-case)
+ | | | | +--ro type1-label
+ | | | | +--ro type1-label uint32
+ | | | +--:(generalized-label-case)
+ | | | | +--ro generalized-label
+ | | | | +--ro generalized-label binary
+ | | | +--:(waveband-switching-label-case)
+ | | | +--ro waveband-switching-label
+ | | | +--ro end-label uint32
+ | | | +--ro start-label uint32
+ | | | +--ro waveband-id uint32
+ | | +--:(srlg-case)
+ | | | +--ro srlg
+ | | | +--ro srlg-id srlg-id
+ | | +--:(unnumbered-case)
+ | | | +--ro unnumbered
+ | | | +--ro router-id uint32
+ | | | +--ro interface-id uint32
+ | | +--:(exrs-case)
+ | | | +--ro exrs
+ | | | +--ro exrs*
+ | | | +--ro mandatory? boolean
+ | | | +--ro attribute enumeration
+ | | | +--ro (subobject-type)?
+ | | | +--:(as-number-case)
+ | | | | +--ro as-number
+ | | | | +--ro as-number inet:as-number
+ | | | +--:(ip-prefix-case)
+ | | | | +--ro ip-prefix
+ | | | | +--ro ip-prefix inet:ip-prefix
+ | | | +--:(label-case)
+ | | | | +--ro label
+ | | | | +--ro uni-directional boolean
+ | | | | +--ro (label-type)?
+ | | | | +--:(type1-label-case)
+ | | | | | +--ro type1-label
+ | | | | | +--ro type1-label uint32
+ | | | | +--:(generalized-label-case)
+ | | | | | +--ro generalized-label
+ | | | | | +--ro generalized-label binary
+ | | | | +--:(waveband-switching-label-case)
+ | | | | +--ro waveband-switching-label
+ | | | | +--ro end-label uint32
+ | | | | +--ro start-label uint32
+ | | | | +--ro waveband-id uint32
+ | | | +--:(srlg-case)
+ | | | | +--ro srlg
+ | | | | +--ro srlg-id srlg-id
+ | | | +--:(unnumbered-case)
+ | | | +--ro unnumbered
+ | | | +--ro router-id uint32
+ | | | +--ro interface-id uint32
+ | | +--:(path-key-case)
+ | | +--ro path-key
+ | | +--ro pce-id pce-id
+ | | +--ro path-key path-key
+ | +--ro lspa
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro hold-priority? uint8
+ | | +--ro setup-priority? uint8
+ | | +--ro local-protection-desired? boolean
+ | | +--ro label-recording-desired? boolean
+ | | +--ro se-style-desired? boolean
+ | | +--ro session-name? string
+ | | +--ro include-any? attribute-filter
+ | | +--ro exclude-any? attribute-filter
+ | | +--ro include-all? attribute-filter
+ | | +--ro tlvs
+ | | +--ro vendor-information-tlv*
+ | | +--ro enterprise-number? iana:enterprise-number
+ | | +--ro (enterprise-specific-information)?
+ | +--ro bandwidth
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro bandwidth? netc:bandwidth
+ | +--ro reoptimization-bandwidth
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro bandwidth? netc:bandwidth
+ | +--ro metrics*
+ | | +--ro metric
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro metric-type uint8
+ | | +--ro bound? boolean
+ | | +--ro computed? boolean
+ | | +--ro value? ieee754:float32
+ | +--ro iro
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro subobject*
+ | | +--ro loose boolean
+ | | +--ro (subobject-type)?
+ | | +--:(as-number-case)
+ | | | +--ro as-number
+ | | | +--ro as-number inet:as-number
+ | | +--:(ip-prefix-case)
+ | | | +--ro ip-prefix
+ | | | +--ro ip-prefix inet:ip-prefix
+ | | +--:(label-case)
+ | | | +--ro label
+ | | | +--ro uni-directional boolean
+ | | | +--ro (label-type)?
+ | | | +--:(type1-label-case)
+ | | | | +--ro type1-label
+ | | | | +--ro type1-label uint32
+ | | | +--:(generalized-label-case)
+ | | | | +--ro generalized-label
+ | | | | +--ro generalized-label binary
+ | | | +--:(waveband-switching-label-case)
+ | | | +--ro waveband-switching-label
+ | | | +--ro end-label uint32
+ | | | +--ro start-label uint32
+ | | | +--ro waveband-id uint32
+ | | +--:(srlg-case)
+ | | | +--ro srlg
+ | | | +--ro srlg-id srlg-id
+ | | +--:(unnumbered-case)
+ | | | +--ro unnumbered
+ | | | +--ro router-id uint32
+ | | | +--ro interface-id uint32
+ | | +--:(exrs-case)
+ | | | +--ro exrs
+ | | | +--ro exrs*
+ | | | +--ro mandatory? boolean
+ | | | +--ro attribute enumeration
+ | | | +--ro (subobject-type)?
+ | | | +--:(as-number-case)
+ | | | | +--ro as-number
+ | | | | +--ro as-number inet:as-number
+ | | | +--:(ip-prefix-case)
+ | | | | +--ro ip-prefix
+ | | | | +--ro ip-prefix inet:ip-prefix
+ | | | +--:(label-case)
+ | | | | +--ro label
+ | | | | +--ro uni-directional boolean
+ | | | | +--ro (label-type)?
+ | | | | +--:(type1-label-case)
+ | | | | | +--ro type1-label
+ | | | | | +--ro type1-label uint32
+ | | | | +--:(generalized-label-case)
+ | | | | | +--ro generalized-label
+ | | | | | +--ro generalized-label binary
+ | | | | +--:(waveband-switching-label-case)
+ | | | | +--ro waveband-switching-label
+ | | | | +--ro end-label uint32
+ | | | | +--ro start-label uint32
+ | | | | +--ro waveband-id uint32
+ | | | +--:(srlg-case)
+ | | | | +--ro srlg
+ | | | | +--ro srlg-id srlg-id
+ | | | +--:(unnumbered-case)
+ | | | +--ro unnumbered
+ | | | +--ro router-id uint32
+ | | | +--ro interface-id uint32
+ | | +--:(path-key-case)
+ | | +--ro path-key
+ | | +--ro pce-id pce-id
+ | | +--ro path-key path-key
+ | +--ro rro
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro subobject*
+ | | +--ro protection-available? boolean
+ | | +--ro protection-in-use? boolean
+ | | +--ro (subobject-type)?
+ | | +--:(ip-prefix-case)
+ | | | +--ro ip-prefix
+ | | | +--ro ip-prefix inet:ip-prefix
+ | | +--:(label-case)
+ | | | +--ro label
+ | | | +--ro uni-directional boolean
+ | | | +--ro (label-type)?
+ | | | | +--:(type1-label-case)
+ | | | | | +--ro type1-label
+ | | | | | +--ro type1-label uint32
+ | | | | +--:(generalized-label-case)
+ | | | | | +--ro generalized-label
+ | | | | | +--ro generalized-label binary
+ | | | | +--:(waveband-switching-label-case)
+ | | | | +--ro waveband-switching-label
+ | | | | +--ro end-label uint32
+ | | | | +--ro start-label uint32
+ | | | | +--ro waveband-id uint32
+ | | | +--ro global? boolean
+ | | +--:(unnumbered-case)
+ | | | +--ro unnumbered
+ | | | +--ro router-id uint32
+ | | | +--ro interface-id uint32
+ | | +--:(path-key-case)
+ | | +--ro path-key
+ | | +--ro pce-id pce-id
+ | | +--ro path-key path-key
+ | +--ro xro
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro flags bits
+ | | +--ro subobject*
+ | | +--ro mandatory? boolean
+ | | +--ro attribute enumeration
+ | | +--ro (subobject-type)?
+ | | +--:(as-number-case)
+ | | | +--ro as-number
+ | | | +--ro as-number inet:as-number
+ | | +--:(ip-prefix-case)
+ | | | +--ro ip-prefix
+ | | | +--ro ip-prefix inet:ip-prefix
+ | | +--:(label-case)
+ | | | +--ro label
+ | | | +--ro uni-directional boolean
+ | | | +--ro (label-type)?
+ | | | +--:(type1-label-case)
+ | | | | +--ro type1-label
+ | | | | +--ro type1-label uint32
+ | | | +--:(generalized-label-case)
+ | | | | +--ro generalized-label
+ | | | | +--ro generalized-label binary
+ | | | +--:(waveband-switching-label-case)
+ | | | +--ro waveband-switching-label
+ | | | +--ro end-label uint32
+ | | | +--ro start-label uint32
+ | | | +--ro waveband-id uint32
+ | | +--:(srlg-case)
+ | | | +--ro srlg
+ | | | +--ro srlg-id srlg-id
+ | | +--:(unnumbered-case)
+ | | +--ro unnumbered
+ | | +--ro router-id uint32
+ | | +--ro interface-id uint32
+ | +--ro of
+ | | +--ro processing-rule? boolean
+ | | +--ro ignore? boolean
+ | | +--ro code of-id
+ | | +--ro tlvs
+ | | +--ro vendor-information-tlv*
+ | | +--ro enterprise-number? iana:enterprise-number
+ | | +--ro (enterprise-specific-information)?
+ | +--ro class-type
+ | +--ro processing-rule? boolean
+ | +--ro ignore? boolean
+ | +--ro class-type class-type
+ +--ro metadata
+ +--ro lsp
+ | +--ro processing-rule? boolean
+ | +--ro ignore? boolean
+ | +--ro tlvs
+ | | +--ro lsp-error-code
+ | | | +--ro error-code? uint32
+ | | +--ro lsp-identifiers
+ | | | +--ro lsp-id? rsvp:lsp-id
+ | | | +--ro tunnel-id? rsvp:tunnel-id
+ | | | +--ro (address-family)?
+ | | | +--:(ipv4-case)
+ | | | | +--ro ipv4
+ | | | | +--ro ipv4-tunnel-sender-address inet:ipv4-address
+ | | | | +--ro ipv4-extended-tunnel-id rsvp:ipv4-extended-tunnel-id
+ | | | | +--ro ipv4-tunnel-endpoint-address inet:ipv4-address
+ | | | +--:(ipv6-case)
+ | | | +--ro ipv6
+ | | | +--ro ipv6-tunnel-sender-address inet:ipv6-address
+ | | | +--ro ipv6-extended-tunnel-id rsvp:ipv6-extended-tunnel-id
+ | | | +--ro ipv6-tunnel-endpoint-address inet:ipv6-address
+ | | +--ro rsvp-error-spec
+ | | | +--ro (error-type)?
+ | | | +--:(rsvp-case)
+ | | | | +--ro rsvp-error
+ | | | +--:(user-case)
+ | | | +--ro user-error
+ | | +--ro symbolic-path-name
+ | | | +--ro path-name? symbolic-path-name
+ | | o--ro vs-tlv
+ | | | +--ro enterprise-number? iana:enterprise-number
+ | | | +--ro (vendor-payload)?
+ | | +--ro vendor-information-tlv*
+ | | | +--ro enterprise-number? iana:enterprise-number
+ | | | +--ro (enterprise-specific-information)?
+ | | +--ro path-binding
+ | | x--ro binding-type? uint8
+ | | x--ro binding-value? binary
+ | | +--ro (binding-type-value)?
+ | | +--:(mpls-label)
+ | | | +--ro mpls-label? netc:mpls-label
+ | | +--:(mpls-label-entry)
+ | | +--ro label? netc:mpls-label
+ | | +--ro traffic-class? uint8
+ | | +--ro bottom-of-stack? boolean
+ | | +--ro time-to-live? uint8
+ | +--ro plsp-id? plsp-id
+ | +--ro delegate? boolean
+ | +--ro sync? boolean
+ | +--ro remove? boolean
+ | +--ro administrative? boolean
+ | +--ro operational? operational-status
+ +--ro path-setup-type
+ +--ro pst? uint8
+
+-----
+
+The LSP-DB is accessible via RESTCONF.
+The PCC's LSPs are stored in the ``pcep-topology`` while the session is active.
+In a next example, there is one PCEP session with PCC identified by its IP address (*43.43.43.43*) and one reported LSP (*foo*).
+
+**URL:** ``/restconf/operational/network-topology:network-topology/topology/pcep-topology/node/pcc:%2F%2F43.43.43.43``
+
+**Method:** ``GET``
+
+**Response Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,4,5,8,12,14,15,16,17,18,20,24,25,26,28,29,32,36
+
+ <node>
+ <node-id>pcc://43.43.43.43</node-id>
+ <path-computation-client>
+ <ip-address>43.43.43.43</ip-address>
+ <state-sync>synchronized</state-sync>
+ <stateful-tlv>
+ <stateful>
+ <lsp-update-capability>true</lsp-update-capability>
+ </stateful>
+ </stateful-tlv>
+ <reported-lsp>
+ <name>foo</name>
+ <lsp>
+ <operational>up</operational>
+ <sync>true</sync>
+ <plsp-id>1</plsp-id>
+ <create>false</create>
+ <administrative>true</administrative>
+ <remove>false</remove>
+ <delegate>true</delegate>
+ <tlvs>
+ <lsp-identifiers>
+ <ipv4>
+ <ipv4-tunnel-sender-address>43.43.43.43</ipv4-tunnel-sender-address>
+ <ipv4-tunnel-endpoint-address>39.39.39.39</ipv4-tunnel-endpoint-address>
+ <ipv4-extended-tunnel-id>39.39.39.39</ipv4-extended-tunnel-id>
+ </ipv4>
+ <tunnel-id>1</tunnel-id>
+ <lsp-id>1</lsp-id>
+ </lsp-identifiers>
+ <symbolic-path-name>
+ <path-name>Zm9v</path-name>
+ </symbolic-path-name>
+ </tlvs>
+ </lsp>
+ <ero>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>201.20.160.40/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>195.20.160.39/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>39.39.39.39/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ </ero>
+ </reported-lsp>
+ </path-computation-client>
+ </node>
+
+@line 2: **node-id** The PCC identifier.
+
+@line 4: **ip-address** IP address of the PCC.
+
+@line 5: **state-sync** Synchronization status of the PCC's LSPs. The *synchronized* indicates the State Synchronization is done.
+
+@line 8: **lsp-update-capability** - Indicates that PCC allows LSP modifications.
+
+@line 12: **name** - Textual representation of LPS's name.
+
+@line 14: **operational** - Represent operational status of the LSP:
+
+ * *down* - not active.
+ * *up* - signaled.
+ * *active* - up and carrying traffic.
+ * *going-down* - LSP is being torn down, resources are being released.
+ * *going-up* - LSP is being signaled.
+
+@line 15: **sync** - The flag set by PCC during LSPs State Synchronization.
+
+@line 16: **plsp-id** - A PCEP-specific identifier for the LSP. It is assigned by PCC and it is constant for a lifetime of a PCEP session.
+
+@line 17: **create** - The *false* indicates that LSP is PCC-initiated.
+
+@line 18: **administrative** - The flag indicates target operational status of the LSP.
+
+@line 20: **delegate** - The delegate flag indicates that the PCC is delegating the LSP to the PCE.
+
+@line 24: **ipv4-tunnel-sender-address** - Contains the sender node's IP address.
+
+@line 25: **ipv4-tunnel-endpoint-address** - Contains the egress node's IP address.
+
+@line 26: **ipv4-extended-tunnel-id** - The *Extended Tunnel ID* identifier.
+
+@line 28: **tunnel-id** - The *Tunnel ID* identifier.
+
+@line 29: **lsp-id** - The *LSP ID* identifier.
+
+@line 32: **path-name** - The symbolic name for the LSP.
+
+@line 36: **ero** - The *Explicit Route Object* is encoding the path of the TE LSP through the network.
+
+LSP Delegation
+''''''''''''''
+The LSP control delegations is an mechanism, where PCC grants to a PCE the temporary right in order to modify LSP attributes.
+The PCC can revoke the delegation or the PCE may waive the delegation at any time.
+The LSP control is delegated to at most one PCE at the same time.
+
+.. figure:: ./images/bgpcep/pcep-delegation-return.png
+ :align: center
+ :alt: Returning a Delegation
+
+ Returning a Delegation.
+
+-----
+
+Following RPC example illustrates a request for the LSP delegation give up:
+
+**URL:** ``/restconf/operations/network-topology-pcep:update-lsp``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,3,6,10
+
+ <input>
+ <node>pcc://43.43.43.43</node>
+ <name>foo</name>
+ <arguments>
+ <lsp xmlns:stateful="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <delegate>false</delegate>
+ <administrative>true</administrative>
+ <tlvs>
+ <symbolic-path-name>
+ <path-name>Zm9v</path-name>
+ </symbolic-path-name>
+ </tlvs>
+ </lsp>
+ </arguments>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+@line 2: **node** The PCC identifier.
+
+@line 3: **name** The name of the LSP.
+
+@line 6: **delegate** - Delegation flag set *false* in order to return the LSP delegation.
+
+@line 10: **path-name** - The Symbolic Path Name TLV must be present when sending a request to give up the delegation.
+
+LSP Update
+''''''''''
+The LSP Update Request is an operation where a PCE requests a PCC to update attributes of an LSP and to rebuild the LSP with updated attributes.
+In order to update LSP, the PCE must hold a LSP delegation.
+The LSP update is done in *make-before-break* fashion - first, new LSP is initiated and then the old LSP is torn down.
+
+.. figure:: ./images/bgpcep/pcep-update.png
+ :align: center
+ :alt: Active Stateful PCE LSP Update
+
+ Active Stateful PCE LSP Update.
+
+-----
+
+Following RPC example shows a request for the LSP update:
+
+**URL:** ``/restconf/operations/network-topology-pcep:update-lsp``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,3,6,7,9
+
+ <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
+ <node>pcc://43.43.43.43</node>
+ <name>foo</name>
+ <arguments>
+ <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <delegate>true</delegate>
+ <administrative>true</administrative>
+ </lsp>
+ <ero>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>200.20.160.41/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>196.20.160.39/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>39.39.39.39/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ </ero>
+ </arguments>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+@line 2: **node** The PCC identifier.
+
+@line 3: **name** The name of the LSP to be updated.
+
+@line 6: **delegate** - Delegation flag set *true* in order to keep the LSP control.
+
+@line 7: **administrative** - Desired administrative status of the LSP is active.
+
+@line 9: **ero** - This LSP attribute is changed.
+
+PCE-initiated LSP Setup
+^^^^^^^^^^^^^^^^^^^^^^^
+The PCEP Extension for PCE-initiated LSP Setup allows PCE to request a creation and deletion of LSPs.
+
+Configuration
+'''''''''''''
+This capability is enabled by default. No additional configuration is required.
+
+LSP Instantiation
+'''''''''''''''''
+The PCE can request LSP creation.
+The LSP instantiation is done by sending an LSP Initiate Message to PCC.
+The PCC assign delegation to PCE which triggered creation.
+PCE-initiated LSPs are identified by *Create* flag.
+
+.. figure:: ./images/bgpcep/pcep-initiate.png
+ :align: center
+ :alt: LSP instantiation
+
+ LSP instantiation.
+
+-----
+
+Following RPC example shows a request for the LSP initiation:
+
+**URL:** ``/restconf/operations/network-topology-pcep:add-lsp``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,3,8,14
+
+ <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
+ <node>pcc://43.43.43.43</node>
+ <name>update-tunel</name>
+ <arguments>
+ <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <delegate>true</delegate>
+ <administrative>true</administrative>
+ </lsp>
+ <endpoints-obj>
+ <ipv4>
+ <source-ipv4-address>43.43.43.43</source-ipv4-address>
+ <destination-ipv4-address>39.39.39.39</destination-ipv4-address>
+ </ipv4>
+ </endpoints-obj>
+ <ero>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>201.20.160.40/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>195.20.160.39/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ <subobject>
+ <loose>false</loose>
+ <ip-prefix>
+ <ip-prefix>39.39.39.39/32</ip-prefix>
+ </ip-prefix>
+ </subobject>
+ </ero>
+ </arguments>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+@line 2: **node** The PCC identifier.
+
+@line 3: **name** The name of the LSP to be created.
+
+@line 8: **endpoints-obj** - The *END-POINT* Object is mandatory for an instantiation request of an RSVP-signaled LSP. It contains source and destination addresses for provisioning the LSP.
+
+@line 14: **ero** - The *ERO* object is mandatory for LSP initiation request.
+
+LSP Deletion
+''''''''''''
+The PCE may request a deletion of PCE-initiated LSPs.
+The PCE must be delegation holder for this particular LSP.
+
+.. figure:: ./images/bgpcep/pcep-deletion.png
+ :align: center
+ :alt: LSP deletion.
+
+ LSP deletion.
+
+-----
+
+Following RPC example shows a request for the LSP deletion:
+
+**URL:** ``/restconf/operations/network-topology-pcep:remove-lsp``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,3
+
+ <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
+ <node>pcc://43.43.43.43</node>
+ <name>update-tunel</name>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+@line 2: **node** The PCC identifier.
+
+@line 3: **name** The name of the LSP to be removed.
+
+PCE-initiated LSP Delegation
+''''''''''''''''''''''''''''
+The PCE-initiated LSP control is delegated to the PCE which requested the initiation.
+The PCC cannot revoke delegation of PCE-initiated LSP.
+When PCE returns delegation for such LSP or PCE fails, then the LSP become orphan and can be removed by a PCC after some time.
+The PCE may ask for a delegation of the orphan LSP.
+
+.. figure:: ./images/bgpcep/pcep-revoke-delegation.png
+ :align: center
+ :alt: LSP re-delegation
+
+ Orphan PCE-initiated LSP - control taken by PCE.
+
+-----
+
+Following RPC example illustrates a request for the LSP delegation:
+
+**URL:** ``/restconf/operations/network-topology-pcep:update-lsp``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,3,6,10
+
+ <input>
+ <node>pcc://43.43.43.43</node>
+ <name>update-tunel</name>
+ <arguments>
+ <lsp xmlns:stateful="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <delegate>true</delegate>
+ <administrative>true</administrative>
+ <tlvs>
+ <symbolic-path-name>
+ <path-name>dXBkYXRlLXR1bmVs</path-name>
+ </symbolic-path-name>
+ </tlvs>
+ </lsp>
+ </arguments>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+@line 2: **node** The PCC identifier.
+
+@line 3: **name** The name of the LSP.
+
+@line 6: **delegate** - *Delegation* flag set *true* in order to take the LSP delegation.
+
+@line 10: **path-name** - The *Symbolic Path Name* TLV must be present when sending a request to take a delegation.
+
+Segment Routing
+^^^^^^^^^^^^^^^
+The PCEP Extensions for Segment Routing (SR) allow a stateful PCE to compute and initiate TE paths in SR networks.
+The SR path is defined as an order list of *segments*.
+Segment Routing architecture can be directly applied to the MPLS forwarding plane without changes.
+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:
+
+**URL:** ``/restconf/config/pcep-segment-routing-app-config:pcep-segment-routing-app-config``
+
+**Method:** ``PUT``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+
+ <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>
+
+LSP Operations for PCEP SR
+''''''''''''''''''''''''''
+The PCEP SR extension defines new ERO subobject - *SR-ERO subobject* capable of carrying a SID.
+
+.. code-block:: console
+
+ sr-ero-type
+ +---- c-flag? boolean
+ +---- m-flag? boolean
+ +---- sid-type? sid-type
+ +---- sid? uint32
+ +---- (nai)?
+ +--:(ip-node-id)
+ | +---- ip-address inet:ip-address
+ +--:(ip-adjacency)
+ | +---- local-ip-address inet:ip-address
+ | +---- remote-ip-address inet:ip-address
+ +--:(unnumbered-adjacency)
+ +---- local-node-id uint32
+ +---- local-interface-id uint32
+ +---- remote-node-id uint32
+ +---- remote-interface-id uint32
+
+-----
+
+Following RPC example illustrates a request for the SR-TE LSP creation:
+
+**URL:** ``/restconf/operations/network-topology-pcep:add-lsp``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 16,21,22,23
+
+ <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
+ <node>pcc://43.43.43.43</node>
+ <name>sr-path</name>
+ <arguments>
+ <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <delegate>true</delegate>
+ <administrative>true</administrative>
+ </lsp>
+ <endpoints-obj>
+ <ipv4>
+ <source-ipv4-address>43.43.43.43</source-ipv4-address>
+ <destination-ipv4-address>39.39.39.39</destination-ipv4-address>
+ </ipv4>
+ </endpoints-obj>
+ <path-setup-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <pst>1</pst>
+ </path-setup-type>
+ <ero>
+ <subobject>
+ <loose>false</loose>
+ <sid-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">ipv4-node-id</sid-type>
+ <m-flag xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">true</m-flag>
+ <sid xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">24001</sid>
+ <ip-address xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">39.39.39.39</ip-address>
+ </subobject>
+ </ero>
+ </arguments>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+@line 16: **path-setup-type** - Set *1* for SR-TE LSP
+
+@line 21: **ipv4-node-id** - The SR-ERO subobject represents *IPv4 Node ID* NAI.
+
+@line 22: **m-flag** - The SID value represents an MPLS label.
+
+@line 23: **sid** - The Segment Identifier.
+
+-----
+
+Following RPC example illustrates a request for the SR-TE LSP update including modified path:
+
+**URL:** ``/restconf/operations/network-topology-pcep:update-lsp``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+
+ <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
+ <node>pcc://43.43.43.43</node>
+ <name>update-tunnel</name>
+ <arguments>
+ <lsp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <delegate>true</delegate>
+ <administrative>true</administrative>
+ </lsp>
+ <path-setup-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:ietf:stateful">
+ <pst>1</pst>
+ </path-setup-type>
+ <ero>
+ <subobject>
+ <loose>false</loose>
+ <sid-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">ipv4-node-id</sid-type>
+ <m-flag xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">true</m-flag>
+ <sid xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">24002</sid>
+ <ip-address xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">200.20.160.41</ip-address>
+ </subobject>
+ <subobject>
+ <loose>false</loose>
+ <sid-type xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">ipv4-node-id</sid-type>
+ <m-flag xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">true</m-flag>
+ <sid xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">24001</sid>
+ <ip-address xmlns="urn:opendaylight:params:xml:ns:yang:pcep:segment:routing">39.39.39.39</ip-address>
+ </subobject>
+ </ero>
+ </arguments>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+LSP State Synchronization Optimization Procedures
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This extension bring optimizations for state synchronization:
+
+* State Synchronization Avoidance
+* Incremental State Synchronization
+* PCE-triggered Initial Synchronization
+* PCE-triggered Re-synchronization
+
+Configuration
+'''''''''''''
+This capability is enabled by default. No additional configuration is required.
+
+State Synchronization Avoidance
+'''''''''''''''''''''''''''''''
+The State Synchronization Avoidance procedure is intended to skip state synchronization if the state has survived and not changed during session restart.
+
+.. figure:: ./images/bgpcep/pcep-sync-skipped.png
+ :align: center
+ :alt: Sync skipped
+
+ State Synchronization Skipped.
+
+Incremental State Synchronization
+'''''''''''''''''''''''''''''''''
+The Incremental State Synchronization procedure is intended to do incremental (delta) state synchronization when possible.
+
+.. figure:: ./images/bgpcep/pcep-sync-incremental.png
+ :align: center
+ :alt: Sync incremental
+
+ Incremental Synchronization Procedure.
PCE-triggered Initial Synchronization
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+'''''''''''''''''''''''''''''''''''''
+The PCE-triggered Initial Synchronization procedure is intended to do let PCE control the timing of the initial state synchronization.
+
+.. figure:: ./images/bgpcep/pcep-sync-initial.png
+ :align: center
+ :alt: Initial Sync
+
+ PCE-triggered Initial State Synchronization Procedure.
-Making an trigger-sync operation will trigger a PCUpd message to PCC
-with PLSP-ID = 0 and SYNC = 1 in order to trigger the LSP-DB
-synchronization process.
+-----
-**URL:**
-http://localhost:8181/restconf/operations/network-topology-pcep:trigger-sync
+Following RPC example illustrates a request for the initial synchronization:
-**Method:** POST
+**URL:** ``/restconf/operations/network-topology-pcep:trigger-sync``
-**Content-Type:** application/xml
+**Method:** ``POST``
-**Body:**
+**Content-Type:** ``application/xml``
-.. code:: xml
+**Request Body:**
- <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
- <node>pcc://43.43.43.43</node>
- <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
- </input>
+.. code-block:: xml
+ :linenos:
+
+ <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
+ <node>pcc://43.43.43.43</node>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
PCE-triggered Re-synchronization
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+''''''''''''''''''''''''''''''''
+The PCE-triggered Re-synchronization: To let PCE re-synchronize the state for sanity check.
+
+.. figure:: ./images/bgpcep/pcep-re-sync.png
+ :align: center
+ :alt: Re-sync
+
+ PCE-triggered Re-synchronization Procedure.
+
+-----
+
+Following RPC example illustrates a request for the LSP re-synchronization:
+
+**URL:** ``/restconf/operations/network-topology-pcep:trigger-sync``
+
+**Method:** ``POST``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 3
+
+ <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
+ <node>pcc://43.43.43.43</node>
+ <name>update-lsp</name>
+ <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
+ </input>
+
+@line 3: **name** - The LSP name. If this parameter is omitted, re-synchronization is requested for all PCC's LSPs.
+
+Test tools
+----------
+PCC Mock
+^^^^^^^^
+The PCC Mock is a stand-alone Java application purposed to simulate a PCC(s).
+The simulator is capable to report sample LSPs, respond to delegation, LSP management operations and synchronization optimization procedures.
+This application is not part of the OpenDaylight Karaf distribution, however it can be downloaded from OpenDaylight's Nexus (use latest release version):
+
+``https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/bgpcep/pcep-pcc-mock``
+
+Usage
+'''''
+The application can be run from command line:
+
+.. code-block:: console
+
+ java -jar pcep-pcc-mock-*-executable.jar
+
+
+with optional input parameters:
+
+.. code-block:: console
+
+ --local-address <Address:Port> (optional, default 127.0.0.1)
+ The first PCC IP address. If more PCCs are required, the IP address will be incremented. Port number can be optionally specified.
+
+ --remote-address <Address1:Port1,Address2:Port2,Address3:Port3,...> (optional, default 127.0.0.1:4189)
+ The list of IP address for the PCE servers. Port number can be optionally specified, otherwise default port number 4189 is used.
+
+ --pcc <N> (optional, default 1)
+ Number of mocked PCC instances.
+
+ --lsp <N> (optional, default 1)
+ Number of tunnels (LSPs) reported per PCC, might be zero.
+
+ --pcerr (optional flag)
+ If the flag is present, response with PCErr, otherwise PCUpd.
+
+ --log-level <LEVEL> (optional, default INFO)
+ Set logging level for pcc-mock.
+
+ -d, --deadtimer <0..255> (optional, default 120)
+ DeadTimer value in seconds.
+
+ -ka, --keepalive <0.255> (optional, default 30)
+ KeepAlive timer value in seconds.
+
+ --password <password> (optional)
+ If the password is present, it is used in TCP MD5 signature, otherwise plain TCP is used.
+
+ --reconnect <seconds> (optional)
+ If the argument is present, the value in seconds, is used as a delay before each new reconnect (initial connect or connection re-establishment) attempt.
+ The number of reconnect attempts is unlimited. If the argument is omitted, pcc-mock is not trying to reconnect.
+
+ --redelegation-timeout <seconds> (optional, default 0)
+ The timeout starts when LSP delegation is returned or PCE fails, stops when LSP is re-delegated to PCE.
+ When timeout expires, LSP delegation is revoked and held by PCC.
+
+ --state-timeout <seconds> (optional, default -1 (disabled))
+ The timeout starts when LSP delegation is returned or PCE fails, stops when LSP is re-delegated to PCE.
+ When timeout expires, PCE-initiated LSP is removed.
+
+ --state-sync-avoidance <disconnect_after_x_seconds> <reconnect_after_x_seconds> <dbVersion>
+ Synchronization avoidance capability enabled.
+ - disconnect_after_x_seconds: seconds that will pass until disconnections is forced. If set to smaller number than 1, disconnection wont be performed.
+ - reconnect_after_x_seconds: seconds that will pass between disconnection and new connection attempt. Only happens if disconnection has been performed.
+ - dbVersion: dbVersion used in new Open and must be always equal or bigger than LSP. If equal than LSP skip synchronization will be performed,
+ if not full synchronization will be performed taking in account new starting dbVersion desired.
+ --incremental-sync-procedure <disconnect_after_x_seconds> <reconnect_after_x_seconds> <dbVersion>
+ Incremental synchronization capability enabled.
+ - dbVersion: dbVersion used in new Open and must be always bigger than LSP. Incremental synchronization will be performed taking in account new starting dbVersion desired.
+
+ --triggered-initial-sync
+ PCE-triggered synchronization capability enabled. Can be combined combined with state-sync-avoidance/incremental-sync-procedure.
+
+ --triggered-re-sync
+ PCE-triggered re-synchronization capability enabled.
+
+Data Change Counter Tool
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Data Change Counter tool registers a Data Change Listener to a specified topology's subtree.
+This will allow us to know the quantity of changes produced under it, with each data change event counter will be incremented.
+
+Installation
+''''''''''''
+Installing data change counter tool
+
+.. code-block:: console
+
+ feature:install odl-restconf odl-bgpcep-data-change-counter
+
+Configuration
+'''''''''''''
+Once we set the configuration, a new data change counter will be created and registers to example-linkstate-topology.
+
+.. important:: **Clustering** - Each Counter Identifier should be unique.
+
+**URL:** ``/restconf/config/odl-data-change-counter-config:data-change-counter-config/data-change-counter``
+
+**Method:** ``PUT``
+
+**Content-Type:** ``application/xml``
+
+**Request Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,3
+
+ <data-change-counter-config xmlns="urn:opendaylight:params:xml:ns:yang:bgpcep:data-change-counter-config">
+ <counter-id>data-change-counter</counter-id>
+ <topology-name>example-linkstate-topology</topology-name>
+ </data-change-counter-config>
+
+@line 2: **Counter Id** - Unique counter change identifier.
+
+@line 3: **Topology Name** - An identifier for a topology.
+
+Usage
+'''''
+
+Counter state for topology
+
+**URL:** ``/restconf/operational/data-change-counter:data-change-counter/counter/data-change-counter``
+
+**Method:** ``GET``
+
+**Response Body:**
+
+.. code-block:: xml
+ :linenos:
+ :emphasize-lines: 2,3
+
+ <counter xmlns="urn:opendaylight:params:xml:ns:yang:bgp-data-change-counter">
+ <id>data-change-counter</id>
+ <count>0</count>
+ </counter>
+
+@line 2: **Counter Id** - Unique counter change identifier.
+
+@line 3: **Count** - Number of changes under registered topology's subtree.
+
+Troubleshooting
+---------------
+This section offers advices in a case OpenDaylight PCEP plugin is not working as expected.
+
+.. contents:: Contents
+ :depth: 2
+ :local:
+
+PCEP is not working...
+^^^^^^^^^^^^^^^^^^^^^^
+* First of all, ensure that all required features are installed, local PCE and remote PCC configuration is correct.
+
+ To list all installed features in OpenDaylight use the following command at the Karaf console:
+
+ .. code-block:: console
+
+ feature:list -i
+
+* Check OpenDaylight Karaf logs:
+
+ From Karaf console:
+
+ .. code-block:: console
+
+ log:tail
+
+ or open log file: ``data/log/karaf.log``
+
+ Possibly, a reason/hint for a cause of the problem can be found there.
+
+* Try to minimize effect of other OpenDaylight features, when searching for a reason of the problem.
+
+* Try to set DEBUG severity level for PCEP logger via Karaf console commands, in order to collect more information:
+
+ .. code-block:: console
-Making an trigger-resync operation will trigger a PCUpd message to PCC.
-The PCE can choose to re-synchronize its entire LSP database or a single
-LSP.
+ log:set DEBUG org.opendaylight.protocol.pcep
-**URL:**
-http://localhost:8181/restconf/operations/network-topology-pcep:trigger-sync
+ .. code-block:: console
-**Method:** POST
+ log:set DEBUG org.opendaylight.bgpcep.pcep
-**Content-Type:** application/xml
+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.
-**Body:**
+Write an e-mail to bgpcep-users@lists.opendaylight.org and provide following information:
-.. code:: xml
+#. State OpenDaylight version
- <input xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep">
- <node>pcc://43.43.43.43</node>
- <name>re-sync-lsp</name>
- <network-topology-ref xmlns:topo="urn:TBD:params:xml:ns:yang:network-topology">/topo:network-topology/topo:topology[topo:topology-id="pcep-topology"]</network-topology-ref>
- </input>
+#. Describe your use-case and provide as much details related to PCEP as possible
-PCE-triggered LSP database Re-synchronization
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#. Steps to reproduce
-PCE-triggered LSP database Re-synchronization works same as in
-PCE-triggered Initial Synchronization.
+#. Attach Karaf log files, optionally packet captures, REST input/output
+References
+----------
+* `A Path Computation Element (PCE)-Based Architecture <https://tools.ietf.org/html/rfc4655>`_
+* `Path Computation Element (PCE) Communication Protocol Generic Requirements <https://tools.ietf.org/html/rfc4657>`_
+* `Unanswered Questions in the Path Computation Element Architecture <https://tools.ietf.org/html/rfc7399>`_
+* `A PCE-Based Architecture for Application-Based Network Operations <https://tools.ietf.org/html/rfc7491>`_
+* `Framework for PCE-Based Inter-Layer MPLS and GMPLS Traffic Engineering <https://tools.ietf.org/html/rfc5623>`_
+* `Applicability of a Stateful Path Computation Element (PCE) <https://tools.ietf.org/html/draft-ietf-pce-stateful-pce-app-07>`_
Code Review / docs.git / blobdiff