A YANG Data Model for Microwave TopologyEricsson Incscott.mansfield@ericsson.comEricsson ABLindholmspiren 11Goteborg417 56Swedenjonas.ahlberg@ericsson.comHuawei TechnologiesNo.1899, Xiyuan AvenueChengdu611731Chinaamy.yemin@huawei.comNEC Laboratories EuropeKurfursten-Anlage 36Heidelberg69115GermanyXi.Li@neclab.euNokia - ITVia Energy Park, 14Vimercate (MI)20871Italydaniela.spreafico@nokia.com
RTG
ccampmicrowavetopologyThis document defines a YANG data model to describe microwave and millimeter-wave radio links in a network topology.Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by
the Internet Engineering Steering Group (IESG). Further
information on Internet Standards is available in Section 2 of
RFC 7841.
Information about the current status of this document, any
errata, and how to provide feedback on it may be obtained at
.
Copyright Notice
Copyright (c) 2024 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
() 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.
Table of Contents
. Introduction
. Abbreviations
. Tree Structure
. Prefixes in Data Node Names
. Microwave Topology YANG Data Model
. YANG Tree
. Relationship between Radio Links and Carriers
. Relationship with Client Topology Model
. Applicability of the Data Model for Traffic Engineering (TE) Topologies
. Microwave Topology YANG Module
. Security Considerations
. IANA Considerations
. References
. Normative References
. Informative References
. Microwave Topology Model with Base Topology Models
. 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
. Instance Data for 2+0 Mode
. Instance Data for Geolocation Information
Acknowledgments
Contributors
Authors' Addresses
IntroductionThis document defines a YANG data model to describe microwave and millimeter-wave radio links in a network topology (hereafter, "microwave" is used to simplify the text). The YANG data model describes radio links, supporting carrier(s), and the associated carrier termination points . A carrier is a single link providing transport capacity over the air. It is typically defined by its transmitting and receiving frequencies. A radio link provides the 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 Time-Division Multiplexing (TDM). The model augments the defined in , which is based on defined in .The microwave point-to-point radio technology provides connectivity on Layer 0 or Layer 1 (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 Layer 2 (L2) Ethernet, is carried over the microwave radio link. 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 could be used as a criterion when configuring and optimizing a path for a connection or service through the network end to end.
Optimization of the microwave radio link configurations on a network level, with the purpose to minimize overall interference and/or maximize the overall capacity provided by the links.
AbbreviationsThe following abbreviations are used in this document:
CTP:
Carrier Termination Point
RLT:
Radio Link Terminal
RLTP:
Radio Link Termination Point
Tree StructureA simplified graphical representation of the data model is used in of this document. The meaning of the symbols in these diagrams is defined in .Prefixes in Data Node NamesIn this document, names of data nodes and other data model objects are prefixed using the standard prefix associated with the corresponding YANG imported modules, as shown in .
Prefixes for Imported YANG Modules
Prefix
YANG Module
Reference
nw
ietf-network
nt
ietf-network-topology
mw-types
ietf-microwave-types
tet
ietf-te-topology
Microwave Topology YANG Data ModelYANG TreeMicrowave Topology Tree
module: ietf-microwave-topology
augment /nw:networks/nw:network/nw:network-types/tet:te-topology:
+--rw mw-topology!
augment /nw:networks/nw:network/nw:node/tet:te
/tet:te-node-attributes:
+--rw mw-node!
augment /nw:networks/nw:network/nw:node/nt:termination-point
/tet:te:
+--rw mw-tp!
+--rw (mw-tp-option)?
+--:(microwave-rltp)
| +--rw microwave-rltp!
+--:(microwave-ctp)
+--rw microwave-ctp!
augment /nw:networks/nw:network/nt:link/tet:te
/tet:te-link-attributes:
+--rw mw-link!
+--rw (mw-link-option)
+--:(microwave-radio-link)
| +--rw microwave-radio-link!
| +--rw rlt-mode
| +--rw num-bonded-carriers uint32
| +--rw num-protecting-carriers uint32
+--:(microwave-carrier)
+--rw microwave-carrier!
+--rw tx-frequency? uint32
+--ro actual-rx-frequency? uint32
+--rw channel-separation? uint32
+--ro actual-tx-cm? identityref
+--ro actual-snir? decimal64
+--ro actual-transmitted-level? decimal64
augment /nw:networks/nw:network/nt:link/tet:te
/tet:te-link-attributes/tet:max-link-bandwidth
/tet:te-bandwidth:
+--ro mw-bandwidth? uint64
Relationship between Radio Links and CarriersA microwave radio link is always an aggregate of one or multiple carriers in various configurations or modes. The supporting carriers are identified by their termination points and are listed in the container-bundled links as part of the te-link-config in the 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. includes JSON examples of how such a relationship can be modeled.Relationship with Client Topology ModelA 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 or dependency from higher topology layers to a supporting microwave radio link topology layer. includes JSON examples of an L2 Ethernet link transported over one supporting microwave link.Applicability of the Data Model for Traffic Engineering (TE) TopologiesSince microwave is a point-to-point radio technology, a majority of the leafs in the Data Model for Traffic Engineering (TE) Topologies augmented by the microwave topology model are not applicable. Examples of which leafs are considered applicable can be found in Appendices and in this document.In the more specific context of the microwave-specific augmentations of te-topology, the admin-status, and oper-status leafs (from te-topology) are only applicable to microwave carriers (in the mw-link tree); they are not applicable to microwave radio links. Radio links are instead enabled or disabled in the constituent carriers. Furthermore, the status leafs related to mw-tp can be used with inter-domain links and when the status of only one side of the link is known. However, 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.Microwave Topology YANG ModuleThis module imports typedefs and modules from , , and . It references and .
module ietf-microwave-topology {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-microwave-topology";
prefix mwt;
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";
}
import ietf-microwave-types {
prefix mw-types;
reference
"RFC 8561: A YANG Data Model for Microwave Radio Link";
}
organization
"Internet Engineering Task Force (IETF) CCAMP WG";
contact
"WG Web: <https://datatracker.ietf.org/wg/ccamp/>
WG List: <ccamp@ietf.org>
Editor: Jonas Ahlberg
<jonas.ahlberg@ericsson.com>
Editor: Scott Mansfield
<scott.mansfield@ericsson.com>
Editor: Min Ye
<amy.yemin@huawei.com>
Editor: Italo Busi
<Italo.Busi@huawei.com>
Editor: Xi Li
<Xi.Li@neclab.eu>
Editor: Daniela Spreafico
<daniela.spreafico@nokia.com>
";
description
"This is a module for microwave topology.
Copyright (c) 2024 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 9656; see
the RFC itself for full legal notices.";
revision 2024-09-30 {
description
"Initial revision.";
reference
"RFC 9656: A YANG Data Model for Microwave Topology";
}
grouping rlt-mode {
description
"This grouping provides a flexible definition of the 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 the 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 actual-rx-frequency {
type uint32;
units "kHz";
config false;
description
"Computed 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 channel 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;
}
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;
}
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 "bits/seconds";
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/tet:te"
+ "/tet:te-node-attributes" {
when '../../../nw:network-types'
+ '/tet:te-topology/mwt:mw-topology' {
description
"Augmentation parameters apply only to networks with a
microwave network topology type.";
}
description
"Augment network node to indicate a microwave node.";
container mw-node {
presence "Indicates a microwave node.";
description
"Microwave node";
}
}
augment "/nw:networks/nw:network/nw:node/nt:termination-point/"
+ "tet:te" {
when '../../../nw:network-types/tet:te-topology/'
+ 'mwt:mw-topology' {
description
"Augmentation parameters apply only for networks with a
microwave network topology type.";
}
description
"Augmentation to add microwave-technology-specific
characteristics to a termination point.";
container mw-tp {
presence "Denotes a microwave termination point.";
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.";
reference
"RFC 8561: A YANG Data Model for Microwave Radio Link";
}
}
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.";
reference
"RFC 8561: A YANG Data Model for Microwave Radio Link";
}
}
}
}
}
augment "/nw:networks/nw:network/nt:link/tet:te/"
+ "tet:te-link-attributes" {
when '../../../nw:network-types/tet:te-topology/'
+ 'mwt:mw-topology' {
description
"Augmentation parameters apply only for networks with a
microwave network topology type.";
}
description
"Augmentation to add microwave-technology-specific
characteristics to a link.";
container mw-link {
presence "This indicates a microwave link";
description
"Specification of type of link.";
choice mw-link-option {
mandatory true;
description
"Selection of type of link.";
case microwave-radio-link {
container microwave-radio-link {
presence "Denotes a microwave radio link";
description
"Denotes and describes a microwave radio link.";
uses microwave-radio-link-attributes;
}
}
case microwave-carrier {
container microwave-carrier {
presence "Denotes a microwave carrier";
description
"Denotes and describes a microwave carrier.";
uses microwave-carrier-attributes;
}
}
}
}
}
augment "/nw:networks/nw:network/nt:link/tet:te/"
+ "tet:te-link-attributes/"
+ "tet:max-link-bandwidth/"
+ "tet:te-bandwidth" {
when '../../../../../nw:network-types/tet:te-topology/'
+ 'mwt:mw-topology' {
description
"Augmentation parameters apply only for networks with a
microwave network topology type.";
}
description
"Augmentation for TE bandwidth.";
uses microwave-bandwidth;
}
}
Security ConsiderationsThe 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 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 can 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 behavior of the link.
tx-frequency and channel-separation: A malicious
client could attempt to modify the frequency configuration of
a carrier, which could modify the intended behavior or make
the configuration invalid and, thereby, stop the operation of it.
IANA ConsiderationsIANA has assigned a new URI from the "IETF XML Registry" as follows: