--- 1/draft-ietf-tictoc-1588v2-yang-06.txt 2017-11-27 23:13:09.030205327 -0800 +++ 2/draft-ietf-tictoc-1588v2-yang-07.txt 2017-11-27 23:13:09.082206558 -0800 @@ -1,22 +1,22 @@ Internet Working Group Y. Jiang, Ed. Huawei Internet-Draft X. Liu Independent Intended status: Standards Track J. Xu Huawei R. Cummings, Ed. National Instruments -Expires: April 2018 October 26, 2017 +Expires: May 2018 November 28, 2017 YANG Data Model for IEEE 1588-2008 - draft-ietf-tictoc-1588v2-yang-06 + draft-ietf-tictoc-1588v2-yang-07 Abstract This document defines a YANG data model for the configuration of IEEE 1588-2008 devices and clocks, and also retrieval of the configuration information, data set and running states of IEEE 1588-2008 clocks. Status of this Memo @@ -33,21 +33,21 @@ documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html - This Internet-Draft will expire on April 26, 2018. + This Internet-Draft will expire on May 28, 2018. Copyright Notice Copyright (c) 2017 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 (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents @@ -66,21 +66,21 @@ 2.1. Interpretations from IEEE 1588 Working Group ........... 8 2.2. Configuration and state ................................ 8 3. IEEE 1588-2008 YANG Module ................................ 9 4. Security Considerations .................................. 22 5. IANA Considerations ...................................... 23 6. References ............................................... 23 6.1. Normative References .................................. 23 6.2. Informative References ................................ 23 7. Acknowledgments .......................................... 24 Appendix A Transferring YANG Work to IEEE 1588 WG (Informational) - ................................................................. 25 + ............................................................... 25 A.1. Assumptions for the Transfer .......................... 25 A.2. Intellectual Property Considerations .................. 26 A.3. Namespace and Module Name ............................. 27 A.4. IEEE 1588 YANG Modules in ASCII Format ................ 28 1. Introduction As a synchronization protocol, IEEE 1588-2008 [IEEE1588] is widely supported in the carrier networks, industrial networks, automotive networks, and many other applications. It can provide high @@ -127,21 +127,21 @@ scope of this document. When used in practice, network products in support of synchronization typically conform to one or more IEEE 1588-2008 profiles. Each profile specifies how IEEE 1588-2008 is used in a given industry (e.g. telecom, automotive) and application. A profile can require features that are optional in IEEE 1588-2008, and it can specify new features that use IEEE 1588-2008 as a foundation. - It is expected that the IEEE 1588-2008 YANG module will be used as + It is expected that the IEEE 1588-2008 YANG module be used as follows: o The IEEE 1588-2008 YANG module can be used as-is for products that conform to one of the default profiles specified in IEEE 1588- 2008. o When the IEEE 1588 standard is revised (e.g. the IEEE 1588 revision in progress scheduled to be published in 2017), it will add some new optional features to its data sets. The YANG module of this document can be revised and extended to add the new @@ -192,36 +192,42 @@ P2P Peer-to-Peer PTP Precision Time Protocol TAI International Atomic Time TC Transparent Clock UTC Coordinated Universal Time - PTP dataset Structured attributes of clocks (an OC, BC or TC) used - for PTP protocol decisions and for providing values for PTP message - fields, see Section 8 of [IEEE1588]. + PTP dataset + Structured attributes of clocks (an OC, BC or TC) used for + PTP protocol decisions and for providing values for PTP + message fields, see Section 8 of [IEEE1588]. - PTP instance A PTP implementation in the device (i.e., an OC or BC) + PTP instance + A PTP implementation in the device (i.e., an OC or BC) represented by a specific PTP dataset. 2. IEEE 1588-2008 YANG Model hierarchy This section describes the hierarchy of an IEEE 1588-2008 YANG module. Query and configuration of device wide or port specific - configuration information and clock data set is described for this + configuration information and clock data set are described for this version. Query and configuration of clock information include: + (Note: The attribute names are consistent with IEEE 1588-2008, but + changed to the YANG style, i.e., using all lower-case, with dashes + between words.) + - Clock data set attributes in a clock node, including: current-ds, parent-ds, default-ds, time-properties-ds, and transparent-clock- default-ds. - Port-specific data set attributes, including: port-ds and transparent-clock-port-ds. The readers are assumed to be familiar with IEEE 1588-2008. As all PTP terminologies and PTP data set attributes are described in details in IEEE 1588-2008 [IEEE1588], this document only outlines @@ -246,21 +252,21 @@ o Ellipsis ("...") stands for contents of subtrees that are not shown. o Arrow ("->") stands for a reference to a particular leaf instance in the tree. module: ietf-ptp +--rw ptp +--rw instance-list* [instance-number] - | +--rw instance-number uint16 + | +--rw instance-number uint32 | +--rw default-ds | | +--rw two-step-flag? boolean | | +--rw clock-identity? clock-identity-type | | +--rw number-ports? uint16 | | +--rw clock-quality | | | +--rw clock-class? uint8 | | | +--rw clock-accuracy? uint8 | | | +--rw offset-scaled-log-variance? uint16 | | +--rw priority1? uint8 | | +--rw priority2? uint8 @@ -353,21 +359,25 @@ - Static: Read-only to management, and the value typically does not change. Under certain circumstances, the classification of an IEEE 1588 data set member can change. For details on the classification of each PTP data set member, refer to the IEEE Std 1588-2008 specification for that member. 3. IEEE 1588-2008 YANG Module - file "ietf-ptp@2017-10-20.yang" + This module imports typedefs from [RFC7223]. Most attribute names + are based on the information model defined in [IEEE1588], but + adapted to the YANG style of naming. + + file "ietf-ptp@2017-11-28.yang" module ietf-ptp { namespace "urn:ietf:params:xml:ns:yang:ietf-ptp"; prefix "ptp"; import ietf-interfaces { prefix if; } organization "IETF TICTOC Working Group"; @@ -380,22 +390,22 @@ Editor: Yuanlong Jiang Editor: Rodney Cummings "; description "This YANG module defines a data model for the configuration of IEEE 1588-2008 clocks, and also for retrieval of the state data of IEEE 1588-2008 clocks."; - revision "2017-10-20" { - description "Version 6.0"; + revision "2017-11-28" { + description "Version 7.0"; reference "draft-ietf-tictoc-1588v2-yang"; } typedef delay-mechanism-enumeration { type enumeration { enum e2e { value 1; description "The port uses the delay request-response mechanism."; } @@ -541,21 +550,21 @@ key "instance-number"; description "List of one or more PTP datasets in the device (see IEEE Std 1588-2008 subclause 6.3). Each PTP dataset represents a distinct instance of PTP implementation in the device (i.e. distinct Ordinary Clock or Boundary Clock)."; leaf instance-number { - type uint16; + type uint32; description "The instance number of the current PTP instance. This instance number is used for management purposes only. This instance number does not represent the PTP domain number, and is not used in PTP messages."; } container default-ds { description "The default data set of the clock (see IEEE Std @@ -998,25 +1009,24 @@ Some data nodes defined in this YANG module are writable, and an inappropriate use of them may adversely impact a synchronization network. For example, loss of synchronization on a clock, accuracy degradation on a set of clocks, or even break down of a whole synchronization network. 5. IANA Considerations This document registers a URI in the IETF XML registry, and the following registration is requested to be made: - URI: urn:ietf:params:xml:ns:yang:ietf-ptp-dataset + URI: urn:ietf:params:xml:ns:yang:ietf-ptp This document registers a YANG module in the YANG Module Names: - name: ietf-ptp-dataset namespace: urn:ietf:params:xml:ns:yang:ietf- - ptp-dataset + name: ietf-ptp namespace: urn:ietf:params:xml:ns:yang:ietf-ptp 6. References 6.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997 [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF) ", RFC 6020, @@ -1062,23 +1072,24 @@ [RFC8040] Bierman, A., Bjorklund, M., and Watsen, K., "RESTCONF protocol", RFC 8040, January 2017 [RFC8173] Shankarkumar, V., Montini, L., Frost, T., and Dowd, G., "Precision Time Protocol Version 2 (PTPv2) Management Information Base", RFC 8173, June 2017 7. Acknowledgments The authors would like to thank Joe Gwinn, Mahesh Jethanandani, Tal - Mizrahi, Opher Ronen, Liang Geng, Alex Campbell, and John Fletcher - for their valuable reviews and suggestions, and thank Benoit Claise - and Radek Krejci for their validation of the YANG module. + Mizrahi, Opher Ronen, Liang Geng, Alex Campbell, Tom Petch and John + Fletcher for their valuable reviews and suggestions, and thank + Benoit Claise and Radek Krejci for their validation of the YANG + module. Appendix A Transferring YANG Work to IEEE 1588 WG (Informational) This appendix describes a future plan to transition responsibility for IEEE 1588 YANG modules from the IETF TICTOC Working Group (WG) to the IEEE 1588 WG, which develops the time synchronization technology that the YANG modules are designed to manage. This appendix is forward-looking with regard to future standardization roadmaps in IETF and IEEE. Since those roadmaps @@ -1197,29 +1208,28 @@ organizations. IEEE 802 has an active PAR (IEEE P802d) for creating a URN namespace for IEEE use (see http://standards.ieee.org/develop/project/802d.html). It is likely that this IEEE 802 PAR will be approved and published prior to the transfer of YANG work to the IEEE 1588 WG. If so, the IEEE 1588 WG can use the IEEE URN namespace for the first IEEE 1588 YANG module, such as: - urn:ieee:Std:1588:yang:ieee1588-ptp-dataset + urn:ieee:Std:1588:yang:ieee1588-ptp - where "ieee1588-ptp-dataset" is the registered YANG module name in - the IEEE. + where "ieee1588-ptp" is the registered YANG module name in the IEEE. Under the assumptions of section A.1, the first IEEE 1588 YANG module prefix can be the same as the last IETF 1588 YANG module - prefix (i.e. "ptp-dataset"), since the nodes within both YANG - modules are compatible. + prefix (i.e. "ptp"), since the nodes within both YANG modules are + compatible. The result of these name changes are that for complete compatibility, a server (i.e. IEEE 1588 node) can choose to implement a YANG module for the last IETF 1588 YANG module (with IETF root) as well as the first IEEE 1588 YANG module (with IEEE root). Since the content of the YANG module transferred are the same, the server implementation is effectively common for both. From a client's perspective, a client of the last IETF 1588 YANG module (or earlier) looks for the IETF-rooted module name; and a