A YANG Model for BGP-LS, BGP-LS-VPN, and BGP-LS-SPF

Acronym	Definition
AFI	Address Family Indicator
LS	Link-State
LSA	Link-State Advertisements
LSDB	Link-State DataBase
SAFI	Subsequent Address Family Indicator
SPF	Shortest Path First
TE	Traffic Engineering

YANG Models

BGP Link-State YANG model The YANG model augments the BGP model in BGP Model for Service Provider Network to add extensions to BGP configuration. These extensions include the addition of three new Address Family Indicator (AFI) and Subsequent Address Family Indicator (SAFI) - BGP-LS, BGP-LS-VPN, and BGP-LS-SPF. The BGP model is augmented both at a global level, and at a neighbor level to add support for the three new AFI/SAFI. In addition, there is support for statistics both at a global and at a neighbor level for the new address families. The 'feature' definition in BGP Model for Service Provider Network for 'clear-statistics' is used in this model to determine whether ability to clear statistics will be supported. The model imports Common YANG Data Types , A YANG Data Model for Routing Management(NMDA Version), and BGP Model for Service Provider Network.

YANG Model for BGP-LS, BGP-LS-VPN, BGP-LS-SPF file "ietf-bgp-ls@2026-02-09.yang" module ietf-bgp-ls { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-bgp-ls"; prefix bgp-ls; import ietf-yang-types { prefix yang; reference "RFC 9911: Common YANG Data Types."; } import ietf-routing { prefix rt; reference "RFC 8349, A YANG Data Model for Routing Management (NMDA Version)."; } import ietf-bgp { prefix bgp; reference "I-D.ietf-idr-bgp-model: BGP YANG Model for Service Provider Networks."; } import iana-bgp-types { prefix bt; reference "I-D.ietf-idr-bgp-model: BGP YANG Model for Service Provider Networks."; } import ietf-bgp-lsdb { prefix bgp-lsdb; reference "RFC XXXX: A YANG model for BGP-LS, BGP-LS-VPN, and BGP-LS-SPF."; } organization "IETF LSVR Working Group"; contact "WG Web: WG List: Authors: Mahesh Jethanandani (mjethanandani at gmail.com), Keyur Patel (keyur at arrcus.com), Aravind Babu MahendraBabu (aramahen at cisco.com)"; description "This module contains contains management information for BGP-LS database. Copyright (c) 2023 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 XXXX (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2026-02-09 { description "Initial Version"; reference "RFC XXXX, BGP Model for Link State Distribution."; } // Identities. identity bgp-ls { base bt:afi-safi-type; description "BGP Link-State."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity bgp-ls-vpn { base bt:afi-safi-type; description "BGP Link-State VPN."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity bgp-ls-spf { base bt:afi-safi-type; description "BGP Link-State Shortest Path First (BGP-LS-SPF)."; reference "RFC 9815: BGP Link-State SPF Routing."; } identity attribute-type { description "Base identity for BGP-LS Attribute type."; } identity multi-topology-identifier { base attribute-type; description "Multi Topology Identifier TLV."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity node-flag-bits { base attribute-type; description "The Node Flag Bits TLV."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity opaque-node-attribute { base attribute-type; description "The Opaque Node Attribute TLV."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity node-name { base attribute-type; description "The Node Name TLV."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity isis-area-identifier { base attribute-type; description "IS-IS Area Identifier."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity ipv4-route-id-of-local-node { base attribute-type; description "IPv4 Router-ID of Local Node."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } identity ipv6-router-id-of-local-node { base attribute-type; description "IPv6 Router-ID of Local Node."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } // Typedefs typedef spf-algorithm-type { type enumeration { enum normal { description "Normal Shortest Path First (SPF) algorithm based on link metric. This is the standard shortest path algorithm as computed by the IGP protocol. Consistent with the deployed practice for link-state protocols, Algorithm 0 permits any node to overwrite the SPF path with a different path based on its local policy."; } enum strict { description "Strict Shortest Path First (SPF) algorithm based on link metric. The algorithm is identical to Algorithm 0 but Algorithm 1 requires that all nodes along the path will honor the SPF routing decision. Local policy at the node claiming support for Algorithm 1 MUST NOT alter the SPF paths computed by Algorithm 1"; } enum unknown { description "Unknown Algorithm"; } } description "SPF algorithm type."; } // Groupings grouping bgp-neighbor-ls-common { description "Grouping for neighbor configuration for Link-State."; leaf metric { type uint32; default 10; description "Metric associated with the corresponding link to be used in the SPF graph computation."; } leaf status { type enumeration { enum reachable { description "The link is reachable in the current SPF topology."; } enum uncreachable { description "The link is unreachable in the current SPF topology."; } } default reachable; description "Sets SPF-Status of the corresponding LS Link NLRI."; } } grouping bgp-mp-ls { description "Grouping for BGP-LS paramters."; container link-state { when "derived-from-or-self(../../bgp:afi-safi/bgp:name, " + "'bgp-ls')" { description "Include this container for BGP Linkstate specific configuration"; } presence "This container is for BGP Linkstate specific congfiguration."; description "Information related to Link-State configuration and management."; uses bgp:mp-all-afi-safi-common; leaf max-rate { type uint32; units per-second; default 200; description "Maximum rate at which Link-State NLRIs will be advertised or withdrawn from neighbors."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } leaf max-number { type uint32; description "Maximim number of Link-State NLRIs stored in a router's RIB."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } } } grouping bgp-mp-ls-spf { description "Grouping for BGP-LS-SPF parameters."; container link-state-spf { when "derived-from-or-self (../../bgp:afi-safi/bgp:name, " + "'bgp-ls-spf')" { description "Include this container for BGP Link-State SPF specific configuration"; } description "BGP Linkstate-SPF configuration options"; uses bgp:mp-all-afi-safi-common; } } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:global" + "/bgp:afi-safis/bgp:afi-safi" { description "Augmentation of the BGP model to add BGL-LS."; uses bgp-mp-ls; uses bgp-mp-ls-spf; } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:global" + "/bgp:afi-safis/bgp:afi-safi/link-state" { description "Augmentation of BGL-LS to add dB."; uses bgp-lsdb:lsdb-top; } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:global" + "/bgp:afi-safis/bgp:afi-safi/link-state-spf" { description "Augmentation of BGL-LS-SPF."; leaf instance-identifier { type uint64; default 0; description "Instance Identifier to be used for all Link-State NLRI advertisements originated locally"; } leaf algorithm-type { type spf-algorithm-type; default normal; description "SPF Algorithm type associated with Link-State AFI SAFI"; } leaf node-status { type enumeration { enum reachable { description "The local node is reachable in the current SPF topology."; } enum unreacable { description "The local node is unreachable in the current SPF topology."; } enum no-transit-support { description "The local node is reachable but does not support forwarding of transit traffic."; } } default reachable; description "Sets SPF-Status of the local node."; } container log { config false; description "This container lists the SPF computation events."; list event { key id; description "List of computation events - implemented as a wrapping buffer."; leaf id { type uint32; description "Event identifier."; } leaf type { type enumeration { enum full { description "Full SPF computation."; } enum route-only { description "Route reachability only SPF computation"; } } description "Type of SPF computation performed."; } leaf schedule-time { type yang:date-and-time; description "Time when the SPF computation was scheduled."; } leaf delay { type uint64; description "Delay in micro-seconds applied for this SPF event."; } leaf start-time { type yang:date-and-time; description "Time when the SPF computation started."; } leaf end-time { type yang:date-and-time; description "Time when the SPF computation ended."; } leaf duration { type uint64; description "Time taken in micro-seconds to execute the SPF computations."; } leaf node-count { type uint64; description "Number of nodes involved in the SPF computations."; } leaf prefix-count { type uint64; description "Number of prefixes involved in the SPF computations."; } leaf route-download-count { type uint64; description "Number of routes updated in the SPF computations."; } list lsp-trigger { key "id"; description "This list includes the LSPs that triggered the SPF computation."; leaf id { type uint32; description "Trigger identifier."; } leaf nlri-prefix { type string; description "Prefix of the NLRI triggering SPF computation."; } leaf nlri-sequence { type uint32; description "Sequence number of the NLRI triggering SPF computation."; } leaf trigger-time { type yang:date-and-time; description "Time when the trigger event was recorded."; } } } } uses bgp-lsdb:lsdb-top; } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:neighbors" + "/bgp:neighbor/bgp:afi-safis/bgp:afi-safi" { description "Augmentation of the BGP model to add BGL-LS."; uses bgp-mp-ls; uses bgp-mp-ls-spf; } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:neighbors" + "/bgp:neighbor/bgp:afi-safis/bgp:afi-safi/link-state-spf" { description "Augmentation of the BGP neighbor to add BGL-LS."; uses bgp-neighbor-ls-common; } /* augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:global" + "/bgp:afi-safis/bgp:afi-safi/bgp:statistics" { when "derived-from-or-self (../bgp:name, 'bgp-ls')" { description "Include these for BGP Link-State specific statistics."; } description "Augmentation of the global statistics counter to add BGP-LS statistics."; leaf updates-sent { type yang:zero-based-counter32; description "Total number of Link-State NLRI updates sent."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } leaf updates-received { type yang:zero-based-counter32; description "Total number of Link-State NLRI updates received."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } leaf local-ls-originated { type yang:zero-based-counter32; description "Total number of locally originated Link-State NLRIs."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } action clear { if-feature "bt:clear-statistics"; description "Clear statistics action command. Execution of this command should result in all the counters to be cleared and set to 0."; input { leaf clear-at { type yang:date-and-time; description "Time when the clear action needs to be executed."; } } output { leaf clear-finished-at { type yang:date-and-time; description "Time when the clear action command completed."; } } } } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:global" + "/bgp:afi-safis/bgp:afi-safi/bgp:statistics" { when "derived-from-or-self (../bgp:name, 'bgp-ls-spf')" { description "Include these for BGP Link-State SPF specific statistics."; } description "Augmentation of the global statistics counter to add BGP-LS-SPF statistics."; leaf scheduled { type yang:zero-based-counter64; description "Number of times SPF has been re/scheduled"; } leaf computed { type yang:zero-based-counter64; description "Number of times SPF has been computed"; } leaf maximum-duration { type uint64; units "microseconds"; description "Maximum duration taken for SPF compuation in microseconds."; } leaf minimum-duration { type uint64; units "microseconds"; description "Minimum duration taken for SPF compuation in microseconds."; } leaf average-duration { type uint64; units "microseconds"; description "Average duration taken for SPF compuation in microseconds."; } leaf last-computation-time { type yang:date-and-time; description "Timestamp for last SPF computation for this address-family"; } } */ augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:neighbors" + "/bgp:neighbor/bgp:statistics" { when "derived-from-or-self (../bgp:afi-safis/bgp:afi-safi" + "/bgp:name, 'bgp-ls')" { description "Include these for BGP Link-State specific statistics."; } description "Augmentation of the BGP per-neighbor statistics to add BGP-LS specific counters."; leaf updates-sent { type yang:zero-based-counter32; description "Total number of Link-State NLRIs updates sent per neighbor."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } leaf updates-received { type yang:zero-based-counter32; description "Total number of Link-State NLRIs updates received per neighbor."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } leaf error-updates-received { type yang:zero-based-counter32; description "Total number of Link-State NLRIs updates received that were errored, per neighbor."; reference "RFC 9552: Distribution of Link-State and Traffic Engineering Information Using BGP."; } leaf computations { type yang:zero-based-counter32; description "Count of number of SPF computations made."; reference "RFC 9815: BGP Link-State SPF Routing."; } leaf triggering-events { type yang:zero-based-counter32; description "SPF triggering events."; reference "RFC 9815: BGP Link-State SPF Routing."; } action clear { if-feature "bt:clear-statistics"; description "Clear statistics action command. Execution of this command should result in all the counters to be cleared and set to 0."; input { leaf clear-at { type yang:date-and-time; description "Time when the clear action needs to be executed."; } } output { leaf clear-finished-at { type yang:date-and-time; description "Time when the clear action command completed."; } } } } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:peer-groups" + "/bgp:peer-group/bgp:afi-safis/bgp:afi-safi" { description "Augmentation of the BGP peer-group to add BGP-LS and BGP-LS-SPF."; uses bgp-mp-ls; uses bgp-mp-ls-spf; } augment "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/bgp:bgp/bgp:peer-groups" + "/bgp:peer-group/bgp:afi-safis/bgp:afi-safi/" + "link-state-spf" { description "Augmentation of the BGP peer-groups to add BGL-LS."; uses bgp-neighbor-ls-common; } }

]]>


      
	BGP Link-State Database YANG model
  The model imports Common YANG Data
	Types 
	
	
          YANG Model for Link-State Database
           file "ietf-bgp-lsdb@2026-02-09.yang"
