A YANG Data Model for Microwave Topology

A YANG Data Model for Microwave Topology Ericsson

jonas.ahlberg@ericsson.com

Ericsson

scott.mansfield@ericsson.com

Huawei Technologies

amy.yemin@huawei.com

Huawei Technologies

italo.busi@huawei.com

NEC Laboratories Europe

xi.li@neclab.eu

Nokia - IT

daniela.spreafico@nokia.com

Routing ccamp Internet-Draft This document defines a YANG data model to describe microwave/millimeter radio links in a network topology. Discussion Venues Source for this draft and an issue tracker can be found at .

Introduction This document defines a YANG data model to describe topologies of microwave/millimeter wave (hereafter microwave is used to simplify the text). The YANG data model describes radio links, supporting carrier(s) and the associated termination points. A carrier is a description of a link providing transport capacity over the air by a single carrier. It is typically defined by its transmitting and receiving frequencies. A radio link is a link providing the aggregated transport capacity of the supporting carriers in aggregated and/or protected configurations, which can be used to carry traffic on higher topology layers such as Ethernet and TDM. The model augments "YANG Data Model for Traffic Engineering (TE) Topologies" defined in , which is based on "A YANG Data Model for Network Topologies" defined in . The microwave point-to-point radio technology provides connectivity on L0/L1 over a radio link between two termination points, using one or several supporting carriers in aggregated or protected configurations. That application of microwave technology cannot be used to perform cross-connection or switching of the traffic to create network connectivity across multiple microwave radio links. Instead, a payload of traffic on higher topology layers, normally L2 Ethernet, is carried over the microwave radio link and when the microwave radio link is terminated at the endpoints, cross-connection and switching can be performed on that higher layer creating connectivity across multiple supporting microwave radio links. The microwave topology model is expected to be used between a Provisioning Network Controller (PNC) and a Multi Domain Service Coordinator(MDSC) . Examples of use cases that can be supported are:

Correlation between microwave radio links and the supported links on higher topology layers. e.g. an L2 Ethernet topology. This information can be used to understand how changes in the performance/status of a microwave radio link affect traffic on higher layers.
Propagation of relevant characteristics of a microwave radio link, such as bandwidth, 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.
Optimization of the microwave radio link configurations on a network level, e.g. with the purpose to minimize overall interference and/or maximize the overall capacity provided by the links.

Terminology and Definitions The following acronyms are used in this document: PNC Provisioning Network Controller MDSC Multi Domain Service Coordinator

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 .

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 when, and only when, they appear in all capitals, as shown here.

Microwave Topology YANG Data Model

YANG Tree

Relationship between radio links and carriers A microwave radio link is always an aggregate of one or multiple carries, in various configurations/modes. The supporting carriers are identified by its termination points and are listed in the container bundled-links as part of the te-link-config in the YANG Data Model for Traffic Engineering (TE) Topologies for a radio-link. The exact configuration of the included carriers is further specified in the rlt-mode container (1+0, 2+0, 1+1, etc.) for the radio-link. Appendix A includes JSON examples of how such a relationship can be modelled.

Relationship with client topology model A microwave radio link carries a payload of traffic on higher topology layers, normally L2 Ethernet. The leafs supporting-network, supporting-node, supporting-link, and supporting-termination-point in the generic YANG module for Network Topologies are expected to be used to model a relationship/dependency from higher topology layers to a supporting microwave radio link topology layer. Appendix A includes JSON examples of an L2 Ethernet link transported over one supporting microwave link.

Applicability of the Data Model for Traffic Engineering (TE) Topologies Since microwave is a point-to-point radio technology providing connectivity on L0/L1 over a radio link between two termination points and cannot be used to perform cross-connection or switching of the traffic to create network connectivity across multiple microwave radio links, a majority of the leafs in the Data Model for Traffic Engineering (TE) Topologies augmented by the microwave topology model are not applicable. An example of which leafs are considered applicable can be found in appendices and in this document. More specifically, admin-status and oper-status are recommended to be reported for links only. Status for termination points can be used when links are inter-domain and when the status of only one side of link is known, but since microwave is a point-to-point technology where both ends normally belong to the same domain it is not expected to be applicable in normal cases. Furthermore, admin-status is not applicable for microwave radio links. Enable and disable of a radio link is instead done in the constituent carriers.

