YANG Schema Item iDentifier (SID)
draft-ietf-core-sid-04

• Status
• IESG evaluation record
• IESG writeups
• Email expansions
• History

• Versions
• 00
• 01
• 02
• 03
• 04

draft-ietf-core-sid-04.txt:
xym 0.4:
Extracting 'ietf-sid-file@2017-11-26.yang'
   Removed 0 empty lines


ietf-sid-file@2017-11-26.yang:
pyang 1.7.5: pyang --verbose --ietf -p {libs} {model}:
No validation errors

yanglint 0.14.80: yanglint --verbose -p {rfclib} -p {draftlib} -p {tmplib} {model} -i:
No validation errors

Internet Engineering Task Force                        M. Veillette, Ed.
Internet-Draft                                   Trilliant Networks Inc.
Intended status: Standards Track                           A. Pelov, Ed.
Expires: December 6, 2018                                         Acklio
                                                           June 04, 2018

                   YANG Schema Item iDentifier (SID)
                         draft-ietf-core-sid-04

Abstract

   YANG Schema Item iDentifiers (SID) are globally unique 64-bit
   unsigned numbers used to identify YANG items.  This document defines
   the semantics, the registration, and assignment processes of SIDs.
   To enable the implementation of these processes, this document also
   defines a file format used to persist and publish assigned SIDs.

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 December 6, 2018.

Copyright Notice

   Copyright (c) 2018 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

Veillette & Pelov       Expires December 6, 2018                [Page 1]
Internet-Draft      YANG Schema Item iDentifier (SID)          June 2018

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology and Notation  . . . . . . . . . . . . . . . . . .   3
   3.  ".sid" file lifecycle . . . . . . . . . . . . . . . . . . . .   4
   4.  ".sid" file format  . . . . . . . . . . . . . . . . . . . . .   7
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .  11
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  11
     6.1.  "SID mega-range" registry . . . . . . . . . . . . . . . .  11
       6.1.1.  IANA SID Mega-Range Registry  . . . . . . . . . . . .  12
       6.1.2.  IANA "RFC SID range assignment" sub-registries  . . .  13
     6.2.  "YANG module assignment" registry . . . . . . . . . . . .  14
   7.  Acknowledgments . . . . . . . . . . . . . . . . . . . . . . .  14
   8.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  14
     8.1.  Normative References  . . . . . . . . . . . . . . . . . .  14
     8.2.  Informative References  . . . . . . . . . . . . . . . . .  15
   Appendix A.  ".sid" file example  . . . . . . . . . . . . . . . .  16
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  25

1.  Introduction

   Some of the items defined in YANG [RFC7950] require the use of a
   unique identifier.  In both NETCONF [RFC6241] and RESTCONF [RFC8040],
   these identifiers are implemented using names.  To allow the
   implementation of data models defined in YANG in constrained devices
   and constrained networks, a more compact method to identify YANG
   items is required.  This compact identifier, called SID, is encoded
   using a 64-bit unsigned integer.  The following items are identified
   using SIDs:

   o  identities

   o  data nodes (Note: including those part of a YANG template as
      defined by the 'yang-data' extension.)

   o  RPCs and associated input(s) and output(s)

   o  actions and associated input(s) and output(s)

   o  notifications and associated information

   o  YANG modules, submodules and features

   To minimize their size, SIDs are often represented as a difference
   between the current SID and a reference SID.  Such difference is

Veillette & Pelov       Expires December 6, 2018                [Page 2]
Internet-Draft      YANG Schema Item iDentifier (SID)          June 2018

   called "delta", shorthand for "delta-encoded SID".  Conversion from
   SIDs to deltas and back to SIDs is a stateless process.  Each
   protocol implementing deltas must unambiguously define the reference
   SID for each YANG item.

   SIDs are globally unique numbers, a registration system is used in