module ietf-bgp-lsdb {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-bgp-lsdb";
  prefix bgp-lsdb;

  import ietf-inet-types {
    prefix inet;
    reference
      "RFC 9911: Common YANG Data Types.";
  }

  import ietf-yang-types {
    prefix yang;
    reference
      "RFC 9911: Common YANG Data Types.";
  }
  
  import ietf-bgp-ls-topo-types {
    prefix bgp-ls-topo-t;
    reference
      "RFC XXXX: BGP Model for Link State Distribution.";
  }

  import ietf-routing-types {
    prefix ietf-rt-t;
    reference
      "RFC 8294: Common YANG Data Types for the Routing Area.";
  }

  import ietf-isis {
    prefix ietf-isis-t;
    reference
      "RFC 9130: YANG Data Model for IS-IS Protocol.";
  }

  import ietf-ospf {
    prefix ietf-ospf-t;
    reference
      "RFC 9129: YANG Data Model for the OSPF Protocol.";
  }

  include ietf-bgp-ls-topo-attr;

  organization
    "IETF LSVR Working Group";
  contact
    "WG Web:   
     WG List:  

     Authors: Mahesh Jethanandani (mjethanandani at gmail.com),
              Keyur Patel (keyur at arrcus.com),
              Aravind Babu MahendraBabu (aramahen at cisco.com)";