Microwave Topology YANG Module WG List: Editor: Jonas Ahlberg Editor: Scott Mansfield Editor: Min Ye Editor: Italo Busi Editor: Xi Li Editor: Daniela Spreafico "; description "This is a module for microwave topology. 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; see the RFC itself for full legal notices."; revision 2023-02-15 { description "Draft to be used as a basis for the continued microwave team discussions"; reference ""; } grouping rlt-mode { description "This grouping provides a flexible definition of number of bonded carriers and protecting carriers of a radio link."; leaf num-bonded-carriers { type uint32; mandatory true; description "Number of bonded carriers."; } leaf num-protecting-carriers { type uint32; mandatory true; description "Number of protecting carriers."; } } grouping microwave-radio-link-attributes { description "Grouping used for attributes describing a microwave radio link."; container rlt-mode { description "This grouping provides a flexible definition of number of bonded carriers and protecting carriers of a radio link."; uses rlt-mode; } } grouping microwave-carrier-attributes { description "Grouping used for attributes describing a microwave carrier."; leaf tx-frequency { type uint32; units "kHz"; description "Selected transmitter frequency. Related to the data node tx-frequency in RFC 8561."; reference "RFC 8561: A YANG Data Model for Microwave Radio Link"; } leaf rx-frequency { type uint32; units "kHz"; description "Selected receiver frequency. Related to the data node actual-rx-frequency in RFC 8561."; reference "RFC 8561: A YANG Data Model for Microwave Radio Link"; } leaf channel-separation { type uint32; units "kHz"; description "The amount of bandwidth allocated to a carrier. The distance between adjacent channels in a radio frequency channels arrangement. Related to the data node channel-separation in RFC 8561."; reference "ETSI EN 302 217-1 and RFC 8561: A YANG Data Model for Microwave Radio Link"; } leaf actual-tx-cm { type identityref { base mw-types:coding-modulation; } config false; description "Actual coding/modulation in transmitting direction. Related to the data node actual-tx-cm in RFC 8561."; reference "RFC 8561: A YANG Data Model for Microwave Radio Link"; } leaf actual-snir { type decimal64 { fraction-digits 1; range "0..99"; } units "dB"; config false; description "Actual signal to noise plus the interference ratio (0.1 dB resolution). Related to the data node actual-snir in RFC 8561."; reference "RFC 8561: A YANG Data Model for Microwave Radio Link"; } leaf actual-transmitted-level { type decimal64 { fraction-digits 1; range "0..99"; } units "dBm"; config false; description "Actual transmitted power level (0.1 dBm resolution). Related to the data node actual-transmitted-level in RFC 8561."; reference "ETSI EN 301 129 and RFC 8561: A YANG Data Model for Microwave Radio Link"; } } grouping microwave-bandwidth { description "Grouping used for microwave bandwidth."; leaf mw-bandwidth { type uint64; units "Kbps"; config false; description "Nominal microwave radio link and carrier bandwidth."; } } augment "/nw:networks/nw:network/nw:network-types/" + "tet:te-topology" { description "Augment network types to define a microwave network topology type."; container mw-topology { presence "Indicates a topology type of microwave."; description "Microwave topology type"; } } augment "/nw:networks/nw:network/nw:node/nt:termination-point/" + "tet:te" { when '../../../nw:network-types/tet:te-topology/' + 'mwtopo:mw-topology' { description "Augmentation parameters apply only for networks with an microwave network topology type."; } description "Augmentation to add microwave technology specific characteristics to a termination point."; container mw-tp-choice { description "Specification of type of termination point."; choice mw-tp-option { description "Selection of type of termination point."; case microwave-rltp { container "microwave-rltp" { presence "Denotes a microwave radio link termination point. It corresponds to a microwave RLT interface as defined in RFC 8561."; description "Denotes and describes a microwave radio link termination point."; } } case microwave-ctp { container "microwave-ctp" { presence "Denotes a microwave carrier termination point. It corresponds to a microwave CT interface as defined in RFC 8561."; description "Denotes and describes a microwave carrier termination point."; } } } } } augment "/nw:networks/nw:network/nt:link/tet:te/" + "tet:te-link-attributes" { when '../../../nw:network-types/tet:te-topology/' + 'mwtopo:mw-topology' { description "Augmentation parameters apply only for networks with an microwave network topology type."; } description "Augmentation to add microwave technology specific characteristics to a link."; container mw-link-choice { description "Specification of type of link."; choice mw-link-option { description "Selection of type of link."; case microwave-radio-link { container "microwave-radio-link" { presence "Denotes a microwave radio link"; uses microwave-radio-link-attributes; description "Denotes and describes a microwave radio link"; } } case microwave-carrier { container "microwave-carrier" { presence "Denotes a microwave carrier"; uses microwave-carrier-attributes; description "Denotes and describes a microwave carrier"; } } } } } augment "/nw:networks/nw:network/nt:link/tet:te/" + "tet:te-link-attributes/" + "tet:max-link-bandwidth/" + "tet:te-bandwidth/tet:technology" { when '../../../../../nw:network-types/tet:te-topology/' + 'mwtopo:mw-topology' { description "Augmentation parameters apply only for networks with an microwave network topology type."; } description "Augmentation for TE bandwidth."; case microwave { uses microwave-bandwidth; } } } ]]>

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 or RESTCONF . The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) . The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS . The NETCONF access control model 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 . The security considerations from 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 subtrees and data nodes and their sensitivity/vulnerability:

