YANG Model for IS-IS Protocol Implementation Conformance Statement (PICS)

YANG is a data definition language used to define the contents of a conceptual data store that allows networked devices to be managed using NETCONF . 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 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) .

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 .

This document uses the graphical representation of data models defined in .

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

file "iana-isis-pics@2024-03-03.yang" 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 "; description "The YANG module defines the identities for IS-IS Protocol Implementation Conformance Statement (PICS). Copyright (c) 2025 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 2025-05-05 { 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."; } }

]]>


    
       file "ietf-isis-pics@2025-05-05.yang"
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:   
     WG List:  

     Author:   Yingzhen Qu
               
     Author:   Les Ginsberg
               
     Author:   Tony Przygienda
               
     Author:   Bruno Decraene
               
     Author:   Yongqing Zhu
               ";

  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) 2025 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 2025-05-05 {
    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.";
    } 
  }  
}

      ]]>




    

    
      
        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  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
        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 registers URIs in the IETF XML registry as defined in
    .  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 .
   
   
   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
   
  
  
    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 moduel is published, it MUST define how a new "identity" statement
  should be added to the iana-isis-pics module. The following guidlines should be followed.


  The name of the "identity" is "isis-pics-" plus the lowercase of the RFC name abbreviation. The
  "identity" statement should have the following substatements defined:
  
  
  "base": contains the value of "isis-pics".
  "description": contains "The identity for IS-IS PICS support of xxxx.",
                 replace the "xxxx" with the RFC information.
  "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.
  






    
      The YANG model was developed using the suite of YANG tools written
      and maintained by numerous authors.