| RFC 10057 | TE YANG Data Model | November 2026 |
| Saad, et al. | Standards Track | [Page] |
This document defines a YANG data model for the provisioning and management of Traffic Engineering (TE) tunnels, Label Switched Paths (LSPs), and interfaces. The model covers data pertinent to TE tunnels, TE LSPs, and TE interfaces that are independent of any technology or data plane encapsulation. The model is divided into two YANG modules that address both device-specific and device-independent data, supporting configuration, operational state, Remote Procedure Calls (RPCs), and event notifications.¶
This is an Internet Standards Track document.¶
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.¶
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc10057.¶
Copyright (c) 2026 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document defines a YANG data model intended for the provisioning and management of point-to-point Traffic Engineering (TE) tunnels, Label Switched Paths (LSPs), and interfaces. The modeling of point-to-multipoint TE Tunnels [RFC4875] and Segment Routing (SR) Policies [RFC9256] falls outside the scope of this document.¶
The data model described herein is divided into two YANG modules. The "ietf-te" module contains generic, device-independent data, and the "ietf-te-device" module addresses device-specific data.¶
This document outlines the high-level relationships between the YANG modules it defines and other external protocol YANG modules. The TE data model intentionally excludes data specific to any signaling protocol, such as RSVP-TE [RFC3209] [RFC3473] or SR [RFC8402] [RFC9256] with the expectation that such technology models will be defined in separate documents and will augment the TE model as needed.¶
The following terms are defined in [RFC6241] and are used in this specification:¶
This document also makes use of the following terminology introduced in the YANG Data Modeling Language [RFC7950]:¶
In this document, names of data nodes and other data model objects are prefixed using the standard prefix associated with the corresponding YANG imported modules as shown in Table 1.¶
| Prefix | YANG Module | Reference |
|---|---|---|
| yang | ietf-yang-types | [RFC9911] |
| inet | ietf-inet-types | [RFC9911] |
| rt-types | ietf-routing-types | [RFC8294] |
| te-types | ietf-te-types | [RFC10056] |
| te-packet-types | ietf-te-packet-types | [RFC10056] |
| te | ietf-te | RFC 10057 |
| te-dev | ietf-te-device | RFC 10057 |
The YANG tree diagrams extracted from the modules defined in this document are given in subsequent sections as per the syntax defined in [RFC8340].¶
This document describes a YANG data model for TE tunnels, TE LSPs, and TE interfaces that are independent of any data plane technology. One of the design objectives is to allow specific data plane technology models to reuse the TE data model and possibly augment it with technology-specific data.¶
The elements of the TE data model, including TE Tunnels, LSPs, and interfaces, have leafs that identify the technology layer where they reside. For example, the LSP encoding type can identify the technology associated with a TE Tunnel or LSP.¶
Also, the TE data model does not cover signaling protocol data. The signaling protocols used to instantiate TE LSPs are outside the scope of this document and are expected to be covered by augmentations defined in other documents.¶
The following other design considerations are taken into account with respect to data organization:¶
The device-independent TE data is defined in the "ietf-te" module and can be used to manage data off a device, such as a TE controller. When the model is used to manage a specific device, the model contains the TE Tunnels originating from the specific device. When the model is used to manage a TE controller, the 'tunnel' list contains all TE Tunnels and TE tunnel segments originating from devices that the TE controller manages.¶
The device-specific TE data is defined in the "ietf-te-device" module.¶
The TE interfaces in the "ietf-te-device" module are modeled as references to existing interfaces defined in the 'ietf-interfaces' YANG module [RFC8343]. This approach ensures consistency by leveraging standardized interface definitions, allowing TE-specific parameters to be associated with interfaces already defined elsewhere, rather than redefining interface structures within the TE module.¶
Minimal elements in the model are designated as "mandatory" to allow freedom to vendors to adapt the data model to their specific product implementation.¶
Suitable defaults are specified for all configurable elements.¶
Where TE functions or features might be optional within the deployed TE network, the model declares them as optional.¶
Some groupings defined in this document include 'default' statements, which can be problematic for use cases involving templates or profiling. This design does not conform to the guidelines specified in Section 4.13 of [RFC9907]. However, this deviation is intentional as these groupings are specifically tailored for use within the YANG modules defined in this document as well as in [PATH-COMP]. The customization ensures appropriate behavior and consistency across these related modules.¶
The data model defined in this document covers the core TE features that are commonly supported by different vendor implementations. The support of extended or vendor specific TE features is expected to be in either augmentations or deviations to this model that are defined in separate documents.¶
The TE YANG module "ietf-te" provides device-independent building blocks that are agnostic of specific technologies or control plane instances. The TE device YANG module, defined in the "ietf-te-device", augments the "ietf-te" YANG module as illustrated in Figure 1 by including device-specific data such as TE interface attributes and local TE node timers.¶
The augmentation of the TE data model for specific instances of data plane technology and signaling protocols are outside the scope of this document.¶
TE module +---------+
| ietf-te |o-------------+
+---------+ \
o o \
| \ \
| \ TE device module \
| +----------------+ \
| | ietf-te-device | \
| +----------------+ \
| o \
| | \
| | \
+---------------+ +---------------+
RSVP-TE module | ietf-rsvp-te^ |o | ietf-te-mpls^ |
+---------------+ \ +---------------+
| \
| \
| \
| \
| \
o +-------------------+
+------------+ | ietf-rsvp-otn-te^ |
RSVP module | ietf-rsvp^ | +-------------------+
+------------+ RSVP-TE with OTN
extensions
The TE YANG module "ietf-te" supports the management and operation of a TE network. This includes creating, modifying, and retrieving information about TE Tunnels, LSPs, and interfaces and their associated attributes, e.g., Administrative Groups (AGs), Shared Risk Link Groups (SRLGs), etc.¶
A full tree diagram of the TE data model is shown in Appendix B.¶
The TE model is built around several core constructs: TE tunnel, TE path, and LSP. These concepts are central to the model's structure and functionality.¶
The relationship among these concepts is as follows:¶
A TE tunnel is the high-level logical object that defines the desired connectivity and its properties. Each TE tunnel can have one or more TE paths, which define candidate or active routes through the network that may be used to realize the tunnel's connectivity, subject to certain constraints and preferences. For each TE path selected for use, one or more LSPs are instantiated in the network to realize the forwarding state necessary to carry traffic along the specified TE path.¶
In summary, a TE tunnel defines the service, a TE path defines how to achieve the service, and an LSP is the instantiated mechanism that actually provides the service in the forwarding plane.¶
The 'te' container is the top-level container in the "ietf-te" module. The presence of the 'te' container enables TE function system-wide. Further descriptions of containers that exist under the 'te' top-level container are provided in the following sections.¶
The three containers grouped under the 'te' container are shown in Figure 2 and described below.¶
The model also contains two Remote Procedure Calls (RPCs) as shown in Appendix B and described below.¶
module: ietf-te
+--rw te!
+--rw globals
| ...
+--rw tunnels
| ...
+--ro lsps
...
rpcs:
+---x tunnels-path-compute
| +---w input
| | ...
| +--ro output
| ...
+---x tunnels-actions
+---w input
| ...
+--ro output
...
The 'globals' container covers properties that control a TE feature's behavior system-wide and its respective state as shown in Figure 3 and described in the text that follows.¶
+--rw globals
| +--rw named-admin-groups
| | +--rw named-admin-group* [name]
| | ...
| +--rw named-srlgs
| | +--rw named-srlg* [name]
| | ...
| +--rw named-path-constraints
| +--rw named-path-constraint* [name]
A YANG container for a list of named path constraints. Each named path constraint is composed of a set of constraints that can be applied during path computation. A named path constraint can be applied to multiple TE Tunnels. Path constraints may also be specified directly under the TE Tunnel. The path constraints specified under the TE Tunnel take precedence over the path constraints derived from the referenced named path constraint. A named path constraint entry can be formed of the path constraints shown in Figure 4:¶
| +--rw named-path-constraints
| +--rw named-path-constraint* [name]
| {te-types:named-path-constraints}?
| +--rw name string
| +--rw te-bandwidth
| | ...
| +--rw link-protection? identityref
| +--rw setup-priority? uint8
| +--rw hold-priority? uint8
| +--rw signaling-type? identityref
| +--rw path-metric-bounds
| | ...
| +--rw path-affinities-values
| | ...
| +--rw path-affinity-names
| | ...
| +--rw path-srlgs-lists
| | ...
| +--rw path-srlgs-names
| | ...
| +--rw disjointness?
| | te-path-disjointness
| +--rw explicit-route-objects
| | ...
| +--rw path-in-segment!
| | ...
| +--rw path-out-segment!
| ...
A YANG container that holds path constraints in the form of route entries present in the following two lists:¶
A list of route entries to include or exclude for the path computation. For route entries in this list that are to be excluded, the hop-type is only allowed to be 'strict' as described in [RFC4874], Section 3.1.¶
The constraint type (include or exclude) is specified with each route entry. The path computation considers route entry constraints in the order they appear in this list. Once a route entry constraint is consumed from this list, it is not considered any further in the computation of the TE path.¶
The 'route-object-include-exclude' is used to configure constraints on which route objects (e.g., nodes, links) are included or excluded in the path computation.¶
The interpretation of an empty 'route-object-include-exclude' list depends on the TE Tunnel (end-to-end or Tunnel Segment) and on the specific path according to the following rules:¶
An empty 'route-object-include-exclude' list for the primary path of an end-to-end TE Tunnel indicates that there are no route objects to be included or excluded in the path computation.¶
An empty 'route-object-include-exclude' list for the primary path of a TE Tunnel Segment indicates that no primary LSP is required for that TE Tunnel Segment.¶
An empty 'route-object-include-exclude' list for a reverse path means it always follows the forward path (i.e., the TE Tunnel is co-routed). When the 'route-object-include-exclude' list is not empty, the reverse path is routed independently of the forward path.¶
An empty 'route-object-include-exclude' list for the secondary (forward) path of a TE Tunnel segment indicates that the secondary path has the same endpoints as the primary path.¶
The 'tunnels' container holds the list of TE Tunnels that are provisioned on ingress router devices in the network as shown in Figure 5.¶
module: ietf-te
+--rw te
+--rw tunnels
+--rw tunnel* [name]
+--rw name string
+--rw alias? string
+--rw identifier? uint32
+--rw color? uint32
+--rw description? string
+--rw admin-state? identityref
+--ro operational-state? identityref
+--rw encoding? identityref
+--rw switching-type? identityref
+--rw source
| ...
+--rw destination
| ...
+--rw bidirectional? boolean
+--rw controller
| ...
+--rw reoptimize-timer? uint16
+--rw association-objects
| ...
+--rw protection
| ...
+--rw restoration
| ...
+--rw network-id? nw:network-id
+--rw te-topology-identifier
| ...
+--rw te-bandwidth
| ...
+--rw link-protection? identityref
+--rw setup-priority? uint8
+--rw hold-priority? uint8
+--rw signaling-type? identityref
+--rw hierarchy
| ...
+--rw primary-paths
| ...
+--rw secondary-paths
| ...
+--rw secondary-reverse-paths
| ...
+---x tunnel-action
| ...
+---x protection-external-commands
...
When the TE model is used to manage a specific device, the 'tunnel' list contains the TE Tunnels originating from the specific device. When the model is used to manage a TE controller, the 'tunnel' list contains all TE Tunnels and TE tunnel segments originating from devices that the TE controller manages.¶
The TE Tunnel model allows the configuration and management of the following TE tunnel objects:¶
The TE Tunnel has a number of attributes that are set directly under the tunnel (as shown in Figure 5). The main attributes of a TE Tunnel are described below:¶
YANG containers that hold the tunnel source and destination node endpoint identities, including:¶
A YANG container that holds hierarchy related properties of the TE Tunnel. A TE LSP can be set up in MPLS or Generalized MPLS (GMPLS) networks to be used as a TE link to carry traffic in other (client) networks [RFC6107]. In this case, the model introduces the TE Tunnel hierarchical link endpoint parameters to identify the specific link in the client layer that the underlying TE Tunnel is associated with. The hierarchy container includes the following:¶
A YANG container that holds the list of primary paths. A primary path is identified by 'name'. A primary path is selected from the list to instantiate a primary forwarding LSP for the tunnel. The list of primary paths is visited by order of preference. A primary path has the following attributes:¶
The following set of common path attributes are shared for primary (forward and reverse) and secondary paths:¶
A YANG grouping that contains leafs representing the path attributes that are passed to the TE path computation engine to be considered during the path computation. This includes:¶
Note: Unless overridden under a specific path of the TE tunnel, the TE tunnel's primary path constraints, optimization objectives, and associations are inherited by the primary reverse path, secondary path, and secondary reverse path.¶
In addition to the path common attributes, the primary path has the following attributes that are not present in the secondary path:¶
Only the primary path contains the list of 'candidate-secondary-paths' that can protect the primary path.¶
Only the primary path can contain a primary-reverse-path associated with the primary path (and its associated list of 'candidate-secondary-reverse-path').¶
The 'lsps' container includes the set of TE LSPs that have been instantiated. A TE LSP is identified by a 3-tuple ('tunnel-name', 'lsp-id', 'node').¶
When the model is used to manage a specific device, the 'lsps' list contains all TE LSPs that traverse the device (including ingressing, transiting, and egressing the device).¶
When the model is used to manage a TE controller, the 'lsps' list contains the TE LSPs on devices managed by the controller that act as ingress, and may optionally include TE LSPs on devices managed by the controller that act as a transit or egress role.¶
Figure 6 shows the YANG tree diagram of depth=4 for the TE YANG module "ietf-te". The full tree diagram is shown in Appendix B.¶
module: ietf-te
+--rw te
+--rw enable? boolean
+--rw globals
| +--rw named-admin-groups
| | +--rw named-admin-group* [name]
| | {te-types:extended-admin-groups,
| | te-types:named-extended-admin-groups}?
| | ...
| +--rw named-srlgs
| | +--rw named-srlg* [name] {te-types:named-srlg-groups}?
| | ...
| +--rw named-path-constraints
| +--rw named-path-constraint* [name]
| {te-types:named-path-constraints}?
| ...
+--rw tunnels
| +--rw tunnel* [name]
| +--rw name string
| +--rw alias? string
| +--rw identifier? uint32
| +--rw color? uint32
| +--rw description? string
| +--rw admin-state? identityref
| +--ro operational-state? identityref
| +--rw encoding? identityref
| +--rw switching-type? identityref
| +--rw source
| | ...
| +--rw destination
| | ...
| +--rw bidirectional? boolean
| +--rw controller
| | ...
| +--rw reoptimize-timer? uint16
| +--rw association-objects
| | ...
| +--rw protection
| | ...
| +--rw restoration
| | ...
| +--rw network-id? nw:network-id
| +--rw te-topology-identifier
| | ...
| +--rw te-bandwidth
| | ...
| +--rw link-protection? identityref
| +--rw setup-priority? uint8
| +--rw hold-priority? uint8
| +--rw signaling-type? identityref
| +--rw hierarchy
| | ...
| +--rw primary-paths
| | ...
| +--rw secondary-paths
| | ...
| +--rw secondary-reverse-paths
| | ...
| +---x tunnel-action
| | ...
| +---x protection-external-commands
| ...
+--ro lsps
+--ro lsp* [tunnel-name lsp-id node]
+--ro tunnel-name string
+--ro lsp-id uint16
+--ro node
| te-types:te-node-id
+--ro source?
| te-types:te-node-id
+--ro destination?
| te-types:te-node-id
+--ro tunnel-id? uint16
+--ro extended-tunnel-id?
| yang:dotted-quad
+--ro operational-state? identityref
+--ro signaling-type? identityref
+--ro origin-type? enumeration
+--ro lsp-resource-status? enumeration
+--ro lockout-of-normal? boolean
+--ro freeze? boolean
+--ro lsp-protection-role? enumeration
+--ro lsp-protection-state? identityref
+--ro ingress-node-id?
| te-types:te-node-id
+--ro egress-node-id?
| te-types:te-node-id
+--ro lsp-actual-route-information
...
rpcs:
+---x tunnels-path-compute
| +---w input
| | +---w path-compute-info
| +--ro output
| +--ro path-compute-result
+---x tunnels-actions
+---w input
| +---w tunnel-info
| | +---w (filter-type)
| | ...
| +---w action-info
| +---w action? identityref
| +---w disruptive? empty
+--ro output
+--ro action-result? identityref
The TE YANG module "ietf-te" imports the following modules:¶
This module references the following documents: [RFC4206], [RFC4427], [RFC4872], [RFC3209], [RFC6780], [RFC7471], [RFC9012], [RFC8570], [RFC8232], [RFC7271], [RFC8234], [RFC4655], [RFC8231], [RFC7308], [RFC8345], [RFC9256], and [ITU_G.808.1].¶
<CODE BEGINS> file "ietf-te@2026-11-18.yang"
module ietf-te {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-te";
prefix te;
/* Import TE generic types */
import ietf-te-types {
prefix te-types;
reference
"RFC 10056: Common YANG Data Types for Traffic Engineering";
}
import ietf-yang-types {
prefix yang;
reference
"RFC 9911: Common YANG Data Types";
}
import ietf-network {
prefix nw;
reference
"RFC 8345: A YANG Data Model for Network Topologies";
}
import ietf-network-topology {
prefix nt;
reference
"RFC 8345: A YANG Data Model for Network Topologies";
}
organization
"IETF Traffic Engineering Architecture and Signaling (TEAS)
Working Group.";
contact
"WG Web: <https://datatracker.ietf.org/wg/teas/>
WG List: <mailto:teas@ietf.org>
Editor: Tarek Saad
<mailto:tsaad.net@gmail.com>
Editor: Rakesh Gandhi
<mailto:rgandhi@cisco.com>
Editor: Vishnu Pavan Beeram
<mailto:vbeeram@juniper.net>
Editor: Xufeng Liu
<mailto: xufeng.liu.ietf@gmail.com>
Editor: Igor Bryskin
<mailto:i_bryskin@yahoo.com>";
description
"YANG data module for TE configuration, state, and RPCs.
Copyright (c) 2026 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).
All revisions of IETF and IANA published modules can be found at
the YANG Parameters registry group:
https://www.iana.org/assignments/yang-parameters.
This version of this YANG module is part of RFC 10057; see
the RFC itself for full legal notices.";
revision 2026-11-18 {
description
"Initial revision for the TE generic YANG module.";
reference
"RFC 10057: A YANG Data Model for Traffic Engineering Tunnels,
Label Switched Paths, and Interfaces";
}
typedef tunnel-ref {
type leafref {
path "/te:te/te:tunnels/te:tunnel/te:name";
require-instance false;
}
description
"This type is used by data models that need to reference
a configured TE tunnel.";
}
/**
* TE tunnel generic groupings
*/
grouping path-common-properties {
description
"Common path attributes.";
leaf name {
type string;
description
"TE path name.";
}
leaf symbolic-name {
type string;
description
"The symbolic path name is a human-readable string that
identifies an LSP in the network. The symbolic path name
must remain constant throughout an LSP's lifetime.";
reference
"RFC 8231: Path Computation Element Communication Protocol
(PCEP) Extensions for Stateful PCE,
Section 7.3.2";
}
leaf path-computation-method {
type identityref {
base te-types:path-computation-method;
}
default "te-types:path-locally-computed";
description
"The method used for computing the path, either
locally computed, queried from a server or not
computed at all (explicitly configured).";
}
container path-computation-server {
when "derived-from-or-self(../path-computation-method, "
+ "'te-types:path-externally-queried')" {
description
"The IP address or the TE identifier of the external
path computation server.";
}
uses te-types:te-generic-node-id;
description
"Address of the external path computation
server.";
}
leaf compute-only {
when "../use-path-computation = 'true'" {
description
"Applicable when path computation is requested.";
}
type empty;
description
"When present, the path is computed, but no resources
are committed or reserved in the network. The path may
be recomputed upon topology changes.";
}
leaf use-path-computation {
when "derived-from-or-self(../path-computation-method, "
+ "'te-types:path-locally-computed')";
type boolean;
default "true";
description
"When 'true' indicates the path is dynamically computed
and/or validated against the Traffic-Engineering Database
(TED), and when 'false' indicates no path expansion or
validation against the TED is required.";
}
leaf lockdown {
type empty;
description
"When present, indicates the existing path should not be
globally repaired or reoptimized.";
}
leaf path-scope {
type identityref {
base te-types:path-scope-type;
}
default "te-types:path-scope-end-to-end";
config false;
description
"Indicates whether the path is a segment or portion of
the full path, or is an end-to-end path for
the TE Tunnel.";
}
}
grouping path-compute-info {
description
"Attributes used for path computation request.";
uses tunnel-associations-properties;
uses te-types:generic-path-optimization;
leaf named-path-constraint {
if-feature "te-types:named-path-constraints";
type leafref {
path "/te:te/te:globals/te:named-path-constraints/"
+ "te:named-path-constraint/te:name";
}
description
"Reference to a globally defined named path constraint set.";
}
uses path-constraints-common;
}
grouping path-forward-properties {
description
"The path preference.";
leaf preference {
type uint8 {
range "1..255";
}
default "1";
description
"Specifies a preference for this path. The lower the number,
the higher the preference.";
}
leaf co-routed {
when "/te:te/te:tunnels/te:tunnel/te:bidirectional = 'true'" {
description
"Applicable to bidirectional tunnels only.";
}
type boolean;
default "false";
description
"When set to true, indicates whether the reverse path must
be co-routed with the primary.";
}
}
grouping k-requested-paths {
description
"The k-shortest paths requests.";
leaf k-requested-paths {
type uint8;
default "1";
description
"The number of k-shortest paths requested from the path
computation server, which are returned in order based on
their computed optimization objective costs.";
}
}
grouping path-state {
description
"TE per path state parameters.";
uses path-computation-response;
container lsp-provisioning-error-infos {
config false;
description
"LSP provisioning error information.";
list lsp-provisioning-error-info {
description
"List of LSP provisioning error info entries.";
leaf error-reason {
type identityref {
base te-types:lsp-provisioning-error-reason;
}
description
"LSP provision error type.";
}
leaf error-description {
type string;
description
"The textual representation of the error that occurred
during LSP provisioning.";
}
leaf error-timestamp {
type yang:date-and-time;
description
"Timestamp of when the reported error occurred.";
}
leaf error-node-id {
type te-types:te-node-id;
description
"Node identifier of node where error occurred.";
}
leaf error-link-id {
type te-types:te-tp-id;
description
"Link ID where the error occurred.";
}
leaf lsp-id {
type uint16;
description
"The LSP-ID for which LSP provisioning error was
returned.";
}
}
}
container lsps {
config false;
description
"The TE LSPs container.";
list lsp {
key "node lsp-id";
description
"List of LSPs associated with the tunnel.";
leaf tunnel-name {
type leafref {
path "/te:te/te:lsps/te:lsp/te:tunnel-name";
}
description
"TE tunnel name.";
}
leaf node {
type leafref {
path "/te:te/te:lsps/te:lsp[tunnel-name="
+ "current()/../te:tunnel-name][lsp-id="
+ "current()/../te:lsp-id]/te:node";
}
description
"The node where the LSP state resides.";
}
leaf lsp-id {
type leafref {
path "/te:te/te:lsps/te:lsp[tunnel-name="
+ "current()/../tunnel-name]/te:lsp-id";
}
description
"The TE LSP identifier.";
}
leaf state-change-timestamp {
type yang:date-and-time;
description
"Indicates the time at which the LSP operational
state was last updated.";
}
}
}
}
grouping path-computation-response {
description
"Attributes reported by path computation response.";
container computed-paths-properties {
config false;
description
"Computed path properties container.";
list computed-path-properties {
key "k-index";
description
"List of computed paths.";
leaf k-index {
type uint8;
description
"The k-th path returned from the computation server.
A lower k value path is more optimal than higher k
value paths.";
}
uses te-types:generic-path-properties {
augment "path-properties" {
description
"Additional path properties returned by path
computation.";
uses te-types:te-bandwidth;
leaf disjointness-type {
type te-types:te-path-disjointness;
description
"The type of resource disjointness.
When reported for a primary path, it represents the
minimum level of disjointness of all the secondary
paths. When reported for a secondary path, it
represents the disjointness of the secondary path.";
}
leaf last-computed-timestamp {
type yang:date-and-time;
description
"Timestamp of when the path was last computed.";
}
}
}
}
}
container computed-path-error-infos {
config false;
description
"Path computation information container.";
list computed-path-error-info {
description
"List of path computation info entries.";
leaf error-description {
type string;
description
"Textual representation of the error that occurred
during path computation.";
}
leaf error-timestamp {
type yang:date-and-time;
description
"Timestamp of last path computation attempt.";
}
leaf error-reason {
type identityref {
base te-types:path-computation-error-reason;
}
description
"Reason for the path computation error.";
}
}
}
}
grouping protection-restoration-properties {
description
"Protection and restoration parameters.";
container protection {
description
"Protection parameters.";
leaf protection-type {
type identityref {
base te-types:lsp-protection-type;
}
default "te-types:lsp-protection-unprotected";
description
"LSP protection type.";
}
leaf protection-reversion-disable {
type boolean;
default "false";
description
"Disable protection reversion to working path.";
}
leaf hold-off-time {
type uint32;
units "milliseconds";
description
"The time interval from the declaration of a Signal Fail
(SF) or Signal Degrade (SD) condition until the protect-
ion switching algorithm is initiated to maintain service
continuity.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)";
}
leaf wait-to-revert {
type uint16;
units "seconds";
description
"Time to wait before attempting LSP reversion.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)";
}
leaf aps-signal-id {
type uint8 {
range "1..255";
}
default "1";
description
"The Automatic Protection Switching (APS) signal number
used to reference the traffic of this tunnel. The default
value for normal traffic is 1.
The default value for extra-traffic is 255. If not
specified, non-default values can be assigned by the
server, if and only if, the server controls both
endpoints.";
reference
"ITU_G.808.1: Generic protection switching - Linear trail
and subnetwork protection";
}
}
container restoration {
description
"Restoration parameters.";
leaf restoration-type {
type identityref {
base te-types:lsp-restoration-type;
}
description
"LSP restoration type.";
}
leaf restoration-scheme {
type identityref {
base te-types:restoration-scheme-type;
}
description
"LSP restoration scheme.";
}
leaf restoration-reversion-disable {
type boolean;
default "false";
description
"When 'true', disables restoration reversion to the working
path.";
}
leaf hold-off-time {
type uint32;
units "milliseconds";
description
"The time interval from the declaration of a Signal Fail
(SF) or Signal Degrade (SD) condition until the protect-
ion switching algorithm is initiated to maintain service
continuity.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)";
}
leaf wait-to-restore {
type uint16;
units "seconds";
description
"Time to wait before attempting LSP restoration.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)";
}
leaf wait-to-revert {
type uint16;
units "seconds";
description
"Time to wait before attempting LSP reversion.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)";
}
}
}
grouping tunnel-associations-properties {
description
"TE tunnel association grouping.";
container association-objects {
description
"TE tunnel associations.";
list association-object {
key "association-key";
unique "type id source/id source/type";
description
"List of association base objects.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery";
leaf association-key {
type string;
description
"Association key used to identify a specific
association in the list.";
}
leaf type {
type identityref {
base te-types:association-type;
}
description
"Association type.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery";
}
leaf id {
type uint16;
description
"Association identifier.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery";
}
container source {
uses te-types:te-generic-node-id;
description
"Association source.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery";
}
}
list association-object-extended {
key "association-key";
unique
"type id source/id source/type global-source extended-id";
description
"List of extended ASSOCIATION objects.";
reference
"RFC 6780: RSVP ASSOCIATION Object Extensions";
leaf association-key {
type string;
description
"Association key used to identify a specific
association in the list.";
}
leaf type {
type identityref {
base te-types:association-type;
}
description
"Association type.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)
RFC 6780: RSVP ASSOCIATION Object Extensions";
}
leaf id {
type uint16;
description
"Association identifier.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)
RFC 6780: RSVP ASSOCIATION Object Extensions";
}
container source {
uses te-types:te-generic-node-id;
description
"Association source.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)
RFC 6780: RSVP ASSOCIATION Object Extensions";
}
leaf global-source {
type uint32;
description
"Association global source.";
reference
"RFC 6780: RSVP ASSOCIATION Object Extensions";
}
leaf extended-id {
type yang:hex-string;
description
"Association extended identifier.";
reference
"RFC 6780: RSVP ASSOCIATION Object Extensions";
}
}
}
}
grouping tunnel-end-point {
description
"Common grouping used to specify the tunnel source and
destination end-points.";
leaf node-id {
type nw:node-id;
description
"The TE tunnel end-point node identifier.";
}
leaf te-node-id {
type te-types:te-node-id;
description
"The TE tunnel end-point TE node identifier.";
}
leaf tunnel-tp-id {
when '../node-id or ../te-node-id' {
description
"The TE tunnel termination point identifier is local to
a node.";
}
type binary;
description
"The TE tunnel end-point TE tunnel termination point
identifier.";
}
}
/* Some of the groupings defined in this module are reused
* in the ietf-te-path-computation YANG module
* defined in draft-ietf-teas-yang-path-computation */
grouping tunnel-common-attributes {
description
"Common grouping to define the TE tunnel parameters.";
container source {
description
"TE tunnel source end-point.";
uses tunnel-end-point;
}
container destination {
description
"TE tunnel destination end-point.";
uses tunnel-end-point;
}
leaf bidirectional {
type boolean;
default "false";
description
"When 'true', it indicates a bidirectional tunnel.";
}
}
/* This grouping is reused in the ietf-te-path-computation YANG
* module defined in draft-ietf-teas-yang-path-computation */
grouping tunnel-hierarchy-properties {
description
"A grouping for TE tunnel hierarchy information.";
container hierarchy {
description
"Container for TE hierarchy related information.";
container dependency-tunnels {
description
"List of tunnels that this tunnel can be potentially
dependent on.";
list dependency-tunnel {
key "name";
description
"A tunnel entry that this tunnel can potentially depend
on.";
leaf name {
type tunnel-ref;
description
"Dependency tunnel name. The tunnel may not have been
instantiated yet.";
}
uses te-types:encoding-and-switching-type;
}
}
container hierarchical-link {
description
"Identifies a hierarchical link (in client layer)
that this tunnel is associated with. By default, the
topology of the hierarchical link is the same topology of
the tunnel.";
reference
"RFC 4206: Label Switched Paths (LSP) Hierarchy with
Generalized Multi-Protocol Label Switching
(GMPLS) Traffic Engineering (TE)";
leaf enable {
type boolean;
default "false";
description
"When 'true', enables the hierarchical link properties
supported by this tunnel.";
}
leaf local-node-id {
type nw:node-id;
description
"The local node identifier.";
}
leaf local-te-node-id {
type te-types:te-node-id;
description
"The local TE node identifier.";
}
leaf local-link-tp-id {
type nt:tp-id;
description
"The local link termination point identifier.";
reference
"RFC 8345: A YANG Data Model for Network Topologies";
}
leaf local-te-link-tp-id {
type te-types:te-tp-id;
description
"The local TE link termination point identifier.";
}
leaf remote-node-id {
type nw:node-id;
description
"The remote node identifier.";
}
leaf remote-link-tp-id {
type nt:tp-id;
description
"The remote link termination point identifier.";
reference
"RFC 8345: A YANG Data Model for Network Topologies";
}
leaf remote-te-link-tp-id {
type te-types:te-tp-id;
description
"The remote TE link termination point identifier.";
}
leaf remote-te-node-id {
type te-types:te-node-id;
description
"Remote TE node identifier.";
}
leaf link-id {
type nt:link-id;
description
"A network topology assigned identifier to the link.";
reference
"RFC 8345: A YANG Data Model for Network Topologies";
}
leaf network-id {
type nw:network-id;
description
"The network topology identifier where the hierarchical
link supported by this TE tunnel is instantiated.";
}
uses te-types:te-topology-identifier {
description
"The TE topology identifier where the hierarchical link
supported by this TE tunnel is instantiated.";
}
}
}
}
grouping path-constraints-common {
description
"Global named path constraints configuration
grouping.";
uses te-types:common-path-constraints-attributes;
uses te-types:generic-path-disjointness;
uses te-types:path-constraints-route-objects;
container path-in-segment {
presence "The end-to-end tunnel starts in a previous domain;
this tunnel is a segment in the current domain.";
description
"If an end-to-end tunnel crosses multiple domains using
the same technology, some additional constraints have to be
taken in consideration in each domain.
This TE tunnel segment is stitched to the upstream TE tunnel
segment.";
uses te-types:label-set-info;
}
container path-out-segment {
presence
"The end-to-end tunnel is not terminated in this domain;
this tunnel is a segment in the current domain.";
description
"If an end-to-end tunnel crosses multiple domains using
the same technology, some additional constraints have to be
taken in consideration in each domain.
This TE tunnel segment is stitched to the downstream TE
tunnel segment.";
uses te-types:label-set-info;
}
}
/**
* TE container
*/
container te {
description
"TE global container.";
leaf enable {
type boolean;
description
"When 'true', the TE component features are enabled.";
}
/* TE Global Data */
container globals {
description
"Globals TE system-wide configuration data container.";
container named-admin-groups {
description
"TE named admin groups container.";
list named-admin-group {
if-feature "te-types:extended-admin-groups";
if-feature "te-types:named-extended-admin-groups";
key "name";
description
"List of named TE admin-groups.";
leaf name {
type string;
description
"A name that uniquely identifies a TE
interface named admin-group.";
}
leaf bit-position {
type uint32;
description
"Bit-position value for a named Administrative Group
(AG). The value is an integer that represents one of
the bit positions in the administrative group bitmask.
Values for bit-positions between 0 and 31 are
interpreted as the original 32 bit AGs. Values of bit-
positions >=32 are interpreted as Extended
Administrative Group (EAG) values as per RFC 7308.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels
RFC 7308: Extended Administrative Groups in MPLS
Traffic Engineering (MPLS-TE)";
}
}
}
container named-srlgs {
description
"TE named SRLGs container.";
list named-srlg {
if-feature "te-types:named-srlg-groups";
key "name";
description
"A list of named SRLG groups.";
leaf name {
type string;
description
"A name that uniquely identifies a TE
interface named SRLG.";
}
leaf value {
type te-types:srlg;
description
"An SRLG value.";
}
leaf cost {
type uint32;
description
"The cost associated with an SRLG. This is used as
a penalty during path computation when the TE path
traverses a link with this SRLG.";
}
}
}
container named-path-constraints {
description
"TE named path constraints container.";
list named-path-constraint {
if-feature "te-types:named-path-constraints";
key "name";
leaf name {
type string;
description
"A unique identifier for a set of path constraints.
Operators should ensure that when this model is used
to manage multiple devices, the parameters associated
with the set of path constraints sharing the same name
remain consistent across those devices in order to
maintain uniform path behavior.";
}
uses path-constraints-common;
description
"A list of named path constraints.";
}
}
}
/* TE Tunnel Data */
container tunnels {
description
"Tunnels TE configuration data container.";
list tunnel {
key "name";
description
"The list of TE tunnels.";
leaf name {
type string;
description
"TE tunnel name.";
}
leaf alias {
type string;
description
"An alternate name of the TE tunnel that can be modified
anytime during its lifetime.";
}
leaf identifier {
type uint32;
description
"A numeric identifier for the tunnel, unique within the
scope of the ingress node. While the 'name' leaf serves
as a human-readable management key, this
'identifier' corresponds to the Tunnel ID used in
control plane signaling (e.g., the RSVP-TE SESSION
object as defined in RFC 3209), allowing for
correlation between management state and network-wide
signaling.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels";
}
leaf color {
type uint32;
description
"A TE Tunnel (RFC 3209) can be associated with an intent
or objective (e.g., low latency) by tagging it with a
color. This color attribute is used as a guiding
criterion for mapping services onto the TE Tunnel
(RFC 9012) (RFC 9256).";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels
RFC 9012: The BGP Tunnel Encapsulation Attribute
RFC 9256: Segment Routing Policy Architecture";
}
leaf description {
type string;
default "None";
description
"Textual description for this TE tunnel.";
}
leaf admin-state {
type identityref {
base te-types:tunnel-admin-state-type;
}
default "te-types:tunnel-admin-state-up";
description
"TE tunnel administrative state.";
}
leaf operational-state {
type identityref {
base te-types:tunnel-state-type;
}
config false;
description
"TE tunnel operational state.";
}
leaf state-change-timestamp {
type yang:date-and-time;
description
"Indicates the time at which the TE tunnel's operational
state was last updated.";
}
uses te-types:encoding-and-switching-type;
uses tunnel-common-attributes;
container controller {
description
"Contains tunnel data relevant to external controllers.
This target node may be augmented by external modules,
for example, to add data for PCEP initiated and/or
delegated tunnels.";
leaf protocol-origin {
type identityref {
base te-types:protocol-origin-type;
}
description
"The protocol origin for instantiating the tunnel.";
}
leaf controller-entity-id {
type string;
description
"An identifier that is associated with the entity that
controls the tunnel as defined in RFC 8232.";
reference
"RFC 8232: Optimizations of Label Switched Path State
Synchronization Procedures for a Stateful
PCE";
}
}
leaf reoptimize-timer {
type uint16;
units "seconds";
description
"Frequency of reoptimization of a traffic-engineered
LSP. A value of 0 means that the LSP is never
reoptimized.";
}
uses tunnel-associations-properties;
uses protection-restoration-properties;
uses te-types:tunnel-constraints;
uses tunnel-hierarchy-properties;
container primary-paths {
description
"The set of primary paths.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery";
list primary-path {
key "name";
description
"List of primary paths for this tunnel.";
leaf active {
type boolean;
config false;
description
"When 'true', indicates an active path has been
selected from the primary paths list.";
}
uses path-common-properties;
uses path-forward-properties;
uses k-requested-paths;
uses path-compute-info;
uses path-state;
container primary-reverse-path {
when "../../../te:bidirectional = 'true'";
description
"The reverse primary path properties.";
uses path-common-properties;
uses path-compute-info;
uses path-state;
container candidate-secondary-reverse-paths {
description
"The set of referenced candidate reverse secondary
paths from the full set of secondary reverse paths
which may be used for this primary path.";
list candidate-secondary-reverse-path {
key "secondary-reverse-path";
ordered-by user;
description
"List of candidate secondary reverse paths.";
leaf secondary-reverse-path {
type leafref {
path "../../../../../../"
+ "te:secondary-reverse-paths/"
+ "te:secondary-reverse-path/te:name";
}
description
"A reference to the secondary reverse path that
may be utilized when the containing primary
reverse path is in use.";
}
leaf active {
type boolean;
config false;
description
"When 'true', indicates an active path has been
selected from the secondary reverse paths
list.";
}
}
}
}
container candidate-secondary-paths {
description
"The set of candidate secondary paths which may be
used for this primary path. When secondary paths are
specified in the list the path of the secondary LSP
in use must be restricted to those paths
referenced.
The priority of the secondary paths is specified
within the list. Higher priority values are less
preferred, i.e., a path with priority 0 is the
most preferred path. In the case that the
list is empty, any secondary path may be
utilized when the current primary path is in use.";
list candidate-secondary-path {
key "secondary-path";
ordered-by user;
description
"List of candidate secondary paths for this
tunnel.";
leaf secondary-path {
type leafref {
path "../../../../../te:secondary-paths/"
+ "te:secondary-path/te:name";
}
description
"A reference to the secondary path that may be
utilized when the containing primary path is
in use.";
}
leaf active {
type boolean;
config false;
description
"When 'true', indicates an active path has been
selected from the candidate secondary paths.";
}
}
}
}
}
container secondary-paths {
description
"The set of secondary paths.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery";
list secondary-path {
key "name";
description
"List of secondary paths for this tunnel.";
uses path-common-properties;
leaf preference {
type uint8 {
range "1..255";
}
default "1";
description
"Specifies a preference for this path. The lower the
number, the higher the preference.";
}
leaf secondary-reverse-path {
type leafref {
path "../../../"
+ "te:secondary-reverse-paths/"
+ "te:secondary-reverse-path/te:name";
}
description
"A reference to the reverse secondary path when
co-routed with the secondary path.";
}
uses path-compute-info;
uses protection-restoration-properties;
uses path-state;
}
}
container secondary-reverse-paths {
description
"The set of secondary reverse paths.";
list secondary-reverse-path {
key "name";
description
"List of secondary paths for this tunnel.";
uses path-common-properties;
leaf preference {
type uint8 {
range "1..255";
}
default "1";
description
"Specifies a preference for this path. The lower the
number, the higher the preference. Paths that have
the same preference will be activated together.";
}
uses path-compute-info;
uses protection-restoration-properties;
uses path-state;
}
}
action tunnel-action {
description
"Action commands to manipulate the TE tunnel state.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels,
Section 2.5";
input {
leaf action-type {
type identityref {
base te-types:tunnel-action-type;
}
description
"The action to be invoked on the TE tunnel.";
}
}
output {
leaf action-result {
type identityref {
base te-types:te-action-result;
}
description
"The result of the tunnel action operation.";
}
}
}
action protection-external-commands {
description
"Actions to manipulate the protection external
commands of the TE tunnel.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol Label
Switching (GMPLS)";
input {
leaf protection-external-command {
type identityref {
base te-types:protection-external-commands;
}
description
"Protection external command.";
}
leaf ingress-node {
type boolean;
default "true";
description
"When 'true', indicates that the action is
applied on the ingress node.
By default, the action applies to the ingress
node.";
}
leaf egress-node {
type boolean;
default "false";
description
"When 'true', indicates that the action is
applied on the egress node. By default,
the action applies to the ingress node.";
}
leaf path-name {
type string;
description
"The name of the path that the external command
applies to.";
}
leaf path-type {
type te-types:path-type;
description
"The type of the path that the external command
applies to.";
}
leaf traffic-type {
type enumeration {
enum normal-traffic {
description
"The manual-switch or forced-switch command
applies to the normal traffic (this Tunnel).";
}
enum null-traffic {
description
"The manual-switch or forced-switch command
applies to the null traffic.";
}
enum extra-traffic {
description
"The manual-switch or forced-switch command
applies to the extra traffic (the extra-traffic
Tunnel sharing protection bandwidth with this
Tunnel).";
}
}
description
"Indicates whether the manual-switch or forced-switch
commands applies to the normal traffic, the null
traffic or the extra-traffic.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS).";
}
leaf extra-traffic-tunnel-ref {
type tunnel-ref;
description
"In case there are multiple extra-traffic tunnels
sharing protection bandwidth with this Tunnel
(m:n protection), represents which extra-traffic
Tunnel the manual-switch or forced-switch to
extra-traffic command applies to.";
}
}
}
}
}
/* TE LSPs Data */
container lsps {
config false;
description
"TE LSPs state container.";
list lsp {
key "tunnel-name lsp-id node";
unique "source destination tunnel-id lsp-id "
+ "extended-tunnel-id";
description
"List of LSPs associated with the tunnel.";
leaf tunnel-name {
type string;
description
"The TE tunnel name.";
}
leaf lsp-id {
type uint16;
description
"An identifier unique in the context of the ingress LSP.
For example, as used in the RSVP-TE SENDER_TEMPLATE and
FILTER_SPEC objects. The value can be changed to allow a
sender to share resources with itself.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels";
}
leaf node {
type te-types:te-node-id;
description
"The node where the LSP state is retrieved.";
}
leaf source {
type te-types:te-node-id;
description
"The address of the ingress LSP endpoint that identifies
the start of the tunnel. This typically corresponds to
the Tunnel Sender Address extracted from the RSVP-TE
SENDER_TEMPLATE object.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels";
}
leaf destination {
type te-types:te-node-id;
description
"The address of the egress LSP endpoint that identifies
the end of the tunnel. This typically corresponds to
the Tunnel Endpoint Address extracted from the RSVP-TE
SESSION object.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels";
}
leaf tunnel-id {
type uint16;
description
"An identifier of the tunnel that remains constant over
the life of the tunnel. For example, this may be the
Tunnel ID extracted from RSVP-TE SESSION object.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels";
}
leaf extended-tunnel-id {
type te-types:te-node-id;
description
"A qualifier used to ensure the global uniqueness of the
tunnel identifier. It carries a 4-byte or 16-byte value,
typically corresponding to the Extended Tunnel ID
extracted from the RSVP-TE SESSION object as defined in
RFC 3209.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels";
}
leaf operational-state {
type identityref {
base te-types:lsp-state-type;
}
description
"The LSP operational state.";
}
leaf signaling-type {
type identityref {
base te-types:path-signaling-type;
}
description
"The signaling protocol used to set up this LSP.";
}
leaf origin-type {
type enumeration {
enum ingress {
description
"Origin ingress.";
}
enum egress {
description
"Origin egress.";
}
enum transit {
description
"Origin transit.";
}
}
description
"The origin of the LSP relative to the location of the
local switch in the path.";
}
leaf lsp-resource-status {
type enumeration {
enum primary {
description
"A primary LSP is a fully established LSP for which
the resource allocation has been committed at the
data plane.";
}
enum secondary {
description
"A secondary LSP is an LSP that has been provisioned
in the control plane only; e.g., resource allocation
has not been committed at the data plane.";
}
}
description
"LSP resource allocation state.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery, Section 4.2.1";
}
leaf lockout-of-normal {
type boolean;
description
"When set to 'true', it represents a lockout of normal
traffic external command. When set to 'false', it
represents a clear lockout of normal traffic external
command. The lockout of normal traffic command applies
to this Tunnel.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)";
}
leaf freeze {
type boolean;
description
"When set to 'true', it represents a freeze external
command. When set to 'false', it represents a clear
freeze external command. The freeze command applies to
all the Tunnels which are sharing the protection
resources with this Tunnel.";
reference
"RFC 4427: Recovery (Protection and Restoration)
Terminology for Generalized Multi-Protocol
Label Switching (GMPLS)";
}
leaf lsp-protection-role {
type enumeration {
enum working {
description
"A working LSP must be a primary LSP whilst a
protecting LSP can be either a primary or a
secondary LSP. Also, known as protected LSPs when
working LSPs are associated with protecting LSPs.";
}
enum protecting {
description
"A secondary LSP is an LSP that has been provisioned
in the control plane only; e.g., resource allocation
has not been committed at the data plane.";
}
}
description
"LSP role type.";
reference
"RFC 4872: RSVP-TE Extensions in Support of End-to-End
Generalized Multi-Protocol Label Switching
(GMPLS) Recovery, Section 4.2.1";
}
leaf lsp-protection-state {
type identityref {
base te-types:lsp-protection-state;
}
config false;
description
"The reported protection state controlling which
tunnel is using the resources of the protecting LSP.";
}
leaf ingress-node-id {
type te-types:te-node-id;
description
"Indicates the te-node-id of the ingress node of the TE
tunnel or tunnel segment when the protection action is
applied to the ingress node or the Wait To Restore (WTR)
timer is active.
This is set to '0.0.0.0' when the controller is not
aware of the te-node-id of ingress-node.";
}
leaf egress-node-id {
type te-types:te-node-id;
description
"Indicates the te-node-id of the egress node of the TE
tunnel or tunnel segment when the protection action is
applied to the ingress node or the WTR timer is active.
This is set to '0.0.0.0' when the controller is not
aware of the te-node-id of ingress-node.";
}
container lsp-actual-route-information {
description
"RSVP recorded route object information.";
list lsp-actual-route-information {
when "../../origin-type = 'ingress'" {
description
"Applicable on ingress LSPs only.";
}
key "index";
description
"Record route list entry.";
uses te-types:record-route-state;
}
}
}
}
}
/* TE Tunnel RPCs/execution Data */
rpc tunnels-path-compute {
description
"This RPC is a generic API whose
input and output parameters are expected to be provided by
augments to this module.";
reference
"RFC 4655: A Path Computation Element (PCE)-Based
Architecture.";
input {
container path-compute-info {
/*
* An external path compute module may augment this
* target.
*/
description
"RPC input information.";
}
}
output {
container path-compute-result {
/*
* An external path compute module may augment this
* target.
*/
description
"RPC output information.";
}
}
}
rpc tunnels-actions {
description
"RPC that manipulates the state of a TE tunnel.";
reference
"RFC 3209: RSVP-TE: Extensions to RSVP for LSP Tunnels,
Section 2.5";
input {
container tunnel-info {
description
"TE tunnel information.";
choice filter-type {
mandatory true;
description
"Filter choice.";
case all-tunnels {
leaf all {
type empty;
mandatory true;
description
"When present, applies the action on all TE
tunnels.";
}
}
case one-tunnel {
leaf tunnel {
type tunnel-ref;
description
"Apply action on the specific TE tunnel.";
}
}
}
}
container action-info {
description
"TE tunnel action information.";
leaf action {
type identityref {
base te-types:tunnel-action-type;
}
description
"The action type.";
}
leaf disruptive {
when "derived-from-or-self(../action, "
+ "'te-types:tunnel-action-reoptimize')";
type empty;
description
"Specifies whether reoptimization operations,
particularly when multiple tunnels are involved,
are permitted to cause traffic disruption on some
TE tunnels.";
}
}
}
output {
leaf action-result {
type identityref {
base te-types:te-action-result;
}
description
"The result of the tunnel action operation.";
}
}
}
}
<CODE ENDS>¶
The TE device YANG module "ietf-te-device" models data that is specific to managing a TE device. This module augments the TE YANG module.¶
The "ietf-te-device" module defines the configuration and operational state data that is specific to the device, including those related to the TE subsystem, tunnels, LSPs, and interfaces.¶
The "ietf-te-device" module augments the TE YANG module "ietf-te" at the 'globals', 'tunnels', and 'lsps' levels to include the device-specific configurations and operational state.¶
Figure 7 shows the "ietf-te-device" subtree generated with depth=4 that describes those augmentations.¶
module: ietf-te-device
augment /te:te/te:globals:
+--rw lsp-install-interval? uint32
+--rw lsp-cleanup-interval? uint32
+--rw lsp-invalidation-interval? uint32
augment /te:te/te:tunnels/te:tunnel:
+--rw path-invalidation-action? identityref
+--rw lsp-install-interval? uint32
+--rw lsp-cleanup-interval? uint32
+--rw lsp-invalidation-interval? uint32
augment /te:te/te:lsps/te:lsp:
+--ro lsp-timers
| +--ro uptime? uint32
| +--ro time-to-install? uint32
| +--ro time-to-destroy? uint32
+--ro downstream-info
| ..
+--ro upstream-info
..
The following is the description of the augmented data at each level.¶
These are device-specific global configuration parameters related to LSP timers, applied system-wide.¶
These are device-specific configuration parameters that apply to individual TE Tunnels:¶
These are read-only operational state parameters providing device-specific details for individual LSPs:¶
The TE interface is modeled as a reference to an existing interface as defined in the 'ietf-interfaces' YANG module [RFC8343].¶
Figure 8 shows the TE interface subtree from the TE device module "ietf-te-device" with depth=4. The full tree diagram is shown in Appendix B.¶
module: ietf-te-device
augment /te:te:
+--rw interfaces
+--rw threshold-type? enumeration
+--rw delta-percentage? rt-types:percentage
+--rw threshold-specification? enumeration
+--rw up-thresholds* rt-types:percentage
+--rw down-thresholds* rt-types:percentage
+--rw up-down-thresholds* rt-types:percentage
+--rw interface* [name]
+--rw name if:interface-ref
+--rw te-metric?
| te-types:te-metric
+--rw (admin-group-type)?
| +--:(value-admin-groups)
| | ...
| +--:(named-admin-groups)
| ...
+--rw (srlg-type)?
| +--:(value-srlgs)
| | ...
| +--:(named-srlgs)
| ...
+--rw threshold-type? enumeration
+--rw delta-percentage?
| rt-types:percentage
+--rw threshold-specification? enumeration
+--rw up-thresholds*
| rt-types:percentage
+--rw down-thresholds*
| rt-types:percentage
+--rw up-down-thresholds*
| rt-types:percentage
+--rw switching-capabilities* [switching-capability]
| +--rw switching-capability identityref
| +--rw encoding? identityref
+--ro te-advertisements-state
+--ro flood-interval? uint32
+--ro last-flooded-time? uint32
+--ro next-flooded-time? uint32
+--ro last-flooded-trigger? enumeration
+--ro advertised-level-areas* [level-area]
...
The main elements under the interfaces container are:¶
A list of individual TE interfaces configured on the device. Each entry represents a network interface enabled for Traffic Engineering and contains its specific attributes and state. A TE interface is identified by the 'name' leaf, which references an existing network interface on the device.¶
A choice node that allows configuring SRLGs for the interface using either direct values or named references.¶
A list of switching capabilities supported by this interface.¶
A read-only container that provides operational state information related to how this TE interface's attributes are advertised.¶
Figure 9 shows the YANG tree diagram of the TE device YANG module defined in "ietf-te-device".¶
module: ietf-te-device
augment /te:te:
+--rw interfaces
+--rw threshold-type? enumeration
+--rw delta-percentage? rt-types:percentage
+--rw threshold-specification? enumeration
+--rw up-thresholds* rt-types:percentage
+--rw down-thresholds* rt-types:percentage
+--rw up-down-thresholds* rt-types:percentage
+--rw interface* [name]
+--rw name if:interface-ref
+--rw te-metric?
| te-types:te-metric
+--rw (admin-group-type)?
| +--:(value-admin-groups)
| | +--rw (value-admin-group-type)?
| | +--:(admin-groups)
| | | +--rw admin-group?
| | | te-types:admin-group
| | +--:(extended-admin-groups)
| | {te-types:extended-admin-groups}?
| | +--rw extended-admin-group?
| | te-types:extended-admin-group
| +--:(named-admin-groups)
| +--rw named-admin-groups* [named-admin-group]
| {te-types:extended-admin-groups,
| te-types:named-extended-admin-groups}?
| +--rw named-admin-group leafref
+--rw (srlg-type)?
| +--:(value-srlgs)
| | +--rw values* [value]
| | +--rw value uint32
| +--:(named-srlgs)
| +--rw named-srlgs* [named-srlg]
| {te-types:named-srlg-groups}?
| +--rw named-srlg leafref
+--rw threshold-type? enumeration
+--rw delta-percentage?
| rt-types:percentage
+--rw threshold-specification? enumeration
+--rw up-thresholds*
| rt-types:percentage
+--rw down-thresholds*
| rt-types:percentage
+--rw up-down-thresholds*
| rt-types:percentage
+--rw switching-capabilities* [switching-capability]
| +--rw switching-capability identityref
| +--rw encoding? identityref
+--ro te-advertisements-state
+--ro flood-interval? uint32
+--ro last-flooded-time? uint32
+--ro next-flooded-time? uint32
+--ro last-flooded-trigger? enumeration
+--ro advertised-level-areas* [level-area]
+--ro level-area uint32
augment /te:te/te:globals:
+--rw lsp-install-interval? uint32
+--rw lsp-cleanup-interval? uint32
+--rw lsp-invalidation-interval? uint32
augment /te:te/te:tunnels/te:tunnel:
+--rw path-invalidation-action? identityref
+--rw lsp-install-interval? uint32
+--rw lsp-cleanup-interval? uint32
+--rw lsp-invalidation-interval? uint32
augment /te:te/te:lsps/te:lsp:
+--ro lsp-timers
| +--ro uptime? uint32
| +--ro time-to-install? uint32
| +--ro time-to-destroy? uint32
+--ro downstream-info
| +--ro nhop? te-types:te-tp-id
| +--ro outgoing-interface? if:interface-ref
| +--ro neighbor
| | +--ro id? te-gen-node-id
| | +--ro type? enumeration
| +--ro label? rt-types:generalized-label
+--ro upstream-info
+--ro phop? te-types:te-tp-id
+--ro neighbor
| +--ro id? te-gen-node-id
| +--ro type? enumeration
+--ro label? rt-types:generalized-label
rpcs:
+---x link-state-update
+---w input
+---w (filter-type)
+--:(match-all)
| +---w all empty
+--:(match-one-interface)
+---w interface? if:interface-ref
The "ietf-te-device" module imports the following modules:¶
ietf-te defined in this document¶
<CODE BEGINS> file "ietf-te-device@2026-11-18.yang"
module ietf-te-device {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-te-device";
prefix te-dev;
/* Import TE module */
import ietf-te {
prefix te;
reference
"RFC 10057: A YANG Data Model for Traffic Engineering Tunnels,
Label Switched Paths, and Interfaces";
}
/* Import TE types */
import ietf-te-types {
prefix te-types;
reference
"RFC 10056: Common YANG Data Types for Traffic Engineering.";
}
import ietf-interfaces {
prefix if;
reference
"RFC8343: A YANG Data Model for Interface Management";
}
import ietf-routing-types {
prefix rt-types;
reference
"RFC8294: Common YANG Data Types for the Routing Area";
}
organization
"IETF Traffic Engineering Architecture and Signaling (TEAS)
Working Group";
contact
"WG Web: <https://datatracker.ietf.org/wg/teas/>
WG List: <mailto:teas@ietf.org>
Editor: Tarek Saad
<mailto:tsaad.net@gmail.com>
Editor: Rakesh Gandhi
<mailto:rgandhi@cisco.com>
Editor: Vishnu Pavan Beeram
<mailto:vbeeram@juniper.net>
Editor: Himanshu Shah
<mailto:hshah@ciena.com>
Editor: Xufeng Liu
<mailto: xufeng.liu.ietf@gmail.com>
Editor: Igor Bryskin
<mailto:i_bryskin@yahoo.com>";
description
"This module defines a data model for TE device configurations,
state, and RPCs.
Copyright (c) 2026 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 10057
(https://www.rfc-editor.org/info/rfc10057); see the RFC itself
for full legal notices.";
revision 2026-11-18 {
description
"Initial revision for the TE device YANG module.";
reference
"RFC 10057: A YANG Data Model for Traffic Engineering Tunnels,
Label Switched Paths, and Interfaces";
}
grouping lsp-device-timers {
description
"Device TE LSP timers configs.";
leaf lsp-install-interval {
type uint32;
units "seconds";
description
"TE LSP installation delay time.";
}
leaf lsp-cleanup-interval {
type uint32;
units "seconds";
description
"TE LSP cleanup delay time.";
}
leaf lsp-invalidation-interval {
type uint32;
units "seconds";
description
"TE LSP path invalidation before taking action delay time.";
}
}
grouping te-igp-flooding-bandwidth-config {
description
"Configurable items for igp flooding bandwidth
threshold configuration.";
leaf threshold-type {
type enumeration {
enum delta {
description
"'delta' indicates that the local
system should flood IGP updates when a
change in reserved bandwidth >= the specified
delta occurs on the interface.";
}
enum threshold-crossed {
description
"THRESHOLD-CROSSED indicates that
the local system should trigger an update (and
hence flood) the reserved bandwidth when the
reserved bandwidth changes such that it crosses,
or becomes equal to one of the threshold values.";
}
}
description
"The type of threshold that should be used to specify the
values at which bandwidth is flooded. 'delta' indicates that
the local system should flood IGP updates when a change in
reserved bandwidth >= the specified delta occurs on the
interface. Where 'threshold-crossed' is specified, the local
system should trigger an update (and hence flood) the
reserved bandwidth when the reserved bandwidth changes such
that it crosses, or becomes equal to one of the threshold
values.";
}
leaf delta-percentage {
when "../threshold-type = 'delta'" {
description
"The percentage delta can only be specified when the
threshold type is specified to be a percentage delta of
the reserved bandwidth.";
}
type rt-types:percentage;
description
"The percentage of the maximum-reservable-bandwidth
considered as the delta that results in an IGP update
being flooded.";
}
leaf threshold-specification {
when "../threshold-type = 'threshold-crossed'" {
description
"The selection of whether mirrored or separate threshold
values are to be used requires user-specified thresholds
to be set.";
}
type enumeration {
enum mirrored-up-down {
description
"mirrored-up-down indicates that a single set of
threshold values should be used for both increasing
and decreasing bandwidth when determining whether
to trigger updated bandwidth values to be flooded
in the IGP TE extensions.";
}
enum separate-up-down {
description
"separate-up-down indicates that a separate
threshold values should be used for the increasing
and decreasing bandwidth when determining whether
to trigger updated bandwidth values to be flooded
in the IGP TE extensions.";
}
}
description
"This value specifies whether a single set of threshold
values should be used for both increasing and decreasing
bandwidth when determining whether to trigger updated
bandwidth values to be flooded in the IGP TE extensions.
'mirrored-up-down' indicates that a single value (or set of
values) should be used for both increasing and decreasing
values, where 'separate-up-down' specifies that the
increasing and decreasing values will be separately
specified.";
}
leaf-list up-thresholds {
when "../threshold-type = 'threshold-crossed'"
+ "and ../threshold-specification = 'separate-up-down'" {
description
"A list of up-thresholds can only be specified when the
bandwidth update is triggered based on crossing a
threshold and separate up and down thresholds are
required.";
}
type rt-types:percentage;
description
"The thresholds (expressed as a percentage of the maximum
reservable bandwidth) at which bandwidth updates are to be
triggered when the bandwidth is increasing.";
}
leaf-list down-thresholds {
when "../threshold-type = 'threshold-crossed'"
+ "and ../threshold-specification = 'separate-up-down'" {
description
"A list of down-thresholds can only be specified when the
bandwidth update is triggered based on crossing a
threshold and separate up and down thresholds are
required.";
}
type rt-types:percentage;
description
"The thresholds (expressed as a percentage of the maximum
reservable bandwidth) at which bandwidth updates are to be
triggered when the bandwidth is decreasing.";
}
leaf-list up-down-thresholds {
when "../threshold-type = 'threshold-crossed'"
+ "and ../threshold-specification = 'mirrored-up-down'" {
description
"A list of thresholds corresponding to both increasing
and decreasing bandwidths can be specified only when an
update is triggered based on crossing a threshold, and
the same up and down thresholds are required.";
}
type rt-types:percentage;
description
"The thresholds (expressed as a percentage of the maximum
reservable bandwidth of the interface) at which bandwidth
updates are flooded -- used both when the bandwidth is
increasing and decreasing.";
}
}
/**
* TE device augmentations
*/
augment "/te:te" {
description
"TE global container.";
/* TE Interface Configuration Data */
container interfaces {
description
"Configuration data model for TE interfaces.";
uses te-igp-flooding-bandwidth-config;
list interface {
key "name";
description
"The list of interfaces enabled for TE.";
leaf name {
type if:interface-ref;
description
"The reference to interface enabled for TE.";
}
/* TE interface parameters */
leaf te-metric {
type te-types:te-metric;
description
"TE interface metric.";
}
choice admin-group-type {
description
"TE interface administrative groups
representation type.";
case value-admin-groups {
choice value-admin-group-type {
description
"The type of admin-groups.";
case admin-groups {
description
"Administrative group/Resource
class.";
leaf admin-group {
type te-types:admin-group;
description
"TE interface administrative group.";
}
}
case extended-admin-groups {
if-feature "te-types:extended-admin-groups";
description
"Extended administrative group/Resource
class.";
leaf extended-admin-group {
type te-types:extended-admin-group;
description
"TE interface extended administrative group.";
}
}
}
}
case named-admin-groups {
list named-admin-groups {
if-feature "te-types:extended-admin-groups";
if-feature "te-types:named-extended-admin-groups";
key "named-admin-group";
description
"A list of named admin-group entries.";
leaf named-admin-group {
type leafref {
path "../../../../te:globals/"
+ "te:named-admin-groups/te:named-admin-group/"
+ "te:name";
}
description
"A named admin-group entry.";
}
}
}
}
choice srlg-type {
description
"Choice of SRLG configuration.";
case value-srlgs {
list values {
key "value";
description
"List of SRLG values that
this link is part of.";
leaf value {
type uint32 {
range "0..4294967295";
}
description
"Value of the SRLG.";
}
}
}
case named-srlgs {
list named-srlgs {
if-feature "te-types:named-srlg-groups";
key "named-srlg";
description
"A list of named SRLG entries.";
leaf named-srlg {
type leafref {
path "../../../../te:globals/"
+ "te:named-srlgs/te:named-srlg/te:name";
}
description
"A named SRLG entry.";
}
}
}
}
uses te-igp-flooding-bandwidth-config;
list switching-capabilities {
key "switching-capability";
description
"List of interface capabilities for this interface.";
leaf switching-capability {
type identityref {
base te-types:switching-capabilities;
}
description
"Switching Capability for this interface.";
}
leaf encoding {
type identityref {
base te-types:lsp-encoding-types;
}
description
"Encoding supported by this interface.";
}
}
container te-advertisements-state {
config false;
description
"TE interface advertisements state container.";
leaf flood-interval {
type uint32;
description
"The periodic flooding interval.";
}
leaf last-flooded-time {
type uint32;
units "seconds";
description
"Time elapsed since last flooding in seconds.";
}
leaf next-flooded-time {
type uint32;
units "seconds";
description
"Time remained for next flooding in seconds.";
}
leaf last-flooded-trigger {
type enumeration {
enum link-up {
description
"Link-up flooding trigger.";
}
enum link-down {
description
"Link-down flooding trigger.";
}
enum threshold-up {
description
"Bandwidth reservation up threshold.";
}
enum threshold-down {
description
"Bandwidth reservation down threshold.";
}
enum bandwidth-change {
description
"Bandwidth capacity change.";
}
enum user-initiated {
description
"Initiated by user.";
}
enum srlg-change {
description
"SRLG property change.";
}
enum periodic-timer {
description
"Periodic timer expired.";
}
}
default "periodic-timer";
description
"Trigger for the last flood.";
}
list advertised-level-areas {
key "level-area";
description
"List of level-areas that the TE interface is
advertised in.";
leaf level-area {
type uint32;
description
"The IGP area or level where the TE interface link
state is advertised in.";
}
}
}
}
}
}
/* TE globals device augmentation */
augment "/te:te/te:globals" {
description
"Global TE device specific configuration parameters.";
uses lsp-device-timers;
}
/* TE tunnels device configuration augmentation */
augment "/te:te/te:tunnels/te:tunnel" {
description
"Tunnel device dependent augmentation.";
leaf path-invalidation-action {
type identityref {
base te-types:path-invalidation-action-type;
}
description
"Tunnel path invalidation action.";
}
uses lsp-device-timers;
}
/* TE LSPs device state augmentation */
augment "/te:te/te:lsps/te:lsp" {
description
"TE LSP device dependent augmentation.";
container lsp-timers {
when "../te:origin-type = 'ingress'" {
description
"Applicable to ingress LSPs only.";
}
description
"Ingress LSP timers.";
leaf uptime {
type uint32;
units "seconds";
description
"The LSP uptime.";
}
leaf time-to-install {
type uint32;
units "seconds";
description
"The time remaining for a new LSP to be instantiated
in forwarding to carry traffic.";
}
leaf time-to-destroy {
type uint32;
units "seconds";
description
"The time remaining for an existing LSP to be torn down.";
}
}
container downstream-info {
when "../te:origin-type != 'egress'" {
description
"Downstream information of the LSP.";
}
description
"Downstream information.";
leaf nhop {
type te-types:te-tp-id;
description
"Downstream next-hop address.";
}
leaf outgoing-interface {
type if:interface-ref;
description
"Downstream interface.";
}
container neighbor {
uses te-types:te-generic-node-id;
description
"Downstream neighbor address.";
}
leaf label {
type rt-types:generalized-label;
description
"Downstream label.";
}
}
container upstream-info {
when "../te:origin-type != 'ingress'" {
description
"Upstream information of the LSP.";
}
description
"Upstream information.";
leaf phop {
type te-types:te-tp-id;
description
"Upstream next-hop or previous-hop address.";
}
container neighbor {
uses te-types:te-generic-node-id;
description
"Upstream neighbor address.";
}
leaf label {
type rt-types:generalized-label;
description
"Upstream label.";
}
}
}
/* TE interfaces RPCs/execution Data */
rpc link-state-update {
description
"Triggers a link state update for the specific interface.";
input {
choice filter-type {
mandatory true;
description
"Filter choice.";
case match-all {
leaf all {
type empty;
mandatory true;
description
"Match all TE interfaces.";
}
}
case match-one-interface {
leaf interface {
type if:interface-ref;
description
"Match a specific TE interface.";
}
}
}
}
}
}
<CODE ENDS>¶
Notifications are a key component of any topology data model.¶
[RFC8639] and [RFC8641] define a subscription mechanism and a push mechanism for YANG datastores. These mechanisms currently allow the user to:¶
This document registers the following URIs in the IETF XML registry [RFC3688]. Following the format in [RFC3688], the following registrations have been made.¶
IANA has registered two YANG modules in the "YANG Module Names" registry [RFC6020].¶
The "ietf-te" and "ietf-te-device" YANG modules define a data model that is designed to be accessed via YANG-based management protocols, such as the Network Configuration Protocol (NETCONF) [RFC6241] and RESTCONF [RFC8040]. These YANG-based management protocols (1) have to use a secure transport layer (e.g., Secure Shell (SSH) [RFC6242], TLS [RFC9846], and QUIC [RFC9000]) and (2) have to use mutual authentication.¶
The Network Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.¶
There are a number of data nodes defined in these YANG modules that are writable/creatable/deletable (i.e., "config true", which is the default). All writable data nodes are likely to be sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) and delete operations to these data nodes without proper protection or authentication can have a negative effect on network operations. The following subtrees and data nodes have particular sensitivities/vulnerabilities:¶
Some of the readable data nodes in these YANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. Specifically, the following subtrees and data nodes have particular sensitivities/vulnerabilities:¶
Some of the RPC or action operations in these YANG modules may be considered sensitive or vulnerable in some network environments. It is thus important to control access to these operations. Specifically, the following operations have particular sensitivities/ vulnerabilities:¶
The "ietf-te" YANG module defines a set of identities, types, and groupings. These nodes are intended to be reused by other YANG modules. The module by itself does not expose any data nodes that are writable, data nodes that contain read-only state, or RPCs. As such, there are no additional security issues related to the "ietf-te" YANG module that need to be considered.¶
Modules that use the groupings that are defined in this document should identify the corresponding security considerations. For example, reusing some of these groupings will expose privacy-related information (e.g., 'node-example').¶
This section provides examples demonstrating the use of the model with RESTCONF [RFC8040] and JSON encoding. The examples are based on a 4-node network topology depicted in Figure 10, where RSVP-TE tunnels can be established. The loopback addresses for each node, which serve as the TE node IDs, are detailed in Table 2.¶
| Node | TE Node ID (IPv4) | TE Node ID (IPv6) |
|---|---|---|
| A | 192.0.2.1 | 2001:db8::1 |
| B | 192.0.2.2 | 2001:db8::2 |
| C | 192.0.2.3 | 2001:db8::3 |
| D | 192.0.2.4 | 2001:db8::4 |
This network topology forms the foundation for the subsequent examples, which illustrate the setup and configuration of RSVP-TE tunnels using the model.¶
2001:db8::1 2001:db8::2 2001:db8::4
192.0.2.1 192.0.2.2 192.0.2.4
+-------+ +-------+ +-------+
| | | | | |
| A +--------+ B +------+ D |
+---+---+ +-------+ +---+---+
| |
| +-------+ |
| | | |
+------------+ C +----------+
| |
+-------+
192.0.2.3
2001:db8::3
This example uses the TE Tunnel YANG data model defined in this document to create an RSVP-TE signaled Tunnel of packet LSP encoding type. First, the TE Tunnel is created with no specific restrictions or constraints (e.g., protection or restoration). The TE Tunnel ingresses on router A and egresses on router D.¶
In this case, the TE Tunnel is created without specifying additional information about the primary paths.¶
POST /restconf/data/ietf-te:te/tunnels HTTP/1.1
Host: example.com
Accept: application/yang-data+json
Content-Type: application/yang-data+json
{
"ietf-te:tunnel": [
{
"name": "Example_LSP_Tunnel_A_2",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"source": {
"te-node-id": "192.0.2.1"
},
"destination": {
"te-node-id": "192.0.2.4"
},
"bidirectional": false,
"signaling-type": "ietf-te-types:path-setup-rsvp"
}
]
}
{
"ietf-te:tunnel": [
{
"name": "Example_LSP_Tunnel_A_2 (IPv6)",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"source": {
"te-node-id": "2001:db8::1"
},
"destination": {
"te-node-id": "2001:db8::4"
},
"bidirectional": false,
"signaling-type": "ietf-te-types:path-setup-rsvp"
}
]
}¶
This example uses the YANG data model to create a 'named path constraint' that can be referenced by TE Tunnels. The path constraint, in this case, limits the TE Tunnel hops for the computed path.¶
POST /restconf/data/ietf-te:te/globals/named-path-constraints
HTTP/1.1
Host: example.com
Accept: application/yang-data+json
Content-Type: application/yang-data+json
{
"ietf-te:named-path-constraint": [
{
"name": "max-hop-3",
"path-metric-bounds": {
"path-metric-bound": [
{
"metric-type": "ietf-te-types:path-metric-hop",
"upper-bound": "3"
}
]
}
}
]
}¶
In this example, the previously created 'named path constraint' is applied to the TE Tunnel created in Appendix A.1.¶
POST /restconf/data/ietf-te:te/tunnels HTTP/1.1
Host: example.com
Accept: application/yang-data+json
Content-Type: application/yang-data+json
{
"ietf-te:tunnel": [
{
"name": "Example_LSP_Tunnel_A_4_1",
"description": "Simple_LSP_with_named_path",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"source": {
"te-node-id": "192.0.2.1"
},
"destination": {
"te-node-id": "192.0.2.4"
},
"signaling-type": "ietf-te-types:path-setup-rsvp",
"primary-paths": {
"primary-path": [
{
"name": "Simple_LSP_1",
"use-path-computation": true,
"path-scope": "ietf-te-types:path-scope-end-to-end",
"named-path-constraint": "max-hop-3"
}
]
}
}
]
}¶
In this example, the per-tunnel path constraint is explicitly indicated under the TE Tunnel created in Appendix A.1 to constrain the computed path for the tunnel.¶
POST /restconf/data/ietf-te:te/tunnels HTTP/1.1
Host: example.com
Accept: application/yang-data+json
Content-Type: application/yang-data+json
{
"ietf-te:tunnel": [
{
"name": "Example_LSP_Tunnel_A_4_2",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"source": {
"te-node-id": "192.0.2.1"
},
"destination": {
"te-node-id": "192.0.2.4"
},
"bidirectional": false,
"signaling-type": "ietf-te-types:path-setup-rsvp",
"primary-paths": {
"primary-path": [
{
"name": "path1",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"path-metric-bounds": {
"path-metric-bound": [
{
"metric-type": "ietf-te-types:path-metric-hop",
"upper-bound": "3"
}
]
}
}
]
}
}
]
}¶
In this example, the 'GET' query is sent to return the state stored about the tunnel.¶
GET /restconf/data/ietf-te:te/tunnels +
/tunnel="Example_LSP_Tunnel_A_4_1"
/primary-paths/ HTTP/1.1
Host: example.com
Accept: application/yang-data+json¶
The request, with status code 200 would include, for example, the following json:¶
{
"ietf-te:primary-path": [
{
"name": "path1",
"path-computation-method":
"ietf-te-types:path-locally-computed",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"computed-paths-properties": {
"computed-path-properties": [
{
"k-index": 1,
"path-properties": {
"path-route-objects": {
"path-route-object": [
{
"index": 1,
"numbered-node-hop": {
"node-id": "192.0.2.2",
"hop-type": "strict"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.4",
"hop-type": "strict"
}
}
]
}
}
}
]
},
"lsps": {
"lsp": [
{
"node": "192.0.2.1",
"lsp-id": 25356,
"tunnel-name": "Example_LSP_Tunnel_A_4_1"
}
]
}
}
]
}¶
The example in this section uses the network topology depicted in Figure 11. The loopback addresses for each node, which serve as the TE node IDs, are detailed in Table 3.¶
| Node | TE Node ID (IPv4) | TE Node ID (IPv6) |
|---|---|---|
| A | 192.0.2.1 | 2001:db8::1 |
| B | 192.0.2.2 | 2001:db8::2 |
| C | 192.0.2.3 | 2001:db8::3 |
| D | 192.0.2.4 | 2001:db8::4 |
| E | 192.0.2.5 | 2001:db8::5 |
| F | 192.0.2.6 | 2001:db8::6 |
| G | 192.0.2.7 | 2001:db8::7 |
| H | 192.0.2.8 | 2001:db8::8 |
| I | 192.0.2.9 | 2001:db8::9 |
| J | 192.0.2.10 | 2001:db8::a |
+----------+ +----------+
+-|192.0.2.9 |---+ |192.0.2.10|
| +----------+ | +----------+
| | | |
+----------+ +----------+ +----------+ | |
|192.0.2.8 |----|192.0.2.3 |-----|192.0.2.4 |----+ |
+----------+ +----------+ +----------+ |
| | | |
+----------+ | | |
|192.0.2.1 |---------+ | +----------+
+----------+ +-----------|192.0.2.5 |
| | +----------+
| | +----------+ | |
| +--------------|192.0.2.2 |---------------------+ |
| +----------+ |
| | | |
+----------+ | | +----------+
|192.0.2.6 |----------------+ +-------------------|192.0.2.7 |
+----------+ +----------+
Below is the state retrieved for a TE tunnel that is set up from ingress node A (192.0.2.1) to egress node E (192.0.2.5) with primary, secondary, reverse, and secondary reverse paths as shown in Figure 11.¶
{
"ietf-te:te": {
"tunnels": {
"tunnel": [
{
"name": "example-1",
"description": "Example in slide 1",
"source": {
"te-node-id": "192.0.2.1"
},
"destination": {
"te-node-id": "192.0.2.5"
},
"bidirectional": true,
"primary-paths": {
"primary-path": [
{
"name": "primary-1 (fwd)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"co-routed": false,
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.2",
"hop-type": "loose"
}
}
]
},
"primary-reverse-path": {
"name": "primary-2 (rev)",
"path-scope":
"ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.3",
"hop-type": "loose"
}
}
]
},
"candidate-secondary-reverse-paths": {
"candidate-secondary-reverse-path": [
{
"secondary-reverse-path": "secondary-3 (rev)"
},
{
"secondary-reverse-path": "secondary-4 (rev)"
},
{
"secondary-reverse-path": "secondary-5 (rev)"
}
]
}
},
"candidate-secondary-paths": {
"candidate-secondary-path": [
{
"secondary-path": "secondary-1 (fwd)"
},
{
"secondary-path": "secondary-2 (fwd)"
}
]
}
}
]
},
"secondary-paths": {
"secondary-path": [
{
"name": "secondary-1 (fwd)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.1"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.2",
"hop-type": "loose"
}
}
]
}
},
{
"name": "secondary-2 (fwd)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.2"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.5",
"hop-type": "loose"
}
}
]
}
}
]
},
"secondary-reverse-paths": {
"secondary-reverse-path": [
{
"name": "secondary-3 (rev)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.5"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.4",
"hop-type": "loose"
}
}
]
}
},
{
"name": "secondary-4 (rev)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.4"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.3",
"hop-type": "loose"
}
}
]
}
},
{
"name": "secondary-5 (rev)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.3"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.1",
"hop-type": "loose"
}
}
]
}
}
]
}
},
{
"name": "example-3",
"description": "Example in slide 3",
"source": {
"te-node-id": "192.0.2.1"
},
"destination": {
"te-node-id": "192.0.2.5"
},
"bidirectional": true,
"primary-paths": {
"primary-path": [
{
"name": "primary-1 (bidir)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"co-routed": true,
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.2",
"hop-type": "loose"
}
}
]
},
"primary-reverse-path": {
"path-scope": "ietf-te-types:path-scope-end-to-end"
},
"candidate-secondary-paths": {
"candidate-secondary-path": [
{
"secondary-path": "secondary-1 (bidir)"
},
{
"secondary-path": "secondary-2 (bidir)"
}
]
}
}
]
},
"secondary-paths": {
"secondary-path": [
{
"name": "secondary-1 (bidir)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.1"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.2",
"hop-type": "loose"
}
}
]
}
},
{
"name": "secondary-2 (bidir)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.2"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.5",
"hop-type": "loose"
}
}
]
}
}
]
}
},
{
"name": "example-4",
"description": "Example in slide 4",
"source": {
"te-node-id": "192.0.2.1"
},
"destination": {
"te-node-id": "192.0.2.5"
},
"bidirectional": true,
"primary-paths": {
"primary-path": [
{
"name": "primary-1 (fwd)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"co-routed": true,
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.2",
"hop-type": "loose"
}
}
]
},
"primary-reverse-path": {
"name": "primary-2 (rev)",
"path-scope":
"ietf-te-types:path-scope-end-to-end",
"candidate-secondary-reverse-paths": {
"candidate-secondary-reverse-path": [
{
"secondary-reverse-path": "secondary-3 (rev)"
},
{
"secondary-reverse-path": "secondary-4 (rev)"
}
]
}
},
"candidate-secondary-paths": {
"candidate-secondary-path": [
{
"secondary-path": "secondary-1 (fwd)"
},
{
"secondary-path": "secondary-2 (fwd)"
}
]
}
}
]
},
"secondary-paths": {
"secondary-path": [
{
"name": "secondary-1 (fwd)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.1"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.2",
"hop-type": "loose"
}
}
]
}
},
{
"name": "secondary-2 (fwd)",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-node-hop": {
"node-id": "192.0.2.2"
}
},
{
"index": 2,
"numbered-node-hop": {
"node-id": "192.0.2.5",
"hop-type": "loose"
}
}
]
}
}
]
},
"secondary-reverse-paths": {
"secondary-reverse-path": [
{
"name": "secondary-3 (rev)",
"path-scope": "ietf-te-types:path-scope-end-to-end"
},
{
"name": "secondary-4 (rev)",
"path-scope": "ietf-te-types:path-scope-end-to-end"
}
]
}
}
]
}
}
}¶
XXXXXXX
XXX XXX
XX XX
X X
X Domain 2 X
XXXXXXX X X XXXXXXXX
XXX +-----------+ +-----------+ XXX
XX | 192.0.2.1 | | 192.0.2.2 | XX
X +-----------+ +-----------+ X
X X XXXXXX X X
+-----------+ X X +-----------+
|192.0.2.100| Domain 1 X X Domain 3 |192.0.2.200|
+-----------+ X XXXXXX X +-----------+
X +-----------+ +-----------+ X
X | 192.0.2.3 | | 192.0.2.4 | X
XX +-----------+ +-----------+ XX
XXX X X XXX XXX
XXXXXXX X X XXXXXXX
X X
X Domain 4 X
XX XX
XXX XXX
XXXXXXX
The following state is retrieved for a multi-domain TE tunnel, where both the primary and secondary paths consist of TE tunnel segments, as shown in Figure 12. In each domain, a TE tunnel segment is established to form the complete end-to-end TE path. The nodes (192.0.2.100) and (192.0.2.200) form the multi-domain end-to-end source and destination respectively. The nodes (192.0.2.1), (192.0.2.2), (192.0.2.3), and (192.0.2.4) act as domain border nodes and transit nodes for the end-to-end TE tunnel LSPs.¶
{
"ietf-te:te": {
"tunnels": {
"tunnel": [
{
"name": "Example_Head_End_Tunnel_Segment",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"source": {
"te-node-id": "192.0.2.100"
},
"bidirectional": true,
"signaling-type": "ietf-te-types:path-setup-rsvp",
"primary-paths": {
"primary-path": [
{
"name": "primary-path-1",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"co-routed": true,
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.1"
}
}
]
},
"primary-reverse-path": {
"path-scope": "ietf-te-types:path-scope-end-to-end"
},
"candidate-secondary-paths": {
"candidate-secondary-path": [
{
"secondary-path": "secondary-path-1"
}
]
}
}
]
},
"secondary-paths": {
"secondary-path": [
{
"name": "secondary-path-1",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.3"
}
}
]
}
}
]
}
},
{
"name": "Example_Primary_Transit_Tunnel_Segment",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"bidirectional": true,
"signaling-type": "ietf-te-types:path-setup-rsvp",
"primary-paths": {
"primary-path": [
{
"name": "primary-path-2",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"co-routed": true,
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.1"
}
},
{
"index": 2,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.2"
}
}
]
},
"primary-reverse-path": {
"path-scope": "ietf-te-types:path-scope-end-to-end"
}
}
]
}
},
{
"name": "Example_Secondary_Transit_Tunnel_Segment",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"bidirectional": true,
"signaling-type": "ietf-te-types:path-setup-rsvp",
"primary-paths": {
"primary-path": [
{
"name": "primary-path-4",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"co-routed": true,
"primary-reverse-path": {
"path-scope": "ietf-te-types:path-scope-end-to-end"
},
"candidate-secondary-paths": {
"candidate-secondary-path": [
{
"secondary-path": "secondary-path-4"
}
]
}
}
]
},
"secondary-paths": {
"secondary-path": [
{
"name": "secondary-path-4",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.3"
}
},
{
"index": 2,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.4"
}
}
]
}
}
]
}
},
{
"name": "Example_Tail_End_Tunnel_Segment",
"admin-state": "ietf-te-types:tunnel-admin-state-up",
"encoding": "ietf-te-types:lsp-encoding-packet",
"destination": {
"te-node-id": "192.0.2.200"
},
"bidirectional": true,
"signaling-type": "ietf-te-types:path-setup-rsvp",
"primary-paths": {
"primary-path": [
{
"name": "primary-path-3",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"co-routed": true,
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.2"
}
}
]
},
"primary-reverse-path": {
"path-scope": "ietf-te-types:path-scope-end-to-end"
},
"candidate-secondary-paths": {
"candidate-secondary-path": [
{
"secondary-path": "secondary-path-3"
}
]
}
}
]
},
"secondary-paths": {
"secondary-path": [
{
"name": "secondary-path-3",
"path-scope": "ietf-te-types:path-scope-end-to-end",
"explicit-route-objects": {
"route-object-include-exclude": [
{
"index": 1,
"explicit-route-usage":
"ietf-te-types:route-include-object",
"numbered-link-hop": {
"link-tp-id": "192.0.2.4"
}
}
]
}
}
]
}
}
]
}
}
}¶
The full tree diagram of the TE YANG data model defined in module "ietf-te" is shown below.¶
module: ietf-te
+--rw te
+--rw enable? boolean
+--rw globals
| +--rw named-admin-groups
| | +--rw named-admin-group* [name]
| | {te-types:extended-admin-groups,
| | te-types:named-extended-admin-groups}?
| | +--rw name string
| | +--rw bit-position? uint32
| +--rw named-srlgs
| | +--rw named-srlg* [name] {te-types:named-srlg-groups}?
| | +--rw name string
| | +--rw value? te-types:srlg
| | +--rw cost? uint32
| +--rw named-path-constraints
| +--rw named-path-constraint* [name]
| {te-types:named-path-constraints}?
| +--rw name string
| +---u path-constraints-common
+--rw tunnels
| +--rw tunnel* [name]
| +--rw name string
| +--rw alias? string
| +--rw identifier? uint32
| +--rw color? uint32
| +--rw description? string
| +--rw admin-state? identityref
| +--ro operational-state? identityref
| +--rw state-change-timestamp?
| | yang:date-and-time
| +---u te-types:encoding-and-switching-type
| +---u tunnel-common-attributes
| +--rw controller
| | +--rw protocol-origin? identityref
| | +--rw controller-entity-id? string
| +--rw reoptimize-timer? uint16
| +---u tunnel-associations-properties
| +---u protection-restoration-properties
| +---u te-types:tunnel-constraints
| +---u tunnel-hierarchy-properties
| +--rw primary-paths
| | +--rw primary-path* [name]
| | +--ro active? boolean
| | +---u path-common-properties
| | +---u path-forward-properties
| | +---u k-requested-paths
| | +---u path-compute-info
| | +---u path-state
| | +--rw primary-reverse-path
| | | +---u path-common-properties
| | | +---u path-compute-info
| | | +---u path-state
| | | +--rw candidate-secondary-reverse-paths
| | | +--rw candidate-secondary-reverse-path*
| | | [secondary-reverse-path]
| | | +--rw secondary-reverse-path leafref
| | | +--ro active? boolean
| | +--rw candidate-secondary-paths
| | +--rw candidate-secondary-path* [secondary-path]
| | +--rw secondary-path leafref
| | +--ro active? boolean
| +--rw secondary-paths
| | +--rw secondary-path* [name]
| | +---u path-common-properties
| | +--rw preference? uint8
| | +--rw secondary-reverse-path? leafref
| | +---u path-compute-info
| | +---u protection-restoration-properties
| | +---u path-state
| +--rw secondary-reverse-paths
| | +--rw secondary-reverse-path* [name]
| | +---u path-common-properties
| | +--rw preference? uint8
| | +---u path-compute-info
| | +---u protection-restoration-properties
| | +---u path-state
| +---x tunnel-action
| | +---w input
| | | +---w action-type? identityref
| | +--ro output
| | +--ro action-result? identityref
| +---x protection-external-commands
| +---w input
| +---w protection-external-command? identityref
| +---w ingress-node? boolean
| +---w egress-node? boolean
| +---w path-name? string
| +---w path-type?
| | te-types:path-type
| +---w traffic-type? enumeration
| +---w extra-traffic-tunnel-ref? tunnel-ref
+--ro lsps
+--ro lsp* [tunnel-name lsp-id node]
+--ro tunnel-name string
+--ro lsp-id uint16
+--ro node te-types:te-node-id
+--ro source? te-types:te-node-id
+--ro destination? te-types:te-node-id
+--ro tunnel-id? uint16
+--ro extended-tunnel-id? yang:dotted-quad
+--ro operational-state? identityref
+--ro signaling-type? identityref
+--ro origin-type? enumeration
+--ro lsp-resource-status? enumeration
+--ro lockout-of-normal? boolean
+--ro freeze? boolean
+--ro lsp-protection-role? enumeration
+--ro lsp-protection-state? identityref
+--ro ingress-node-id? te-types:te-node-id
+--ro egress-node-id? te-types:te-node-id
+--ro lsp-actual-route-information
+--ro lsp-actual-route-information* [index]
+---u te-types:record-route-state
rpcs:
+---x tunnels-path-compute
| +---w input
| | +---w path-compute-info
| +--ro output
| +--ro path-compute-result
+---x tunnels-actions
+---w input
| +---w tunnel-info
| | +---w (filter-type)
| | +--:(all-tunnels)
| | | +---w all empty
| | +--:(one-tunnel)
| | +---w tunnel? tunnel-ref
| +---w action-info
| +---w action? identityref
| +---w disruptive? empty
+--ro output
+--ro action-result? identityref
grouping path-common-properties:
+-- name? string
+-- path-computation-method? identityref
+-- path-computation-server
| +---u te-types:te-generic-node-id
+-- compute-only? empty
+-- use-path-computation? boolean
+-- lockdown? empty
+--ro path-scope? identityref
grouping path-compute-info:
+---u tunnel-associations-properties
+---u te-types:generic-path-optimization
+-- named-path-constraint? leafref
| {te-types:named-path-constraints}?
+---u path-constraints-common
grouping path-forward-properties:
+-- preference? uint8
+-- co-routed? boolean
grouping k-requested-paths:
+-- k-requested-paths? uint8
grouping path-state:
+---u path-computation-response
+--ro lsp-provisioning-error-infos
| +--ro lsp-provisioning-error-info* []
| +--ro error-reason? identityref
| +--ro error-description? string
| +--ro error-timestamp? yang:date-and-time
| +--ro error-node-id? te-types:te-node-id
| +--ro error-link-id? te-types:te-tp-id
| +--ro lsp-id? uint16
+--ro lsps
+--ro lsp* [node lsp-id]
+--ro tunnel-name? -> /te/lsps/lsp/tunnel-name
+--ro node? leafref
+--ro lsp-id? leafref
+--ro state-change-timestamp? yang:date-and-time
grouping path-computation-response:
+--ro computed-paths-properties
| +--ro computed-path-properties* [k-index]
| +--ro k-index? uint8
| +---u te-types:generic-path-properties
+--ro computed-path-error-infos
+--ro computed-path-error-info* []
+--ro error-description? string
+--ro error-timestamp? yang:date-and-time
+--ro error-reason? identityref
grouping protection-restoration-properties:
+-- protection
| +-- protection-type? identityref
| +-- protection-reversion-disable? boolean
| +-- hold-off-time? uint32
| +-- wait-to-revert? uint16
| +-- aps-signal-id? uint8
+-- restoration
+-- restoration-type? identityref
+-- restoration-scheme? identityref
+-- restoration-reversion-disable? boolean
+-- hold-off-time? uint32
+-- wait-to-restore? uint16
+-- wait-to-revert? uint16
grouping tunnel-associations-properties:
+-- association-objects
+-- association-object* [association-key]
| +-- association-key? string
| +-- type? identityref
| +-- id? uint16
| +-- source
| +---u te-types:te-generic-node-id
+-- association-object-extended* [association-key]
+-- association-key? string
+-- type? identityref
+-- id? uint16
+-- source
| +---u te-types:te-generic-node-id
+-- global-source? uint32
+-- extended-id? yang:hex-string
grouping tunnel-end-point:
+-- node-id? nw:node-id
+-- te-node-id? te-types:te-node-id
+-- tunnel-tp-id? binary
grouping tunnel-common-attributes:
+-- source
| +---u tunnel-end-point
+-- destination
| +---u tunnel-end-point
+-- bidirectional? boolean
grouping tunnel-hierarchy-properties:
+-- hierarchy
+-- dependency-tunnels
| +-- dependency-tunnel* [name]
| +-- name? tunnel-ref
| +---u te-types:encoding-and-switching-type
+-- hierarchical-link
+-- enable? boolean
+-- local-node-id? nw:node-id
+-- local-te-node-id? te-types:te-node-id
+-- local-link-tp-id? nt:tp-id
+-- local-te-link-tp-id? te-types:te-tp-id
+-- remote-node-id? nw:node-id
+-- remote-link-tp-id? nt:tp-id
+-- remote-te-link-tp-id? te-types:te-tp-id
+-- remote-te-node-id? te-types:te-node-id
+--ro link-id? nt:link-id
+-- network-id? nw:network-id
+---u te-types:te-topology-identifier
grouping path-constraints-common:
+---u te-types:common-path-constraints-attributes
+---u te-types:generic-path-disjointness
+---u te-types:path-constraints-route-objects
+-- path-in-segment!
| +---u te-types:label-set-info
+-- path-out-segment!
+---u te-types:label-set-info¶
The authors would like to thank the members of the multivendor YANG design team who are involved in the definition of this model.¶
The authors would like to thank Tom Petch and Adrian Farrel for reviewing and providing useful feedback about the document. The authors would also like to thank Loa Andersson, Lou Berger, Sergio Belotti, Italo Busi, Carlo Perocchio, Francesco Lazzeri, Aihua Guo, Dhruv Dhody, and Raqib Jones for providing feedback on this document.¶