rlt-mode: A malicious client could attempt to modify the mode in which the radio link is configured and thereby change the intended behaviour of the link.
tx-frequency, rx-frequency and channel-separation: A malicious client could attempt to modify the frequency configuration of a carrier which could modify the intended behaviour or make the configurtion invalid and thereby stop the operation of it.

IANA Considerations IANA is asked to assign a new URI from the "IETF XML Registry" as follows: It is proposed that IANA should record YANG module names in the "YANG Module Names" registry as follows:

References Normative References YANG Data Model for Traffic Engineering (TE) Topologies This document defines a YANG data model for representing, retrieving, and manipulating Traffic Engineering (TE) Topologies. The model serves as a base model that other technology-specific TE topology models can augment. A YANG Data Model for Network Topologies This document defines an abstract (generic, or base) YANG data model for network/service topologies and inventories. The data model serves as a base model that is augmented with technology-specific details in other, more specific topology and inventory data models. Key words for use in RFCs to Indicate Requirement Levels In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings. Network Configuration Protocol (NETCONF) The Network Configuration Protocol (NETCONF) defined in this document provides mechanisms to install, manipulate, and delete the configuration of network devices. It uses an Extensible Markup Language (XML)-based data encoding for the configuration data as well as the protocol messages. The NETCONF protocol operations are realized as remote procedure calls (RPCs). This document obsoletes RFC 4741. [STANDARDS-TRACK] RESTCONF Protocol This document describes an HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in the Network Configuration Protocol (NETCONF). Using the NETCONF Protocol over Secure Shell (SSH) This document describes a method for invoking and running the Network Configuration Protocol (NETCONF) within a Secure Shell (SSH) session as an SSH subsystem. This document obsoletes RFC 4742. [STANDARDS-TRACK] The Transport Layer Security (TLS) Protocol Version 1.3 This document specifies version 1.3 of the Transport Layer Security (TLS) protocol. TLS allows client/server applications to communicate over the Internet in a way that is designed to prevent eavesdropping, tampering, and message forgery. This document updates RFCs 5705 and 6066, and obsoletes RFCs 5077, 5246, and 6961. This document also specifies new requirements for TLS 1.2 implementations. Network Configuration Access Control Model The standardization of network configuration interfaces for use with the Network Configuration Protocol (NETCONF) or the RESTCONF protocol requires a structured and secure operating environment that promotes human usability and multi-vendor interoperability. There is a need for standard mechanisms to restrict NETCONF or RESTCONF protocol access for particular users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content. This document defines such an access control model. This document obsoletes RFC 6536. The IETF XML Registry This document describes an IANA maintained registry for IETF standards which use Extensible Markup Language (XML) related items such as Namespaces, Document Type Declarations (DTDs), Schemas, and Resource Description Framework (RDF) Schemas. YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF) YANG is a data modeling language used to model configuration and state data manipulated by the Network Configuration Protocol (NETCONF), NETCONF remote procedure calls, and NETCONF notifications. [STANDARDS-TRACK] Informative References Framework for Abstraction and Control of TE Networks (ACTN) Traffic Engineered (TE) networks have a variety of mechanisms to facilitate the separation of the data plane and control plane. They also have a range of management and provisioning protocols to configure and activate network resources. These mechanisms represent key technologies for enabling flexible and dynamic networking. The term "Traffic Engineered network" refers to a network that uses any connection-oriented technology under the control of a distributed or centralized control plane to support dynamic provisioning of end-to- end connectivity. Abstraction of network resources is a technique that can be applied to a single network domain or across multiple domains to create a single virtualized network that is under the control of a network operator or the customer of the operator that actually owns the network resources. This document provides a framework for Abstraction and Control of TE Networks (ACTN) to support virtual network services and connectivity services. YANG Tree Diagrams This document captures the current syntax used in YANG module tree diagrams. The purpose of this document is to provide a single location for this definition. This syntax may be updated from time to time based on the evolution of the YANG language. A YANG Data Model for Layer 2 Network Topologies This document defines a YANG data model for Layer 2 network topologies. In particular, this data model augments the generic network and network topology data models with topology attributes that are specific to Layer 2.

Instance data for 2+0 mode for a bonded configuration

Instance data for 1+1 mode for a protected configuration

