Routing +---------------+ v: import YANG module | ietf-routing | o: augment +---------------+ o | v MPLS base +-----------+ v: import YANG module | ietf-mpls | o: augment +-----------+ o o------+ | \ v v +-------------------+ +---------------------+ MPLS static | ietf-mpls-static@ | | ietf-mpls-ldp.yang@ | . . LSP YANG +-------------------+ +---------------------+ module @: not in this document; shown for illustration only
+-----------------+ | MPLS base model | +-----------------+ ____/ | |_____ |________ / | \ \ / | \ \ o o o + +---------+ +---------+ +--------+ +-----------+ | RIB(v4) | | RIB(v6) | | RIB(x) | | RIB(mpls) | +---------+ +---------+ +--------+ +-----------+ +: created by the MPLS base model o: augmented by the MPLS base model
module: ietf-mpls augment /rt:routing: +--rw mpls +--rw ttl-propagate? boolean +--rw mpls-label-blocks | +--rw mpls-label-block* [index] | +--rw index string | +--rw start-label? rt-types:mpls-label | +--rw end-label? rt-types:mpls-label | +--rw block-allocation-mode? identityref | +--ro inuse-labels-count? yang:gauge32 +--rw interfaces +--rw interface* [name] +--rw name if:interface-ref +--rw mpls-enabled? boolean +--rw maximum-labeled-packet? uint32 augment /rt:routing/rt:ribs/rt:rib/rt:routes/rt:route: +--ro mpls-enabled? boolean +--ro mpls-local-label? rt-types:mpls-label +--ro destination-prefix? -> ../mpls-local-label +--ro route-context? string augment /rt:routing/rt:ribs/rt:rib/rt:routes/rt:route/rt:next-hop /rt:next-hop-options/rt:simple-next-hop: +--ro mpls-label-stack +--ro entry* [id] +--ro id uint8 +--ro label? rt-types:mpls-label +--ro ttl? uint8 +--ro traffic-class? uint8 augment /rt:routing/rt:ribs/rt:rib/rt:routes/rt:route/rt:next-hop /rt:next-hop-options/rt:next-hop-list/rt:next-hop-list /rt:next-hop: +--ro index? string +--ro backup-index? string +--ro loadshare? uint16 +--ro role? nhlfe-role +--ro mpls-label-stack +--ro entry* [id] +--ro id uint8 +--ro label? rt-types:mpls-label +--ro ttl? uint8 +--ro traffic-class? uint8 augment /rt:routing/rt:ribs/rt:rib/rt:active-route/rt:input: +---w destination-address? -> ../mpls-local-label +---w mpls-local-label? rt-types:mpls-label augment /rt:routing/rt:ribs/rt:rib/rt:active-route/rt:output /rt:route/rt:next-hop/rt:next-hop-options /rt:simple-next-hop: +-- mpls-label-stack +-- entry* [id] +-- id uint8 +-- label? rt-types:mpls-label +-- ttl? uint8 +-- traffic-class? uint8 augment /rt:routing/rt:ribs/rt:rib/rt:active-route/rt:output /rt:route/rt:next-hop/rt:next-hop-options /rt:next-hop-list/rt:next-hop-list/rt:next-hop: +-- index? string +-- backup-index? string +-- loadshare? uint16 +-- role? nhlfe-role +-- mpls-label-stack +-- entry* [id] +-- id uint8 +-- label? rt-types:mpls-label +-- ttl? uint8 +-- traffic-class? uint8
module ietf-mpls { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-mpls"; prefix mpls; import ietf-routing { prefix rt; reference "RFC 8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-routing-types { prefix rt-types; reference "RFC 8294: Common YANG Data Types for the Routing Area"; } import ietf-yang-types { prefix yang; reference "RFC 6991: Common YANG Data Types"; } import ietf-interfaces { prefix if; reference "RFC 8343: A YANG Data Model for Interface Management"; } organization "IETF MPLS Working Group"; contact "WG Web: <https://datatracker.ietf.org/wg/mpls/> WG List: <mailto:mpls@ietf.org> Editor: Tarek Saad <mailto:tsaad@juniper.net> Editor: Kamran Raza <mailto:skraza@cisco.com> Editor: Rakesh Gandhi <mailto:rgandhi@cisco.com> Editor: Xufeng Liu <mailto:xufeng.liu.ietf@gmail.com> Editor: Vishnu Pavan Beeram <mailto:vbeeram@juniper.net>"; description "This YANG module defines the essential components for the management of the MPLS subsystem. The model fully conforms to the Network Management Datastore Architecture (NMDA). Copyright (c) 2020 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 8960; see the RFC itself for full legal notices."; revision 2020-12-18 { description "Initial revision."; reference "RFC 8960: A YANG Data Model for MPLS Base"; } /* Identities */ identity mpls { base rt:address-family; description "This identity represents the MPLS address family."; } identity mpls-unicast { base mpls:mpls; description "This identity represents the MPLS unicast address family."; } identity label-block-alloc-mode { description "Base identity for label-block allocation mode."; } identity label-block-alloc-mode-manager { base label-block-alloc-mode; description "Label-block allocation on the reserved block is managed by the label manager."; } identity label-block-alloc-mode-application { base label-block-alloc-mode; description "Label-block allocation on the reserved block is managed by the application."; } /** * Typedefs */ typedef mpls-operations-type { type enumeration { enum impose-and-forward { description "Operation to impose one or more outgoing labels and forward to the next hop."; } enum pop-and-forward { description "Operation to pop the incoming label and forward to the next hop."; } enum pop-impose-and-forward { description "Operation to pop the incoming label, impose one or more outgoing labels, and forward to the next hop."; } enum swap-and-forward { description "Operation to swap the incoming label with the outgoing label and forward to the next hop."; } enum pop-and-lookup { description "Operation to pop the incoming label and perform a lookup."; } } description "Types of MPLS operations."; } typedef nhlfe-role { type enumeration { enum primary { description "The next hop acts as the primary for carrying traffic."; } enum backup { description "The next hop acts as the backup."; } enum primary-and-backup { description "The next hop simultaneously acts as both the primary and the backup for carrying traffic."; } } description "Role of the next hop."; } grouping nhlfe-single-contents { description "A grouping that describes a single Next Hop Label Forwarding Entry (NHLFE) and its associated parameters as described in the MPLS architecture. This grouping is specific to the case when a single next hop is associated with the route."; uses rt-types:mpls-label-stack; } grouping nhlfe-multiple-contents { description "A grouping that describes a set of NHLFEs and their associated parameters as described in the MPLS architecture. This grouping is used when multiple next hops are associated with the route."; leaf index { type string; description "A user-specified identifier utilized to uniquely reference the next-hop entry in the next-hop list. The value of this index has no semantic meaning other than for referencing the entry."; } leaf backup-index { type string; description "A user-specified identifier utilized to uniquely reference the backup next-hop entry in the NHLFE list. The value of this index has no semantic meaning other than for referencing the entry."; reference "RFC 4090: Fast Reroute Extensions to RSVP-TE for LSP Tunnels RFC 5714: IP Fast Reroute Framework"; } leaf loadshare { type uint16; default "1"; description "This value is used to compute a load share to perform unequal load balancing when multiple outgoing next hops are specified. A share is computed as a ratio of this number to the total under all next hops."; reference "RFC 3031: Multiprotocol Label Switching Architecture, Sections 3.11 and 3.12 RFC 7424: Mechanisms for Optimizing Link Aggregation Group (LAG) and Equal-Cost Multipath (ECMP) Component Link Utilization in Networks, Section 5.4"; } leaf role { type nhlfe-role; description "Role of the NHLFE."; } uses nhlfe-single-contents; } grouping interfaces-mpls { description "List of MPLS interfaces."; container interfaces { description "List of MPLS-enabled interfaces."; list interface { key "name"; description "MPLS-enabled interface entry."; leaf name { type if:interface-ref; description "A reference to the name of an interface in the system that is to be enabled for MPLS."; } leaf mpls-enabled { type boolean; default "false"; description "'true' if MPLS encapsulation is enabled on the interface. 'false' if MPLS encapsulation is disabled on the interface."; } leaf maximum-labeled-packet { type uint32; units "octets"; description "Maximum labeled packet size."; reference "RFC 3032: MPLS Label Stack Encoding, Section 3.2"; } } } } grouping globals { description "MPLS global configuration grouping."; leaf ttl-propagate { type boolean; default "true"; description "Propagate TTL between IP and MPLS."; } } grouping label-blocks { description "Label-block allocation grouping."; container mpls-label-blocks { description "Label-block allocation container."; list mpls-label-block { key "index"; description "List of MPLS label blocks."; leaf index { type string; description "A user-specified identifier utilized to uniquely reference an MPLS label block."; } leaf start-label { type rt-types:mpls-label; must '. <= ../end-label' { error-message "'start-label' must be less than or equal " + "to 'end-label'"; } description "Label-block start."; } leaf end-label { type rt-types:mpls-label; must '. >= ../start-label' { error-message "'end-label' must be greater than or " + "equal to 'start-label'"; } description "Label-block end."; } leaf block-allocation-mode { type identityref { base label-block-alloc-mode; } description "Label-block allocation mode."; } leaf inuse-labels-count { when "derived-from-or-self(../block-allocation-mode, " + "'mpls:label-block-alloc-mode-manager')"; type yang:gauge32; config false; description "Number of labels in use in the label block."; } } } } grouping rib-mpls-properties { description "A grouping of native MPLS RIB properties."; leaf destination-prefix { type leafref { path "../mpls-local-label"; } description "MPLS destination prefix."; } leaf route-context { type string; description "A context associated with the native MPLS route."; } } grouping rib-active-route-mpls-input { description "A grouping applicable to native MPLS RIB 'active-route' RPC input augmentation."; leaf destination-address { type leafref { path "../mpls-local-label"; } description "MPLS native 'active-route' destination."; } leaf mpls-local-label { type rt-types:mpls-label; description "MPLS local label."; } } augment "/rt:routing" { description "MPLS augmentation."; container mpls { description "MPLS container to be used as an augmentation target node for the configuration of other MPLS sub-features, e.g., MPLS static Label Switched Paths (LSPs), MPLS LDP LSPs, and Traffic Engineering MPLS LSP Tunnels."; uses globals; uses label-blocks; uses interfaces-mpls; } } /* Augmentation of MPLS routes */ augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" { description "This augmentation is applicable to all MPLS routes."; leaf mpls-enabled { type boolean; default "false"; description "Indicates whether MPLS is enabled for this route."; } leaf mpls-local-label { when "../mpls-enabled = 'true'"; type rt-types:mpls-label; description "MPLS local label associated with the route."; } uses rib-mpls-properties { /* MPLS Address Family (AF) augmentation to the native MPLS RIB */ when "derived-from-or-self(../../rt:address-family, " + "'mpls:mpls')" { description "This augment is valid only for routes of the native MPLS RIB."; } } } /* MPLS simple-next-hop augmentation */ augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route/" + "rt:next-hop/rt:next-hop-options/rt:simple-next-hop" { description "Augments the 'simple-next-hop' case in IP unicast routes."; uses nhlfe-single-contents { when "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" + "/mpls:mpls-enabled = 'true'"; } } /* MPLS next-hop-list augmentation */ augment "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route/" + "rt:next-hop/rt:next-hop-options/rt:next-hop-list/" + "rt:next-hop-list/rt:next-hop" { description "This leaf augments the 'next-hop-list' case of IP unicast routes."; uses nhlfe-multiple-contents { when "/rt:routing/rt:ribs/rt:rib/rt:routes/rt:route" + "/mpls:mpls-enabled = 'true'"; } } /* MPLS RPC input augmentation */ augment "/rt:routing/rt:ribs/rt:rib/rt:active-route/rt:input" { description "Input MPLS augmentation for the 'active-route' action statement."; uses rib-active-route-mpls-input { /* MPLS AF augmentation to the native MPLS RIB */ when "derived-from-or-self(../rt:address-family, " + "'mpls:mpls')" { description "This augment is valid only for routes of the native MPLS RIB."; } } } /* MPLS RPC output augmentation */ augment "/rt:routing/rt:ribs/rt:rib/rt:active-route/" + "rt:output/rt:route/" + "rt:next-hop/rt:next-hop-options/rt:simple-next-hop" { description "Output MPLS augmentation for the 'active-route' action statement."; uses nhlfe-single-contents; } augment "/rt:routing/rt:ribs/rt:rib/rt:active-route/" + "rt:output/rt:route/" + "rt:next-hop/rt:next-hop-options/rt:next-hop-list/" + "rt:next-hop-list/rt:next-hop" { description "Output MPLS augmentation for the 'active-route' action statement."; uses nhlfe-multiple-contents; } }
State on R1: ============ IPv4 Prefix MPLS Label P1: 198.51.100.1/32 16001 P2: 198.51.100.2/32 16002 IPv6 Prefix MPLS Label P3: 2001:db8:0:10::1/128 16003 P4: 2001:db8:0:10::2/128 16004 RSVP MPLS LSPv4-Tunnel: Source: 198.51.100.3 Destination: 198.51.100.4 Tunnel-ID: 10 LSP-ID: 1 192.0.2.5/30 2001:db8:0:1::1/64 eth0 +--- / +-----+ | R1 | +-----+ \ +--- eth1 192.0.2.13/30 2001:db8:0:2::1/64
{ "ietf-routing:routing":{ "ribs":{ "rib":[ { "name":"RIB-V4", "address-family": "ietf-ipv4-unicast-routing:v4ur:ipv4-unicast", "routes":{ "route":[ { "next-hop":{ "outgoing-interface":"eth0", "ietf-mpls:mpls-label-stack":{ "entry":[ { "id":1, "label":16001, "ttl":255 } ] }, "ietf-ipv4-unicast-routing:next-hop-address": "192.0.2.5" }, "source-protocol":"ietf-isis:isis", "ietf-mpls:mpls-enabled":true, "ietf-mpls:mpls-local-label":16001, "ietf-ipv4-unicast-routing:destination-prefix": "198.51.100.1/32", "ietf-mpls:route-context":"SID-IDX:1" }, { "next-hop":{ "next-hop-list":{ "next-hop":[ { "outgoing-interface":"eth0", "ietf-mpls:index":"1", "ietf-mpls:backup-index":"2", "ietf-mpls:role":"primary-and-backup", "ietf-mpls:mpls-label-stack":{ "entry":[ { "id":1, "label":16002, "ttl":255 } ] }, "ietf-ipv4-unicast-routing:address": "192.0.2.5" }, { "outgoing-interface":"eth1", "ietf-mpls:index":"2", "ietf-mpls:backup-index":"1", "ietf-mpls:role":"primary-and-backup", "ietf-mpls:mpls-label-stack":{ "entry":[ { "id":1, "label":16002, "ttl":255 } ] }, "ietf-ipv4-unicast-routing:address": "192.0.2.13" } ] } }, "source-protocol":"ietf-isis:isis", "ietf-mpls:mpls-enabled":true, "ietf-mpls:mpls-local-label":16002, "ietf-ipv4-unicast-routing:destination-prefix": "198.51.100.2/32", "ietf-mpls:route-context":"SID-IDX:2" } ] } }, { "name":"RIB-V6", "address-family": "ietf-ipv6-unicast-routing:v6ur:ipv6-unicast", "routes":{ "route":[ { "next-hop":{ "outgoing-interface":"eth0", "ietf-mpls:mpls-label-stack":{ "entry":[ { "id":1, "label":16003, "ttl":255 } ] }, "ietf-ipv6-unicast-routing:next-hop-address": "2001:db8:0:1::1" }, "source-protocol":"ietf-isis:isis", "ietf-mpls:mpls-enabled":true, "ietf-mpls:mpls-local-label":16003, "ietf-ipv6-unicast-routing:destination-prefix": "2001:db8:0:10::1/128", "ietf-mpls:route-context":"SID-IDX:3" }, { "next-hop":{ "next-hop-list":{ "next-hop":[ { "outgoing-interface":"eth0", "ietf-mpls:index":"1", "ietf-mpls:backup-index":"2", "ietf-mpls:role":"primary-and-backup", "ietf-mpls:mpls-label-stack":{ "entry":[ { "id":1, "label":16004, "ttl":255 } ] }, "ietf-ipv6-unicast-routing:address": "2001:db8:0:1::1" }, { "outgoing-interface":"eth1", "ietf-mpls:index":"2", "ietf-mpls:backup-index":"1", "ietf-mpls:role":"primary-and-backup", "ietf-mpls:mpls-label-stack":{ "entry":[ { "id":1, "label":16004, "ttl":255 } ] }, "ietf-ipv6-unicast-routing:address": "2001:db8:0:2::1" } ] } }, "source-protocol":"ietf-isis:isis", "ietf-mpls:mpls-enabled":true, "ietf-mpls:mpls-local-label":16004, "ietf-ipv6-unicast-routing:destination-prefix": "2001:db8:0:10::2/128", "ietf-mpls:route-context":"SID-IDX:4" } ] } }, { "name":"RIB-MPLS", "address-family":"ietf-mpls:mpls:mpls", "routes":{ "route":[ { "next-hop":{ "outgoing-interface":"eth0", "ietf-mpls:mpls-label-stack":{ "entry":[ { "id":1, "label":24002, "ttl":255 } ] }, "ietf-ipv4-unicast-routing:next-hop-address": "192.0.2.5" }, "source-protocol":"ietf-rsvp:rsvp", "ietf-mpls:mpls-enabled":true, "ietf-mpls:mpls-local-label":24001, "ietf-mpls:destination-prefix":"24001", "ietf-mpls:route-context": "RSVP Src:198.51.100.3,Dst:198.51.100.4,T:10,L:1" } ] } } ] }, "ietf-mpls:mpls":{ "mpls-label-blocks":{ "mpls-label-block":[ { "index":"mpls-srgb-label-block", "start-label":16000, "end-label":16500, "block-allocation-mode": "ietf-mpls:label-block-alloc-mode-manager" } ] }, "interfaces":{ "interface":[ { "name":"eth0", "mpls-enabled":true, "maximum-labeled-packet":1488 }, { "name":"eth1", "mpls-enabled":true, "maximum-labeled-packet":1488 } ] } } } }