draft-ietf-tictoc-1588v2-yang-09.txt   draft-ietf-tictoc-1588v2-yang-10.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: January 2019 July 24, 2018 Expires: March 2019 September 10, 2018
YANG Data Model for IEEE 1588-2008 YANG Data Model for IEEE 1588-2008
draft-ietf-tictoc-1588v2-yang-09 draft-ietf-tictoc-1588v2-yang-10
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. 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).
Status of this Memo Status of this Memo
skipping to change at page 1, line 45 skipping to change at page 1, line 45
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 January 24, 2019. This Internet-Draft will expire on March 10, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2018 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 9, line 11 skipping to change at page 9, line 11
case, an implementation MAY choose to return a warning upon writing case, an implementation MAY choose to return a warning upon writing
to a read-only member, or use the deviation mechanism to develop a to a read-only member, or use the deviation mechanism to develop a
new deviation model as described in Section 7.20.3 of [RFC7950]. new deviation model as described in Section 7.20.3 of [RFC7950].
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-07-24.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 {
yang-version 1.1; yang-version 1.1;
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;
reference reference
"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";
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>
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 "2018-07-24" { revision "2018-09-10" {
//Note to RFC Editor: update the date to date of publication //Note to RFC Editor: update the date to date of publication
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
} }
typedef delay-mechanism-enumeration { typedef delay-mechanism-enumeration {
type enumeration { type enumeration {
enum e2e { enum e2e {
skipping to change at page 13, line 23 skipping to change at page 13, line 23
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
1588-2008 subclause 8.2.1)."; 1588-2008 subclause 8.2.1). This data set represents
the configuration/state required for operation
of Precision Time Protocol (PTP) state machines.";
leaf two-step-flag { leaf two-step-flag {
type boolean; type boolean;
description description
"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;
description description
"The clockIdentity of the local clock"; "The clockIdentity of the local clock";
} }
leaf number-ports { leaf number-ports {
skipping to change at page 14, line 34 skipping to change at page 14, line 38
type boolean; type boolean;
description description
"When set to true, the clock is a slave-only clock."; "When set to true, the clock is a slave-only clock.";
} }
} }
container current-ds { container current-ds {
description description
"The current data set of the clock (see IEEE Std "The current data set of the clock (see IEEE Std
1588-2008 subclause 8.2.2)."; 1588-2008 subclause 8.2.2). This data set represents
local states learned from the exchange of
Precision Time Protocol (PTP) messages.";
leaf steps-removed { leaf steps-removed {
type uint16; type uint16;
default 0; default 0;
description description
"The number of communication paths traversed "The number of communication paths traversed
between the local clock and the grandmaster clock."; between the local clock and the grandmaster clock.";
} }
leaf offset-from-master { leaf offset-from-master {
skipping to change at page 22, line 31 skipping to change at page 22, line 34
} }
} }
} }
} }
<CODE ENDS> <CODE ENDS>
4. Security Considerations 4. Security Considerations
YANG modules are designed to be accessed via the NETCONF protocol The YANG module specified in this document defines a schema for
[RFC6241], thus security considerations in [RFC6241] apply here. data that is designed to be accessed via network management
Security measures such as using the NETCONF over SSH [RFC6242] and protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The
restricting its use with access control [RFC8341] can further lowest NETCONF layer is the secure transport layer, and the
improve its security, avoid injection attacks and misuse of the mandatory-to-implement secure transport is Secure Shell (SSH)
protocol. Furthermore, general security considerations of time [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-
protocols are discussed in [RFC7384]. to-implement secure transport is TLS [RFC8446]. Furthermore,
general security considerations of time protocols are discussed in
[RFC7384].
All subtrees and most data nodes defined in this YANG module are The NETCONF access control model [RFC8341] provides the means to
writable: restrict access for particular NETCONF or RESTCONF users to a
preconfigured subset of all available NETCONF or RESTCONF protocol
operations and content.
There are a number of data nodes defined in this YANG module are
writable, and the involved subtrees that are sensitive include:
/ptp/instance-list specifies an instance (i.e., PTP data sets) for /ptp/instance-list specifies an instance (i.e., PTP data sets) for
an OC or BC. an OC or BC.
/ptp/transparent-clock-default-ds specifies a default data set for /ptp/transparent-clock-default-ds specifies a default data set for
a TC. a TC.
/ptp/transparent-clock-port-ds-list specifies a list of port data /ptp/transparent-clock-port-ds-list specifies a list of port data
sets for a TC. sets for a TC.
An inappropriate use of them may adversely impact a PTP Write operations (e.g., edit-config) to these data nodes without
synchronization network. For example, loss of synchronization on a proper protection can have a negative effect on network operations.
clock, accuracy degradation on a set of clocks, or even break down Specifically, an inappropriate configuration of them may adversely
of a whole synchronization network. impact a PTP 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 5. IANA Considerations
This document registers the following URI in the "IETF XML This document registers the following URI in the "IETF XML
registry" [RFC3688]: registry" [RFC3688]:
URI: urn:ietf:params:xml:ns:yang:ietf-ptp URI: urn:ietf:params:xml:ns:yang:ietf-ptp
Registrant Contact: The IESG Registrant Contact: The IESG
XML: N/A; the requested URI is an XML namespace XML: N/A; the requested URI is an XML namespace
This document registers the following YANG module in the "YANG This document registers the following YANG module in the "YANG
skipping to change at page 23, line 33 skipping to change at page 23, line 44
Reference: RFC XXXX Reference: RFC XXXX
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
[RFC3688] Mealling, M., "The IETF XML Registry", RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", RFC 3688,
January 2004, January 2004
[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
[RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and Bierman,
Bierman, "Network Configuration Protocol (NETCONF)", RFC A., "Network Configuration Protocol (NETCONF)", RFC 6241,
6241, June 2011 June 2011
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, June 2011 Shell (SSH)", RFC 6242, June 2011
[RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991, [RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991,
July 2013 July 2013
[RFC7950] Bjorklund, M., "The YANG 1.1 Data Modeling Language", RFC [RFC7950] Bjorklund, M., "The YANG 1.1 Data Modeling Language", RFC
7950, August 2016 7950, August 2016
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, January 2017
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, May 2017 2119 Key Words", BCP 14, RFC 8174, May 2017
[RFC8341] Bierman, A. and Bjorklund, M., "Network Configuration [RFC8341] Bierman, A. and Bjorklund, M., "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 8341, March Protocol (NETCONF) Access Control Model", RFC 8341, March
2018 2018
[RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore Architecture and R. Wilton, "Network Management Datastore Architecture
(NMDA)", RFC 8342, March 2018 (NMDA)", RFC 8342, March 2018
[RFC8343] Bjorklund, M., "A YANG Data Model for Interface [RFC8343] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 8343, March 2018 Management", RFC 8343, March 2018
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS)
Protocol Version 1.3", RFC 8446, August 2018
[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
skipping to change at page 28, line 18 skipping to change at page 28, line 18
When work on the first IEEE YANG module begins in the IEEE 1588 WG, When work on the first IEEE YANG module begins in the IEEE 1588 WG,
that work derives from the last IETF YANG module of this RFC, that work derives from the last IETF YANG module of this RFC,
requiring a transfer of that work from the IETF to the IEEE. In requiring a transfer of that work from the IETF to the IEEE. In
order to avoid having the transfer of that work be dependent on the order to avoid having the transfer of that work be dependent on the
availability of this RFC's authors at the time of its publication, availability of this RFC's authors at the time of its publication,
the IEEE Standards Association department of Risk Management and the IEEE Standards Association department of Risk Management and
Licensing provided the appropriate forms and mechanisms for this Licensing provided the appropriate forms and mechanisms for this
document's authors to assign a non-exclusive license for IEEE to document's authors to assign a non-exclusive license for IEEE to
create derivative works from this document. Those IEEE forms and create derivative works from this document. Those IEEE forms and
mechanisms will be updated as needed during the development of this mechanisms will be updated as needed for any future IETF YANG
document (Note: i.e., RFC XXXX, update it to the actual RFC if modules for IEEE 1588 (The signed forms are held by the IEEE
published) and any future IETF YANG modules for IEEE 1588. This Standards Association department of Risk Management and Licensing.).
will help to make the future transfer of work from IETF to IEEE This will help to make the future transfer of work from IETF to
occur as smoothly as possible. IEEE occur as smoothly as possible.
As stated in the initial "Status of this Memo", the YANG module in As stated in the initial "Status of this Memo", the YANG module in
this document conforms to the provisions of BCP 78. The IETF will this document conforms to the provisions of BCP 78. The IETF will
retain all the rights granted at the time of publication in the retain all the rights granted at the time of publication in the
published RFCs. published RFCs.
A.3. Namespace and Module Name A.3. Namespace and Module Name
As specified in Section 5 "IANA Considerations", the YANG module in As specified in Section 5 "IANA Considerations", the YANG module in
this document uses IETF as the root of its URN namespace and YANG this document uses IETF as the root of its URN namespace and YANG
 End of changes. 17 change blocks. 
31 lines changed or deleted 51 lines changed or added

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