Microwave Topology Model with example extensions This appendix provides an examples of how the Microwave Topology Model can be used with the interface reference topology (ifref) and the bandwidth-availability-topology (bwa) models. There is also a snippet of json to show geolocation information instance data. The tree below shows an example of the relevant leafs for a complete Microwave Topology Model including interface reference topology (ifref) and bandwidth-availability-topology (bwa) models. /nw:networks/nw:network/nw:network-id +--rw node* [node-id] | +--rw node-id node-id | +--rw supporting-node* [network-ref node-ref] | | +--rw network-ref | | | -> ../../../nw:supporting-network/nw:network-ref | | +--rw node-ref | | -> /nw:networks/nw:network/nw:node/nw:node-id | +--rw nt:termination-point* [tp-id] | | +--rw nt:tp-id tp-id | | +--rw nt:supporting-termination-point* | | | [network-ref node-ref tp-ref] | | | +--rw nt:network-ref | | | | -> ../../../nw:supporting-node/nw:network-ref | | | +--rw nt:node-ref | | | | -> ../../../nw:supporting-node/nw:node-ref | | | +--rw nt:tp-ref leafref | | +--rw tet:te! | | +--rw tet:admin-status? | | | te-types:te-admin-status | | +--rw tet:name? string | | +--ro tet:oper-status? | | | te-types:te-oper-status | | +--rw mwtopo:mw-tp-choice | | | +--rw (mwtopo:mw-tp-option)? | | | +--:(mwtopo:microwave-rltp) | | | | +--rw mwtopo:microwave-rltp! | | | +--:(mwtopo:microwave-ctp) | | | +--rw mwtopo:microwave-ctp! | | +--rw ifref:tp-to-interface-path? -> /if:interfaces/interface/name | +--rw tet:te-node-id? te-types:te-node-id | +--rw tet:te! | +--ro tet:geolocation | +--ro tet:altitude? int64 | +--ro tet:latitude? geographic-coordinate-degree | +--ro tet:longitude? geographic-coordinate-degree +--rw nt:link* [link-id] +--rw nt:link-id link-id +--rw nt:source | +--rw nt:source-node? -> ../../../nw:node/nw:node-id | +--rw nt:source-tp? leafref +--rw nt:destination | +--rw nt:dest-node? -> ../../../nw:node/nw:node-id | +--rw nt:dest-tp? leafref +--rw tet:te! +--rw (tet:bundle-stack-level)? | +--:(tet:bundle) | +--rw tet:bundled-links | +--rw tet:bundled-link* [sequence] | +--rw tet:sequence uint32 | +--rw tet:src-tp-ref? leafref | +--rw tet:des-tp-ref? leafref +--rw tet:te-link-attributes | +--rw tet:name? string | +--rw tet:admin-status? | | te-types:te-admin-status | +--rw tet:max-link-bandwidth | | +--rw tet:te-bandwidth | | +--rw (tet:technology)? | | +--:(mwtopo:microwave) | | +--ro mwtopo:mw-bandwidth? uint64 | +--rw mwtopo:mw-link-choice | | +--rw (mwtopo:mw-link-option)? | | +--:(mwtopo:microwave-radio-link) | | | +--rw mwtopo:microwave-radio-link! | | | +--rw mwtopo:rlt-mode | | | +--rw mwtopo:num-bonded-carriers | | | | uint32 | | | +--rw mwtopo:num-protecting-carriers | | | uint32 | | +--:(mwtopo:microwave-carrier) | | +--rw mwtopo:microwave-carrier! | | +--rw mwtopo:tx-frequency? | | | uint32 | | +--rw mwtopo:rx-frequency? | | | uint32 | | +--rw mwtopo:channel-separation? | | | uint32 | | +--ro mwtopo:actual-tx-cm? | | | identityref | | +--ro mwtopo:actual-snir? | | | decimal64 | | +--ro mwtopo:actual-transmitted-level? | | decimal64 | +--rw bwatopo:link-availability* [availability] | | +--rw bwatopo:availability decimal64 | | +--rw bwatopo:link-bandwidth? uint64 | +--ro bwatopo:actual-bandwidth? yang:gauge64 +--ro tet:oper-status? ]]> Microwave is a transport technology which can be used to transport client services, such as L2 Ethernet links. When an L2 link is transported over a single supporting microwave radio link, the topologies could be as shown below. Note that the figure just shows an example, there might be other possibilities to demonstrate such a topology. The example of the instantiation encoded in JSON is using only a selected subset of the leafs from the L2 topology model .

Instance data for 2+0 mode A L2 network with a supporting microwave network, including microwave-topology (MW) and bandwidth-availability-topology (BWA) models as well as the reference to the associated interface management information, is encoded in JSON as follows:

Instance data for geolocation information This example provides a json snippet that shows geolocation information.

Acknowledgments This document was prepared using kramdown The authors would like to thank ...