draft-ietf-tictoc-1588v2-yang-04.txt   draft-ietf-tictoc-1588v2-yang-05.txt 
Internet Working Group Y. Jiang, Ed. Internet Working Group Y. Jiang, Ed.
X. Liu X. Liu
Internet-Draft J. Xu Internet-Draft J. Xu
Huawei Huawei
Intended status: Standards Track R. Cummings, Ed. Intended status: Standards Track R. Cummings, Ed.
National Instruments National Instruments
Expires: August 2017 February 8, 2017 Expires: October 2017 April 20, 2017
YANG Data Model for IEEE 1588v2 YANG Data Model for IEEE 1588v2
draft-ietf-tictoc-1588v2-yang-04 draft-ietf-tictoc-1588v2-yang-05
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 42 skipping to change at page 1, line 42
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 August 8, 2017. This Internet-Draft will expire on October 20, 2017.
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 22 skipping to change at page 2, line 22
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.
Table of Contents Table of Contents
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
3. IEEE 1588-2008 YANG Module ................................ 9 2.2. Configuration and state ................................ 8
4. Security Considerations .................................. 22 3. IEEE 1588-2008 YANG Module ............................... 10
5. IANA Considerations ...................................... 22 4. Security Considerations .................................. 23
6. References ............................................... 22 5. IANA Considerations ...................................... 23
6.1. Normative References .................................. 22 6. References ............................................... 23
6.2. Informative References ................................ 22 6.1. Normative References .................................. 23
7. Acknowledgments .......................................... 23 6.2. Informative References ................................ 24
7. Acknowledgments .......................................... 25
Appendix A Transferring YANG Work to IEEE 1588 WG (Informational) Appendix A Transferring YANG Work to IEEE 1588 WG (Informational)
.............................................................. 24 .............................................................. 26
A.1. Assumptions for the Transfer .......................... 24 A.1. Assumptions for the Transfer .......................... 26
A.2. Intellectual Property Considerations .................. 25 A.2. Intellectual Property Considerations .................. 27
A.3. Namespace and Module Name ............................. 26 A.3. Namespace and Module Name ............................. 28
A.4. IEEE 1588 YANG Modules in ASCII Format ................ 27 A.4. IEEE 1588 YANG Modules in ASCII Format ................ 29
1. Introduction 1. Introduction
As a synchronization protocol, IEEE 1588-2008 (also known as IEEE As a synchronization protocol, IEEE 1588-2008 (also known as IEEE
1588v2) [IEEE1588] is widely supported in the carrier networks, 1588v2) [IEEE1588] is widely supported in the carrier networks,
industrial networks, automotive networks, and many other industrial networks, automotive networks, and many other
applications. It can provide high precision time synchronization as applications. It can provide high precision time synchronization as
fine as nano-seconds. The protocol depends on a Precision Time fine as nano-seconds. The protocol depends on a Precision Time
Protocol (PTP) engine to decide its own state automatically, and a Protocol (PTP) engine to decide its own state automatically, and a
PTP transportation layer to carry the PTP timing and various PTP transportation layer to carry the PTP timing and various
skipping to change at page 5, line 38 skipping to change at page 5, line 42
- 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
each of them in the YANG module. each of them in the YANG module.
A simplified graphical representation of the data model is A simplified graphical representation of the data model is
typically used by YANG modules as described in [REST-CONF]. This typically used by YANG modules as described in [RFC8040]. This
document uses the same representation and the meaning of the document uses the same representation and the meaning of the
symbols in these diagrams is as follows: symbols in these diagrams is as follows:
o Brackets "[" and "]" enclose list keys. o Brackets "[" and "]" enclose list keys.
o Abbreviations before data node names: "rw" means configuration o Abbreviations before data node names: "rw" means configuration
data (read-write) and "ro" state data (read-only). data (read-write) and "ro" state data (read-only).
o Symbols after data node names: "?" means an optional node, "!" o Symbols after data node names: "?" means an optional node, "!"
means a presence container, and "*" denotes a list and leaf-list. means a presence container, and "*" denotes a list and leaf-list.
skipping to change at page 7, line 16 skipping to change at page 7, line 19
| | +--rw time-traceable? boolean | | +--rw time-traceable? boolean
| | +--rw frequency-traceable? boolean | | +--rw frequency-traceable? boolean
| | +--rw ptp-timescale? boolean | | +--rw ptp-timescale? boolean
| | +--rw time-source? uint8 | | +--rw time-source? uint8
| +--rw port-ds-list* [port-number] | +--rw port-ds-list* [port-number]
| +--rw port-number -> ../port-identity/port-number | +--rw port-number -> ../port-identity/port-number
| +--rw port-identity | +--rw port-identity
| | +--rw clock-identity? clock-identity-type | | +--rw clock-identity? clock-identity-type
| | +--rw port-number? uint16 | | +--rw port-number? uint16
| +--rw port-state? port-state-enumeration | +--rw port-state? port-state-enumeration
| +--rw underlying-interface? if:interface-ref
| +--rw log-min-delay-req-interval? int8 | +--rw log-min-delay-req-interval? int8
| +--rw peer-mean-path-delay? time-interval-type | +--rw peer-mean-path-delay? time-interval-type
| +--rw log-announce-interval? int8 | +--rw log-announce-interval? int8
| +--rw announce-receipt-timeout? uint8 | +--rw announce-receipt-timeout? uint8
| +--rw log-sync-interval? int8 | +--rw log-sync-interval? int8
| +--rw delay-mechanism? delay-mechanism-enumeration | +--rw delay-mechanism? delay-mechanism-enumeration
| +--rw log-min-pdelay-req-interval? int8 | +--rw log-min-pdelay-req-interval? int8
| +--rw version-number? uint8 | +--rw version-number? uint8
+--rw transparent-clock-default-ds +--rw transparent-clock-default-ds
| +--rw clock-identity? clock-identity-type | +--rw clock-identity? clock-identity-type
skipping to change at page 9, line 5 skipping to change at page 8, line 29
described in the new revision of IEEE 1588. The instance concept is described in the new revision of IEEE 1588. The instance concept is
used exclusively to allow for optional support of multiple domains. used exclusively to allow for optional support of multiple domains.
The instance number has no usage within PTP messages. The instance number has no usage within PTP messages.
Based on statements in IEEE 1588-2008 subclauses 8.3.1. and 10.1, Based on statements in IEEE 1588-2008 subclauses 8.3.1. and 10.1,
most transparent clock products have interpreted the transparent most transparent clock products have interpreted the transparent
clock data sets to reside as a singleton at the root level of the clock data sets to reside as a singleton at the root level of the
managed product. Since 1588-2008 transparent clocks are domain managed product. Since 1588-2008 transparent clocks are domain
independent, the instance concept is not applicable for domains. independent, the instance concept is not applicable for domains.
2.2. Configuration and state
The information model of IEEE Std 1588-2008 classifies each member
in PTP data sets as one of the following:
- Configurable: Writable by management.
- Dynamic: Read-only to management, and the value is changed by
1588 protocol operation.
- 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 example, each PTP port's port-state
is normally Dynamic, i.e., it is read-only to management and only
IEEE 1588 protocol determines its value. Nevertheless, some IEEE
1588-2008 products support a proprietary boolean attribute (e.g.,
leaf in a product-specific 1588 YANG augment) that allows the port-
state to be configured externally. When the proprietary boolean is
false, the port-state is Dynamic, representing YANG state data.
When the proprietary boolean is true, the port-state is
Configurable, representing YANG configuration data.
Future revisions of the IEEE 1588 standard are considering formal
standardization of this sort of proprietary feature, this will be
reflected in future 1588 YANG module revisions but out scope of
this document.
Due to the fact that the classification of 1588 members can change,
this model uses a single-tree of YANG hierarch rather than
separates it into a configuration data tree and a state data tree.
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 3. IEEE 1588-2008 YANG Module
<CODE BEGINS> file "ietf-ptp-dataset@2017-02-08.yang" <CODE BEGINS> file "ietf-ptp-dataset@2017-04-20.yang"
module ietf-ptp-dataset{ module ietf-ptp-dataset{
namespace "urn:ietf:params:xml:ns:yang:ietf-ptp-dataset"; namespace "urn:ietf:params:xml:ns:yang:ietf-ptp-dataset";
prefix "ptp-dataset"; prefix "ptp-dataset";
import ietf-interfaces {
prefix if;
}
organization "IETF TICTOC Working Group"; organization "IETF TICTOC Working Group";
contact contact
"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>
WG Chair: Karen O'Donoghue WG Chair: Karen O'Donoghue
<mailto:odonoghue@isoc.org> <mailto:odonoghue@isoc.org>
WG Chair: Yaakov Stein WG Chair: Yaakov Stein
<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-02-08" { revision "2017-04-20" {
description "Version 4.0"; description "Version 5.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 "The port uses the delay request-response
mechanism."; mechanism.";
} }
enum P2P { enum P2P {
skipping to change at page 17, line 31 skipping to change at page 18, line 35
uses port-identity-grouping; uses port-identity-grouping;
} }
leaf port-state { leaf port-state {
type port-state-enumeration; type port-state-enumeration;
default "INITIALIZING"; default "INITIALIZING";
description description
"Current state associated with the port."; "Current state associated with the port.";
} }
leaf underlying-interface {
type if:interface-ref;
description
"Reference to the configured underlying interface that is
used by this PTP Port (see RFC 7223).";
}
leaf log-min-delay-req-interval { leaf log-min-delay-req-interval {
type int8; type int8;
description description
"The base-two logarithm of the minDelayReqInterval "The base-two logarithm of the minDelayReqInterval
(the minimum permitted mean time interval between (the minimum permitted mean time interval between
successive Delay_Req messages)."; successive Delay_Req messages).";
} }
leaf peer-mean-path-delay { leaf peer-mean-path-delay {
type time-interval-type; type time-interval-type;
skipping to change at page 22, line 41 skipping to change at page 24, line 8
[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,
October 2010 October 2010
[RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991, [RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991,
July 2013 July 2013
[RFC7223] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 7223, May 2014
[IEEE1588] IEEE, "IEEE Standard for a Precision Clock [IEEE1588] IEEE, "IEEE Standard for a Precision Clock
Synchronization Protocol for Networked Measurement and Synchronization Protocol for Networked Measurement and
Control Systems", IEEE Std 1588-2008, July 2008 Control Systems", IEEE Std 1588-2008, July 2008
6.2. Informative References 6.2. Informative References
[IEEE8021AS] IEEE, "Timing and Synchronizations for Time-Sensitive [IEEE8021AS] IEEE, "Timing and Synchronizations for Time-Sensitive
Applications in Bridged Local Area Networks", IEEE Applications in Bridged Local Area Networks", IEEE
802.1AS-2001, 2011 802.1AS-2001, 2011
[PTP-MIB] Shankarkumar, V., Montini, L., Frost, T., and Dowd, G., [PTP-MIB] 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", draft-ietf-tictoc-ptp-mib-11, Work in Information Base", draft-ietf-tictoc-ptp-mib-12, Work in
progress progress
[REST-CONF] Bierman, A., Bjorklund, M., and Watsen, K., "RESTCONF [RFC8040] Bierman, A., Bjorklund, M., and Watsen, K., "RESTCONF
protocol", draft-ietf-netconf-restconf-18, Work in protocol", RFC 8040, January 2017
progress
[RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between [RFC3444] Pras, A. and J. Schoenwaelder, "On the Difference between
Information Models and Data Models", RFC 3444, January Information Models and Data Models", RFC 3444, January
2003 2003
[RFC4663] Harrington, D., "Transferring MIB Work from IETF Bridge [RFC4663] Harrington, D., "Transferring MIB Work from IETF Bridge
MIB WG to IEEE 802.1 WG", RFC 4663, September 2006 MIB WG to IEEE 802.1 WG", RFC 4663, September 2006
[RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A.
Bierman, "Network Configuration Protocol (NETCONF)", RFC Bierman, "Network Configuration Protocol (NETCONF)", RFC
 End of changes. 17 change blocks. 
27 lines changed or deleted 78 lines changed or added

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