]> A YANG Data Model for MPLS Traffic Engineering Tunnels Cisco Systems Inc
tsaad@cisco.com
Cisco Systems Inc
rgandhi@cisco.com
IBM Corporation
xufeng.liu.ietf@gmail.com
Juniper Networks
vbeeram@juniper.net
Individual
i_bryskin@yahoo.com
TEAS Working Group Internet-Draft This document defines a YANG data model for the configuration and management of Multiprotocol Label Switching (MPLS) Traffic Engineering (TE) tunnels, Label Switched Paths (LSPs) and interfaces. The model augments the TE generic YANG model for MPLS packet dataplane technology. This model covers data for configuration, operational state, remote procedural calls, and event notifications.
Introduction YANG and is a data modeling language used to define the contents of a conceptual data store that allows networked devices to be managed using NETCONF . YANG has proved relevant beyond its initial confines, as bindings to other interfaces (e.g. RESTCONF ) and encoding other than XML (e.g. JSON) are being defined. Furthermore, YANG data models can be used as the basis of implementation for other interfaces, such as CLI and programmatic APIs. This document describes the YANG data model for configuration and management of MPLS TE tunnels, LSPs, and interfaces. Other YANG module(s) that model the establishment of MPLS LSP(s) via signaling protocols such as RSVP-TE (, ) are described in separate document(s).
Terminology The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. The terminology for describing YANG data models is found in .
Prefixes in Data Node Names 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 inet ietf-inet-types rt-types ietf-routing-types te ietf-te te-mpls ietf-te-mpls This document te-types ietf-te-types
Acronyms and Abbreviations
  • MPLS: Multiprotocol Label Switching LSP: Label Switched Path LSR: Label Switching Router LER: Label Edge Router TE: Traffic Engineering
