| Internet-Draft | IS-IS PICS YANG | November 2024 |
| Qu, et al. | Expires 7 May 2025 | [Page] |
The YANG model in this document is to be used to query an IS-IS Protocol Implementation Conformance Statement (PICS).¶
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 (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 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.¶
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.¶
Operators may find it useful to know what aspects of a protocol are implemented by a given node in their network. Historically this information has been provided in a Protocol Implementation Conformance Statement (PICS) which is available as an offline document. (An example of PICS for IS-IS can be found in [ISO10589] Section 12.) However, there is no reason why this information could not be provided via YANG - which is what this document defines. This allows an operator to query nodes in real time as to what protocol features are supported. This in turn can assist with avoiding (or at least diagnosing) interoperability problems and/or determining when a feature can be safely deployed.¶
The YANG modules in this document conform to the Network Management Datastore Architecture (NMDA) [RFC8342].¶
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].¶
This document uses the graphical representation of data models defined in [RFC8340].¶
A new IANA registry will be created for IS-IS PICS, which maintains the list of RFCs that support IS-IS PICS.¶
Module iana-isis-pics.yang is the initial version for IS-IS PICS identity type definitions.¶
When a new identity is added to the "IS-IS PICS" registry, the iana-isis-pics YANG module is updated by IANA.¶
Module ietf-isis-pics.yang is a device model and designed to query a node with IS-IS PICS status.¶
The leaf-list of "isis-pics" lists all the supported PICS that defined in the iana-isis-pics module.¶
The container "isis-pics-mptlv" is a place holder and meant to be augmented by individual RFC PICS module with multi-part tlv support.¶
The following figure shows the tree diagram of the ietf-isis-pics module.¶
module: ietf-isis-pics
+--ro isis-pics
+--ro supported-isis-pics* identityref
+--ro isis-pics-mptlv
¶
<CODE BEGINS> file "[email protected]" module iana-isis-pics { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:iana-isis-pics"; prefix iana-isis-pics; organization "IANA"; contact "Internet Assigned Numbers Authority Postal: ICANN 12025 Waterfront Drive, Suite 300 Los Angeles, CA 90094-2536 United States of America Tel: +1 310 301 5800 <mailto:[email protected]>"; description "The YANG module defines the identities for IS-IS Protocol Implementation Conformance Statement (PICS). 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 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; revision 2024-03-03 { description "Initial Version"; reference "RFC XXXX: YANG Data Model for IS-IS PICS."; } identity isis-pics { description "This identity is used as a base for all ISIS pics defined in the 'IS-IS PICS' registry."; } } <CODE ENDS>¶
<CODE BEGINS> file "[email protected]" module ietf-isis-pics { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-isis-pics"; prefix isis-pics; import iana-isis-pics { prefix "iana-isis-pics"; } organization "IETF LSR - Link State Routing Working Group"; contact "WG Web: <http://datatracker.ietf.org/wg/lsr> WG List: <mailto:[email protected]> Author: Yingzhen Qu <mailto:[email protected]> Author: Les Ginsberg <mailto:[email protected]> Author: Tony Przygienda <mailto:[email protected]> Author: Yongqing Zhu <mailto:[email protected]>"; description "The YANG module is used to query an IS-IS implementation for Protocol Implementation Conformance Statement (PICS). 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 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; reference "RFC XXXX: YANG Data Model for IS-IS PICS"; revision 2024-07-03 { description "Initial Version"; reference "RFC XXXX: YANG Data Model for IS-IS PICS."; } typedef support { type boolean; default "false"; description "When set to True, it means a feature or definition is supported/implemented."; } container isis-pics { config false; description "IS-IS Protocol Implementation Conformance Statement (PICS)."; leaf-list supported-isis-pics { type identityref { base iana-isis-pics:isis-pics; } description "List of supported isis pics."; } container isis-pics-mptlv { description "IS-IS Protocol Implementation Conformance Statement (PICS) for RFC xxxx: Multi-part TLVs in IS-IS. This container is meant to be augmented by RFC PICS module where a TLV is defined."; } } } <CODE ENDS>¶
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.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.¶
This document defines the initial version of the IANA-maintained iana-isis-pics YANG module.¶
The document requests IANA to create a "IS-IS PICS" registry, and iana-isis-pics YANG module is intended to reflect the the registry.¶
When a IS-IS PICS is added to the registry, a new "identity" statement must be added to the iana-isis-pics YANG module. The following substatements to the "identity" statement should be defined:¶
"base": contains the value of "isis-pic". "reference": the corresponding RFC information.¶
When the iana-isis-pis YANG module is updated, a new "revision" statement must be added in from of the existing revision statements.¶
This document registers a URI in the IETF XML registry [RFC3688]. Following the format in [RFC3688], the following registrations are requested to be made:¶
URI: urn:ietf:params:xml:ns:yang:iana-isis-pics Registrant Contact: IANA. XML: N/A, the requested URI is an XML namespace.¶
URI: urn:ietf:params:xml:ns:yang:ietf-isis-pics Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace.¶
This document registers the following two YANG module in the YANG Module Names registry [RFC6020].¶
name: iana-isis-pics namespace: urn:ietf:params:xml:ns:yang:iana-isis-pics prefix: iana-isis-pics reference: RFC XXXX¶
name: ietf-isis-pics namespace: urn:ietf:params:xml:ns:yang:ietf-isis-pics prefix: isis-pics reference: RFC XXXX¶
The YANG model was developed using the suite of YANG tools written and maintained by numerous authors.¶