Internet-Draft BWA Topo YANG Model October 2023
Ahlberg, et al. Expires 20 April 2024 [Page]
CCAMP Working Group
Intended Status:
Standards Track
J. Ahlberg
Ericsson AB
S. Mansfield
Ericsson Inc
M. Ye
Huawei Technologies
I. Busi
Huawei Technologies
X. Li
NEC Laboratories Europe
D. Spreafico
Nokia - IT

A YANG Data Model for Bandwidth Availability Topology


This document defines a YANG data model to describe bandwidth availability for a link in a network topology.

About This Document

This note is to be removed before publishing as an RFC.

The latest revision of this draft can be found at Status information for this document may be found at

Discussion of this document takes place on the CCAMP Working Group mailing list (, which is archived at Subscribe at

Source for this draft and an issue tracker can be found at

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

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 20 April 2024.

Table of Contents

1. Introduction

This document defines a YANG data model to describe bandwidth availability for a link. It is an important characteristic of links with variable bandwidth, where each level of bandwidth can be associated with a certain level of availability. An example of such a link is microwave radio link, where the bandwidth can be dynamically adapted to changing signal conditions, impacted by interference & fading, in order to guarantee the required quality of the link at every single moment. [RFC8330] defines a mechanism to report bandwidth-availability information through OSPF-TE, but it could also be useful for a controller to access such bandwidth-availability information as part of the topology model when performing a path/route computation. The model augments "YANG Data Model for Traffic Engineering (TE) Topologies" defined in [RFC8795], which is based on "A YANG Data Model for Network Topologies" defined in [RFC8345].

The bandwidth availability model is expected to be used between a Provisioning Network Controller (PNC) and a Multi Domain Service Coordinator(MDSC) [RFC8453]. Examples of use cases that can be supported are:

  1. Propagation of relevant characteristics of a link, including bandwidth availability, to higher topology layers, where it e.g. could be used as a criterion when configuring and optimizing a path for a connection/service through the network end to end.

  2. A link could dynamically adjust its bandwidth according to changes in the signal conditions. [RFC8330] defines a mechanism to report bandwidth-availability information through OSPF-TE, but it could also be useful for a controller to access such bandwidth-availability information as part of the topology model when performing a path/route computation.

1.1. Terminology and Definitions

The following acronyms are used in this document:

PNC Provisioning Network Controller

MDSC Multi Domain Service Coordinator

1.2. Tree Structure

A simplified graphical representation of the data model is used in chapter 3.1 of this document. The meaning of the symbols in these diagrams is defined in [RFC8340].

2. 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.

3. Bandwidth Availability Topology YANG Data Model

3.1. YANG Tree

module: ietf-bandwidth-availability-topology

  augment /nw:networks/nw:network/nt:link/tet:te
    +---u link-bw-availability-table

3.2. Bandwidth Availability Topology YANG Data Module

<CODE BEGINS> file "ietf-bandwidth-availability-topology.yang"

module ietf-bandwidth-availability-topology {
   yang-version "1.1";
   prefix "bwatopo";

   import ietf-yang-types {
     prefix yang;
       "RFC 6991";

   import ietf-network {
     prefix "nw";
     reference "RFC 8345: A YANG Data Model for Network Topologies";

   import ietf-network-topology {
     prefix "nt";
     reference "RFC 8345: A YANG Data Model for Network Topologies";

   import ietf-te-topology {
     prefix "tet";
     reference "RFC 8795: YANG Data Model for Traffic Engineering
                (TE) Topologies";

     "Internet Engineering Task Force (IETF) CCAMP WG";
     "WG List: <>

      Editor: Jonas Ahlberg
      Editor: Scott Mansfield
      Editor: Min Ye
      Editor: Italo Busi
      Editor: Xi Li
      Editor: Daniela Spreafico

     "This is a module for defining bandwidth availability matrix,
      for links in a topology. It is intended to be used in
      conjunction with an instance of ietf-network-topology and its

      Example use cases include:
      - Defining bandwidth availability matrix for a microwave link
      - Defining bandwidth availability matrix for a LAG link
        comprising of two or more member links

     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

     This version of this YANG module is part of RFC XXXX
     (; see the RFC itself for
     full legal notices.";

   revision 2023-02-15 {
     "First rough draft.";
     reference "";

    * Groupings
   grouping link-bw-availability-table {

     description "Grouping used for bandwidth availability.";

     list link-availability{
       key "availability";
         "Table describing the bandwidths available at corresponding
          availability level for a link.";

       leaf availability {
         type decimal64 {
           fraction-digits 4;
           range "0..99.9999";
         description "Availability level";

       leaf link-bandwidth {
         type uint64;
         units "Kbps";

           "The link bandwidth corresponding to the availability
     leaf actual-bandwidth{
       type yang:gauge64;
       units "bits/second";
       config false;
         "An estimate of the link's current bandwidth in bits per
          second. Related to the data node speed in RFC 8343.";
         "RFC 8343: A YANG Data Model for Interface Management";

    * Data nodes

   augment "/nw:networks/nw:network/nt:link/tet:te/"
           + "tet:te-link-attributes" {
       "Augmenting link with link bandwidth availability matrix.";
     uses link-bw-availability-table;


4. Security Considerations

The YANG module specified in this document defines schemas 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 NETCONF access control model [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.

The YANG module specified in this document imports and augments the ietf-network and ietf-network-topology models defined in [RFC8345]. The security considerations from [RFC8345] are applicable to the module in this document.

There are a several 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 data nodes and their sensitivity/vulnerability:

In the "ietf-bandwidth-availability-topology" module:

5. IANA Considerations

IANA is asked to assign a new URI from the "IETF XML Registry" [RFC3688] as follows:

URI: urn:ietf:params:xml:ns:yang:ietf-bandwidth-availability-topology
Registrant Contact: The IESG
XML: N/A; the requested URI is an XML namespace.

It is proposed that IANA should record YANG module names in the "YANG Module Names" registry [RFC6020] as follows:

    Name: ietf-bandwidth-availability-topology
    Maintained by IANA?: N
    Prefix: bwavtopo
    Reference: RFC XXXX

6. References

6.1. Normative References

Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, , <>.
Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, , <>.
Bjorklund, M., Ed., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, DOI 10.17487/RFC6020, , <>.
Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, , <>.
Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, , <>.
Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, , <>.
Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, , <>.
Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, , <>.
Clemm, A., Medved, J., Varga, R., Bahadur, N., Ananthakrishnan, H., and X. Liu, "A YANG Data Model for Network Topologies", RFC 8345, DOI 10.17487/RFC8345, , <>.
Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, , <>.
Liu, X., Bryskin, I., Beeram, V., Saad, T., Shah, H., and O. Gonzalez de Dios, "YANG Data Model for Traffic Engineering (TE) Topologies", RFC 8795, DOI 10.17487/RFC8795, , <>.

6.2. Informative References

Long, H., Ye, M., Mirsky, G., D'Alessandro, A., and H. Shah, "OSPF Traffic Engineering (OSPF-TE) Link Availability Extension for Links with Variable Discrete Bandwidth", RFC 8330, DOI 10.17487/RFC8330, , <>.
Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, , <>.
Ceccarelli, D., Ed. and Y. Lee, Ed., "Framework for Abstraction and Control of TE Networks (ACTN)", RFC 8453, DOI 10.17487/RFC8453, , <>.

Appendix A. Examples of the application of the Bandwidth Availability Topology Model

This appendix provides some examples and illustrations of how the Bandwidth Availability Topology Model can be used. There is one extended tree to illustrate the model and a JSON based instantiation for a small network example.

A.1. A tree for a the Bandwidth Availability Topology Model

The tree below shows the leafs for the Bandwidth Availability Model including the augmented Network Topology Model defined in [RFC8345] and Traffic Engineering (TE) Topologies model defined in [RFC8795].

module: ietf-network
  +--rw networks
     +--rw network* [network-id]
        +--rw network-id                network-id
        +--rw nt:link* [link-id]
           +--rw nt:link-id               link-id
           +--rw tet:te!
              +--rw tet:te-link-attributes
                 +--rw bwatopo:link-availability* [availability]
                 |  +--rw bwatopo:availability      decimal64
                 |  +--rw bwatopo:link-bandwidth?   uint64
                 +--ro bwatopo:actual-bandwidth?    yang:gauge64

A.2. A JSON example

  "ietf-network:networks": {
    "network": [
        "network-id": "Generic-network",
        "network-types": {
          "ietf-te-topology:te-topology": {
            "ietf-eth-te-topology:eth-tran-topology": {}
        "node": [
            "node-id": "Generic-N1",
            "ietf-network-topology:termination-point": [
                "tp-id": "Generic-N1-TP1"
            "node-id": "Generic-N2",
            "ietf-network-topology:termination-point": [
                "tp-id": "Generic-N2-TP2"
        "ietf-network-topology:link": [
            "link-id": "Generic-N1-N2",
            "source": {
              "source-node": "Generic-N1",
              "source-tp": "Generic-N1-TP1"
            "destination": {
              "dest-node": "Generic-N2",
              "dest-tp": "Generic-N2-TP2"
            "ietf-te-topology:te": {
              "te-link-attributes": {
      "ietf-bandwidth-availability-topology:link-availability": [
                    "availability": "0.999",
                    "link-bandwidth": "20000000"


This document was prepared using kramdown

The authors would like to thank ...

Authors' Addresses

Jonas Ahlberg
Ericsson AB
Lindholmspiren 11
SE-417 56 Goteborg
Scott Mansfield
Ericsson Inc
Min Ye
Huawei Technologies
No.1899, Xiyuan Avenue
Italo Busi
Huawei Technologies
Xi Li
NEC Laboratories Europe
Kurfursten-Anlage 36
69115 Heidelberg
Daniela Spreafico
Nokia - IT
Via Energy Park, 14
20871 Vimercate (MI)