draft-ietf-tictoc-1588v2-yang-06.txt   draft-ietf-tictoc-1588v2-yang-07.txt 
Internet Working Group Y. Jiang, Ed. Internet Working Group Y. Jiang, Ed.
Huawei Huawei
Internet-Draft X. Liu Internet-Draft X. Liu
Independent Independent
Intended status: Standards Track J. Xu Intended status: Standards Track J. Xu
Huawei Huawei
R. Cummings, Ed. R. Cummings, Ed.
National Instruments National Instruments
Expires: April 2018 October 26, 2017 Expires: May 2018 November 28, 2017
YANG Data Model for IEEE 1588-2008 YANG Data Model for IEEE 1588-2008
draft-ietf-tictoc-1588v2-yang-06 draft-ietf-tictoc-1588v2-yang-07
Abstract Abstract
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. 1588-2008 clocks.
Status of this Memo Status of this Memo
skipping to change at page 1, line 44 skipping to change at page 1, line 44
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 April 26, 2018. This Internet-Draft will expire on May 28, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 31 skipping to change at page 2, line 31
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 ................................ 23 6.2. Informative References ................................ 23
7. Acknowledgments .......................................... 24 7. Acknowledgments .......................................... 24
Appendix A Transferring YANG Work to IEEE 1588 WG (Informational) Appendix A Transferring YANG Work to IEEE 1588 WG (Informational)
................................................................. 25 ............................................................... 25
A.1. Assumptions for the Transfer .......................... 25 A.1. Assumptions for the Transfer .......................... 25
A.2. Intellectual Property Considerations .................. 26 A.2. Intellectual Property Considerations .................. 26
A.3. Namespace and Module Name ............................. 27 A.3. Namespace and Module Name ............................. 27
A.4. IEEE 1588 YANG Modules in ASCII Format ................ 28 A.4. IEEE 1588 YANG Modules in ASCII Format ................ 28
1. Introduction 1. Introduction
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
skipping to change at page 3, line 48 skipping to change at page 3, line 48
scope of this document. scope of this document.
When used in practice, network products in support of When used in practice, network products in support of
synchronization typically conform to one or more IEEE 1588-2008 synchronization typically conform to one or more IEEE 1588-2008
profiles. Each profile specifies how IEEE 1588-2008 is used in a profiles. Each profile specifies how IEEE 1588-2008 is used in a
given industry (e.g. telecom, automotive) and application. A given industry (e.g. telecom, automotive) and application. A
profile can require features that are optional in IEEE 1588-2008, profile can require features that are optional in IEEE 1588-2008,
and it can specify new features that use IEEE 1588-2008 as a and it can specify new features that use IEEE 1588-2008 as a
foundation. 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: 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 scheduled to be published in 2017), it will revision in progress scheduled to be published in 2017), 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 can be revised and extended to add the new of this document can be revised and extended to add the new
skipping to change at page 4, line 38 skipping to change at page 4, line 38
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in
this document are to be interpreted as described in [RFC2119]. this document are to be interpreted as described in [RFC2119].
1.2. Terminology 1.2. Terminology
Most terminologies used in this document are extracted from Most terminologies used in this document are extracted from
[IEEE1588]. [IEEE1588].
BC Boundary Clock BC Boundary Clock
DS Data Set DS Data Set
E2E End-to-End E2E End-to-End
EUI Extended Unique Identifier. EUI Extended Unique Identifier.
GPS Global Positioning System GPS Global Positioning System
IANA Internet Assigned Numbers Authority IANA Internet Assigned Numbers Authority
IP Internet Protocol IP Internet Protocol
skipping to change at page 5, line 20 skipping to change at page 5, line 20
P2P Peer-to-Peer P2P Peer-to-Peer
PTP Precision Time Protocol PTP Precision Time Protocol
TAI International Atomic Time TAI International Atomic Time
TC Transparent Clock TC Transparent Clock
UTC Coordinated Universal Time UTC Coordinated Universal Time
PTP dataset Structured attributes of clocks (an OC, BC or TC) used PTP dataset
for PTP protocol decisions and for providing values for PTP message Structured attributes of clocks (an OC, BC or TC) used for
fields, see Section 8 of [IEEE1588]. 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
represented by a specific PTP dataset. 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 2. IEEE 1588-2008 YANG Model hierarchy
This section describes the hierarchy of an IEEE 1588-2008 YANG This section describes the hierarchy of an IEEE 1588-2008 YANG
module. Query and configuration of device wide or port specific 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. version.
Query and configuration of clock information include: 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, - Clock data set attributes in a clock node, including: current-ds,
parent-ds, default-ds, time-properties-ds, and transparent-clock- parent-ds, default-ds, time-properties-ds, and transparent-clock-
default-ds. default-ds.
- Port-specific data set attributes, including: port-ds and - Port-specific data set attributes, including: port-ds and
transparent-clock-port-ds. transparent-clock-port-ds.
The readers are assumed to be familiar with IEEE 1588-2008. As all The readers are assumed to be familiar with IEEE 1588-2008. As all
PTP terminologies and PTP data set attributes are described in PTP terminologies and PTP data set attributes are described in
details in IEEE 1588-2008 [IEEE1588], this document only outlines details in IEEE 1588-2008 [IEEE1588], this document only outlines
skipping to change at page 6, line 28 skipping to change at page 6, line 36
o Ellipsis ("...") stands for contents of subtrees that are not o Ellipsis ("...") stands for contents of subtrees that are not
shown. shown.
o Arrow ("->") stands for a reference to a particular leaf o Arrow ("->") stands for a reference to a particular leaf
instance in the tree. instance in the tree.
module: ietf-ptp module: ietf-ptp
+--rw ptp +--rw ptp
+--rw instance-list* [instance-number] +--rw instance-list* [instance-number]
| +--rw instance-number uint16 | +--rw instance-number uint32
| +--rw default-ds | +--rw default-ds
| | +--rw two-step-flag? boolean | | +--rw two-step-flag? boolean
| | +--rw clock-identity? clock-identity-type | | +--rw clock-identity? clock-identity-type
| | +--rw number-ports? uint16 | | +--rw number-ports? uint16
| | +--rw clock-quality | | +--rw clock-quality
| | | +--rw clock-class? uint8 | | | +--rw clock-class? uint8
| | | +--rw clock-accuracy? uint8 | | | +--rw clock-accuracy? uint8
| | | +--rw offset-scaled-log-variance? uint16 | | | +--rw offset-scaled-log-variance? uint16
| | +--rw priority1? uint8 | | +--rw priority1? uint8
| | +--rw priority2? uint8 | | +--rw priority2? uint8
skipping to change at page 9, line 7 skipping to change at page 9, line 7
- Static: Read-only to management, and the value typically does not - Static: Read-only to management, and the value typically does not
change. change.
Under certain circumstances, the classification of an IEEE 1588 Under certain circumstances, the classification of an IEEE 1588
data set member can change. For details on the classification of data set member can change. For details on the classification of
each PTP data set member, refer to the IEEE Std 1588-2008 each PTP data set member, refer to the IEEE Std 1588-2008
specification for that member. specification for that member.
3. IEEE 1588-2008 YANG Module 3. IEEE 1588-2008 YANG Module
<CODE BEGINS> 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.
<CODE BEGINS> file "ietf-ptp@2017-11-28.yang"
module ietf-ptp { module ietf-ptp {
namespace "urn:ietf:params:xml:ns:yang:ietf-ptp"; namespace "urn:ietf:params:xml:ns:yang:ietf-ptp";
prefix "ptp"; prefix "ptp";
import ietf-interfaces { import ietf-interfaces {
prefix if; prefix if;
} }
organization "IETF TICTOC Working Group"; organization "IETF TICTOC Working Group";
skipping to change at page 9, line 34 skipping to change at page 9, line 38
<mailto: Yaakov_s@rad.com> <mailto: Yaakov_s@rad.com>
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>";
description description
"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 "2017-10-20" { revision "2017-11-28" {
description "Version 6.0"; description "Version 7.0";
reference "draft-ietf-tictoc-1588v2-yang"; reference "draft-ietf-tictoc-1588v2-yang";
} }
typedef delay-mechanism-enumeration { typedef delay-mechanism-enumeration {
type enumeration { type enumeration {
enum e2e { enum e2e {
value 1; value 1;
description description
"The port uses the delay request-response mechanism."; "The port uses the delay request-response mechanism.";
} }
skipping to change at page 13, line 6 skipping to change at page 13, line 11
key "instance-number"; key "instance-number";
description description
"List of one or more PTP datasets in the device (see IEEE "List of one or more PTP datasets in the device (see IEEE
Std 1588-2008 subclause 6.3). Std 1588-2008 subclause 6.3).
Each PTP dataset represents a distinct instance of Each PTP dataset represents a distinct instance of
PTP implementation in the device (i.e. distinct PTP implementation in the device (i.e. distinct
Ordinary Clock or Boundary Clock)."; Ordinary Clock or Boundary Clock).";
leaf instance-number { leaf instance-number {
type uint16; type uint32;
description description
"The instance number of the current PTP instance. "The instance number of the current PTP instance.
This instance number is used for management purposes This instance number is used for management purposes
only. This instance number does not represent the PTP only. This instance number does not represent the PTP
domain number, and is not used in PTP messages."; domain number, and is not used in PTP messages.";
} }
container default-ds { container default-ds {
description description
"The default data set of the clock (see IEEE Std "The default data set of the clock (see IEEE Std
skipping to change at page 23, line 9 skipping to change at page 23, line 9
Some data nodes defined in this YANG module are writable, and an Some data nodes defined in this YANG module are writable, and an
inappropriate use of them may adversely impact a synchronization inappropriate use of them may adversely impact a synchronization
network. For example, loss of synchronization on a clock, accuracy network. For example, loss of synchronization on a clock, accuracy
degradation on a set of clocks, or even break down of a whole degradation on a set of clocks, or even break down of a whole
synchronization network. synchronization network.
5. IANA Considerations 5. IANA Considerations
This document registers a URI in the IETF XML registry, and the This document registers a URI in the IETF XML registry, and the
following registration is requested to be made: 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: This document registers a YANG module in the YANG Module Names:
name: ietf-ptp-dataset namespace: urn:ietf:params:xml:ns:yang:ietf- name: ietf-ptp namespace: urn:ietf:params:xml:ns:yang:ietf-ptp
ptp-dataset
6. References 6. References
6.1. Normative References 6.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997 Requirement Levels", BCP 14, RFC 2119, March 1997
[RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF) ", RFC 6020, Network Configuration Protocol (NETCONF) ", RFC 6020,
skipping to change at page 24, line 29 skipping to change at page 24, line 25
[RFC8040] Bierman, A., Bjorklund, M., and Watsen, K., "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and Watsen, K., "RESTCONF
protocol", RFC 8040, January 2017 protocol", RFC 8040, January 2017
[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 Joe Gwinn, Mahesh Jethanandani, Tal The authors would like to thank Joe Gwinn, Mahesh Jethanandani, Tal
Mizrahi, Opher Ronen, Liang Geng, Alex Campbell, and John Fletcher Mizrahi, Opher Ronen, Liang Geng, Alex Campbell, Tom Petch and John
for their valuable reviews and suggestions, and thank Benoit Claise Fletcher for their valuable reviews and suggestions, and thank
and Radek Krejci for their validation of the YANG module. Benoit Claise and Radek Krejci for their validation of the YANG
module.
Appendix A Transferring YANG Work to IEEE 1588 WG (Informational) Appendix A Transferring YANG Work to IEEE 1588 WG (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.
This appendix is forward-looking with regard to future This appendix is forward-looking with regard to future
standardization roadmaps in IETF and IEEE. Since those roadmaps standardization roadmaps in IETF and IEEE. Since those roadmaps
skipping to change at page 27, line 46 skipping to change at page 27, line 42
organizations. organizations.
IEEE 802 has an active PAR (IEEE P802d) for creating a URN IEEE 802 has an active PAR (IEEE P802d) for creating a URN
namespace for IEEE use (see namespace for IEEE use (see
http://standards.ieee.org/develop/project/802d.html). It is likely http://standards.ieee.org/develop/project/802d.html). It is likely
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-dataset urn:ieee:Std:1588:yang:ieee1588-ptp
where "ieee1588-ptp-dataset" is the registered YANG module name in where "ieee1588-ptp" is the registered YANG module name in the IEEE.
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 prefix can be the same as the last IETF 1588 YANG module
prefix (i.e. "ptp-dataset"), since the nodes within both YANG prefix (i.e. "ptp"), since the nodes within both YANG modules are
modules are compatible. compatible.
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
skipping to change at page 30, line 5 skipping to change at page 29, line 5
are provided for experimental work (i.e. pre-PAR) as well as are provided for experimental work (i.e. pre-PAR) as well as
standard work (post-PAR drafts). IEEE-SA has approved use of this standard work (post-PAR drafts). IEEE-SA has approved use of this
repository for project development, but not for published standards. repository for project development, but not for published standards.
As an example of public availability of YANG modules for published As an example of public availability of YANG modules for published
standards, IEEE 802.1 provides a public list of ASCII files for MIB standards, IEEE 802.1 provides a public list of ASCII files for MIB
(see http://www.ieee802.org/1/files/public/MIBs/ and (see http://www.ieee802.org/1/files/public/MIBs/ and
http://www.ieee802.org/1/pages/MIBS.html), and analogous lists are http://www.ieee802.org/1/pages/MIBS.html), and analogous lists are
planned for IEEE 802.1 YANG files. planned for IEEE 802.1 YANG files.
Authors' Addresses Authors' Addresses
Yuanlong Jiang (Editor) Yuanlong Jiang (Editor)
Huawei Technologies Co., Ltd. Huawei Technologies Co., Ltd.
Bantian, Longgang district Bantian, Longgang district
Shenzhen 518129, China Shenzhen 518129, China
Email: jiangyuanlong@huawei.com Email: jiangyuanlong@huawei.com
Xian Liu Xian Liu
Independent Independent
Shenzhen 518129, China Shenzhen 518129, China
 End of changes. 23 change blocks. 
36 lines changed or deleted 45 lines changed or added

This html diff was produced by rfcdiff 1.46. The latest version is available from http://tools.ietf.org/tools/rfcdiff/