  description
    "This module contains contains configuration and management
     information for BGP-LS, BGP-LS-SPF.

     Copyright (c) 2023 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 XXXX
     (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
     for full legal notices.

     The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL
     NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED',
     'MAY', and 'OPTIONAL' in this document are to be interpreted as
     described in BCP 14 (RFC 2119) (RFC 8174) when, and only when,
     they appear in all capitals, as shown here.";

  revision 2026-02-09 {
    description
      "Initial Version";
    reference
      "RFC XXXX, BGP Model for Link State Distribution.";
  }

  // Groupings

  grouping lsdb-top {
    description
      "Details for all databases under an application instance.";

    container bgp-ls-topology {
      config false;
      description
        "Top level container for BGP-LS topology entries";

      container instances {
        description
          "Enclosing container for instance list";

        list instance {
          key "vrf-name protocol identifier";
          description
            "List of instances";
          
          leaf vrf-name {
            type string;
            description
              "Name of the VRF this database belongs to.";
          }

          leaf protocol {
            type bgp-ls-topo-t:protocol;
            description
              "Protocol originating the NLRI.";
            reference
              "RFC 9552: Distribution of Link-State and Traffic
               Engineering Information Using BGP, Section 5.2.";
          }

          leaf identifier {
            type uint64;
            description
              "Instance identifier identifying the IGP routing
               domain where the NLRI belongs.";
            reference
              "RFC 9552: Distribution of Link-State and Traffic
               Engineering Information Using BGP, Section 5.2.";
          }

          container nodes {
            description
              "BGP-LS topology entries for nodes";

            list ospf-node {
              key "is-as-scoped area-id router-id dr-identifier as";
              description
                "List of node types";

              leaf is-as-scoped {
                type boolean;
                description
                  "Is area ID valid?";
              }

              leaf area-id {
                type ietf-ospf-t:area-id-type;
                description
                  "Area ID.";
                reference
                  "RFC 9552: Distribution of Link-State and
                   Traffic Engineering Information Using BGP,
                   Section 5.2.1.";
              }

              leaf router-id {
                type ietf-rt-t:router-id;
                description
                  "Router ID.";
                reference
                  "RFC 9552: Distribution of Link-State and
                   Traffic Engineering Information Using BGP,
                   Section 5.2.1.";
              }

              leaf dr-identifier {
                type inet:ipv4-address;
                description
                  "Designated Router (DR) Identifier.";
                reference
                  "RFC 9552: Distribution of Link-State and
                   Traffic Engineering Information Using BGP,
                   Section 5.2.1.";
              }

              leaf as {
                type inet:as-number;
                description
                  "Autonomous System (AS) number associated with the
                   BGP process originating the NLRI.";
                reference
                  "RFC 9552: Distribution of Link-State and
                   Traffic Engineering Information Using BGP,
                   Section 5.2.1.";
              }

              uses bgp-ls-topo-node-attr;
            }

            list isis-node {
              key "system-id psn-id as";
              description
                "List of node types";

              leaf system-id {
                type ietf-isis-t:system-id;
                description
                  "System ID.";
                reference
                  "RFC 9552: Distribution of Link-State and
                   Traffic Engineering Information Using BGP,
                   Section 5.2.1.";
              }

              leaf psn-id {
                type uint8;
                description
                  "Pseudo Node Identifier (PSN ID).";
                reference
                  "RFC 9552: Distribution of Link-State and
                   Traffic Engineering Information Using BGP,
                   Section 5.2.1.";
              }

              leaf as {
                type inet:as-number;
                description
                  "Autonomous System (AS) number associated with the
                   BGP process originating the NLRI.";
                reference
                  "RFC 9552: Distribution of Link-State and
                   Traffic Engineering Information Using BGP,
                   Section 5.2.1.";
              }

              uses bgp-ls-topo-node-attr;
            }
          }

          container unknowns {
            description
              "BGP-LS topology entries for unknown NLRIs -- active 
              when the nlri-type is unknown";
            list unknown {
              key "nlri";
              description
                "List of unknown types";

              leaf nlri {
                type yang:hex-string;
                description
                  "NLRI.";
                reference
                  "RFC 9552: Distribution of Link-State and Traffic
                   Engineering Information Using BGP, Section 5.2.";
              }

              leaf attributes {
                type yang:hex-string;
                description
                  "Attributes.";
                reference
                  "RFC 9552: Distribution of Link-State and Traffic
                   Engineering Information Using BGP, Section 5.3.";
              }
            }
          }        
        }
      }
    }
  }
}


]]>