Internet DRAFT - draft-ietf-lsvr-bgp-ls-yang
draft-ietf-lsvr-bgp-ls-yang
LSVR M. Jethanandani, Ed.
Internet-Draft K. Patel
Intended status: Standards Track Arrcus, Inc
Expires: 12 April 2024 10 October 2023
A YANG Model for BGP-LS, BGP-LS-VPN, and BGP-LS-SPF
draft-ietf-lsvr-bgp-ls-yang-02
Abstract
This document defines a YANG data model for configuration and
management of BGP-LS, BGP-LS-VPN, and BGP-LS-SPF.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 12 April 2024.
Copyright Notice
Copyright (c) 2023 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.
Jethanandani & Patel Expires 12 April 2024 [Page 1]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1. Acronyms . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Tree Diagram . . . . . . . . . . . . . . . . . . . . . . . . 3
4. YANG Models . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.1. BGP Link-State YANG model . . . . . . . . . . . . . . . . 7
4.2. BGP Link-State Database YANG model . . . . . . . . . . . 29
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 40
6. Security Considerations . . . . . . . . . . . . . . . . . . . 41
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 42
7.1. Normative References . . . . . . . . . . . . . . . . . . 42
7.2. Informative References . . . . . . . . . . . . . . . . . 43
Appendix A. Complete Tree Diagram . . . . . . . . . . . . . . . 44
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . 51
Contributors . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 51
1. Introduction
North-Bound Distribution of Link-State (LS) and Traffic Engineering
(TE) Information Using BGP [RFC7752] describes a mechanism by which
LS and TE information can be collected and shared with external
components using BGP routing protocol. That LS combined with
Shortest Path First (SPF) algorithm can be used by BGP for making
routing decisions. Additionally, BGP Link-State Shortest Path First
(SPF) Routing [I-D.ietf-lsvr-bgp-spf] describes how it allows BGP to
be used efficiently as both the underlay and the overlay protocol in
Many Massively Scaled Data Centers (MSDC). This document defines a
YANG 1.1 [RFC7950] model that can be used to configure a router of
that capability. It also defines a model for Link State DataBase
(LSDB) that is used to store Link State Advertisements (LSA).
The model conforms to the NMDA [RFC8342] architecture.
1.1. Requirements Language
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 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here.
Jethanandani & Patel Expires 12 April 2024 [Page 2]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
2. Terminology
This document references terms defined in other documents.
* BGP SPF Routing Domain
* BGP-LS-SPF NLRI
2.1. Acronyms
This document uses a few acronyms. Some of them are defined here for
reference.
+=========+=====================================+
| 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 |
+---------+-------------------------------------+
Table 1: Acronyms
3. Tree Diagram
An abridged version of the tree diagram is shown here. Annotations
used in the diagram are defined in YANG Tree Diagrams [RFC8340].
module: ietf-bgp-ls
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:global
/bgp:afi-safis/bgp:afi-safi:
+--rw link-state!
| +--rw prefix-limit
| | +--rw max-prefixes? uint32
| | +--rw shutdown-threshold-pct? rt-types:percentage
| | +--rw restart-timer? uint32
Jethanandani & Patel Expires 12 April 2024 [Page 3]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
| +--rw max-rate? uint32
| +--rw max-number? uint32
| +--rw instance-id? uint64
| +--rw asn-plus-bgp-ls-ids? uint32
| +--ro local-databases
| +--ro database* [vrf-name instance protocol-id area-id]
| ...
+--ro tlvs
| +--ro tlv* []
| +--ro multi-topology-identifier
| | ...
| +--ro node-flag-bits
| | ...
| +--ro opaque-node-attribute
| | ...
| +--ro node-name
| | ...
| +--ro isis-area-identifier
| | ...
| +--ro ipv4-router-id
| | ...
| +--ro ipv6-router-id
| | ...
| +--ro unknown-tlvs
| ...
+--rw link-state-spf
+--rw prefix-limit
| +--rw max-prefixes? uint32
| +--rw shutdown-threshold-pct? rt-types:percentage
| +--rw restart-timer? uint32
+--rw instance-identifier? uint64
+--rw algorithm-type? spf-algorithm-type
+--rw node-status? enumeration
+--ro log
| +--ro event* [id]
| ...
+--ro local-databases
+--ro database* [vrf-name instance protocol-id area-id]
...
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:neighbors
/bgp:neighbor/bgp:afi-safis/bgp:afi-safi:
+--rw link-state!
| +--rw prefix-limit
| | +--rw max-prefixes? uint32
| | +--rw shutdown-threshold-pct? rt-types:percentage
| | +--rw restart-timer? uint32
| +--rw max-rate? uint32
Jethanandani & Patel Expires 12 April 2024 [Page 4]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
| +--rw max-number? uint32
| +--rw instance-id? uint64
| +--rw asn-plus-bgp-ls-ids? uint32
+--ro tlvs
| +--ro tlv* []
| +--ro multi-topology-identifier
| | ...
| +--ro node-flag-bits
| | ...
| +--ro opaque-node-attribute
| | ...
| +--ro node-name
| | ...
| +--ro isis-area-identifier
| | ...
| +--ro ipv4-router-id
| | ...
| +--ro ipv6-router-id
| | ...
| +--ro unknown-tlvs
| ...
+--rw link-state-spf
+--rw prefix-limit
| +--rw max-prefixes? uint32
| +--rw shutdown-threshold-pct? rt-types:percentage
| +--rw restart-timer? uint32
+--rw metric? uint32
+--rw status? enumeration
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:global
/bgp:afi-safis/bgp:afi-safi/bgp:statistics:
+--ro updates-sent? yang:zero-based-counter32
+--ro updates-received? yang:zero-based-counter32
+--ro local-ls-originated? yang:zero-based-counter32
+---x clear {bt:clear-statistics}?
+---w input
| +---w clear-at? yang:date-and-time
+--ro output
+--ro clear-finished-at? yang:date-and-time
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:global
/bgp:afi-safis/bgp:afi-safi/bgp:statistics:
+--ro scheduled? yang:zero-based-counter64
+--ro computed? yang:zero-based-counter64
+--ro maximum-duration? uint64
+--ro minimum-duration? uint64
+--ro average-duration? uint64
+--ro last-computation-time? yang:date-and-time
Jethanandani & Patel Expires 12 April 2024 [Page 5]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:neighbors
/bgp:neighbor/bgp:statistics:
+--rw updates-sent? yang:zero-based-counter32
+--rw updates-received? yang:zero-based-counter32
+--rw error-updates-received? yang:zero-based-counter32
+--rw computations? yang:zero-based-counter32
+--rw triggering-events? yang:zero-based-counter32
+---x clear {bt:clear-statistics}?
+---w input
| +---w clear-at? yang:date-and-time
+--rw output
+--rw clear-finished-at? yang:date-and-time
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:
+--rw link-state!
| +--rw prefix-limit
| | +--rw max-prefixes? uint32
| | +--rw shutdown-threshold-pct? rt-types:percentage
| | +--rw restart-timer? uint32
| +--rw max-rate? uint32
| +--rw max-number? uint32
| +--rw instance-id? uint64
| +--rw asn-plus-bgp-ls-ids? uint32
+--ro tlvs
| +--ro tlv* []
| +--ro multi-topology-identifier
| | ...
| +--ro node-flag-bits
| | ...
| +--ro opaque-node-attribute
| | ...
| +--ro node-name
| | ...
| +--ro isis-area-identifier
| | ...
| +--ro ipv4-router-id
| | ...
| +--ro ipv6-router-id
| | ...
| +--ro unknown-tlvs
| ...
+--rw link-state-spf
+--rw prefix-limit
| +--rw max-prefixes? uint32
| +--rw shutdown-threshold-pct? rt-types:percentage
| +--rw restart-timer? uint32
Jethanandani & Patel Expires 12 April 2024 [Page 6]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
+--rw metric? uint32
+--rw status? enumeration
Figure 1: Tree Diagram for BGP-LS, BGP-LS-SPF YANG Model
4. YANG Models
4.1. BGP Link-State YANG model
The YANG model augments the BGP model in BGP Model for Service
Provider Network [I-D.ietf-idr-bgp-model] 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 [I-D.ietf-idr-bgp-model] 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 [RFC6991], A YANG Data Model
for Routing Management(NMDA Version) [RFC8349], and BGP Model for
Service Provider Network [I-D.ietf-idr-bgp-model].
<CODE BEGINS> file "ietf-bgp-ls@2023-10-10.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 6991: 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
Jethanandani & Patel Expires 12 April 2024 [Page 7]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
Networks.";
}
import ietf-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: <http://tools.ietf.org/wg/lsvr>
WG List: <lsvr@ietf.org>
Authors: Mahesh Jethanandani (mjethanandani at gmail.com),
Keyur Patel (keyur at arrcus.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.";
Jethanandani & Patel Expires 12 April 2024 [Page 8]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
revision 2023-10-10 {
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 7752: Link-State Info Distribution using BGP.";
}
identity bgp-ls-vpn {
base bt:afi-safi-type;
description
"BGP Link-State VPN.";
reference
"RFC 7752: Link-State Info Distribution using BGP.";
}
identity bgp-ls-spf {
base bt:afi-safi-type;
description
"BGP Link-State Shortest Path First (BGP-LS-SPF).";
reference
"I-D.ietf-lsvr-bgp-spf: 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
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
identity node-flag-bits {
base attribute-type;
Jethanandani & Patel Expires 12 April 2024 [Page 9]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
description
"The Node Flag Bits TLV.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
identity opaque-node-attribute {
base attribute-type;
description
"The Opaque Node Attribute TLV.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
identity node-name {
base attribute-type;
description
"The Node Name TLV.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
identity isis-area-identifier {
base attribute-type;
description
"IS-IS Area Identifier.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
identity ipv4-route-id-of-local-node {
base attribute-type;
description
"IPv4 Router-ID of Local Node.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
identity ipv6-router-id-of-local-node {
base attribute-type;
description
"IPv6 Router-ID of Local Node.";
reference
Jethanandani & Patel Expires 12 April 2024 [Page 10]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
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 {
Jethanandani & Patel Expires 12 April 2024 [Page 11]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
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 7752: Link-State Info Distribution Using BGP.";
}
Jethanandani & Patel Expires 12 April 2024 [Page 12]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
leaf max-number {
type uint32;
description
"Maximim number of Link-State NLRIs stored in a router's
RIB.";
reference
"RFC 7752: Link-State Info Distribution Using BGP.";
}
leaf instance-id {
type uint64;
description
"64-bit Instance-ID.";
reference
"RFC 7752: Link-State Info Distribution Using BGP.";
}
leaf asn-plus-bgp-ls-ids {
type uint32;
description
"A pair of ASN and BGP-LS identifiers per flooding set
in which the node participates.";
reference
"RFC 7752: Link-State Info Distribution Using BGP.";
}
}
container tlvs {
config false;
description
"Container for BGP-LS attribute TLVs.";
list tlv {
description
"List of all TLVs.";
container multi-topology-identifier {
description
"Multi Topo Identifier TLV.";
leaf type {
type identityref {
base attribute-type;
}
description
"Type should be of value 263.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Jethanandani & Patel Expires 12 April 2024 [Page 13]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
Using BGP.";
}
leaf length {
type uint16;
units octets;
description
"The length of the TLV in octets.";
reference
"RFC 8654: Extended Message Support for BGP.";
}
leaf-list value {
type uint16 {
range 0..2048;
}
description
"Leaf list of Multi Topology IDs.";
}
}
container node-flag-bits {
description
"Node Flag Bits TLV.";
leaf type {
type identityref {
base attribute-type;
}
description
"The type should be 1024";
}
leaf length {
type uint8 {
range 0..1;
}
description
"The length of this TLV in octets.";
}
leaf value {
type bits {
bit overload {
position 0;
description
"Overload bit.";
reference
Jethanandani & Patel Expires 12 April 2024 [Page 14]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"ISO10589: International Organization for
Standardization, Intermediate System to
Intermediate System intra-domain
routeing information exchange protocol for use
in conjunction with the protocol for providing
the connectionless-mode network service
(ISO 8473), ISO/IEC 10589, November 2002.";
}
bit attached {
position 1;
description
"Attached bit.";
reference
"ISO10589: International Organization for
Standardization, Intermediate System to
Intermediate System intra-domain
routeing information exchange protocol for use
in conjunction with the protocol for providing
the connectionless-mode network service
(ISO 8473), ISO/IEC 10589, November 2002.";
}
bit external {
position 2;
description
"External bit.";
reference
"RFC 2328: OSPF Version 2.";
}
}
description
"The value of this TLV.";
}
}
container opaque-node-attribute {
description
"Opaque Node Attribute TLV.";
leaf type {
type identityref {
base attribute-type;
}
description
"The type should be 1025";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Jethanandani & Patel Expires 12 April 2024 [Page 15]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
Using BGP.";
}
leaf length {
type uint16 {
range 0..max;
}
units octets;
description
"The length of the TLV in octets.";
reference
"RFC 8654: Extended Message Support for BGP.";
}
leaf-list value {
type uint16 {
range 0..2048;
}
description
"Leaf list of Opaque Node Attribute TLV.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
}
container node-name {
description
"Node Name TLV.";
leaf type {
type identityref {
base attribute-type;
}
description
"The type should be 1026";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
leaf length {
type uint16 {
range 0..max;
}
units octets;
description
"The length of the TLV in octets.";
Jethanandani & Patel Expires 12 April 2024 [Page 16]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
reference
"RFC 8654: Extended Message Support for BGP.";
}
leaf-list value {
type uint16 {
range 0..2048;
}
description
"Leaf list of Node Name TLV.";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
}
container isis-area-identifier {
description
"IS-IS Area Identifier TLV.";
leaf type {
type identityref {
base attribute-type;
}
description
"The type should be 1027";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
leaf length {
type uint16 {
range 0..max;
}
units octets;
description
"The length of the TLV in octets.";
reference
"RFC 8654: Extended Message Support for BGP.";
}
leaf-list value {
type uint16 {
range 0..2048;
}
description
"Leaf list of IS-IS Area Identifier TLV.";
Jethanandani & Patel Expires 12 April 2024 [Page 17]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
}
container ipv4-router-id {
description
"IPv4 Router-ID of Local Node TLV.";
leaf type {
type identityref {
base attribute-type;
}
description
"The type should be 1028";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
leaf length {
type uint8 {
range 0..4;
}
description
"4-octet router-id of the router originating the LSP.";
reference
"RFC 5305: IS-IS Extenstions for Traffic Engineering.";
}
leaf value {
type uint16 {
range 0..max;
}
description
"4-octet router-id of the router originating the LSP.";
reference
"RFC 5305: IS-IS Extenstions for Traffic Engineering.";
}
}
container ipv6-router-id {
description
"IPv6 Router-ID of Local Node TLV.";
leaf type {
type identityref {
Jethanandani & Patel Expires 12 April 2024 [Page 18]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
base attribute-type;
}
description
"The type should be 1029";
reference
"I-D.ietf-idr-rfc7752-bis: Link State Info Distribution
Using BGP.";
}
leaf length {
type uint8 {
range 0..16;
}
description
"16-octet router-id of the router originating the LSP.";
reference
"RFC 6119: IPv6 Traffic Engineering in IS-IS.";
}
leaf value {
type uint16 {
range 0..max;
}
description
"16-octet router-id of the router originating the LSP.";
reference
"RFC 6119: IS-IS Traffic Engineering in IS-IS.";
}
}
uses unknown-tlvs;
}
}
}
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";
Jethanandani & Patel Expires 12 April 2024 [Page 19]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
uses bgp:mp-all-afi-safi-common;
}
}
grouping tlv {
description
"Generic grouping for all TLVs.";
leaf type {
type identityref {
base attribute-type;
}
description
"TLV type.";
}
leaf length {
type uint16;
description
"TLV length in octets.";
}
leaf value {
type yang:hex-string;
description
"TLV value in the form of a hex string.";
}
}
grouping unknown-tlvs {
description
"Unknown TLVs grouping. Used for unknown TLVs or
unknown sub-TLVs.";
container unknown-tlvs {
description
"All unknown TLVs.";
list unknown-tlv {
description
"Unknown TLV.";
uses tlv;
}
}
}
augment "/rt:routing/rt:control-plane-protocols" +
"/rt:control-plane-protocol/bgp:bgp/bgp:global" +
"/bgp:afi-safis/bgp:afi-safi" {
Jethanandani & Patel Expires 12 April 2024 [Page 20]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
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 {
Jethanandani & Patel Expires 12 April 2024 [Page 21]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
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 {
Jethanandani & Patel Expires 12 April 2024 [Page 22]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
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.";
Jethanandani & Patel Expires 12 April 2024 [Page 23]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
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" +
Jethanandani & Patel Expires 12 April 2024 [Page 24]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"/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 7752: Link-State Info Distribution Using BGP.";
}
leaf updates-received {
type yang:zero-based-counter32;
description
"Total number of Link-State NLRI updates received.";
reference
"RFC 7752: Link-State Info Distribution Using BGP.";
}
leaf local-ls-originated {
type yang:zero-based-counter32;
description
"Total number of locally originated Link-State NLRIs.";
reference
"RFC 7752: Link-State Info Distribution 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.";
}
Jethanandani & Patel Expires 12 April 2024 [Page 25]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
}
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
Jethanandani & Patel Expires 12 April 2024 [Page 26]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
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 7752: Link-State Info Distribution Using BGP.";
}
leaf updates-received {
type yang:zero-based-counter32;
description
"Total number of Link-State NLRIs updates received per
neighbor.";
reference
"RFC 7752: Link-State Info Distribution Using BGP.";
}
Jethanandani & Patel Expires 12 April 2024 [Page 27]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
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 7752: Link-State Info Distribution Using BGP.";
}
leaf computations {
type yang:zero-based-counter32;
description
"Count of number of SPF computations made.";
reference
"I-D.ietf-lsvr-bgp-spf: BGP Link-State SPF Routing.";
}
leaf triggering-events {
type yang:zero-based-counter32;
description
"SPF triggering events.";
reference
"I-D.ietf-lsvr-bgp-spf: 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.";
}
}
Jethanandani & Patel Expires 12 April 2024 [Page 28]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
}
}
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;
}
}
<CODE ENDS>
Figure 2: YANG Model for BGP-LS, BGP-LS-VPN, BGP-LS-SPF
4.2. BGP Link-State Database YANG model
The model imports Common YANG Data Types [RFC6991]
<CODE BEGINS> file "ietf-bgp-lsdb@2023-10-10.yang"
module ietf-bgp-lsdb {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-bgp-lsdb";
prefix bgp-lsdb;
import ietf-yang-types {
prefix yang;
reference
"RFC 6991: Common YANG Data Types.";
}
import ietf-inet-types {
prefix inet;
reference
"RFC 6991: Common YANG Data Types.";
}
Jethanandani & Patel Expires 12 April 2024 [Page 29]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
organization
"IETF LSVR Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/lsvr>
WG List: <lsvr@ietf.org>
Authors: Mahesh Jethanandani (mjethanandani at gmail.com),
Keyur Patel (keyur at arrcus.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 2023-10-10 {
description
"Initial Version";
reference
"RFC XXXX, BGP Model for Link State Distribution.";
}
// Typedefs
typedef lsdb-proto-id-type {
type enumeration {
enum unknown {
description "Unknown protocol.";
}
enum isis-level1 {
description "IS-IS Level 1.";
Jethanandani & Patel Expires 12 April 2024 [Page 30]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
}
enum isis-level2 {
description "IS-IS Level 2.";
}
enum ospfv2 {
description "OSPF Version 2.";
}
enum direct {
description "Direct.";
}
enum static {
description "Static";
}
enum ospfv3 {
description "OSPF Version 3.";
}
enum bgp {
description "BGP.";
}
}
description
"LS database proto id type.";
}
typedef lsdb-attr-type {
type enumeration {
enum unknown {
description
"Unknown attribute.";
}
enum node-pdu-auth-info {
description
"Node authentication information attribute.";
}
enum node-hostname {
description
"Node Hostname attribute.";
}
enum node-flags {
description
"Node Flags attribute.";
}
enum node-opaque {
description
"Node Opaque attribute.";
}
enum node-as {
description
Jethanandani & Patel Expires 12 April 2024 [Page 31]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"Node AS Number attribute.";
}
enum node-isis-node-id {
description
"Node ISIS Node-Id attribute.";
}
enum node-ipv4-rtr-id {
description
"Node IPv4 Router-Id attribute.";
}
enum node-ipv6-rtr-id {
description
"Node IPv6 Router-Id attribute.";
}
enum node-sid-index {
description
"Node SID Index attribute.";
}
enum node-topo-ids {
description
"Node Topology-IDs attribute.";
}
enum node-isis-nlpid {
description
"Node NLPID attribute.";
}
enum node-isis-area-id {
description
"Node ISIS Area-Id attribute.";
}
enum node-ospf-area-id {
description
"Node OSPF Area-Id attribute.";
}
enum node-admin-tag {
description
"Node Admin-Tags attribute.";
}
enum node-srgb-range {
description
"Node SRGB Range attribute.";
}
enum node-spf-status {
description
"Node SPF Status attribute.";
}
enum node-spf-algorithm {
description
Jethanandani & Patel Expires 12 April 2024 [Page 32]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"Node SPF Algorithm Type attribute.";
}
enum link-name {
description
"Link Name attribute.";
}
enum link-proto-id {
description
"Link Protocol-Id attribute.";
}
enum link-local-id {
description
"Link Local-Id attribute.";
}
enum link-remote-id {
description
"Node Remote-Id attribute.";
}
enum link-local-isis-node-id {
description
"Link Local ISO Node-Id attribute.";
}
enum link-remote-isis-node-id {
description
"Link Remote ISO Node-Id attribute.";
}
enum link-local-ipv4-rtr-id {
description
"Link Local IPv4 Router-Id attribute.";
}
enum link-remote-ipv4-rtr-id {
description
"Link Remote IPv4 Router-Id attribute.";
}
enum link-local-ipv6-rtr-id {
description
"Link Local IPv6 Router-Id attribute.";
}
enum link-remote-ipv6-rtr-id {
description
"Link Remote IPv6 Router-Id attribute.";
}
enum link-circuit-id {
description
"Link Local Circuit-Id attribute.";
}
enum link-igp-metric {
description
Jethanandani & Patel Expires 12 April 2024 [Page 33]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"Link IGP metric attribute.";
}
enum link-mtu {
description
"Link MTU attribute.";
}
enum link-max-bandwidth {
description
"Link Maximum Bandwidth attribute.";
}
enum link-max-reserve-bandwidth {
description
"Link Maximum Reserved Bandwidth attribute.";
}
enum link-unreserve-bandwidth {
description
"Link Unreserved Bandwidth attribute.";
}
enum link-default-te-metric {
description
"Link TE-Default Metric attribute.";
}
enum link-protection-type {
description
"Link Protection-Type attribute.";
}
enum link-opaque {
description
"Link Opaque attribute.";
}
enum link-mpls-proto-mask {
description
"Link MPLS-Protocol-Mask attribute.";
}
enum lsdb-link-local-ipv4-addr {
description
"Link Local IPv4 Address attribute.";
}
enum lsdb-link-local-ipv6-addr {
description
"Link Local IPv6 Address attribute.";
}
enum lsdb-link-remote-ipv4-addr {
description
"Link Remote IPv4 Address attribute.";
}
enum lsdb-link-remote-ipv6-addr {
description
Jethanandani & Patel Expires 12 April 2024 [Page 34]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"Link Remote IPv6 Address attribute.";
}
enum lsdb-link-isis-level {
description
"Link ISIS Level attribute.";
}
enum lsdb-link-admin-tag {
description
"Link Admin-Tag attribute.";
}
enum lsdb-link-srlg {
description
"Link SRLGs attribute.";
}
enum lsdb-link-spf-status {
description
"Link SPF Status attribute.";
}
enum lsdb-prefix-igp-flags {
description
"Prefix IGP-Flags attribute.";
}
enum lsdb-prefix-metric {
description
"Prefix Metric attribute.";
}
enum lsdb-prefix-ospf-forwarding-address {
description
"Prefix OSPF-Forwarding-Address attribute.";
}
enum lsdb-prefix-ospf-route-type {
description
"Prefix OSPF-Route-Type attribute.";
}
enum lsdb-prefix-opaque {
description
"Prefix Opaque attribute.";
}
enum lsdb-prefix-route-tags {
description
"Prefix Route-Tags attribute.";
}
enum lsdb-prefix-ext-route-tags {
description
"Prefix Extended-Route-Tags attribute.";
}
enum lsdb-prefix-spf-status {
description
Jethanandani & Patel Expires 12 April 2024 [Page 35]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
"Prefix SPF Status attribute.";
}
}
description
"Link-State database attribute type.";
}
typedef lsdb-obj-type {
type enumeration {
enum lsdb-unknown-obj {
description
"Unknown attribute.";
}
enum lsdb-node-obj {
description
"Node Object.";
}
enum lsdb-link-obj {
description
"Link object.";
}
enum lsdb-prefix-obj {
description
"Prefix object.";
}
}
description
"Link-State database object type.";
}
// Groupings
grouping lsdb-obj-common {
description "Common details for all object types.";
leaf handle {
type uint64;
description "Handle of the object.";
}
leaf type {
type lsdb-obj-type;
description "Type of object.";
}
leaf topology-id {
type uint16;
description "Id of the topology object belongs to.";
}
Jethanandani & Patel Expires 12 April 2024 [Page 36]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
leaf pdu-id {
type uint32;
description
"Id of the original protocol PDU unit this object belongs
to.";
}
container attributes {
description
"List of attributes for a given object.";
list attribute {
key "attribute-handle attribute-type";
leaf attribute-handle {
type uint64;
description
"Handle of the attribute.";
}
leaf attribute-type {
type lsdb-attr-type;
description
"Type of attribute.";
}
leaf attribute-length {
type uint16;
description
"Length of attribute value in bytes.";
}
leaf attribute-value {
type union {
type uint8;
type uint16;
type uint32;
type uint64;
type boolean;
type string;
type inet:ip-address;
type yang:hex-string;
}
description
"Actual value of the attribute.";
}
description
"Details of a single attribute.";
Jethanandani & Patel Expires 12 April 2024 [Page 37]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
}
}
}
grouping lsdb-top {
description
"Details for all databases under an application instance.";
container local-databases {
config false;
description
"List of local databases.";
list database {
key "vrf-name instance protocol-id area-id";
description
"Operational state for a given database.";
leaf vrf-name {
type string;
description
"Name of the VRF this database belongs to.";
}
leaf instance {
type string;
description
"Name of the application instance this database belongs
to.";
}
leaf protocol-id {
type lsdb-proto-id-type;
description
"Id of the aplication protocol this database belongs
to.";
}
leaf area-id {
type uint32;
description
"Id of the protocol area this database belongs to.";
}
container nodes {
description
"List of node objects for a given database.";
Jethanandani & Patel Expires 12 April 2024 [Page 38]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
list node {
key "handle";
leaf node-id {
type string;
description
"Id of the node object.";
}
uses lsdb-obj-common;
container links {
description
"List of link objects for a given node object.";
list link {
key "handle";
leaf local-id {
type uint32;
description
"Local identifier of the link object.";
}
leaf local-address {
type string;
description
"Local address of the link object.";
}
leaf local-node-id {
type uint32;
description
"Local Node identifier of the link object.";
}
leaf remote-id {
type uint32;
description
"Remote identifier of the link object.";
}
leaf remote-address {
type string;
description
"Remote address of the link object.";
}
leaf remote-node-id {
Jethanandani & Patel Expires 12 April 2024 [Page 39]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
type uint32;
description
"Remote Node identifier of the link object.";
}
uses lsdb-obj-common;
description
"Details of a single link object.";
}
}
container prefixes {
description
"List of prefix objects for a given node object.";
list prefix {
key "handle";
leaf prefix-key {
type string;
description
"Key value for the prefix object.";
}
uses lsdb-obj-common;
description
"Details of a single prefix object.";
}
}
description
"Details of a single node object.";
}
}
}
}
}
}
<CODE ENDS>
Figure 3: YANG Model for Link-State Database
5. IANA Considerations
This memo registers the following namespace URIs in the IETF XML in
the "IETF XML Registry" [RFC3688]:
URI: urn:ietf:params:xml:ns:yang:ietf-bgp-ls
Registrant Contact: The IESG.
Jethanandani & Patel Expires 12 April 2024 [Page 40]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
XML: N/A; the requested URI is an XML namespace.
URI: urn:ietf:params:xml:ns:yang:ietf-bgp-lsdb
Registrant Contact: The IESG.
XML: N/A; the requested URI is an XML namespace.
This document registers the following YANG modules in the "YANG
Module Names" registry [RFC6020]:
Name: ietf-bgp-ls
Namespace: urn:ietf:params:xml:ns:yang:ietf-bgp-ls
Prefix: bgp-ls
Reference: RFC XXXX
Name: ietf-bgp-lsdb
Namespace: urn:ietf:params:xml:ns:yang:ietf-bgp-lsdb
Prefix: bgp-lsdb
Reference: RFC XXXX
6. Security Considerations
The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such
as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
is the secure transport layer, and the mandatory-to-implement secure
transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
is HTTPS, and the mandatory-to-implement secure transport is TLS
[RFC8446].
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 this YANG module that 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 network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability:
Some of the readable data nodes in this YANG module 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. These are the subtrees and data
nodes and their sensitivity/vulnerability:
Jethanandani & Patel Expires 12 April 2024 [Page 41]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
Some of the RPC operations in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control access to these operations. These are the
operations and their sensitivity/vulnerability:
7. References
7.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<https://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC7752] Gredler, H., Ed., Medved, J., Previdi, S., Farrel, A., and
S. Ray, "North-Bound Distribution of Link-State and
Traffic Engineering (TE) Information Using BGP", RFC 7752,
DOI 10.17487/RFC7752, March 2016,
<https://www.rfc-editor.org/info/rfc7752>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<https://www.rfc-editor.org/info/rfc7950>.
Jethanandani & Patel Expires 12 April 2024 [Page 42]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
<https://www.rfc-editor.org/info/rfc8340>.
[RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration
Access Control Model", STD 91, RFC 8341,
DOI 10.17487/RFC8341, March 2018,
<https://www.rfc-editor.org/info/rfc8341>.
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>.
[RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for
Routing Management (NMDA Version)", RFC 8349,
DOI 10.17487/RFC8349, March 2018,
<https://www.rfc-editor.org/info/rfc8349>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>.
[I-D.ietf-idr-bgp-model]
Jethanandani, M., Patel, K., Hares, S., and J. Haas, "YANG
Model for Border Gateway Protocol (BGP-4)", Work in
Progress, Internet-Draft, draft-ietf-idr-bgp-model-17, 5
July 2023, <https://datatracker.ietf.org/doc/html/draft-
ietf-idr-bgp-model-17>.
[I-D.ietf-lsvr-bgp-spf]
Patel, K., Lindem, A., Zandi, S., and W. Henderickx, "BGP
Link-State Shortest Path First (SPF) Routing", Work in
Progress, Internet-Draft, draft-ietf-lsvr-bgp-spf-28, 29
August 2023, <https://datatracker.ietf.org/doc/html/draft-
ietf-lsvr-bgp-spf-28>.
7.2. Informative References
Jethanandani & Patel Expires 12 April 2024 [Page 43]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
Appendix A. Complete Tree Diagram
Here is a complete tree diagram for the configuration and operational
part of the model.
module: ietf-bgp-ls
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:global
/bgp:afi-safis/bgp:afi-safi:
+--rw link-state!
| +--rw prefix-limit
| | +--rw max-prefixes? uint32
| | +--rw shutdown-threshold-pct? rt-types:percentage
| | +--rw restart-timer? uint32
| +--rw max-rate? uint32
| +--rw max-number? uint32
| +--rw instance-id? uint64
| +--rw asn-plus-bgp-ls-ids? uint32
| +--ro local-databases
| +--ro database* [vrf-name instance protocol-id area-id]
| +--ro vrf-name string
| +--ro instance string
| +--ro protocol-id lsdb-proto-id-type
| +--ro area-id uint32
| +--ro nodes
| +--ro node* [handle]
| +--ro node-id? string
| +--ro handle uint64
| +--ro type? lsdb-obj-type
| +--ro topology-id? uint16
| +--ro pdu-id? uint32
| +--ro attributes
| | +--ro attribute*
| | [attribute-handle attribute-type]
| | +--ro attribute-handle uint64
| | +--ro attribute-type lsdb-attr-type
| | +--ro attribute-length? uint16
| | +--ro attribute-value? union
| +--ro links
| | +--ro link* [handle]
| | +--ro local-id? uint32
| | +--ro local-address? string
| | +--ro local-node-id? uint32
| | +--ro remote-id? uint32
| | +--ro remote-address? string
| | +--ro remote-node-id? uint32
| | +--ro handle uint64
Jethanandani & Patel Expires 12 April 2024 [Page 44]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
| | +--ro type? lsdb-obj-type
| | +--ro topology-id? uint16
| | +--ro pdu-id? uint32
| | +--ro attributes
| | +--ro attribute*
| | [attribute-handle attribute-type]
| | +--ro attribute-handle uint64
| | +--ro attribute-type
| | | lsdb-attr-type
| | +--ro attribute-length? uint16
| | +--ro attribute-value? union
| +--ro prefixes
| +--ro prefix* [handle]
| +--ro prefix-key? string
| +--ro handle uint64
| +--ro type? lsdb-obj-type
| +--ro topology-id? uint16
| +--ro pdu-id? uint32
| +--ro attributes
| +--ro attribute*
| [attribute-handle attribute-type]
| +--ro attribute-handle uint64
| +--ro attribute-type
| | lsdb-attr-type
| +--ro attribute-length? uint16
| +--ro attribute-value? union
+--ro tlvs
| +--ro tlv* []
| +--ro multi-topology-identifier
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro node-flag-bits
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? bits
| +--ro opaque-node-attribute
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro node-name
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro isis-area-identifier
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
Jethanandani & Patel Expires 12 April 2024 [Page 45]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
| +--ro ipv4-router-id
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? uint16
| +--ro ipv6-router-id
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? uint16
| +--ro unknown-tlvs
| +--ro unknown-tlv* []
| +--ro type? identityref
| +--ro length? uint16
| +--ro value? yang:hex-string
+--rw link-state-spf
+--rw prefix-limit
| +--rw max-prefixes? uint32
| +--rw shutdown-threshold-pct? rt-types:percentage
| +--rw restart-timer? uint32
+--rw instance-identifier? uint64
+--rw algorithm-type? spf-algorithm-type
+--rw node-status? enumeration
+--ro log
| +--ro event* [id]
| +--ro id uint32
| +--ro type? enumeration
| +--ro schedule-time? yang:date-and-time
| +--ro delay? uint64
| +--ro start-time? yang:date-and-time
| +--ro end-time? yang:date-and-time
| +--ro duration? uint64
| +--ro node-count? uint64
| +--ro prefix-count? uint64
| +--ro route-download-count? uint64
| +--ro lsp-trigger* [id]
| +--ro id uint32
| +--ro nlri-prefix? string
| +--ro nlri-sequence? uint32
| +--ro trigger-time? yang:date-and-time
+--ro local-databases
+--ro database* [vrf-name instance protocol-id area-id]
+--ro vrf-name string
+--ro instance string
+--ro protocol-id lsdb-proto-id-type
+--ro area-id uint32
+--ro nodes
+--ro node* [handle]
+--ro node-id? string
+--ro handle uint64
Jethanandani & Patel Expires 12 April 2024 [Page 46]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
+--ro type? lsdb-obj-type
+--ro topology-id? uint16
+--ro pdu-id? uint32
+--ro attributes
| +--ro attribute*
| [attribute-handle attribute-type]
| +--ro attribute-handle uint64
| +--ro attribute-type lsdb-attr-type
| +--ro attribute-length? uint16
| +--ro attribute-value? union
+--ro links
| +--ro link* [handle]
| +--ro local-id? uint32
| +--ro local-address? string
| +--ro local-node-id? uint32
| +--ro remote-id? uint32
| +--ro remote-address? string
| +--ro remote-node-id? uint32
| +--ro handle uint64
| +--ro type? lsdb-obj-type
| +--ro topology-id? uint16
| +--ro pdu-id? uint32
| +--ro attributes
| +--ro attribute*
| [attribute-handle attribute-type]
| +--ro attribute-handle uint64
| +--ro attribute-type
| | lsdb-attr-type
| +--ro attribute-length? uint16
| +--ro attribute-value? union
+--ro prefixes
+--ro prefix* [handle]
+--ro prefix-key? string
+--ro handle uint64
+--ro type? lsdb-obj-type
+--ro topology-id? uint16
+--ro pdu-id? uint32
+--ro attributes
+--ro attribute*
[attribute-handle attribute-type]
+--ro attribute-handle uint64
+--ro attribute-type
| lsdb-attr-type
+--ro attribute-length? uint16
+--ro attribute-value? union
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:neighbors
/bgp:neighbor/bgp:afi-safis/bgp:afi-safi:
Jethanandani & Patel Expires 12 April 2024 [Page 47]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
+--rw link-state!
| +--rw prefix-limit
| | +--rw max-prefixes? uint32
| | +--rw shutdown-threshold-pct? rt-types:percentage
| | +--rw restart-timer? uint32
| +--rw max-rate? uint32
| +--rw max-number? uint32
| +--rw instance-id? uint64
| +--rw asn-plus-bgp-ls-ids? uint32
+--ro tlvs
| +--ro tlv* []
| +--ro multi-topology-identifier
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro node-flag-bits
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? bits
| +--ro opaque-node-attribute
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro node-name
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro isis-area-identifier
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro ipv4-router-id
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? uint16
| +--ro ipv6-router-id
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? uint16
| +--ro unknown-tlvs
| +--ro unknown-tlv* []
| +--ro type? identityref
| +--ro length? uint16
| +--ro value? yang:hex-string
+--rw link-state-spf
+--rw prefix-limit
| +--rw max-prefixes? uint32
| +--rw shutdown-threshold-pct? rt-types:percentage
Jethanandani & Patel Expires 12 April 2024 [Page 48]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
| +--rw restart-timer? uint32
+--rw metric? uint32
+--rw status? enumeration
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:global
/bgp:afi-safis/bgp:afi-safi/bgp:statistics:
+--ro updates-sent? yang:zero-based-counter32
+--ro updates-received? yang:zero-based-counter32
+--ro local-ls-originated? yang:zero-based-counter32
+---x clear {bt:clear-statistics}?
+---w input
| +---w clear-at? yang:date-and-time
+--ro output
+--ro clear-finished-at? yang:date-and-time
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:global
/bgp:afi-safis/bgp:afi-safi/bgp:statistics:
+--ro scheduled? yang:zero-based-counter64
+--ro computed? yang:zero-based-counter64
+--ro maximum-duration? uint64
+--ro minimum-duration? uint64
+--ro average-duration? uint64
+--ro last-computation-time? yang:date-and-time
augment /rt:routing/rt:control-plane-protocols
/rt:control-plane-protocol/bgp:bgp/bgp:neighbors
/bgp:neighbor/bgp:statistics:
+--rw updates-sent? yang:zero-based-counter32
+--rw updates-received? yang:zero-based-counter32
+--rw error-updates-received? yang:zero-based-counter32
+--rw computations? yang:zero-based-counter32
+--rw triggering-events? yang:zero-based-counter32
+---x clear {bt:clear-statistics}?
+---w input
| +---w clear-at? yang:date-and-time
+--rw output
+--rw clear-finished-at? yang:date-and-time
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:
+--rw link-state!
| +--rw prefix-limit
| | +--rw max-prefixes? uint32
| | +--rw shutdown-threshold-pct? rt-types:percentage
| | +--rw restart-timer? uint32
| +--rw max-rate? uint32
| +--rw max-number? uint32
| +--rw instance-id? uint64
| +--rw asn-plus-bgp-ls-ids? uint32
Jethanandani & Patel Expires 12 April 2024 [Page 49]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
+--ro tlvs
| +--ro tlv* []
| +--ro multi-topology-identifier
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro node-flag-bits
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? bits
| +--ro opaque-node-attribute
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro node-name
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro isis-area-identifier
| | +--ro type? identityref
| | +--ro length? uint16
| | +--ro value* uint16
| +--ro ipv4-router-id
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? uint16
| +--ro ipv6-router-id
| | +--ro type? identityref
| | +--ro length? uint8
| | +--ro value? uint16
| +--ro unknown-tlvs
| +--ro unknown-tlv* []
| +--ro type? identityref
| +--ro length? uint16
| +--ro value? yang:hex-string
+--rw link-state-spf
+--rw prefix-limit
| +--rw max-prefixes? uint32
| +--rw shutdown-threshold-pct? rt-types:percentage
| +--rw restart-timer? uint32
+--rw metric? uint32
+--rw status? enumeration
Figure 4: Complete tree diagram
Jethanandani & Patel Expires 12 April 2024 [Page 50]
Internet-Draft BGP LS, LS-VPN, LS-SPF YANG Model October 2023
Acknowledgements
TBA
Contributors
Thanks to all of the contributors.
Authors' Addresses
Mahesh Jethanandani (editor)
Arrcus, Inc
Email: mjethanandani@gmail.com
Keyur Patel
Arrcus, Inc
Email: keyur@arrcus.com
Jethanandani & Patel Expires 12 April 2024 [Page 51]
