module ietf-pcep {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-pcep";
prefix pcep;
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types";
}
import ietf-te-types {
prefix te-types;
reference
"RFC 8776: Common YANG Data Types for Traffic Engineering";
}
import ietf-key-chain {
prefix key-chain;
reference
"RFC 8177: YANG Data Model for Key Chains";
}
import ietf-netconf-acm {
prefix nacm;
reference
"RFC 8341: Network Configuration Access Control Model";
}
import ietf-tls-server {
prefix tlss;
reference
"RFC 9645: YANG Groupings for TLS Clients and TLS Servers";
}
import ietf-tls-client {
prefix tlsc;
reference
"RFC 9645: YANG Groupings for TLS Clients and TLS Servers";
}
import ietf-ospf {
prefix ospf;
reference
"RFC 9129: YANG Data Model for the OSPF Protocol";
}
import ietf-isis {
prefix isis;
reference
"RFC 9130: YANG Data Model for the IS-IS Protocol";
}
organization
"IETF PCE (Path Computation Element) Working Group";
contact
"WG Web:
WG List:
Editor: Dhruv Dhody
";
description
"The YANG module defines a generic configuration and
operational model for the Path Computation Element
Communication Protocol (PCEP).
The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
'MAY', and 'OPTIONAL' in this document are to be interpreted as
described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
they appear in all capitals, as shown here.
Copyright (c) 2025 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject to
the license terms contained in, the Revised BSD License set
forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC 9826; see the
RFC itself for full legal notices.";
revision 2025-09-12 {
description
"Initial revision.";
reference
"RFC 9826: A YANG Data Model for the Path Computation
Element Communication Protocol (PCEP)";
}
/*
* Typedefs
*/
typedef role {
type enumeration {
enum unknown {
value 0;
description
"An unknown role.";
}
enum pcc {
value 1;
description
"The role of a Path Computation Client (PCC).";
}
enum pce {
value 2;
description
"The role of a Path Computation Element (PCE).";
}
enum pcc-and-pce {
value 3;
description
"The role of both Path Computation Client (PCC) and
Path Computation Element (PCE).";
}
}
description
"The role of a PCEP speaker.
Takes one of the following values:
- unknown(0): the role is not known,
- pcc(1): the role is of a Path Computation
Client (PCC),
- pce(2): the role is of a Path Computation
Element (PCE),
- pcc-and-pce(3): the role is of both a PCC and
a PCE.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
typedef oper-status {
type enumeration {
enum oper-status-up {
value 1;
description
"The PCEP entity is active.";
}
enum oper-status-down {
value 2;
description
"The PCEP entity is inactive.";
}
enum oper-status-going-up {
value 3;
description
"The PCEP entity is activating.";
}
enum oper-status-going-down {
value 4;
description
"The PCEP entity is deactivating.";
}
enum oper-status-failed {
value 5;
description
"The PCEP entity has failed and will recover
when possible.";
}
enum oper-status-failed-perm {
value 6;
description
"The PCEP entity has failed and will not recover
without operator intervention.";
}
}
description
"The operational status of the PCEP entity.
Takes one of the following values:
- oper-status-up(1): Active,
- oper-status-down(2): Inactive,
- oper-status-going-up(3): Activating,
- oper-status-going-down(4): Deactivating,
- oper-status-failed(5): Failed,
- oper-status-failed-perm(6): Failed Permanently.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
typedef initiator {
type enumeration {
enum local {
value 1;
description
"The local PCEP entity initiated the session.";
}
enum remote {
value 2;
description
"The remote PCEP peer initiated the session.";
}
}
description
"The initiator of the session, that is, whether the TCP
connection was initiated by the local PCEP entity or
the remote peer.
Takes one of the following values:
- local(1): Initiated locally,
- remote(2): Initiated remotely.";
}
typedef sess-state {
type enumeration {
enum tcp-pending {
value 1;
description
"The TCPPending state of PCEP session.";
}
enum open-wait {
value 2;
description
"The OpenWait state of PCEP session.";
}
enum keep-wait {
value 3;
description
"The KeepWait state of PCEP session.";
}
enum session-up {
value 4;
description
"The SessionUP state of PCEP session.";
}
}
description
"The current state of the session.
The set of possible states excludes the idle state
since entries do not exist in the idle state.
Takes one of the following values:
- tcp-pending(1): PCEP TCPPending state,
- open-wait(2): PCEP OpenWait state,
- keep-wait(3): PCEP KeepWait state,
- session-up(4): PCEP SessionUP state.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
typedef domain {
type union {
type ospf:area-id-type;
type isis:area-address;
type inet:as-number;
}
description
"The domain information.";
}
typedef operational-state {
type enumeration {
enum down {
value 0;
description
"Not active.";
}
enum up {
value 1;
description
"Signaled.";
}
enum active {
value 2;
description
"Up and carrying traffic.";
}
enum going-down {
value 3;
description
"LSP is being torn down; resources are
being released.";
}
enum going-up {
value 4;
description
"LSP is being signaled.";
}
}
description
"The operational status of the LSP.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
typedef sync-state {
type enumeration {
enum pending {
value 0;
description
"The state synchronization
has not started.";
}
enum ongoing {
value 1;
description
"The state synchronization
is ongoing.";
}
enum finished {
value 2;
description
"The state synchronization
is finished.";
}
}
description
"The LSP-DB state synchronization operational
status.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
typedef hpce-role {
type enumeration {
enum unknown {
value 0;
description
"An unknown role.";
}
enum child {
value 1;
description
"The PCE is acting as child PCE.";
}
enum parent {
value 2;
description
"The PCE is acting as parent PCE.";
}
}
description
"The H-PCE role of the PCE.";
reference
"RFC 8685: Path Computation Element Communication Protocol
(PCEP) Extensions for the Hierarchical Path Computation
Element (H-PCE) Architecture";
}
/*
* Features
*/
feature svec {
description
"Support synchronized path computation.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
feature gmpls {
description
"Support GMPLS.";
reference
"RFC 8779: Path Computation Element Communication Protocol
(PCEP) Extensions for GMPLS";
}
feature objective-function {
description
"Support OF as per RFC 5541.";
reference
"RFC 5541: Encoding of Objective Functions in the Path
Computation Element Communication Protocol (PCEP)";
}
feature global-concurrent {
description
"Support Global Concurrent Optimization (GCO) as per RFC
5557.";
reference
"RFC 5557: Path Computation Element Communication Protocol
(PCEP) Requirements and Protocol Extensions in Support of
Global Concurrent Optimization";
}
feature path-key {
description
"Support path-key as per RFC 5520.";
reference
"RFC 5520: Preserving Topology Confidentiality in Inter-
Domain Path Computation Using a Path-Key-Based Mechanism";
}
feature p2mp {
description
"Support Point-to-Multipoint (P2MP) as per RFC 8306.";
reference
"RFC 8306: Extensions to the Path Computation Element
Communication Protocol (PCEP) for Point-to-Multipoint
Traffic Engineering Label Switched Paths";
}
feature stateful {
description
"Support stateful PCE as per RFC 8231.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
feature sync-opt {
description
"Support stateful state synchronization optimization
as per RFC 8232.";
reference
"RFC 8232: Optimizations of Label Switched Path State
Synchronization Procedures for a Stateful PCE";
}
feature pce-initiated {
description
"Support PCE-initiated LSP as per
RFC 8281.";
reference
"RFC 8281: Path Computation Element Communication Protocol
(PCEP) Extensions for PCE-Initiated LSP Setup in a Stateful
PCE Model";
}
feature tls {
description
"Support PCEP over TLS as per RFC 8253.";
reference
"RFC 8253: PCEPS: Usage of TLS to Provide a Secure Transport
for the Path Computation Element Communication Protocol
(PCEP)";
}
feature sr-mpls {
description
"Support Segment Routing (SR) for MPLS in PCEP.";
reference
"RFC 8664: Path Computation Element Communication Protocol
(PCEP) Extensions for Segment Routing";
}
feature association {
description
"Support Association in PCEP.";
reference
"RFC 8697: Path Computation Element Communication Protocol
(PCEP) Extensions for Establishing Relationships between
Sets of Label Switched Paths (LSPs)";
}
feature flowspec {
description
"Support Flow Specification in PCEP.";
reference
"RFC 9168: Path Computation Element Communication Protocol
(PCEP) Extension for Flow Specification";
}
feature h-pce {
description
"Support Hierarchical PCE (H-PCE).";
reference
"RFC 8685: Path Computation Element Communication
Protocol (PCEP) Extensions for the Hierarchical Path
Computation Element (H-PCE) Architecture";
}
feature inter-layer {
description
"Support inter-layer path computation.";
reference
"RFC 8282: Extensions to the Path Computation
Element Communication Protocol (PCEP) for Inter-
Layer MPLS and GMPLS Traffic Engineering";
}
/*
* Identities
*/
identity domain-type {
description
"Base domain type for PCE.";
}
identity ospf-area {
base domain-type;
description
"The OSPF area.";
}
identity isis-area {
base domain-type;
description
"The IS-IS area.";
}
identity autonomous-system {
base domain-type;
description
"The Autonomous System (AS).";
}
identity lsp-error {
if-feature "stateful";
description
"Base LSP error.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity no-error-lsp-error {
if-feature "stateful";
base lsp-error;
description
"No error; LSP is fine.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity unknown-lsp-error {
if-feature "stateful";
base lsp-error;
description
"Unknown reason. LSP Error Code value = 1.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity limit-lsp-error {
if-feature "stateful";
base lsp-error;
description
"Limit reached for PCE-controlled LSPs. LSP Error Code
value = 2.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity pending-lsp-error {
if-feature "stateful";
base lsp-error;
description
"Too many pending LSP update requests. LSP Error Code
value = 3.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity unacceptable-lsp-error {
if-feature "stateful";
base lsp-error;
description
"Unacceptable parameters. LSP Error Code value = 4.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity internal-lsp-error {
if-feature "stateful";
base lsp-error;
description
"Internal error. LSP Error Code value = 5.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity admin-lsp-error {
if-feature "stateful";
base lsp-error;
description
"LSP administratively brought down. LSP Error Code value
= 6.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity preempted-lsp-error {
if-feature "stateful";
base lsp-error;
description
"LSP preempted. LSP Error Code value = 7.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity rsvp-lsp-error {
if-feature "stateful";
base lsp-error;
description
"RSVP signaling error. LSP Error Code value = 8.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
identity path-protection {
base te-types:association-type;
description
"Path Protection Association.";
reference
"RFC 8745: Path Computation Element Communication Protocol
(PCEP) Extensions for Associating Working and Protection
Label Switched Paths (LSPs) with Stateful PCE";
}
identity disjoint {
base te-types:association-type;
description
"Disjoint Association.";
reference
"RFC 8800: Path Computation Element Communication Protocol
(PCEP) Extension for Label Switched Path (LSP) Diversity
Constraint Signaling";
}
identity policy {
base te-types:association-type;
description
"Policy Association.";
reference
"RFC 9005: Path Computation Element Communication Protocol
(PCEP) Extension for Associating Policies and Label Switched
Paths (LSPs)";
}
identity virtual-network {
base te-types:association-type;
description
"Virtual Network (VN) Association.";
reference
"RFC 9358: Path Computation Element Communication Protocol
(PCEP) Extensions for Establishing Relationships between
Sets of Label Switched Paths and Virtual Networks";
}
/*
* Groupings
*/
grouping domain {
description
"This grouping specifies a domain where the
PCEP speaker has topology visibility.";
leaf type {
type identityref {
base domain-type;
}
description
"The domain type.";
}
leaf domain {
type domain;
description
"The domain information.";
}
}
grouping domain-info {
description
"This grouping specifies all information that
may be relevant to both PCC and PCE.
This information corresponds to PCE auto-discovery
information.
The scope relates to either a local entity or a peer.";
container domains {
description
"The domain for the local PCEP entity or a peer.";
list domain {
key "type domain";
description
"The domain information.";
uses domain {
description
"The domain for the local PCEP entity or a peer.";
}
}
}
container capabilities {
description
"The PCEP entity or peer capability information.
This may be relevant to PCE selection as well.
This information corresponds to PCE auto-
discovery information.";
reference
"IANA IGP: Path Computation Element (PCE) Capability
Flags in Interior Gateway Protocol (IGP) Parameters
RFC 5088: OSPF Protocol Extensions for Path
Computation Element (PCE) Discovery
RFC 5089: IS-IS Protocol Extensions for Path
Computation Element (PCE) Discovery
RFC 9353: IGP Extension for Path Computation Element
Communication Protocol (PCEP) Security Capability
Support in PCE Discovery (PCED)";
leaf capability {
type bits {
bit gmpls {
if-feature "gmpls";
description
"Path computation with GMPLS link
constraints.";
}
bit bi-dir {
description
"Bidirectional path computation.";
}
bit diverse {
description
"Diverse path computation.";
}
bit load-balance {
description
"Load-balanced path computation.";
}
bit synchronize {
if-feature "svec";
description
"Synchronized paths computation.";
}
bit objective-function {
if-feature "objective-function";
description
"Support for multiple objective functions.";
}
bit add-path-constraint {
description
"Support for additive path constraints (max
hop count, etc.).";
}
bit prioritization {
description
"Support for request prioritization.";
}
bit multi-request {
description
"Support for multiple requests per message.";
}
bit global-concurrent {
if-feature "global-concurrent";
description
"Support for Global Concurrent Optimization
(GCO).";
reference
"RFC 5557: Path Computation Element Communication
Protocol (PCEP) Requirements and Protocol
Extensions in Support of Global Concurrent
Optimization";
}
bit p2mp {
if-feature "p2mp";
description
"Support for P2MP path computation.";
reference
"RFC 8306: Extensions to the Path Computation
Element Communication Protocol (PCEP) for
Point-to-Multipoint Traffic Engineering Label
Switched Paths";
}
bit active {
if-feature "stateful";
description
"Support for active stateful PCE.";
reference
"RFC 8231: Path Computation Element
Communication Protocol (PCEP) Extensions
for Stateful PCE";
}
bit passive {
if-feature "stateful";
description
"Support for passive stateful PCE.";
reference
"RFC 8231: Path Computation Element
Communication Protocol (PCEP) Extensions
for Stateful PCE";
}
bit p2mp-active {
if-feature "stateful";
if-feature "p2mp";
description
"Support for active stateful PCE for P2MP.";
reference
"RFC 8623: Stateful Path Computation Element
(PCE) Protocol Extensions for Usage with
Point-to-Multipoint TE Label Switched Paths
(LSPs)";
}
bit p2mp-passive {
if-feature "stateful";
if-feature "p2mp";
description
"Support for passive stateful PCE for P2MP.";
reference
"RFC 8623: Stateful Path Computation Element
(PCE) Protocol Extensions for Usage with
Point-to-Multipoint TE Label Switched Paths
(LSPs)";
}
bit p2mp-pce-initiated {
if-feature "stateful";
if-feature "pce-initiated";
if-feature "p2mp";
description
"Support for PCE-initiated LSP for P2MP.";
reference
"RFC 8623: Stateful Path Computation Element
(PCE) Protocol Extensions for Usage with
Point-to-Multipoint TE Label Switched Paths
(LSPs)";
}
bit flowspec {
if-feature "flowspec";
description
"Support for Flow Specification.";
reference
"RFC 9168: Path Computation Element Communication
Protocol (PCEP) Extension for Flow Specification";
}
bit tcp-ao {
description
"Support for the TCP Authentication Option
(TCP-AO).";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)
RFC 5925: The TCP Authentication Option";
}
bit tls {
if-feature "tls";
description
"Support for TLS.";
reference
"RFC 8253: PCEPS: Usage of TLS to Provide a
Secure Transport for the Path Computation
Element Communication Protocol (PCEP)";
}
}
description
"The bits string indicating the capabilities.";
reference
"IANA IGP: Path Computation Element (PCE) Capability
Flags in Interior Gateway Protocol (IGP) Parameters
RFC 5088: OSPF Protocol Extensions for Path
Computation Element (PCE) Discovery
RFC 5089: IS-IS Protocol Extensions for Path
Computation Element (PCE) Discovery
RFC 9353: IGP Extension for Path Computation Element
Communication Protocol (PCEP) Security Capability
Support in PCE Discovery (PCED)";
}
leaf pce-initiated {
if-feature "pce-initiated";
type boolean;
default "false";
description
"Set to true if PCE-initiated LSP capability is
enabled.";
reference
"RFC 8281: Path Computation Element Communication
Protocol (PCEP) Extensions for PCE-Initiated LSP
Setup in a Stateful PCE Model";
}
leaf include-db-ver {
if-feature "stateful";
if-feature "sync-opt";
type boolean;
default "true";
description
"Support inclusion of LSP-DB-VERSION
in LSP object.";
reference
"RFC 8232: Optimizations of Label Switched Path State
Synchronization Procedures for a Stateful PCE";
}
leaf trigger-resync {
if-feature "stateful";
if-feature "sync-opt";
type boolean;
default "true";
description
"Support PCE-triggered resynchronization.";
reference
"RFC 8232: Optimizations of Label Switched Path State
Synchronization Procedures for a Stateful PCE";
}
leaf trigger-initial-sync {
if-feature "stateful";
if-feature "sync-opt";
type boolean;
default "true";
description
"PCE-triggered initial synchronization.";
reference
"RFC 8232: Optimizations of Label Switched Path State
Synchronization Procedures for a Stateful PCE";
}
leaf incremental-sync {
if-feature "stateful";
if-feature "sync-opt";
type boolean;
default "true";
description
"Support incremental (delta) synchronization.";
reference
"RFC 8232: Optimizations of Label Switched Path State
Synchronization Procedures for a Stateful PCE";
}
container sr-mpls {
if-feature "sr-mpls";
description
"If segment routing for MPLS is supported at the local
entity or a peer.";
reference
"RFC 8664: Path Computation Element Communication Protocol
(PCEP) Extensions for Segment Routing";
leaf enabled {
type boolean;
default "false";
description
"Set to true if SR-MPLS is enabled.";
}
leaf no-msd-limit {
type boolean;
default "false";
description
"True indicates no limit on Maximum SID Depth (MSD); the
leaf msd is ignored.";
}
leaf nai {
type boolean;
default "false";
description
"True indicates the capability to resolve Node or
Adjacency Identifier (NAI) to Segment
Identifier (SID).";
}
}
container stateful-gmpls {
if-feature "stateful";
if-feature "gmpls";
description
"If stateful GMPLS is supported for a local entity
or a peer.";
reference
"RFC 8779: Path Computation Element Communication Protocol
(PCEP) Extensions for GMPLS";
leaf enabled {
type boolean;
default "false";
description
"Set to true if stateful GMPLS is enabled.";
}
}
leaf inter-layer {
if-feature "inter-layer";
type boolean;
default "false";
description
"If inter-layer path computation is supported for
local entity or a peer.";
reference
"RFC 8282: Extensions to the Path Computation
Element Communication Protocol (PCEP) for Inter-
Layer MPLS and GMPLS Traffic Engineering";
}
container h-pce {
if-feature "h-pce";
description
"If Hierarchical PCE (H-PCE) is supported for local
entity or a peer.";
reference
"RFC 8685: Path Computation Element Communication
Protocol (PCEP) Extensions for the Hierarchical Path
Computation Element (H-PCE) Architecture";
leaf enabled {
type boolean;
default "false";
description
"Set to true if H-PCE is enabled.";
}
leaf stateful {
if-feature "stateful";
type boolean;
default "false";
description
"Set to true if stateful H-PCE is enabled.";
reference
"RFC 8751: Hierarchical Stateful Path Computation
Element (PCE)";
}
leaf role {
when "../../../role = 'pce'"
+ "or "
+ "../../../role = 'pcc-and-pce'" {
description
"These fields are applicable when the role is PCE.";
}
type hpce-role;
description
"The H-PCE role of the PCE.";
}
}
}
leaf msd {
if-feature "sr-mpls";
type uint8;
config false;
description
"Maximum SID Depth (MSD) for SR-MPLS (i.e., the label stack
depth that a PCC is capable of imposing on a packet).";
reference
"RFC 8664: Path Computation Element Communication Protocol
(PCEP) Extensions for Segment Routing";
}
}
grouping pce-info {
description
"This grouping specifies all PCE information
that may be relevant to the PCE selection.
This information corresponds to PCE auto-discovery
information.";
container scope {
description
"This container defines PCE path computation scope
information that may be relevant to PCE selection.
This information corresponds to PCE auto-discovery
information.";
leaf path-scope {
type bits {
bit intra-area-scope {
description
"PCE can compute intra-area paths (L bit).";
}
bit inter-area-scope {
description
"PCE can compute inter-area paths (R bit).";
}
bit inter-area-scope-default {
description
"PCE can act as a default PCE for inter-area
path computation (Rd bit).";
}
bit inter-as-scope {
description
"PCE can compute inter-AS paths (S bit).";
}
bit inter-as-scope-default {
description
"PCE can act as a default PCE for inter-AS
path computation (Sd bit).";
}
bit inter-layer-scope {
description
"PCE can compute inter-layer paths (Y bit).";
}
}
description
"The field corresponding to the path scope bits.";
}
leaf intra-area-pref {
type uint8 {
range "0..7";
}
description
"The PCE's preference for intra-area TE LSP
computation (PrefL field), where 7 reflects
the highest preference.";
}
leaf inter-area-pref {
type uint8 {
range "0..7";
}
description
"The PCE's preference for inter-area TE LSP
computation (PrefR field), where 7 reflects
the highest preference.";
}
leaf inter-as-pref {
type uint8 {
range "0..7";
}
description
"The PCE's preference for inter-AS TE LSP
computation (PrefS field), where 7 reflects
the highest preference.";
}
leaf inter-layer-pref {
type uint8 {
range "0..7";
}
description
"The PCE's preference for inter-layer TE LSP
computation (PrefY field), where 7 reflects
the highest preference.";
}
reference
"RFC 5088: OSPF Protocol Extensions for Path
Computation Element (PCE) Discovery
RFC 5089: IS-IS Protocol Extensions for Path
Computation Element (PCE) Discovery";
}
container neighbor-domains {
description
"The list of neighbor PCE domains
toward which a PCE can compute
paths.";
list domain {
key "type domain";
description
"The neighbor domain.";
uses domain {
description
"The PCE neighbor domain.";
}
}
}
}
grouping notification-instance-hdr {
description
"This group describes common instance-specific data
for notifications.";
leaf peer-addr {
type leafref {
path "/pcep/entity/peers/peer/addr";
}
description
"Reference to peer address.";
}
}
grouping notification-session-hdr {
description
"This group describes common session instance-specific
data for notifications.";
uses notification-instance-hdr;
leaf session-initiator {
type leafref {
path "/pcep/entity/peers/peer[addr=current()/../peer-addr]/"
+ "sessions/session/initiator";
}
description
"Reference to pcep session initiator leaf.";
}
}
grouping of-list {
description
"List of Objective Functions (OF).";
reference
"RFC 5541: Encoding of Objective Functions in the Path
Computation Element Communication Protocol (PCEP)";
list objective-function {
key "of";
description
"The list of authorized OF.";
leaf of {
type identityref {
base te-types:objective-function-type;
}
description
"The OF authorized.";
}
}
}
grouping auth {
description
"The authentication options.";
container auth {
description
"The authentication options.";
choice auth-type-selection {
description
"Options for expressing authentication
setting.";
case auth-key-chain {
leaf key-chain {
type key-chain:key-chain-ref;
description
"Key-chain name.";
}
}
case auth-key {
leaf crypto-algorithm {
type identityref {
base key-chain:crypto-algorithm;
}
mandatory true;
description
"Cryptographic algorithm associated
with key.";
}
choice key-string-style {
description
"Key string styles.";
case keystring {
leaf keystring {
nacm:default-deny-all;
type string;
description
"Key string in ASCII format.";
}
}
case hexadecimal {
if-feature "key-chain:hex-key-string";
leaf hexadecimal-string {
nacm:default-deny-all;
type yang:hex-string;
description
"Key in hexadecimal string format. When
compared to ASCII, specification in
hexadecimal affords greater key entropy
with the same number of internal
key-string octets. Additionally, it
discourages usage of well-known words or
numbers.";
}
}
}
}
case auth-tls {
if-feature "tls";
choice role {
description
"The role of the local entity.";
case server {
container tls-server {
uses tlss:tls-server-grouping {
description
"Server TLS information.";
}
description
"TLS-related information.";
}
}
case client {
container tls-client {
uses tlsc:tls-client-grouping {
description
"Client TLS information.";
}
description
"TLS-related information.";
}
}
}
}
}
}
}
/*
* Configuration data nodes
*/
container pcep {
presence "The PCEP is enabled";
description
"Parameters for list of configured PCEP entities
on the device.";
container entity {
description
"The configured PCEP entity on the device.";
leaf-list addr {
type inet:ip-address-no-zone;
min-elements 1;
ordered-by user;
description
"The local Internet address of this PCEP entity.
If operating as a PCE server, the PCEP entity
listens on this address. If operating as a PCC,
the PCEP entity binds outgoing TCP connections
to this address based on the address family. It is
possible for the PCEP entity to operate as both a
PCC and a PCE server, in which case it uses this
address both to listen for incoming TCP connections
and to bind outgoing TCP connections.";
}
leaf enabled {
type boolean;
default "true";
description
"The administrative status of this PCEP
entity; set to true when UP.";
}
leaf role {
type role;
must '(. != "unknown")' {
error-message "The PCEP entity role cannot be unknown";
}
mandatory true;
description
"The role that this entity can play.
Takes one of the following values:
- pcc(1): this PCEP entity is a PCC,
- pce(2): this PCEP entity is a PCE,
- pcc-and-pce(3): this PCEP entity is both
a PCC and a PCE.";
}
leaf description {
type string;
description
"Description of the PCEP entity configured
by the user.";
}
leaf speaker-entity-id {
if-feature "sync-opt";
type string;
description
"The Speaker Entity Identifier.";
reference
"RFC 8232: Optimizations of Label Switched
Path State Synchronization Procedures for
a Stateful PCE";
}
leaf admin-status {
type boolean;
default "true";
description
"The administrative status of this PCEP entity.
The value true represents admin status as up.
This is the desired operational status as
currently set by an operator or by default in
the implementation. The value of oper-status
represents the current status of an attempt to
reach this desired status.";
}
leaf index {
type uint32;
config false;
description
"The index of the operational PECP entity.";
}
leaf oper-status {
type oper-status;
config false;
description
"The operational status of the PCEP entity.
Takes one of the following values:
- oper-status-up(1): the PCEP entity is active,
- oper-status-down(2): the PCEP entity is inactive,
- oper-status-going-up(3): the PCEP entity is
activating,
- oper-status-going-down(4): the PCEP entity is
deactivating,
- oper-status-failed(5): the PCEP entity has
failed and will recover when possible,
- oper-status-failed-perm(6): the PCEP entity
has failed and will not recover without
operator intervention.";
}
uses domain-info {
description
"Local PCEP entity information.";
}
uses auth {
description
"Local authorization and security parameters.";
}
container pce-info {
when "../role = 'pce'"
+ "or "
+ "../role = 'pcc-and-pce'" {
description
"These fields are applicable when the role is PCE.";
}
description
"The local PCE entity PCE information.";
uses pce-info {
description
"Local PCE information.";
}
container path-key {
if-feature "path-key";
description
"Path-key configuration.";
reference
"RFC 5520: Preserving Topology Confidentiality in
Inter-Domain Path Computation Using a Path-Key-
Based Mechanism";
leaf enabled {
type boolean;
default "false";
description
"Enabled or disabled; set to true when enabled.";
}
leaf discard-timer {
type uint32;
units "minutes";
default "10";
description
"A timer to discard unwanted path-keys.";
}
leaf reuse-time {
type uint32 {
range "30..max";
}
units "minutes";
default "30";
description
"A time after which the path-keys could be reused.";
}
leaf pce-id {
type inet:ip-address-no-zone;
description
"PCE address to be used in each Path-Key Subobject
(PKS), same as local PCE entity IP address.";
}
}
}
leaf connect-timer {
type uint16 {
range "1..max";
}
units "seconds";
default "60";
description
"The time in seconds that the PCEP entity will wait
to establish a TCP connection with a peer. If a
TCP connection is not established within this time,
then PCEP aborts the session setup attempt.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf connect-max-retry {
type uint32;
default "5";
description
"The maximum number of times the system tries to
establish a TCP connection to a peer before the
session with the peer transitions to the idle
state.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf init-back-off-timer {
type uint16 {
range "1..max";
}
units "seconds";
mandatory true;
description
"The initial back-off time in seconds for retrying
a failed session setup attempt to a peer.
The back-off time increases for each failed
session setup attempt, until a maximum back-off
time is reached. The maximum back-off time is the
max-back-off-timer leaf.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf max-back-off-timer {
type uint32;
units "seconds";
mandatory true;
description
"The maximum back-off time in seconds for retrying
a failed session setup attempt to a peer.
The back-off time increases for each failed session
setup attempt, until this maximum value is reached.
Session setup attempts then repeat periodically
without any further increase in back-off time.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf open-wait-timer {
type uint16;
units "seconds";
config false;
description
"The time in seconds that the PCEP entity will wait
to receive an Open message from a peer after the
TCP connection has come up.
If no Open message is received within this time, then
PCEP terminates the TCP connection and deletes the
associated sessions.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf keep-wait-timer {
type uint16;
units "seconds";
config false;
description
"The time in seconds that the PCEP entity will wait
to receive a Keepalive or PCErr message from a peer
during session initialization after receiving an
Open message. If no Keepalive or PCErr message is
received within this time, then PCEP terminates the
TCP connection and deletes the associated
sessions.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf keepalive-timer {
type uint8;
units "seconds";
default "30";
description
"The Keepalive timer that this PCEP
entity will propose in the initial Open message of
each session it is involved in. This is the
maximum time between two consecutive messages sent
to a peer. Zero means that the PCEP entity prefers
not to send Keepalives at all.
Note that the actual Keepalive transmission
intervals, in either direction of an active PCEP
session, are determined by negotiation between the
peers as specified by RFC 5440 and thus may differ
from this configured value.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf dead-timer {
type uint8;
units "seconds";
must '(. > ../keepalive-timer)' {
error-message "The DeadTimer must be "
+ "larger than the Keepalive timer";
}
default "120";
description
"The DeadTimer that this PCEP entity will propose
in the initial Open message of each session it is
involved in. This is the time after which a peer
should declare a session down if it does not
receive any PCEP messages. Zero suggests that the
peer does not run a DeadTimer at all.";
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
leaf allow-negotiation {
type boolean;
default "true";
description
"Whether the PCEP entity will permit the negotiation
of session parameters.";
}
leaf max-keepalive-timer {
type uint8;
units "seconds";
mandatory true;
description
"The maximum value that this PCEP entity will
accept from a peer for the interval between
Keepalive transmissions. Zero means that the PCEP
entity will allow no Keepalive transmission at
all.";
}
leaf max-dead-timer {
type uint8;
units "seconds";
mandatory true;
description
"The maximum value in seconds that this PCEP
entity will accept from a peer for the DeadTimer.
Zero means that the PCEP entity will allow not
running a DeadTimer.";
}
leaf min-keepalive-timer {
type uint8;
units "seconds";
mandatory true;
description
"The minimum value in seconds that this PCEP
entity will accept for the interval between
Keepalive transmissions. Zero means that the
PCEP entity insists on no Keepalive
transmission at all.";
}
leaf min-dead-timer {
type uint8;
units "seconds";
mandatory true;
description
"The minimum value in seconds that this PCEP
entity will accept for the DeadTimer. Zero
means that the PCEP entity insists on not
running a DeadTimer.";
}
leaf sync-timer {
if-feature "svec";
type uint16;
units "seconds";
default "60";
description
"The value of SyncTimer in seconds is used in the
case of synchronized path computation request
using the SVEC object. If after the expiration of
the SyncTimer all the path computation requests
have not been received, a protocol error is
triggered, and the PCE must cancel the whole set
of path computation requests.
Zero means that the PCEP entity does not use the
SyncTimer.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf request-timer {
type uint16 {
range "1..max";
}
units "seconds";
mandatory true;
description
"The maximum time that the PCEP entity will wait
for a response to a PCReq message.";
}
leaf max-sessions {
type uint32;
mandatory true;
description
"Maximum number of sessions involving this PCEP
entity that can exist at any time.";
}
leaf max-unknown-reqs {
type uint32;
default "5";
description
"The maximum number of unrecognized requests and
replies that any session on this PCEP entity is
willing to accept per minute before terminating
the session.
A PCRep message contains an unrecognized reply
if it contains an RP object whose request ID
does not correspond to any in-progress request
sent by this PCEP entity.
A PCReq message contains an unrecognized request
if it contains an RP object whose request ID is
zero.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf max-unknown-msgs {
type uint32;
default "5";
description
"The maximum number of unknown messages that any
session on this PCEP entity is willing to accept
per minute before terminating the session.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf pcep-notification-max-rate {
type uint32;
mandatory true;
description
"This variable indicates the maximum number of
notifications issued per second. If events
occur more rapidly, the implementation may
simply fail to emit these notifications during
that period or may queue them until an
appropriate time. A value of 0 means no
notifications are emitted and all should be
discarded (that is, not queued).";
}
container stateful-parameter {
if-feature "stateful";
description
"The configured stateful PCE parameters.";
leaf state-timeout {
type uint32;
units "seconds";
mandatory true;
description
"When a PCEP session is terminated, a PCC
waits for this time period before flushing
LSP state associated with that PCEP session
and reverting to operator-defined default
parameters or behaviors. The max value
represents infinity.";
reference
"RFC 8231: Path Computation Element Communication
Protocol (PCEP) Extensions for Stateful PCE";
}
leaf redelegation-timeout {
when "../../role = 'pcc'"
+ "or "
+ "../../role = 'pcc-and-pce'" {
description
"This field is applicable when the role is
PCC.";
}
type uint32;
units "seconds";
must '(. < ../state-timeout)' {
error-message "The Redelegation Timeout must be "
+ "less than the State Timeout";
}
mandatory true;
description
"When a PCEP session is terminated, a PCC
waits for this time period before revoking
LSP delegation to a PCE and attempting to
redelegate LSPs associated with the
terminated PCEP session to an alternate
PCE.";
reference
"RFC 8231: Path Computation Element Communication
Protocol (PCEP) Extensions for Stateful PCE";
}
leaf rpt-non-pcep-lsp {
when "../../role = 'pcc'"
+ "or "
+ "../../role = 'pcc-and-pce'" {
description
"This field is applicable when the role is
PCC.";
}
type boolean;
default "true";
description
"If set, a PCC reports LSPs that are not
controlled by any PCE (for example, LSPs
that are statically configured at the
PCC).";
}
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE";
}
container of-list {
when "../role = 'pce'"
+ "or "
+ "../role = 'pcc-and-pce'" {
description
"These fields are applicable when the role is
PCE.";
}
if-feature "objective-function";
uses of-list;
description
"The authorized OF-List at PCE for all peers.";
}
container lsp-db {
if-feature "stateful";
config false;
description
"The LSP-DB.";
leaf db-ver {
when "../../role = 'pcc'"
+ "or "
+ "../../role = 'pcc-and-pce'" {
description
"This field is applicable when the role is
PCC.";
}
if-feature "sync-opt";
type uint64;
description
"The LSP State Database Version Number.";
}
list association-list {
if-feature "association";
key "type id source global-source extended-id";
description
"List of all PCEP associations.";
reference
"RFC 8697: Path Computation Element Communication
Protocol (PCEP) Extensions for Establishing
Relationships between Sets of Label Switched
Paths (LSPs)";
leaf type {
type identityref {
base te-types:association-type;
}
description
"The PCEP Association Type.";
reference
"IANA PCEP: ASSOCIATION Type Field in Path
Computation Element Protocol (PCEP) Numbers
RFC 8697: Path Computation Element Communication
Protocol (PCEP) Extensions for Establishing
Relationships between Sets of Label Switched
Paths (LSPs)";
}
leaf id {
type uint16;
description
"PCEP Association ID.";
}
leaf source {
type inet:ip-address-no-zone;
description
"PCEP Association Source.";
}
leaf global-source {
type uint32;
description
"PCEP Global Association Source.";
}
leaf extended-id {
type string;
description
"Additional information to support unique
identification (Extended Association ID).";
}
list lsp {
key "plsp-id pcc-id lsp-id";
description
"List of all LSP in this association.";
leaf plsp-id {
type leafref {
path "/pcep/entity/lsp-db/"
+ "lsp/plsp-id";
}
description
"Reference to PLSP-ID in LSP-DB.";
}
leaf pcc-id {
type leafref {
path "/pcep/entity/lsp-db/"
+ "lsp[plsp-id=current()/"
+ "../plsp-id]/pcc-id";
}
description
"Reference to PCC-ID in LSP-DB.";
}
leaf lsp-id {
type leafref {
path "/pcep/entity/lsp-db/"
+ "lsp[plsp-id=current()/../plsp-id]"
+ "[pcc-id=current()/../pcc-id]/lsp-id";
}
description
"Reference to LSP-ID in LSP-DB.";
}
}
}
list lsp {
key "plsp-id pcc-id lsp-id";
description
"List of all LSPs in LSP-DB.";
leaf plsp-id {
type uint32 {
range "1..1048575";
}
description
"A PCEP-specific identifier for the LSP. A PCC
creates a unique PLSP-ID for each LSP that is
constant for the lifetime of a PCEP session.
PLSP-ID is 20 bits with 0 and 0xFFFFF
reserved.";
}
leaf pcc-id {
type inet:ip-address-no-zone;
description
"The local IP address of the PCC that
generated the PLSP-ID.";
}
leaf source {
type inet:ip-address-no-zone;
description
"Tunnel sender address extracted from
LSP-IDENTIFIERS TLV.";
reference
"RFC 8231: Path Computation Element
Communication Protocol (PCEP) Extensions
for Stateful PCE";
}
leaf destination {
type inet:ip-address-no-zone;
description
"Tunnel endpoint address extracted from
LSP-IDENTIFIERS TLV.";
reference
"RFC 8231: Path Computation Element
Communication Protocol (PCEP) Extensions
for Stateful PCE";
}
leaf tunnel-id {
type uint16;
description
"Tunnel identifier used in the LSP-IDENTIFIERS
TLV that remains constant over the life
of the tunnel.";
reference
"RFC 8231: Path Computation Element
Communication Protocol (PCEP) Extensions
for Stateful PCE";
}
leaf lsp-id {
type uint16;
description
"Identifier used in the LSP-IDENTIFIERS TLV
that can be changed to allow a sender to share
resources with itself.";
reference
"RFC 8231: Path Computation Element
Communication Protocol (PCEP) Extensions
for Stateful PCE";
}
leaf extended-tunnel-id {
type inet:ip-address-no-zone;
description
"Extended tunnel ID of the LSP in LSP-IDENTIFIERS
TLV. The all-zeros format is represented as
0.0.0.0 and ::.";
reference
"RFC 8231: Path Computation Element
Communication Protocol (PCEP) Extensions
for Stateful PCE";
}
leaf admin-state {
type boolean;
default "true";
description
"The desired operational state.";
}
leaf operational-state {
type operational-state;
description
"The operational status of the LSP.";
}
container delegated {
description
"The delegation-related parameters.";
leaf enabled {
type boolean;
default "false";
description
"LSP is delegated or not; set to true when
delegated.";
}
leaf peer {
when '../enabled' {
description
"The LSP must be delegated.";
}
type leafref {
path "/pcep/entity/peers/peer/addr";
}
description
"At the PCC, the reference to the PCEP peer to
which LSP is delegated; at the PCE, the
reference to the PCEP peer that delegated this
LSP.";
}
leaf srp-id {
type uint32 {
range "1..4294967294";
}
description
"The last SRP-ID-number associated with this
LSP. The values 0x00000000 and 0xFFFFFFFF
are reserved.";
}
}
container initiation {
if-feature "pce-initiated";
description
"The parameters related to PCE initiation.";
reference
"RFC 8281: Path Computation Element Communication
Protocol (PCEP) Extensions for PCE-Initiated LSP
Setup in a Stateful PCE Model";
leaf enabled {
type boolean;
default "false";
description
"Set to true if this LSP is initiated by a PCE.";
}
leaf peer {
when '../enabled' {
description
"The LSP must be PCE-initiated.";
}
type leafref {
path "/pcep/entity/peers/peer/addr";
}
description
"If the role is PCC, this leaf refers to the PCEP
peer (PCE) that initiated this LSP. If the role
is PCE, this leaf refers to the PCEP peer (PCC)
where the LSP is initiated.";
}
}
leaf symbolic-path-name {
type string;
description
"The symbolic path name associated with the LSP.";
reference
"RFC 8231: Path Computation Element Communication
Protocol (PCEP) Extensions for Stateful PCE";
}
leaf last-error {
type identityref {
base lsp-error;
}
description
"The last error for the LSP.";
}
leaf pst {
type identityref {
base te-types:path-signaling-type;
}
default "te-types:path-setup-rsvp";
description
"The Path Setup Type (PST). Note that the
te-types model uses the term Path Signaling
Type.";
reference
"RFC 8408: Conveying Path Setup Type in PCE
Communication Protocol (PCEP) Messages";
}
list association-list {
if-feature "association";
key "type id source global-source extended-id";
description
"List of all PCEP associations.";
leaf type {
type leafref {
path "/pcep/entity/lsp-db/"
+ "association-list/type";
}
description
"PCEP Association Type.";
}
leaf id {
type leafref {
path "/pcep/entity/lsp-db/"
+ "association-list[type=current()/"
+ "../type]/id";
}
description
"PCEP Association ID.";
}
leaf source {
type leafref {
path "/pcep/entity/lsp-db/"
+ "association-list[type=current()/../type]"
+ "[id=current()/../id]/source";
}
description
"PCEP Association Source.";
}
leaf global-source {
type leafref {
path "/pcep/entity/lsp-db/"
+ "association-list[type=current()/../type]"
+ "[id=current()/../id]"
+ "[source=current()/../source]"
+ "/global-source";
}
description
"PCEP Global Association Source.";
}
leaf extended-id {
type leafref {
path "/pcep/entity/lsp-db/"
+ "association-list[type=current()/../type]"
+ "[id=current()/../id]"
+ "[source=current()/../source]"
+ "[global-source=current()/../global-source]"
+ "/extended-id";
}
description
"Additional information to
support unique identification.";
}
reference
"RFC 8697: Path Computation Element Communication
Protocol (PCEP) Extensions for Establishing
Relationships between Sets of Label Switched
Paths (LSPs)";
}
}
}
container path-keys {
when "../role = 'pce' or ../role = 'pcc-and-pce'" {
description
"These fields are applicable when the role is
PCE.";
}
if-feature "path-key";
config false;
description
"The path-keys generated by the PCE.";
reference
"RFC 5520: Preserving Topology Confidentiality
in Inter-Domain Path Computation Using a Path-
Key-Based Mechanism";
list path-key {
key "key";
description
"The list of path-keys generated by the PCE.";
leaf key {
type uint16;
description
"The identifier or token used to represent
the Confidential Path Segment (CPS) within
the context of the PCE.";
}
container cps {
description
"The Confidential Path Segment (CPS).";
list explicit-route-objects {
key "index";
description
"List of Explicit Route Objects (EROs).";
leaf index {
type uint32;
description
"ERO subobject index.";
}
uses te-types:explicit-route-hop;
}
}
leaf pcc-requester {
type leafref {
path "/pcep/entity/peers/peer/addr";
}
description
"Reference to PCC peer address that
issued the original request that led
to the creation of the path-key.";
}
leaf req-id {
type uint32;
description
"The request ID of the original PCReq.";
}
leaf retrieved {
type boolean;
description
"If path-key has been retrieved yet.";
}
leaf pcc-retrieved {
when '../retrieved' {
description
"The path-key should be retrieved.";
}
type leafref {
path "/pcep/entity/peers/peer/addr";
}
description
"Reference to PCC peer address that
retrieved the path-key.";
}
leaf creation-time {
type yang:timestamp;
description
"The timestamp value at the time this path-key
was created.";
}
leaf discard-time {
type uint32;
units "minutes";
description
"A time after which this path-key will be
discarded.";
}
leaf reuse-time {
type uint32;
units "minutes";
description
"A time after which this path-key could be
reused.";
}
}
}
container peers {
description
"The list of configured peers for the
entity (remote PCE).";
list peer {
key "addr";
description
"The peer configured for the entity.
(remote PCE).";
leaf addr {
type inet:ip-address-no-zone;
description
"The local Internet address of this
PCEP peer.";
}
leaf role {
type role;
must '(. != "pcc-and-pce")' {
error-message
"The PCEP peer cannot be both
PCE and PCC at the same time";
}
mandatory true;
description
"The role of the PCEP peer.
Takes one of the following values:
- unknown(0): this PCEP peer role is not
known,
- pcc(1): this PCEP peer is a PCC,
- pce(2): this PCEP peer is a PCE,
- pcc-and-pce(3): is not allowed as PCEP
peer cannot be acting as both a PCC and a
PCE at the same time.";
}
leaf description {
type string;
description
"Description of the PCEP peer
configured by the user.";
}
uses domain-info {
description
"PCE peer information.";
}
container pce-info {
uses pce-info {
description
"Using the PCE peer information grouping.";
}
description
"The PCE peer information.";
}
leaf delegation-pref {
if-feature "stateful";
type uint8 {
range "0..7";
}
mandatory true;
description
"The PCE peer delegation preference, where
7 reflects the highest preference.";
}
uses auth {
description
"The PCE peer authorization and security
parameters.";
}
leaf discontinuity-time {
type yang:timestamp;
config false;
description
"The timestamp of the time when the information and
statistics were last reset.";
}
leaf initiate-session {
type boolean;
config false;
description
"Indicates whether the local PCEP entity initiates
sessions to this peer or waits for the peer to
initiate a session.";
}
leaf session-exists {
type boolean;
config false;
description
"Indicates whether a session with
this peer currently exists.";
}
leaf session-up-time {
type yang:timestamp;
config false;
description
"The timestamp value of the last time a
session with this peer was successfully
established.";
}
leaf session-fail-time {
type yang:timestamp;
config false;
description
"The timestamp value of the last time a
session with this peer failed to be
established.";
}
leaf session-fail-up-time {
type yang:timestamp;
config false;
description
"The timestamp value of the last time a
session with this peer failed from
active.";
}
container sessions {
config false;
description
"This entry represents a single PCEP
session in which the local PCEP entity participates.
This entry exists only if the corresponding PCEP
session has been initialized by some event, such as
manual user configuration, auto-discovery of a peer,
or an incoming TCP connection.";
list session {
key "initiator";
description
"The list of sessions; note that for a time being
two sessions may exist for a peer.";
leaf initiator {
type initiator;
description
"The initiator of the session, that is, whether
the TCP connection was initiated by the local
PCEP entity or the peer.
There is a window during session
initialization where two sessions can exist
between a pair of PCEP speakers, each
initiated by one of the speakers. One of
these sessions is always discarded before it
leaves OpenWait state. However, before it is
discarded, two sessions to the given peer
appear transiently in this YANG module. The
sessions are distinguished by who initiated
them, and so this field is the key.";
}
leaf role {
type leafref {
path "../../../role";
}
description
"The peer role.";
}
leaf state-last-change {
type yang:timestamp;
description
"The timestamp value at the time this
session entered its current state as
denoted by the state leaf.";
}
leaf state {
type sess-state;
description
"The current state of the session.
The set of possible states excludes the
idle state since entries do not exist
in the idle state.";
}
leaf session-creation {
type yang:timestamp;
description
"The timestamp value at the time this
session was created.";
}
leaf connect-retry {
type yang:counter32;
description
"The number of times that the local PCEP
entity has attempted to establish a TCP
connection for this session without
success. The PCEP entity gives up when
this reaches connect-max-retry.";
}
leaf local-id {
type uint8;
description
"The value of the PCEP session ID used by
the local PCEP entity in the Open message
for this session. If the state is tcp-pending,
then this is the session ID that will be
used in the Open message. Otherwise, this
is the session ID that was sent in the
Open message.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf remote-id {
type uint8;
description
"The value of the PCEP session ID used by the
peer in its Open message for this session.
If the state is TCPPending or OpenWait, then
this leaf is not used and MUST be set to
zero.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf keepalive-timer {
type uint8;
units "seconds";
description
"The agreed maximum interval at which the local
PCEP entity transmits PCEP messages on this PCEP
session. Zero means that the local PCEP entity
never sends Keepalives on this session.
This field is used if and only if the state
is session-up. Otherwise, it is not used and
MUST be set to zero.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf peer-keepalive-timer {
type uint8;
units "seconds";
description
"The agreed maximum interval at which the peer
transmits PCEP messages on this PCEP session.
Zero means that the peer never sends Keepalives
on this session.
This field is used if and only if state is
session-up. Otherwise, it is not used and MUST
be set to zero.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf dead-timer {
type uint8;
units "seconds";
description
"The DeadTimer interval for this PCEP session.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf peer-dead-timer {
type uint8;
units "seconds";
description
"The peer's DeadTimer interval for this PCEP
session.
If the state is TCPPending or OpenWait, then
this leaf is not used and MUST be set to zero.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf ka-hold-time-rem {
type uint8;
units "seconds";
description
"The Keepalive hold time remaining for this
session.
If the state is TCPPending or OpenWait, then
this field is not used and MUST be set to
zero.";
}
leaf overloaded {
type boolean;
description
"If the local PCEP entity has informed the peer
that it is currently overloaded, then this is
set to true. Otherwise, it is set to false.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf overloaded-timestamp {
when '../overloaded' {
description
"Valid when overloaded.";
}
type yang:timestamp;
description
"The timestamp value of the time when the
overloaded field was set to true.";
}
leaf overload-time {
type uint32;
units "seconds";
description
"The interval of time that is remaining until the
local PCEP entity will cease to be overloaded on
this session.
This field is only used if overloaded is set to
true. Otherwise, it is not used and MUST be set
to zero.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf peer-overloaded {
type boolean;
description
"If the peer has informed the local PCEP entity
that it is currently overloaded, then this is
set to true. Otherwise, it is set to false.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf peer-overloaded-timestamp {
when '../peer-overloaded' {
description
"Valid when peer is overloaded.";
}
type yang:timestamp;
description
"The timestamp value of the time when the
peer-overloaded field was set to true.";
}
leaf peer-overload-time {
type uint32;
units "seconds";
description
"The interval of time that is remaining until
the peer will cease to be overloaded. If it
is not known how long the peer will stay in
overloaded state, this leaf is set to zero.
This field is only used if peer-overloaded
is set to true. Otherwise, it is not used
and MUST be set to zero.";
reference
"RFC 5440: Path Computation Element (PCE)
Communication Protocol (PCEP)";
}
leaf lspdb-sync {
if-feature "stateful";
type sync-state;
description
"The LSP-DB state synchronization status.";
reference
"RFC 8231: Path Computation Element Communication
Protocol (PCEP) Extensions for Stateful PCE";
}
leaf recv-db-ver {
when "../role = 'pcc'"
+ "or "
+ "../role = 'pcc-and-pce'" {
description
"This field is applicable when the role is
PCC.";
}
if-feature "stateful";
if-feature "sync-opt";
type uint64;
description
"The last received LSP State Database Version
Number.";
reference
"RFC 8231: Path Computation Element Communication
Protocol (PCEP) Extensions for Stateful PCE";
}
container of-list {
when "../role = 'pce'"
+ "or "
+ "../role = 'pcc-and-pce'" {
description
"These fields are applicable when the role is
PCE.";
}
if-feature "objective-function";
uses of-list;
description
"Indicate the list of supported OF on this
session.";
reference
"RFC 5541: Encoding of Objective Functions in
the Path Computation Element Communication
Protocol (PCEP)";
}
container pst-list {
when "../role = 'pce'"
+ "or "
+ "../role = 'pcc-and-pce'" {
description
"These fields are applicable when the role is
PCE.";
}
description
"Indicate the list of supported
PST on this session.";
reference
"RFC 8408: Conveying Path Setup Type in PCE
Communication Protocol (PCEP) Messages";
list path-setup-type {
key "pst";
description
"The list of PST.";
leaf pst {
type identityref {
base te-types:path-signaling-type;
}
description
"The PST supported.";
}
}
}
container assoc-type-list {
if-feature "association";
description
"Indicate the list of supported association types
on this session.";
reference
"RFC 8697: Path Computation Element Communication
Protocol (PCEP) Extensions for Establishing
Relationships between Sets of Label Switched
Paths (LSPs)";
list assoc-type {
key "at";
description
"The list of authorized association types.";
leaf at {
type identityref {
base te-types:association-type;
}
description
"The association type authorized.";
}
}
}
leaf speaker-entity-id {
if-feature "sync-opt";
type string;
description
"The Speaker Entity Identifier.";
reference
"RFC 8232: Optimizations of Label Switched
Path State Synchronization Procedures for
a Stateful PCE";
}
}
}
}
}
}
}
/*
* Notifications
*/
notification pcep-session-up {
description
"This notification is sent when the value of
'/pcep/peers/peer/sessions/session/state'
enters the 'session-up' state.";
uses notification-session-hdr;
leaf state-last-change {
type yang:timestamp;
description
"The timestamp value at the time this session
entered its current state as denoted by the state
leaf.";
}
leaf state {
type sess-state;
description
"The current state of the session.
The set of possible states excludes the idle state
since entries do not exist in the idle state.";
}
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
notification pcep-session-down {
description
"This notification is sent when the value of
'/pcep/peers/peer/sessions/session/state'
leaves the 'session-up' state.";
uses notification-instance-hdr;
leaf session-initiator {
type initiator;
description
"The initiator of the session.";
}
leaf state-last-change {
type yang:timestamp;
description
"The timestamp value at the time this session
entered its current state as denoted by the state
leaf.";
}
leaf state {
type sess-state;
description
"The current state of the session.
The set of possible states excludes the idle state
since entries do not exist in the idle state.";
}
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
notification pcep-session-local-overload {
description
"This notification is sent when the local PCEP entity
enters overload state for a peer.";
uses notification-session-hdr;
leaf overloaded {
type boolean;
description
"If the local PCEP entity has informed the peer
that it is currently overloaded, then this is set
to true. Otherwise, it is set to false.";
}
leaf overloaded-timestamp {
type yang:timestamp;
description
"The timestamp value of the time when the
overloaded field was set to true.";
}
leaf overload-time {
type uint32;
units "seconds";
description
"The interval of time that is remaining until the
local PCEP entity will cease to be overloaded on
this session.";
}
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
notification pcep-session-local-overload-clear {
description
"This notification is sent when the local PCEP entity
leaves overload state for a peer.";
uses notification-instance-hdr;
leaf overloaded {
type boolean;
description
"If the local PCEP entity has informed the peer
that it is currently overloaded, then this is set
to true. Otherwise, it is set to false.";
}
leaf overloaded-clear-timestamp {
type yang:timestamp;
description
"The timestamp value of the time when the
overloaded field was set to false.";
}
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
notification pcep-session-peer-overload {
description
"This notification is sent when a peer enters overload
state.";
uses notification-session-hdr;
leaf peer-overloaded {
type boolean;
description
"If the peer has informed the local PCEP entity that
it is currently overloaded, then this is set to
true. Otherwise, it is set to false.";
}
leaf peer-overloaded-timestamp {
type yang:timestamp;
description
"The timestamp value of the time when the
peer-overloaded field was set to true.";
}
leaf peer-overload-time {
type uint32;
units "seconds";
description
"The interval of time that is remaining until the
peer will cease to be overloaded. If it is not
known how long the peer will stay in overloaded
state, this leaf is set to zero.";
}
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
notification pcep-session-peer-overload-clear {
description
"This notification is sent when a peer leaves overload
state.";
uses notification-instance-hdr;
leaf peer-overloaded {
type boolean;
description
"If the peer has informed the local PCEP entity that
it is currently overloaded, then this is set to
true. Otherwise, it is set to false.";
}
leaf peer-overloaded-clear-timestamp {
type yang:timestamp;
description
"The timestamp value of the time when the
peer-overloaded field was set to false.";
}
reference
"RFC 5440: Path Computation Element (PCE) Communication
Protocol (PCEP)";
}
/*
* RPC
*/
rpc trigger-resync {
if-feature "stateful";
if-feature "sync-opt";
nacm:default-deny-all;
description
"Trigger the resynchronization at the PCE.";
reference
"RFC 8232: Optimizations of Label Switched Path State
Synchronization Procedures for a Stateful PCE";
input {
leaf pcc {
type leafref {
path "/pcep/entity/peers/peer/addr";
}
mandatory true;
description
"The IP address to identify the PCC. The state
synchronization is re-triggered for all LSPs from
the PCC. The rpc on the PCC will be ignored.";
}
}
}
}