draft-ietf-tictoc-1588v2-yang-10.txt
Internet Working Group Y. Jiang, Ed. Internet Working Group Y. Jiang, Ed.
Internet-Draft X. Liu Internet-Draft X. Liu
Intended status: Standards Track J. Xu Intended status: Standards Track J. Xu
R. Cummings, Ed. R. Cummings, Ed.
National Instruments National Instruments
Expires: March 2019 September 10, 2018 Expires: July 2019 January 3, 2019
YANG Data Model for IEEE 1588-2008 YANG Data Model for IEEE 1588-2008
draft-ietf-tictoc-1588v2-yang-10 draft-ietf-tictoc-1588v2-yang-11
This document defines a YANG data model for the configuration of This document defines a YANG data model for the configuration of
IEEE 1588-2008 devices and clocks, and also retrieval of the IEEE 1588-2008 devices and clocks, and also retrieval of the
configuration information, data set and running states of IEEE configuration information, data set and running states of IEEE
1588-2008 clocks. The YANG module in this document conforms to the 1588-2008 clocks. The YANG module in this document conforms to the
Network Management Datastore Architecture (NMDA). Network Management Datastore Architecture (NMDA).
documents at any time. It is inappropriate to use Internet-Drafts documents at any time. It is inappropriate to use Internet-Drafts
as reference material or to cite them other than as "work in as reference material or to cite them other than as "work in
progress." progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html http://www.ietf.org/shadow.html
This Internet-Draft will expire on March 10, 2019. This Internet-Draft will expire on July 3, 2019.
carefully, as they describe your rights and restrictions with carefully, as they describe your rights and restrictions with
respect to this document. Code Components extracted from this respect to this document. Code Components extracted from this
document must include Simplified BSD License text as described in document must include Simplified BSD License text as described in
Section 4.e of the Trust Legal Provisions and are provided without Section 4.e of the Trust Legal Provisions and are provided without
warranty as described in the Simplified BSD License. warranty as described in the Simplified BSD License.
1. Introduction ............................................... 2 1. Introduction .............................................. 2
1.1. Conventions used in this document ....................... 4 1.1. Conventions used in this document ...................... 4
1.2. Terminology ............................................. 4 1.2. Terminology ............................................ 4
2. IEEE 1588-2008 YANG Model hierarchy ........................ 5 2. IEEE 1588-2008 YANG Model hierarchy ....................... 5
2.1. Interpretations from IEEE 1588 Working Group ............ 8 2.1. Interpretations from IEEE 1588 Working Group ........... 8
2.2. Configuration and state ................................. 8 2.2. Configuration and state ................................ 8
3. IEEE 1588-2008 YANG Module ................................. 9 3. IEEE 1588-2008 YANG Module ................................ 9
4. Security Considerations ................................... 22 4. Security Considerations .................................. 22
5. IANA Considerations ....................................... 23 5. IANA Considerations ...................................... 23
6. References ................................................ 23 6. References ............................................... 23
6.1. Normative References ................................... 23 6.1. Normative References .................................. 23
6.2. Informative References ................................. 24 6.2. Informative References ................................ 24
7. Acknowledgments ........................................... 25 7. Acknowledgments .......................................... 25
Appendix A Transferring YANG Work to IEEE 1588 WG ............. 26 Appendix A Transferring YANG Work to IEEE 1588 WG ............ 26
A.1. Assumptions for the Transfer ........................... 27 A.1. Assumptions for the Transfer .......................... 27
A.2. Intellectual Property Considerations ................... 27 A.2. Intellectual Property Considerations .................. 27
A.3. Namespace and Module Name .............................. 28 A.3. Namespace and Module Name ............................. 28
A.4. IEEE 1588 YANG Modules in ASCII Format ................. 29 A.4. IEEE 1588 YANG Modules in ASCII Format ................ 29
As a synchronization protocol, IEEE 1588-2008 [IEEE1588] is widely As a synchronization protocol, IEEE 1588-2008 [IEEE1588] is widely
supported in the carrier networks, industrial networks, automotive supported in the carrier networks, industrial networks, automotive
networks, and many other applications. It can provide high networks, and many other applications. It can provide high
precision time synchronization as fine as nano-seconds. The precision time synchronization as fine as nano-seconds. The
protocol depends on a Precision Time Protocol (PTP) engine to protocol depends on a Precision Time Protocol (PTP) engine to
decide its own state automatically, and a PTP transportation layer decide its own state automatically, and a PTP transportation layer
to carry the PTP timing and various quality messages. The to carry the PTP timing and various quality messages. The
It is expected that the IEEE 1588-2008 YANG module be used as It is expected that the IEEE 1588-2008 YANG module be used as
follows: follows:
o The IEEE 1588-2008 YANG module can be used as-is for products 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- that conform to one of the default profiles specified in IEEE 1588-
2008. 2008.
o When the IEEE 1588 standard is revised (e.g. the IEEE 1588 o When the IEEE 1588 standard is revised (e.g. the IEEE 1588
revision in progress at the time of writing this document), it will revision in progress at the time of writing this document), it will
add some new optional features to its data sets. The YANG module add some new optional features to its data sets. The YANG module
of this document MAY be revised and extended to support these new of this document can be revised and extended to support these new
features. Moreover, the YANG "revision" SHOULD be used to indicate features. Moreover, the YANG "revision" MUST be used to indicate
changes to the YANG module under such a circumstance. changes to the YANG module under such a circumstance.
o A profile standard based on IEEE 1588-2008 may create a o A profile standard based on IEEE 1588-2008 may create a
dedicated YANG module for its profile. The profile's YANG module dedicated YANG module for its profile. The profile's YANG module
SHOULD use YANG "import" to import the IEEE 1588-2008 YANG module SHOULD use YANG "import" to import the IEEE 1588-2008 YANG module
as its foundation. Then the profile's YANG module SHOULD use YANG as its foundation. Then the profile's YANG module SHOULD use YANG
"augment" to add any profile-specific enhancements. "augment" to add any profile-specific enhancements.
o A product that conforms to a profile standard can also create o A product that conforms to a profile standard may also create
its own YANG module. The product's YANG module SHOULD "import" the its own YANG module. The product's YANG module SHOULD "import" the
profile's module, and then use YANG "augment" to add any product- profile's module, and then use YANG "augment" to add any product-
specific enhancements. specific enhancements.
1.1. Conventions used in this document 1.1. Conventions used in this document
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
"MAY", and "OPTIONAL" in this document are to be interpreted as "MAY", and "OPTIONAL" in this document are to be interpreted as
described in BCP 14 [RFC2119] [RFC8174] when, and only when, they described in BCP 14 [RFC2119] [RFC8174] when, and only when, they
- Static: Read-only to management, and the value typically does not - Static: Read-only to management, and the value typically does not
change. change.
For details on the classification of each PTP data set member, For details on the classification of each PTP data set member,
refer to the IEEE Std 1588-2008 specification for that member. refer to the IEEE Std 1588-2008 specification for that member.
Under certain circumstances, the classification of an IEEE 1588 Under certain circumstances, the classification of an IEEE 1588
data set member may change for a YANG implementation, for example, data set member may change for a YANG implementation, for example,
a configurable member needs to be changed to read-only. In such a a configurable member needs to be changed to read-only. In such a
case, an implementation MAY choose to return a warning upon writing case, an implementation SHOULD choose to return a warning upon
to a read-only member, or use the deviation mechanism to develop a writing to a read-only member, or use the deviation mechanism to
new deviation model as described in Section 7.20.3 of [RFC7950]. develop a new deviation model as described in Section 7.20.3 of
3. IEEE 1588-2008 YANG Module 3. IEEE 1588-2008 YANG Module
This module imports typedef "interface-ref" from [RFC8343]. Most This module imports typedef "interface-ref" from [RFC8343]. Most
attributes are based on the information model defined in [IEEE1588], attributes are based on the information model defined in [IEEE1588],
but their names are adapted to the YANG style of naming. but their names are adapted to the YANG style of naming.
<CODE BEGINS> file "ietf-ptp@2018-09-10.yang" <CODE BEGINS> file "ietf-ptp@2018-09-10.yang"
//Note to RFC Editor: update the date to date of publication //Note to RFC Editor: update the date to date of publication
module ietf-ptp { module ietf-ptp {
"RFC8343: A YANG Data Model for Interface Management"; "RFC8343: A YANG Data Model for Interface Management";
organization "IETF TICTOC Working Group"; organization "IETF TICTOC Working Group";
"WG Web: http://tools.ietf.org/wg/tictoc/ "WG Web: http://tools.ietf.org/wg/tictoc/
WG List: <mailto:tictoc@ietf.org> WG List: <mailto:tictoc@ietf.org>
Editor: Yuanlong Jiang Editor: Yuanlong Jiang
<mailto:jiangyuanlong@huawei.com> <mailto:jiangyuanlong@huawei.com>
Editor: Rodney Cummings Editor: Rodney Cummings
mailto:rodney.cummings@ni.com"; <mailto:rodney.cummings@ni.com>";
"This YANG module defines a data model for the configuration "This YANG module defines a data model for the configuration
of IEEE 1588-2008 clocks, and also for retrieval of the state of IEEE 1588-2008 clocks, and also for retrieval of the state
data of IEEE 1588-2008 clocks."; data of IEEE 1588-2008 clocks.";
revision "2018-09-10" { revision "2018-09-10" {
description "Initial version"; description "Initial version";
reference "RFC XXXX: YANG Data Model for IEEE 1588-2008"; reference "RFC XXXX: YANG Data Model for IEEE 1588-2008";
//Note to RFC Editor: update RFC XXXX to the actual RFC number //Note to RFC Editor: update RFC XXXX to the actual RFC number
"The default data set of the clock (see IEEE Std "The default data set of the clock (see IEEE Std
1588-2008 subclause 8.2.1). This data set represents 1588-2008 subclause 8.2.1). This data set represents
the configuration/state required for operation the configuration/state required for operation
of Precision Time Protocol (PTP) state machines."; of Precision Time Protocol (PTP) state machines.";
leaf two-step-flag { leaf two-step-flag {
type boolean; type boolean;
"When set to true, the clock is a two-step clock; "When set to true, the clock is a two-step clock;
otherwise,the clock is a one-step clock."; otherwise,the clock is a one-step clock.";
leaf clock-identity { leaf clock-identity {
type clock-identity-type; type clock-identity-type;
config false; config false;
"The clockIdentity of the local clock"; "The clockIdentity of the local clock";
leaf number-ports { leaf number-ports {
[RFC8340] Bjorklund, M., and Berger, L., "YANG Tree Diagrams", RFC [RFC8340] Bjorklund, M., and Berger, L., "YANG Tree Diagrams", RFC
8340, March 2018 8340, March 2018
[RFC8173] Shankarkumar, V., Montini, L., Frost, T., and Dowd, G., [RFC8173] Shankarkumar, V., Montini, L., Frost, T., and Dowd, G.,
"Precision Time Protocol Version 2 (PTPv2) Management "Precision Time Protocol Version 2 (PTPv2) Management
Information Base", RFC 8173, June 2017 Information Base", RFC 8173, June 2017
7. Acknowledgments 7. Acknowledgments
The authors would like to thank Tom Petch, Mahesh Jethanandani, Tal The authors would like to thank Tom Petch, Radek Krejci, Mahesh
Mizrahi, Opher Ronen, Liang Geng, Alex Campbell, Joe Gwinn, John Jethanandani, Tal Mizrahi, Opher Ronen, Liang Geng, Alex Campbell,
Fletcher, William Zhao and Dave Thaler for their valuable reviews Joe Gwinn, John Fletcher, William Zhao and Dave Thaler for their
and suggestions, thank Benoit Claise and Radek Krejci for their valuable reviews and suggestions, thank Benoit Claise and Radek
validation of the YANG module, and thank Jingfei Lv and Zitao Wang Krejci for their validation of the YANG module, and thank Jingfei
for their discussions on IEEE 1588 and YANG respectively. Lv and Zitao Wang for their discussions on IEEE 1588 and YANG
Appendix A Transferring YANG Work to IEEE 1588 WG Appendix A Transferring YANG Work to IEEE 1588 WG
This Appendix is informational. This Appendix is informational.
This appendix describes a future plan to transition responsibility This appendix describes a future plan to transition responsibility
for IEEE 1588 YANG modules from the IETF TICTOC Working Group (WG) for IEEE 1588 YANG modules from the IETF TICTOC Working Group (WG)
to the IEEE 1588 WG, which develops the time synchronization to the IEEE 1588 WG, which develops the time synchronization
technology that the YANG modules are designed to manage. technology that the YANG modules are designed to manage.
that this IEEE 802 PAR will be approved and published prior to the 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 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, can use the IEEE URN namespace for the first IEEE 1588 YANG module,
such as: such as:
urn:ieee:Std:1588:yang:ieee1588-ptp urn:ieee:Std:1588:yang:ieee1588-ptp
where "ieee1588-ptp" 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 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 module's prefix will be the same as the last IETF 1588 YANG
prefix (i.e. "ptp"), since the nodes within both YANG modules are module's prefix (i.e. "ptp"). Consequently, other YANG modules can
compatible. preserve the same import prefix "ptp" to access PTP nodes during
the migration from the last IETF 1588 YANG module to the first IEEE
1588 YANG module.
The result of these name changes are that for complete The result of these name changes are that for complete
compatibility, a server (i.e., IEEE 1588 node) can choose to compatibility, a server (i.e., IEEE 1588 node) can choose to
implement a YANG module for the last IETF 1588 YANG module (with 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 IETF root) as well as the first IEEE 1588 YANG module (with IEEE
root). Since the content of the YANG module transferred are the root). Since the content of the YANG module transferred are the
same, the server implementation is effectively common for both. same, the server implementation is effectively common for both.
From a client's perspective, a client of the last IETF 1588 YANG 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 module (or earlier) looks for the IETF-rooted module name; and a
44 lines changed or deleted
48 lines changed or added