YANG Data Model for IS-IS Segment Routing MPLS PICS
draft-ietf-lsr-isis-pics-srmpls-yang-00
| Document | Type | Active Internet-Draft (lsr WG) | |
|---|---|---|---|
| Authors | Yingzhen Qu , Les Ginsberg , Tony Przygienda , Bruno Decraene , Yongqing Zhu | ||
| Last updated | 2024-11-03 | ||
| Replaces | draft-qgp-lsr-isis-pics-srmpls-yang | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Intended RFC status | (None) | ||
| Formats | |||
| Yang Validation | 0 errors, 4 warnings | ||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | WG Document | |
| Document shepherd | (None) | ||
| IESG | IESG state | I-D Exists | |
| Consensus boilerplate | Unknown | ||
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-ietf-lsr-isis-pics-srmpls-yang-00
Internet Y. Qu
Internet-Draft Futurewei Technologies
Intended status: Standards Track L. Ginsberg
Expires: 7 May 2025 Cisco Systems
A. Przygienda
Juniper Networks
B. Decraene
Orange
Y. Zhu
China Telecom
3 November 2024
YANG Data Model for IS-IS Segment Routing MPLS PICS
draft-ietf-lsr-isis-pics-srmpls-yang-00
Abstract
The YANG model in this document is to query an IS-IS Protocol
Implementation Conformance Statement (PICS) of Segment Routing on
MPLS data plane.
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 7 May 2025.
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 (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
Qu, et al. Expires 7 May 2025 [Page 1]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
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
1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 2
2. Design of the Model . . . . . . . . . . . . . . . . . . . . . 3
3. ISIS PICS for SR MPLS Tree . . . . . . . . . . . . . . . . . 3
4. IS-IS PICS SR-MPLS YANG Modules . . . . . . . . . . . . . . . 4
5. Security Considerations . . . . . . . . . . . . . . . . . . . 11
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 12
8. Normative References . . . . . . . . . . . . . . . . . . . . 12
9. Informative References . . . . . . . . . . . . . . . . . . . 13
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14
1. Overview
YANG [RFC7950] is a data definition language used to define the
contents of a conceptual data store that allows networked devices to
be managed using NETCONF [RFC6241]. YANG is proving relevant beyond
its initial confines, as bindings to other interfaces (e.g., ReST)
and encodings other than XML (e.g., JSON) are being defined.
Furthermore, YANG data models can be used as the basis for
implementation of other interfaces, such as CLI and programmatic
APIs.
[I-D.ietf-lsr-isis-pics-yang] defines the framework to query IS-IS
Protocol Implementation Conformance Statement (PICS). The module
defined in this document is used to query an IS-IS PICS of Segment
Routing on MPLS data plane [RFC8667].
The YANG modules in this document conform to the Network Management
Datastore Architecture (NMDA) [RFC8342].
1.1. Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119] [RFC8174].
Qu, et al. Expires 7 May 2025 [Page 2]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
2. Design of the Model
The YANG module is used to query an IS-IS implementation of Segment
Routing on MPLS data plane [RFC8667] for the conformance of the
protocol implementation.
Container "isis-pics-sr-mpls" only exists when "isis-pics-sr-mpls" is
included in the list of "supported-isis-pics" in ietf-isis-pics
module.
The existence of a TLV support container means the support of a TLV.
The details of the flags and features are included in the container.
3. ISIS PICS for SR MPLS Tree
This document uses the graphical representation of data models
defined in [RFC8340].
Qu, et al. Expires 7 May 2025 [Page 3]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
module: ietf-isis-pics-sr-mpls
+--ro isis-pics-sr-mpls
+--ro sr-capability-sub-tlv-support!
| +--ro i-bit-support? isis-pics:support
| +--ro v-bit-support? isis-pics:support
+--ro prefix-sid-sub-tlv-support!
| +--ro tlv-135? isis-pics:support
| +--ro tlv-235? isis-pics:support
| +--ro tlv-236? isis-pics:support
| +--ro tlv-237? isis-pics:support
+--ro adj-sid-sub-tlv-support!
| +--ro tlv-22? isis-pics:support
| +--ro tlv-222? isis-pics:support
| +--ro tlv-23? isis-pics:support
| +--ro tlv-223? isis-pics:support
| +--ro tlv-141? isis-pics:support
+--ro lan-adj-sid-sub-tlv-support!
| +--ro tlv-22? isis-pics:support
| +--ro tlv-222? isis-pics:support
| +--ro tlv-23? isis-pics:support
| +--ro tlv-223? isis-pics:support
+--ro sid-label-tlv-support? isis-pics:support
+--ro sid-label-binding-tlv-support!
| +--ro srms
| | +--ro sending? isis-pics:support
| | +--ro receiving? isis-pics:support
| +--ro mirror-sid? isis-pics:support
+--ro mt-sid-label-binding-tlv-support!
| +--ro srms
| | +--ro sending? isis-pics:support
| | +--ro receiving? isis-pics:support
| +--ro mirror-sid? isis-pics:support
+--ro sr-algorithm-tlv-support!
| +--ro algo-support* uint8
+--ro sr-lb-tlv-support? isis-pics:support
+--ro srms-preference-tlv-support? isis-pics:support
augment /isis-pics:isis-pics/isis-pics:isis-pics-mptlv:
+--ro sid-label-binding-support? isis-pics:support
+--ro mt-sid-label-binding-support? isis-pics:support
4. IS-IS PICS SR-MPLS YANG Modules
Qu, et al. Expires 7 May 2025 [Page 4]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
<CODE BEGINS> file "ietf-isis-pics-sr-mpls@2024-07-03.yang"
module ietf-isis-pics-sr-mpls {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-isis-pics-sr-mpls";
prefix isis-pics-sr-mpls;
import iana-isis-pics {
prefix "iana-isis-pics";
}
import ietf-isis-pics {
prefix "isis-pics";
}
organization
"IETF LSR - Link State Routing Working Group";
contact
"WG Web: <http://datatracker.ietf.org/wg/lsr>
WG List: <mailto:lsr@ietf.org>
Author: Yingzhen Qu
<mailto:yingzhen.ietf@gmail.com>
Author: Les Ginsberg
<mailto:ginsberg@cisco.com>
Author: Tony Przygienda
<mailto:prz@juniper.net>
Author: Yongqing Zhu
<mailto:zhuyq8@chinatelecom.cn>";
description
"The YANG module is used to query an IS-IS Protocol
Implementation Conformance Statement (PICS) of Segment
Routing for MPLS data plane (RFC8667).
This YANG model conforms to the Network Management
Datastore Architecture (NMDA) as described in RFC 8342.
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 XXXX
Qu, et al. Expires 7 May 2025 [Page 5]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
(https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself
for full legal notices.";
reference
"RFC XXXX: YANG Data Model for IS-IS Segment Routing MPLS PICS";
revision 2024-07-03 {
description
"Initial Version";
reference
"RFC XXXX: YANG Data Model for IS-IS Segment Routing MPLS PICS.";
}
container isis-pics-sr-mpls {
when "/isis-pics:isis-pics/isis-pics:supported-isis-pics "
+ "= 'iana-isis-pics:isis-pics-sr-mpls'" {
description
"This container only exists when isis-pics-sr-mpls is present
in the ietf-isis-pics module.";
}
config false;
description
"IS-IS Protocol Implementation Conformance Statement (PICS) of
Segment Routing on MPLS data plane.";
reference
"RFC 8667: IS-IS Extensions for Segment Routing";
container sr-capability-sub-tlv-support {
presence "Support of sr-capability sub-tlv.";
//config false;
description
"Support of sr-capability sub-tlv (Type 2).";
leaf i-bit-support {
type isis-pics:support;
description
"support mpls-ipv4 capability.";
}
leaf v-bit-support {
type isis-pics:support;
description
"support mpls-ipv6 capability.";
}
}
container prefix-sid-sub-tlv-support {
presence "Support of prefix-sid sub-tlv.";
Qu, et al. Expires 7 May 2025 [Page 6]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
description
"Support of prefix-sid sub-tlv (Type 3).";
leaf tlv-135 {
type isis-pics:support;
description
"May present in TLV-135, extended IPv4 reachability.";
}
leaf tlv-235 {
type isis-pics:support;
description
"May present in TLV-235, multi-topology IPv4 reachability.";
}
leaf tlv-236 {
type isis-pics:support;
description
"May present in TLV-236, IPv6 IP reachability.";
}
leaf tlv-237 {
type isis-pics:support;
description
"May present in TLV-237, multi-topology IPv6 IP
reachability.";
}
}
container adj-sid-sub-tlv-support {
presence "Support of adj-sid sub-tlv.";
description
"Support of adjacency segment identifier sub-tlv (Type 31).";
leaf tlv-22 {
type isis-pics:support;
description
"May present in TLV-22, extended IS reachability.";
}
leaf tlv-222 {
type isis-pics:support;
description
"May present in TLV-222, MT-ISN.";
}
leaf tlv-23 {
type isis-pics:support;
description
"May present in TLV-23, IS neighbor attribute.";
}
leaf tlv-223 {
type isis-pics:support;
Qu, et al. Expires 7 May 2025 [Page 7]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
description
"May present in TLV-223, MT IS neighbor attribute.";
}
leaf tlv-141 {
type isis-pics:support;
description
"May present in TLV-141, inter-AS reachability information.";
}
}
container lan-adj-sid-sub-tlv-support {
presence "Support of lan-adj-sid sub-tlv.";
description
"Support of LAN adj-sid sub-tlv (Type 32).";
leaf tlv-22 {
type isis-pics:support;
description
"May present in TLV-22, extended IS reachability.";
}
leaf tlv-222 {
type isis-pics:support;
description
"May present in TLV-222, MT-ISN.";
}
leaf tlv-23 {
type isis-pics:support;
description
"May present in TLV-23, IS neighbor attribute.";
}
leaf tlv-223 {
type isis-pics:support;
description
"May present in TLV-223, MT IS neighbor attribute.";
}
}
leaf sid-label-tlv-support {
type isis-pics:support;
description
"Support of sid/label sub-tlv (Type 1).";
}
container sid-label-binding-tlv-support {
presence "Support of sid-label-binding sub-tlv.";
description
"Support of sid/label binding tlv (Type 149).";
Qu, et al. Expires 7 May 2025 [Page 8]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
container srms {
description
"Support to advertise or receive prefix to sid/label
mapping.";
leaf sending {
type isis-pics:support;
description
"Support to advertise SR mappings.";
}
leaf receiving {
type isis-pics:support;
description
"Support to receive and use the MS mapping advertisement.";
}
}
leaf mirror-sid {
type isis-pics:support;
description
"Support to advertise a mirror sid indicating the ability
of a node to process traffic originally destined to
another IGP node.";
}
}
container mt-sid-label-binding-tlv-support {
presence "Support of multi-topology sid-label-binding sub-tlv.";
description
"Support of multi-topology sid/label binding tlv (Type 150).";
container srms {
description
"Support to advertise or receive prefix to sid/label
mapping.";
leaf sending {
type isis-pics:support;
description
"Support to advertise SR mappings.";
}
leaf receiving {
type isis-pics:support;
description
"Support to receive and use the MS mapping advertisement.";
}
}
Qu, et al. Expires 7 May 2025 [Page 9]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
leaf mirror-sid {
type isis-pics:support;
description
"Support to advertise a mirror sid indicating the ability
of a node to process traffic originally destined to
another IGP node.";
}
}
container sr-algorithm-tlv-support {
presence "Support of SR-Algorithm sub-tlv.";
description
"Support of SR-Algorithm sub-tlv (Type 19).";
leaf-list algo-support {
type uint8;
description
"Supported algorithms.";
}
}
leaf sr-lb-tlv-support {
type isis-pics:support;
description
"Support of the SR Local Block sub-tlv (Type 22).";
}
leaf srms-preference-tlv-support {
type isis-pics:support;
description
"Support of the SRMS Preference sub-tlv (Type 24).";
}
}
augment "/isis-pics:isis-pics/isis-pics:isis-pics-mptlv"
{
description
"Augment isis-pics-mptlv container with the tlvs defined
in RFC 8667.";
leaf sid-label-binding-support {
type isis-pics:support;
description
"MP-TLV support of sid/label binding tlv (Type 149).";
}
leaf mt-sid-label-binding-support {
type isis-pics:support;
Qu, et al. Expires 7 May 2025 [Page 10]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
description
"MP-TLV support of multi-topology sid/label
binding tlv (Type 150).";
}
}
}
<CODE ENDS>
5. Security Considerations
The YANG modules specified in this document define 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 NETCONF access control model [RFC8341] provides the means to
restrict access for particular NETCONF or RESTCONF users to a pre-
configured subset of all available NETCONF or RESTCONF protocol
operations and content.
Some of the readable data nodes in the ietf-isis-pics-sr-mpls.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.
6. IANA Considerations
The document requests IANA to create a entry, called isis-pics-sr-
mpls in the "IS-IS PICS" registry [I-D.ietf-lsr-isis-pics-yang].
This document requests IANA to add a new "identity" to the iana-isis-
pics YANG module. The following statement is suggested:
identity isis-pics-sr-mpls {
base "isis-pics";
description
"The identity for support of SR MPLS.";
reference
"RFC 8667: IS-IS Extensions for Segment Routing.";
}
This document registers a URI in the IETF XML registry [RFC3688].
Following the format in [RFC3688], the following registration is
requested to be made:
Qu, et al. Expires 7 May 2025 [Page 11]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
URI: urn:ietf:params:xml:ns:yang:ietf-isis-pics-sr-mpls
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
This document registers a YANG module in the YANG Module Names
registry [RFC6020].
name: ietf-isis-pics-sr-mpls
namespace: urn:ietf:params:xml:ns:yang:ietf-isis-pics-sr-mpls
prefix: isis-pics-sr-mpls
reference: RFC XXXX
7. Acknowledgements
The YANG model was developed using the suite of YANG tools written
and maintained by numerous authors.
8. 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>.
Qu, et al. Expires 7 May 2025 [Page 12]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
[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>.
[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>.
[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>.
[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>.
[RFC8667] Previdi, S., Ed., Ginsberg, L., Ed., Filsfils, C.,
Bashandy, A., Gredler, H., and B. Decraene, "IS-IS
Extensions for Segment Routing", RFC 8667,
DOI 10.17487/RFC8667, December 2019,
<https://www.rfc-editor.org/info/rfc8667>.
[ISO10589] ISO, "Intermediate system to Intermediate system routing
information exchange protocol for use in conjunction with
the Protocol for providing the Connectionless-mode Network
Service (ISO 8473)", August 1987, <ISO/IEC 10589:2002>.
[I-D.ietf-lsr-isis-pics-yang]
Qu, Y., Ginsberg, L., Przygienda, T., Decraene, B., and Y.
Zhu, "YANG Model for IS-IS Protocol Implementation
Conformance Statement (PICS)", Work in Progress, Internet-
Draft, draft-ietf-lsr-isis-pics-yang-00, 3 November 2024,
<https://datatracker.ietf.org/doc/html/draft-ietf-lsr-
isis-pics-yang-00>.
9. Informative References
Qu, et al. Expires 7 May 2025 [Page 13]
Internet-Draft IS-IS PICS SR-MPLS YANG November 2024
[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>.
Authors' Addresses
Yingzhen Qu
Futurewei Technologies
Email: yingzhen.ietf@gmail.com
Les Ginsberg
Cisco Systems
Email: ginsberg@cisco.com.com
Antoni Przygienda
Juniper Networks
Email: prz@juniper.net
Bruno Decraene
Orange
Email: bruno.decraene@orange.com
Yongqing Zhu
China Telecom
Email: zhuyq8@chinatelecom.cn
Qu, et al. Expires 7 May 2025 [Page 14]