MPLS TE YANG Model The MPLS TE YANG model covers the configuration, state, RPC and notifications data pertaining to MPLS TE interfaces, tunnels and LSPs parameters. The data specific to the signaling protocol used to establish MPLS LSP(s) is outside the scope of this document and is covered in other documents.
Module(s) Relationship The MPLS TE YANG module "ietf-te-mpls" imports the following modules: ietf-te defined in ietf-te-types and ietf-te-packet-types defined in ietf-routing-types defined in ietf-mpls-static defined in This module references the following documents: , , , and .
The MPLS TE YANG module "ietf-te-mpls" augments the "ietf-te" TE generic YANG module as shown in .
Model Tree Diagram shows the tree diagram of the MPLS TE YANG model that is defined in ietf-te-mpls.yang.
MPLS TE YANG Module
file "ietf-te-mpls@2023-05-25.yang" module ietf-te-mpls { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-te-mpls"; /* Replace with IANA when assigned */ prefix "te-mpls"; /* Import TE base model */ import ietf-te { prefix te; reference "draft-ietf-teas-yang-te: A YANG Data Model for Traffic Engineering Tunnels and Interfaces"; } /* Import TE MPLS types */ import ietf-te-packet-types { prefix "te-packet-types"; reference "RFC8776: A YANG Data Model for Common Traffic Engineering Types"; } /* Import TE generic types */ import ietf-te-types { prefix te-types; reference "RFC8776: A YANG Data Model for Common Traffic Engineering Types"; } /* Import routing types */ import ietf-routing-types { prefix rt-types; reference "RFC8294: Common YANG Data Types for the Routing Area"; } import ietf-mpls-static { prefix mpls-static; reference "draft-ietf-mpls-static-yang: A YANG Data Model for MPLS Static LSPs"; } import ietf-inet-types { prefix inet; reference "RFC6991: Common YANG Data Types"; } organization "IETF Traffic Engineering Architecture and Signaling (TEAS) Working Group"; contact "WG Web: WG List: Editor: Tarek Saad Editor: Rakesh Gandhi Editor: Vishnu Pavan Beeram Editor: Xufeng Liu Editor: Igor Bryskin "; description "YANG data module for MPLS TE configurations, state, RPC and notifications. The model fully conforms to the Network Management Datastore Architecture (NMDA). Copyright (c) 2018 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 Simplified 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 XXXX; see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: update the date below with the date of RFC publication // and remove this note. revision "2023-05-25" { description "Latest update to MPLS TE YANG module."; reference "RFCXXXX: A YANG Data Model for MPLS-TE Tunnels and LSP(s)"; } /* MPLS TE Identities */ identity tunnel-action-resetup { base te-types:tunnel-action-type; description "Resetup tunnel action type"; } identity path-metric-loss { base te-types:path-metric-type; description "The path loss metric type (as a packet percentage) that encodes a function of the unidirectional loss metrics of all links traversed by a P2P path. The basic unit is 0.000003%, where (2^24 - 2) or 50.331642% is the highest packet-loss percentage that can be expressed."; reference "RFC8233, RFC4710, and RFC8570"; } /* MPLS TE tunnel properties*/ grouping tunnel-igp-shortcut-config { description "TE tunnel IGP shortcut configs"; leaf shortcut-eligible { type boolean; default "true"; description "Whether this LSP is considered to be eligible for us as a shortcut in the IGP. In the case that this leaf is set to true, the IGP SPF calculation uses the metric specified to determine whether traffic should be carried over this LSP"; } leaf metric-type { type identityref { base te-types:lsp-metric-type; } default te-types:lsp-metric-inherited; description "The type of metric specification that should be used to set the LSP(s) metric"; } leaf metric { type int32; description "The value of the metric that should be specified. The value supplied in this leaf is used in conjunction with the metric type to determine the value of the metric used by the system. Where the metric-type is set to lsp-metric-absolute - the value of this leaf is used directly; where it is set to lsp-metric-relative, the relevant (positive or negative) offset is used to formulate the metric; where metric-type is lsp-metric-inherited, the value of this leaf is not utilized"; } leaf-list routing-afs { type inet:ip-version; description "Address families"; } } grouping tunnel-igp-shortcuts { description "TE tunnel IGP shortcut grouping"; container tunnel-igp-shortcut { description "Tunnel IGP shortcut properties"; uses tunnel-igp-shortcut-config; } } grouping tunnel-forwarding-adjacency-configs { description "Tunnel forwarding adjacency grouping"; leaf binding-label { type rt-types:mpls-label; description "MPLS tunnel binding label"; } leaf load-share { type uint32 { range "1..4294967295"; } description "ECMP tunnel forwarding load-share factor."; } leaf policy-class { type uint8 { range "1..7"; } description "The class associated with this tunnel"; } } grouping tunnel-forwarding-adjacency { description "Properties for using tunnel in forwarding."; container forwarding { description "Tunnel forwarding properties container"; uses tunnel-forwarding-adjacency-configs; } } /*** End of MPLS TE tunnel configuration/state */ grouping te-lsp-auto-bandwidth-config { description "Configuration parameters related to autobandwidth"; leaf enabled { type boolean; default false; description "Enables MPLS auto-bandwidth on the LSP"; } leaf min-bw { type te-packet-types:bandwidth-kbps; description "set the minimum bandwidth in Kbps for an auto-bandwidth LSP"; } leaf max-bw { type te-packet-types:bandwidth-kbps; description "set the maximum bandwidth in Kbps for an auto-bandwidth LSP"; } leaf adjust-interval { type uint32; description "time in seconds between adjustments to LSP bandwidth"; } leaf adjust-threshold { type rt-types:percentage; description "percentage difference between the LSP's specified bandwidth and its current bandwidth allocation -- if the difference is greater than the specified percentage, auto-bandwidth adjustment is triggered"; } } grouping te-lsp-overflow-config { description "configuration for MPLS LSP bandwidth overflow adjustment"; leaf enabled { type boolean; default false; description "Enables MPLS LSP bandwidth overflow adjustment on the LSP"; } leaf overflow-threshold { type rt-types:percentage; description "bandwidth percentage change to trigger an overflow event"; } leaf trigger-event-count { type uint16; description "number of consecutive overflow sample events needed to trigger an overflow adjustment"; } } grouping te-lsp-underflow-config { description "configuration for MPLS LSP bandwidth underflow adjustment"; leaf enabled { type boolean; default false; description "enables bandwidth underflow adjustment on the LSP"; } leaf underflow-threshold { type rt-types:percentage; description "bandwidth percentage change to trigger and underflow event"; } leaf trigger-event-count { type uint16; description "number of consecutive underflow sample events needed to trigger an underflow adjustment"; } } grouping te-tunnel-bandwidth-config { description "Configuration parameters related to bandwidth for a tunnel"; leaf specification-type { type te-packet-types:te-bandwidth-requested-type; default specified; description "The method used for setting the bandwidth, either explicitly specified or configured"; } leaf set-bandwidth { when "../specification-type = 'specified'" { description "The bandwidth value when bandwidth is explicitly specified"; } type te-packet-types:bandwidth-kbps; description "set bandwidth explicitly, e.g., using offline calculation"; } leaf class-type { type te-types:te-ds-class; description "The Class-Type of traffic transported by the LSP."; reference "RFC4124: section-4.3.1"; } } grouping te-tunnel-bandwidth-state { description "Operational state parameters relating to bandwidth for a tunnel"; leaf signaled-bandwidth { type te-packet-types:bandwidth-kbps; description "The currently signaled bandwidth of the LSP. In the case where the bandwidth is specified explicitly, then this will match the value of the set-bandwidth leaf; in cases where the bandwidth is dynamically computed by the system, the current value of the bandwidth should be reflected."; } } grouping tunnel-bandwidth_top { description "Top level grouping for specifying bandwidth for a tunnel"; container bandwidth-mpls { description "Bandwidth configuration for TE LSPs"; uses te-tunnel-bandwidth-config; container state { config false; description "State parameters related to bandwidth configuration of TE tunnels"; uses te-tunnel-bandwidth-state; } container auto-bandwidth { when "../specification-type = 'auto'" { description "Include this container for auto bandwidth specific configuration"; } description "Parameters related to auto-bandwidth"; uses te-lsp-auto-bandwidth-config; container overflow { description "configuration of MPLS overflow bandwidth adjustment for the LSP"; uses te-lsp-overflow-config; } container underflow { description "configuration of MPLS underflow bandwidth adjustment for the LSP"; uses te-lsp-underflow-config; } } } } grouping te-path-bandwidth_top { description "Top level grouping for specifying bandwidth for a TE path"; container bandwidth { description "Bandwidth configuration for TE LSPs"; uses te-tunnel-bandwidth-config; container state { config false; description "State parameters related to bandwidth configuration of TE tunnels"; uses te-tunnel-bandwidth-state; } } } /** * MPLS TE augmentations */ augment "/te:te" { container performance-thresholds { uses "te-packet-types:" + "performance-metrics-throttle-container-packet"; description "Performance parameters configurable thresholds"; } description "Performance parameters configurable thresholds"; } /* MPLS TE interface augmentations */ /* MPLS TE tunnel augmentations */ augment "/te:te/te:tunnels/te:tunnel" { description "MPLS TE tunnel config augmentations"; uses tunnel-igp-shortcuts; uses tunnel-forwarding-adjacency; uses tunnel-bandwidth_top; } /* MPLS TE LSPs augmentations */ augment "/te:te/te:tunnels/te:tunnel/" + "te:primary-paths/te:primary-path" { when "/te:te/te:tunnels/te:tunnel" + "/te:primary-paths/te:primary-path" + "/te:signaling-type = 'te-types:path-setup-static'" { description "When the path is statically provisioned"; } description "MPLS TE LSP augmentation"; leaf static-lsp-name { type mpls-static:static-lsp-ref; description "Static LSP name"; } } augment "/te:te/te:tunnels/te:tunnel/" + "te:secondary-paths/te:secondary-path" { when "/te:te/te:tunnels/te:tunnel" + "/te:secondary-paths/te:secondary-path/" + "te:signaling-type = 'te-types:path-setup-static'" { description "When the path is statically provisioned"; } description "MPLS TE LSP augmentation"; leaf static-lsp-name { type mpls-static:static-lsp-ref; description "Static LSP name"; } } augment "/te:te/te:globals/te:named-path-constraints/" + "te:named-path-constraint" { description "foo"; uses te-path-bandwidth_top; } augment "/te:te/te:tunnels/te:tunnel/te:primary-paths" + "/te:primary-path/te:lsps/te:lsp" { description "MPLS TE generic data augmentation pertaining to specific TE LSP"; uses te-packet-types:performance-metrics-attributes-packet; } } ]]>
IANA Considerations This document registers the following URIs in the IETF XML registry . Following the format in , the following registration is requested to be made.
This document registers a YANG module in the YANG Module Names registry .
Security Considerations The YANG module defined in this memo is designed to be accessed via the NETCONF protocol . The lowest NETCONF layer is the secure transport layer and the mandatory-to-implement secure transport is SSH . The NETCONF access control model provides means to restrict access for particular NETCONF users to a pre-configured subset of all available NETCONF protocol operations and content. A number of data nodes defined in this YANG module are writable/creatable/deletable (i.e., config true, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., <edit-config>) to these data nodes without proper protection can have a negative effect on MPLS network operations. Following are the subtrees and data nodes and their sensitivity/vulnerability: "/te/tunnels": The augmentation to this list specifies configuration to TE tunnels on a device. Unauthorized access to this list could cause the device to ignore packets it should receive and process. "/te/globals": The augmentation to this target specifies configuration applicable to the to all or one TE device. Unauthorized access to this list could cause the device to ignore packets it should receive and process.
Contributors
RSVP-TE: Extensions to RSVP for LSP Tunnels This document describes the use of RSVP (Resource Reservation Protocol), including all the necessary extensions, to establish label-switched paths (LSPs) in MPLS (Multi-Protocol Label Switching). Since the flow along an LSP is completely identified by the label applied at the ingress node of the path, these paths may be treated as tunnels. A key application of LSP tunnels is traffic engineering with MPLS as specified in RFC 2702. [STANDARDS-TRACK] Key words for use in RFCs to Indicate Requirement Levels In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF) YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS-TRACK] Network Configuration Protocol (NETCONF) The Network Configuration Protocol (NETCONF) defined in this document provides mechanisms to install, manipulate, and delete the configuration of network devices. It uses an Extensible Markup Language (XML)-based data encoding for the configuration data as well as the protocol messages. The NETCONF protocol operations are realized as remote procedure calls (RPCs). This document obsoletes RFC 4741. [STANDARDS-TRACK] Common YANG Data Types This document introduces a collection of common data types to be used with the YANG data modeling language. This document obsoletes RFC 6021. RESTCONF Protocol This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in the Network Configuration Protocol (NETCONF). The YANG 1.1 Data Modeling Language YANG is a data modeling language used to model configuration data, state data, Remote Procedure Calls, and notifications for network management protocols. This document describes the syntax and semantics of version 1.1 of the YANG language. YANG version 1.1 is a maintenance release of the YANG language, addressing ambiguities and defects in the original specification. There are a small number of backward incompatibilities from YANG version 1. This document also specifies the YANG mappings to the Network Configuration Protocol (NETCONF). Generalized Multi-Protocol Label Switching (GMPLS) Signaling Resource ReserVation Protocol-Traffic Engineering (RSVP-TE) Extensions This document describes extensions to Multi-Protocol Label Switching (MPLS) Resource ReserVation Protocol - Traffic Engineering (RSVP-TE) signaling required to support Generalized MPLS. Generalized MPLS extends the MPLS control plane to encompass time-division (e.g., Synchronous Optical Network and Synchronous Digital Hierarchy, SONET/SDH), wavelength (optical lambdas) and spatial switching (e.g., incoming port or fiber to outgoing port or fiber). This document presents a RSVP-TE specific description of the extensions. A generic functional description can be found in separate documents. [STANDARDS-TRACK] Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. Common YANG Data Types for the Routing Area This document defines a collection of common data types using the YANG data modeling language. These derived common types are designed to be imported by other modules defined in the routing area. A YANG Data Model for Traffic Engineering Tunnels, Label Switched Paths and Interfaces Cisco Systems Inc Cisco Systems Inc IBM Corporation Juniper Networks Individual Telefonica 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 that is independent of any technology or dataplane encapsulation and is divided into two YANG modules that cover device-specific, and device independent data. This model covers data for configuration, operational state, remote procedural calls, and event notifications. Common YANG Data Types for Traffic Engineering This document defines a collection of common data types and groupings in YANG data modeling language. These derived common types and groupings are intended to be imported by modules that model Traffic Engineering (TE) configuration and state capabilities. A YANG Data Model for MPLS Static LSPs Juniper Networks Cisco Systems Volta Networks Juniper Networks Huawei Technologies This document contains the specification for the MPLS Static Label Switched Paths (LSPs) YANG model. The model allows for the provisioning of static LSP(s) on Label Edge Router(s) LER(s) and Label Switched Router(s) LSR(s) devices along a LSP path without the dependency on any signaling protocol. The MPLS Static LSP model augments the MPLS base YANG model with specific data to configure and manage MPLS Static LSP(s). Extensions to the Path Computation Element Communication Protocol (PCEP) to Compute Service-Aware Label Switched Paths (LSPs) In certain networks, such as, but not limited to, financial information networks (e.g., stock market data providers), network performance criteria (e.g., latency) are becoming as critical to data path selection as other metrics and constraints. These metrics are associated with the Service Level Agreement (SLA) between customers and service providers. The link bandwidth utilization (the total bandwidth of a link in actual use for the forwarding) is another important factor to consider during path computation.IGP Traffic Engineering (TE) Metric Extensions describe mechanisms with which network performance information is distributed via OSPF and IS-IS, respectively. The Path Computation Element Communication Protocol (PCEP) provides mechanisms for Path Computation Elements (PCEs) to perform path computations in response to Path Computation Client (PCC) requests. This document describes the extension to PCEP to carry latency, delay variation, packet loss, and link bandwidth utilization as constraints for end-to-end path computation. Real-time Application Quality-of-Service Monitoring (RAQMON) Framework There is a need to monitor end-devices such as IP phones, pagers, Instant Messaging clients, mobile phones, and various other handheld computing devices. This memo extends the remote network monitoring (RMON) family of specifications to allow real-time quality-of-service (QoS) monitoring of various applications that run on these devices and allows this information to be integrated with the RMON family using the Simple Network Management Protocol (SNMP). This memo defines the framework, architecture, relevant metrics, and transport requirements for real-time QoS monitoring of applications. [STANDARDS-TRACK] IS-IS Traffic Engineering (TE) Metric Extensions In certain networks, such as, but not limited to, financial information networks (e.g., stock market data providers), network-performance criteria (e.g., latency) are becoming as critical to data-path selection as other metrics.This document describes extensions to IS-IS Traffic Engineering Extensions (RFC 5305). These extensions provide a way to distribute and collect network-performance information in a scalable fashion. The information distributed using IS-IS TE Metric Extensions can then be used to make path-selection decisions based on network performance.Note that this document only covers the mechanisms with which network-performance information is distributed. The mechanisms for measuring network performance or acting on that information, once distributed, are outside the scope of this document.This document obsoletes RFC 7810. Protocol Extensions for Support of Diffserv-aware MPLS Traffic Engineering This document specifies the protocol extensions for support of Diffserv-aware MPLS Traffic Engineering (DS-TE). This includes generalization of the semantics of a number of Interior Gateway Protocol (IGP) extensions already defined for existing MPLS Traffic Engineering in RFC 3630, RFC 3784, and additional IGP extensions beyond those. This also includes extensions to RSVP-TE signaling beyond those already specified in RFC 3209 for existing MPLS Traffic Engineering. These extensions address the requirements for DS-TE spelled out in RFC 3564. [STANDARDS-TRACK] The IETF XML Registry This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas. Using the NETCONF Protocol over Secure Shell (SSH) This document describes a method for invoking and running the Network Configuration Protocol (NETCONF) within a Secure Shell (SSH) session as an SSH subsystem. This document obsoletes RFC 4742. [STANDARDS-TRACK] Network Configuration Access Control Model The standardization of network configuration interfaces for use with the Network Configuration Protocol (NETCONF) or the RESTCONF protocol requires a structured and secure operating environment that promotes human usability and multi-vendor interoperability. There is a need for standard mechanisms to restrict NETCONF or RESTCONF protocol access for particular users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. This document defines such an access control model.This document obsoletes RFC 6536.