A YANG Data Model for Layer 2 Network Topologies
RFC 8944
| Document | Type | RFC - Proposed Standard (November 2020; No errata) | |
|---|---|---|---|
| Authors | Jie Dong , Xiugang Wei , Qin Wu , Mohamed Boucadair , Anders Liu | ||
| Last updated | 2020-11-17 | ||
| Replaces | draft-dong-i2rs-l2-network-topology | ||
| Stream | Internent Engineering Task Force (IETF) | ||
| Formats | plain text html xml pdf htmlized (tools) htmlized bibtex | ||
| Yang Validation | ☯ 0 errors, 2 warnings. | ||
| Reviews | |||
| Additional Resources | |||
| Stream | WG state | Submitted to IESG for Publication | |
| Document shepherd | Susan Hares | ||
| Shepherd write-up | Show (last changed 2020-03-31) | ||
| IESG | IESG state | RFC 8944 (Proposed Standard) | |
| Action Holders |
(None)
|
||
| Consensus Boilerplate | Yes | ||
| Telechat date | |||
| Responsible AD | Martin Vigoureux | ||
| Send notices to | Susan Hares <shares@ndzh.com.> | ||
| IANA | IANA review state | Version Changed - Review Needed | |
| IANA action state | RFC-Ed-Ack | ||
| IANA expert review state | Expert Reviews OK | ||
Internet Engineering Task Force (IETF) J. Dong
Request for Comments: 8944 X. Wei
Category: Standards Track Q. Wu
ISSN: 2070-1721 Huawei
M. Boucadair
Orange
A. Liu
Tecent
November 2020
A YANG Data Model for Layer 2 Network Topologies
Abstract
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.
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
https://www.rfc-editor.org/info/rfc8944.
Copyright Notice
Copyright (c) 2020 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 Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction
2. Terminology
3. Layer 2 Topology Model
4. Layer 2 Topology YANG Module
5. IANA Considerations
6. Security Considerations
7. References
7.1. Normative References
7.2. Informative References
Appendix A. Companion YANG Module for Non-NMDA-Compliant
Implementations
Appendix B. An Example
Acknowledgements
Authors' Addresses
1. Introduction
[RFC8345] defines the YANG [RFC6020] [RFC7950] data models of the
abstract (generic) network and network topology. Such models can be
augmented with technology-specific details to build more specific
topology models.
This document defines the YANG data model for Layer 2 (L2) network
topologies by augmenting the generic network (Section 6.1 of
[RFC8345]) and network topology (Section 6.2 of [RFC8345]) data
models with L2-specific topology attributes. An example is provided
in Appendix B.
There are multiple applications for such a data model. For example,
within the context of Interface to the Routing System (I2RS), nodes
within the network can use the data model to capture their
understanding of the overall network topology and expose it to a
network controller. A network controller can then use the
instantiated topology data to compare and reconcile its own view of
the network topology with that of the network elements that it
controls. Alternatively, nodes within the network may compare and
reconcile this understanding either among themselves or with the help
of a controller. Beyond the network element and the immediate
context of I2RS itself, a network controller might even use the data
model to represent its view of the topology that it controls and
expose it to external applications. Further use cases where the data
model can be applied are described in [I2RS-UR].
This document uses the common YANG types defined in [RFC6991] and
adopts the Network Management Datastore Architecture (NMDA)
[RFC8342].
2. Terminology
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.
The terminology for describing YANG modules is defined in [RFC7950].
The meanings of the symbols used in the tree diagram are defined in
[RFC8340].
3. Layer 2 Topology Model
The Layer 2 network topology YANG module is designed to be generic
and applicable to Layer 2 networks built with different Layer 2
technologies. It can be used to describe both the physical and the
Show full document text