draft-ietf-ntp-yang-data-model-05.txt   draft-ietf-ntp-yang-data-model-06.txt 
NTP Working Group N. Wu NTP Working Group N. Wu
Internet-Draft D. Dhody Internet-Draft D. Dhody
Intended status: Standards Track Huawei Intended status: Standards Track Huawei
Expires: June 20, 2019 A. Sinha Expires: December 28, 2019 A. Sinha
A. Kumar S N A. Kumar S N
RtBrick Inc. RtBrick Inc.
Y. Zhao Y. Zhao
Ericsson Ericsson
December 17, 2018 June 26, 2019
A YANG Data Model for NTP A YANG Data Model for NTP
draft-ietf-ntp-yang-data-model-05 draft-ietf-ntp-yang-data-model-06
Abstract Abstract
This document defines a YANG data model for Network Time Protocol This document defines a YANG data model for Network Time Protocol
(NTP) implementations. The data model includes configuration data (NTP) implementations. The data model includes configuration data
and state data. and state data.
Requirements Language Requirements Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
skipping to change at page 1, line 45 skipping to change at page 1, line 45
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on June 20, 2019. This Internet-Draft will expire on December 28, 2019.
Copyright Notice Copyright Notice
Copyright (c) 2018 IETF Trust and the persons identified as the Copyright (c) 2019 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
(https://trustee.ietf.org/license-info) in effect on the date of (https://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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Operational State . . . . . . . . . . . . . . . . . . . . 3 1.1. Operational State . . . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 3 1.3. Tree Diagrams . . . . . . . . . . . . . . . . . . . . . . 3
1.4. Prefixes in Data Node Names . . . . . . . . . . . . . . . 3 1.4. Prefixes in Data Node Names . . . . . . . . . . . . . . . 3
1.5. Refrences in the Model . . . . . . . . . . . . . . . . . 4
2. NTP data model . . . . . . . . . . . . . . . . . . . . . . . 4 2. NTP data model . . . . . . . . . . . . . . . . . . . . . . . 4
3. Relationship with NTPv4-MIB . . . . . . . . . . . . . . . . . 8 3. Relationship with NTPv4-MIB . . . . . . . . . . . . . . . . . 9
4. Relationship with RFC 7317 . . . . . . . . . . . . . . . . . 8 4. Relationship with RFC 7317 . . . . . . . . . . . . . . . . . 9
5. Access Rules . . . . . . . . . . . . . . . . . . . . . . . . 9 5. Access Rules . . . . . . . . . . . . . . . . . . . . . . . . 10
6. Key Management . . . . . . . . . . . . . . . . . . . . . . . 9 6. Key Management . . . . . . . . . . . . . . . . . . . . . . . 10
7. NTP YANG Module . . . . . . . . . . . . . . . . . . . . . . . 9 7. NTP YANG Module . . . . . . . . . . . . . . . . . . . . . . . 10
8. Usage Example . . . . . . . . . . . . . . . . . . . . . . . . 32 8. Usage Example . . . . . . . . . . . . . . . . . . . . . . . . 35
8.1. Unicast association . . . . . . . . . . . . . . . . . . . 32 8.1. Unicast association . . . . . . . . . . . . . . . . . . . 36
8.2. Refclock master . . . . . . . . . . . . . . . . . . . . . 34 8.2. Refclock master . . . . . . . . . . . . . . . . . . . . . 37
8.3. Authentication configuration . . . . . . . . . . . . . . 35 8.3. Authentication configuration . . . . . . . . . . . . . . 38
8.4. Access configuration . . . . . . . . . . . . . . . . . . 37 8.4. Access configuration . . . . . . . . . . . . . . . . . . 40
8.5. Multicast configuration . . . . . . . . . . . . . . . . . 37 8.5. Multicast configuration . . . . . . . . . . . . . . . . . 40
8.6. Manycast configuration . . . . . . . . . . . . . . . . . 41 8.6. Manycast configuration . . . . . . . . . . . . . . . . . 44
8.7. Clock state . . . . . . . . . . . . . . . . . . . . . . . 44 8.7. Clock state . . . . . . . . . . . . . . . . . . . . . . . 47
8.8. Get all association . . . . . . . . . . . . . . . . . . . 44 8.8. Get all association . . . . . . . . . . . . . . . . . . . 47
8.9. Global statistic . . . . . . . . . . . . . . . . . . . . 46 8.9. Global statistic . . . . . . . . . . . . . . . . . . . . 49
9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 46 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 49
10. Security Considerations . . . . . . . . . . . . . . . . . . . 47 10. Security Considerations . . . . . . . . . . . . . . . . . . . 50
11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 48 11. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 51
12. References . . . . . . . . . . . . . . . . . . . . . . . . . 48 12. References . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.1. Normative References . . . . . . . . . . . . . . . . . . 48 12.1. Normative References . . . . . . . . . . . . . . . . . . 51
12.2. Informative References . . . . . . . . . . . . . . . . . 50 12.2. Informative References . . . . . . . . . . . . . . . . . 53
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 50 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 53
1. Introduction 1. Introduction
This document defines a YANG [RFC7950] data model for Network Time This document defines a YANG [RFC7950] data model for Network Time
Protocol [RFC5905] implementations. Protocol [RFC5905] implementations.
The data model convers configuration of system parameters of NTP, The data model convers configuration of system parameters of NTP,
such as access rules, authentication and VPN Routing and Forwarding such as access rules, authentication and VPN Routing and Forwarding
(VRF) binding, and also associations of NTP in different modes and (VRF) binding, and also associations of NTP in different modes and
parameters of per-interface. It also provides information about parameters of per-interface. It also provides information about
skipping to change at page 4, line 5 skipping to change at page 4, line 5
data models defined in [RFC8340]. data models defined in [RFC8340].
1.4. Prefixes in Data Node Names 1.4. Prefixes in Data Node Names
In this document, names of data nodes and other data model objects In this document, names of data nodes and other data model objects
are often used without a prefix, as long as it is clear from the are often used without a prefix, as long as it is clear from the
context in which YANG module each name is defined. Otherwise, names context in which YANG module each name is defined. Otherwise, names
are prefixed using the standard prefix associated with the are prefixed using the standard prefix associated with the
corresponding YANG module, as shown in Table 1. corresponding YANG module, as shown in Table 1.
+----------+--------------------------+-----------------------------+ +-----------+--------------------------+-----------+
| Prefix | YANG module | Reference | | Prefix | YANG module | Reference |
+----------+--------------------------+-----------------------------+ +-----------+--------------------------+-----------+
| yang | ietf-yang-types | [RFC6991] | | yang | ietf-yang-types | [RFC6991] |
| inet | ietf-inet-types | [RFC6991] | | inet | ietf-inet-types | [RFC6991] |
| if | ietf-interfaces | [RFC8343] | | if | ietf-interfaces | [RFC8343] |
| ianach | iana-crypt-hash | [RFC7317] | | ianach | iana-crypt-hash | [RFC7317] |
| key- | ietf-key-chain | [RFC8177] | | key-chain | ietf-key-chain | [RFC8177] |
| chain | | | | acl | ietf-access-control-list | [RFC8519] |
| acl | ietf-access-control-list | [I-D.ietf-netmod-acl-model] | | rt-types | ietf-routing-types | [RFC8294] |
| rt-types | ietf-routing-types | [RFC8294] | +-----------+--------------------------+-----------+
+----------+--------------------------+-----------------------------+
Table 1: Prefixes and corresponding YANG modules Table 1: Prefixes and corresponding YANG modules
2. NTP data model 1.5. Refrences in the Model
This document defines the YANG module "ietf-ntp", which has the Following documents are refrenced in the model defined in this
following structure: document -
module: ietf-ntp +-------------------------------------------------------+-----------+
+--rw ntp! | Title | Reference |
+--rw port? inet:port-number {ntp-port}? +-------------------------------------------------------+-----------+
+--rw refclock-master! | Network Time Protocol Version 4: Protocol and | [RFC5905] |
| +--rw master-stratum? ntp-stratum | Algorithms Specification | |
+--rw authentication | Common YANG Data Types | [RFC6991] |
| +--rw auth-enabled? boolean | A YANG Data Model for System Management | [RFC7317] |
| +--rw authentication-keys* [key-id] | YANG Data Model for Key Chains | [RFC8177] |
| +--rw key-id uint32 | Common YANG Data Types for the Routing Area | [RFC8294] |
| +--rw algorithm? identityref | A YANG Data Model for Interface Management | [RFC8343] |
| +--rw key? ianach:crypt-hash | YANG Data Model for Network Access Control Lists | [RFC8519] |
| +--rw istrusted? boolean | (ACLs) | |
+--rw access-rules +-------------------------------------------------------+-----------+
| +--rw access-rule* [access-mode]
| +--rw access-mode access-mode
| +--rw acl? -> /acl:acls/acl/name
+--ro clock-state
| +--ro system-status
| +--ro clock-state ntp-clock-status
| +--ro clock-stratum ntp-stratum
| +--ro clock-refid union
| +--ro associations-address?
| | -> /ntp/associations/address
| +--ro associations-local-mode?
| | -> /ntp/associations/local-mode
| +--ro associations-isconfigured?
| | -> /ntp/associations/isconfigured
| +--ro nominal-freq decimal64
| +--ro actual-freq decimal64
| +--ro clock-precision uint8
| +--ro clock-offset? decimal64
| +--ro root-delay? decimal64
| +--ro root-dispersion? decimal64
| +--ro reference-time? yang:date-and-time
| +--ro sync-state ntp-sync-state
+--rw unicast-configuration* [address type]
| +--rw address inet:host
| +--rw type unicast-configuration-type
| +--rw authentication
| | +--rw (authentication-type)?
| | +--:(symmetric-key)
| | +--rw key-id? leafref
| +--rw prefer? boolean
| +--rw burst? boolean
| +--rw iburst? boolean
| +--rw source? if:interface-ref
| +--rw minpoll? ntp-minpoll
| +--rw maxpoll? ntp-maxpoll
| +--rw port? inet:port-number {ntp-port}?
| +--rw version? ntp-version
+--ro associations* [address local-mode isconfigured]
| +--ro address inet:host
| +--ro local-mode association-mode
| +--ro isconfigured boolean
| +--ro stratum? ntp-stratum
| +--ro refid? union
| +--ro authentication?
| | -> /ntp/authentication/authentication-keys/key-id
| +--ro prefer? boolean
| +--ro peer-interface? if:interface-ref
| +--ro minpoll? ntp-minpoll
| +--ro maxpoll? ntp-maxpoll
| +--ro port? inet:port-number {ntp-port}?
| +--ro version? ntp-version
| +--ro reach? uint8
| +--ro unreach? uint8
| +--ro poll? uint8
| +--ro now? uint32
| +--ro offset? decimal64
| +--ro delay? decimal64
| +--ro dispersion? decimal64
| +--ro originate-time? yang:date-and-time
| +--ro receive-time? yang:date-and-time
| +--ro transmit-time? yang:date-and-time
| +--ro input-time? yang:date-and-time
| +--ro ntp-statistics
| +--ro packet-sent? yang:counter32
| +--ro packet-sent-fail? yang:counter32
| +--ro packet-received? yang:counter32
| +--ro packet-dropped? yang:counter32
+--rw interfaces
| +--rw interface* [name]
| +--rw name if:interface-ref
| +--rw broadcast-server!
| | +--rw ttl? uint8
| | +--rw authentication
| | | +--rw (authentication-type)?
| | | +--:(symmetric-key)
| | | +--rw key-id? leafref
| | +--rw minpoll? ntp-minpoll
| | +--rw maxpoll? ntp-maxpoll
| | +--rw port? inet:port-number {ntp-port}?
| | +--rw version? ntp-version
| +--rw broadcast-client!
| +--rw multicast-server* [address]
| | +--rw address
| | | rt-types:ip-multicast-group-address
| | +--rw ttl? uint8
| | +--rw authentication
| | | +--rw (authentication-type)?
| | | +--:(symmetric-key)
| | | +--rw key-id? leafref
| | +--rw minpoll? ntp-minpoll
| | +--rw maxpoll? ntp-maxpoll
| | +--rw port? inet:port-number {ntp-port}?
| | +--rw version? ntp-version
| +--rw multicast-client* [address]
| | +--rw address rt-types:ip-multicast-group-address
| +--rw manycast-server* [address]
| | +--rw address rt-types:ip-multicast-group-address
| +--rw manycast-client* [address]
| +--rw address
| | rt-types:ip-multicast-group-address
| +--rw authentication
| | +--rw (authentication-type)?
| | +--:(symmetric-key)
| | +--rw key-id? leafref
| +--rw ttl? uint8
| +--rw minclock? uint8
| +--rw maxclock? uint8
| +--rw beacon? uint8
| +--rw minpoll? ntp-minpoll
| +--rw maxpoll? ntp-maxpoll
| +--rw port? inet:port-number {ntp-port}?
| +--rw version? ntp-version
+--ro ntp-statistics
+--ro packet-sent? yang:counter32
+--ro packet-sent-fail? yang:counter32
+--ro packet-received? yang:counter32
+--ro packet-dropped? yang:counter32
groupings: Table 2: Refrences in the YANG modules
authentication
+---- (authentication-type)?
+--:(symmetric-key)
+---- key-id?
-> /ntp/authentication/authentication-keys/key-id
statistics 2. NTP data model
+---- packet-sent? yang:counter32
+---- packet-sent-fail? yang:counter32
+---- packet-received? yang:counter32
+---- packet-dropped? yang:counter32
authentication-key This document defines the YANG module "ietf-ntp", which has the
+---- key-id? uint32 following condensed structure:
+---- algorithm? identityref
+---- key? ianach:crypt-hash
+---- istrusted? boolean
association-ref module: ietf-ntp
+---- associations-address? -> /ntp/associations/address +--rw ntp!
+---- associations-local-mode? -> /ntp/associations/local-mode +--rw port? inet:port-number {ntp-port}?
+---- associations-isconfigured? +--rw refclock-master!
-> /ntp/associations/isconfigured | +--rw master-stratum? ntp-stratum
+--rw authentication
| +--rw auth-enabled? boolean
| +--rw authentication-keys* [key-id]
| +--rw key-id uint32
| +--...
+--rw access-rules
| +--rw access-rule* [access-mode]
| +--rw access-mode access-mode
| +--rw acl? -> /acl:acls/acl/name
+--ro clock-state
| +--ro system-status
| +--ro clock-state ntp-clock-status
| +--ro clock-stratum ntp-stratum
| +--ro clock-refid union
| +--...
+--rw unicast-configuration* [address type]
| +--rw address inet:host
| +--rw type unicast-configuration-type
| +--...
+--ro associations* [address local-mode isconfigured]
| +--...
| +--ro ntp-statistics
| +--...
+--rw interfaces
| +--rw interface* [name]
| +--rw name if:interface-ref
| +--rw broadcast-server!
| | +--...
| +--rw broadcast-client!
| +--rw multicast-server* [address]
| | +--rw address
| | | rt-types:ip-multicast-group-address
| | +--...
| +--rw multicast-client* [address]
| | +--rw address rt-types:ip-multicast-group-address
| +--rw manycast-server* [address]
| | +--rw address rt-types:ip-multicast-group-address
| +--rw manycast-client* [address]
| +--rw address
| | rt-types:ip-multicast-group-address
| +--...
+--ro ntp-statistics
+--...
common-attributes The full data model tree for the YANG module "ietf-ntp" is
+---- minpoll? ntp-minpoll represented as -
+---- maxpoll? ntp-maxpoll
+---- port? inet:port-number {ntp-port}? module: ietf-ntp
+---- version? ntp-version +--rw ntp!
+--rw port? inet:port-number {ntp-port}?
+--rw refclock-master!
| +--rw master-stratum? ntp-stratum
+--rw authentication
| +--rw auth-enabled? boolean
| +--rw authentication-keys* [key-id]
| +--rw key-id uint32
| +--rw algorithm? identityref
| +--rw key? ianach:crypt-hash
| +--rw istrusted? boolean
+--rw access-rules
| +--rw access-rule* [access-mode]
| +--rw access-mode access-mode
| +--rw acl? -> /acl:acls/acl/name
+--ro clock-state
| +--ro system-status
| +--ro clock-state ntp-clock-status
| +--ro clock-stratum ntp-stratum
| +--ro clock-refid union
| +--ro associations-address?
| | -> /ntp/associations/address
| +--ro associations-local-mode?
| | -> /ntp/associations/local-mode
| +--ro associations-isconfigured?
| | -> /ntp/associations/isconfigured
| +--ro nominal-freq decimal64
| +--ro actual-freq decimal64
| +--ro clock-precision uint8
| +--ro clock-offset? decimal64
| +--ro root-delay? decimal64
| +--ro root-dispersion? decimal64
| +--ro reference-time? yang:date-and-time
| +--ro sync-state ntp-sync-state
+--rw unicast-configuration* [address type]
| +--rw address inet:host
| +--rw type unicast-configuration-type
| +--rw authentication
| | +--rw (authentication-type)?
| | +--:(symmetric-key)
| | +--rw key-id? leafref
| +--rw prefer? boolean
| +--rw burst? boolean
| +--rw iburst? boolean
| +--rw source? if:interface-ref
| +--rw minpoll? ntp-minpoll
| +--rw maxpoll? ntp-maxpoll
| +--rw port? inet:port-number {ntp-port}?
| +--rw version? ntp-version
+--ro associations* [address local-mode isconfigured]
| +--ro address inet:host
| +--ro local-mode association-mode
| +--ro isconfigured boolean
| +--ro stratum? ntp-stratum
| +--ro refid? union
| +--ro authentication?
| | -> /ntp/authentication/authentication-keys/key-id
| +--ro prefer? boolean
| +--ro peer-interface? if:interface-ref
| +--ro minpoll? ntp-minpoll
| +--ro maxpoll? ntp-maxpoll
| +--ro port? inet:port-number {ntp-port}?
| +--ro version? ntp-version
| +--ro reach? uint8
| +--ro unreach? uint8
| +--ro poll? uint8
| +--ro now? uint32
| +--ro offset? decimal64
| +--ro delay? decimal64
| +--ro dispersion? decimal64
| +--ro originate-time? yang:date-and-time
| +--ro receive-time? yang:date-and-time
| +--ro transmit-time? yang:date-and-time
| +--ro input-time? yang:date-and-time
| +--ro ntp-statistics
| +--ro packet-sent? yang:counter32
| +--ro packet-sent-fail? yang:counter32
| +--ro packet-received? yang:counter32
| +--ro packet-dropped? yang:counter32
+--rw interfaces
| +--rw interface* [name]
| +--rw name if:interface-ref
| +--rw broadcast-server!
| | +--rw ttl? uint8
| | +--rw authentication
| | | +--rw (authentication-type)?
| | | +--:(symmetric-key)
| | | +--rw key-id? leafref
| | +--rw minpoll? ntp-minpoll
| | +--rw maxpoll? ntp-maxpoll
| | +--rw port? inet:port-number {ntp-port}?
| | +--rw version? ntp-version
| +--rw broadcast-client!
| +--rw multicast-server* [address]
| | +--rw address
| | | rt-types:ip-multicast-group-address
| | +--rw ttl? uint8
| | +--rw authentication
| | | +--rw (authentication-type)?
| | | +--:(symmetric-key)
| | | +--rw key-id? leafref
| | +--rw minpoll? ntp-minpoll
| | +--rw maxpoll? ntp-maxpoll
| | +--rw port? inet:port-number {ntp-port}?
| | +--rw version? ntp-version
| +--rw multicast-client* [address]
| | +--rw address rt-types:ip-multicast-group-address
| +--rw manycast-server* [address]
| | +--rw address rt-types:ip-multicast-group-address
| +--rw manycast-client* [address]
| +--rw address
| | rt-types:ip-multicast-group-address
| +--rw authentication
| | +--rw (authentication-type)?
| | +--:(symmetric-key)
| | +--rw key-id? leafref
| +--rw ttl? uint8
| +--rw minclock? uint8
| +--rw maxclock? uint8
| +--rw beacon? uint8
| +--rw minpoll? ntp-minpoll
| +--rw maxpoll? ntp-maxpoll
| +--rw port? inet:port-number {ntp-port}?
| +--rw version? ntp-version
+--ro ntp-statistics
+--ro packet-sent? yang:counter32
+--ro packet-sent-fail? yang:counter32
+--ro packet-received? yang:counter32
+--ro packet-dropped? yang:counter32
This data model defines one top-level container which includes both This data model defines one top-level container which includes both
the NTP configuration and the NTP running state including access the NTP configuration and the NTP running state including access
rules, authentication, associations, unicast configurations, rules, authentication, associations, unicast configurations,
interfaces, system status and associations. interfaces, system status and associations.
3. Relationship with NTPv4-MIB 3. Relationship with NTPv4-MIB
If the device implements the NTPv4-MIB [RFC5907], data nodes from If the device implements the NTPv4-MIB [RFC5907], data nodes from
YANG module can be mapped to table entries in NTPv4-MIB. YANG module can be mapped to table entries in NTPv4-MIB.
skipping to change at page 9, line 23 skipping to change at page 10, line 23
| unicast-configuration/type | server/association-type | | unicast-configuration/type | server/association-type |
| unicast-configuration/iburst | server/iburst | | unicast-configuration/iburst | server/iburst |
| unicast-configuration/prefer | server/prefer | | unicast-configuration/prefer | server/prefer |
+-------------------------------+--------------------------------+ +-------------------------------+--------------------------------+
YANG NTP Configuration Data Nodes and counterparts in RFC 7317 YANG NTP Configuration Data Nodes and counterparts in RFC 7317
Objects Objects
5. Access Rules 5. Access Rules
As per [RFC1305], NTP could include an access-control feature that As per [RFC1305] and [RFC5905], NTP could include an access-control
prevents unauthorized access and controls which peers are allowed to feature that prevents unauthorized access and controls which peers
update the local clock. Further it is useful to differentiate are allowed to update the local clock. Further it is useful to
between the various kinds of access (such as peer or server; refer differentiate between the various kinds of access (such as peer or
access-mode) and attach different acl-rule to each. For this, the server; refer access-mode) and attach different acl-rule to each.
YANG module allow such configuration via /ntp/access-rules. The For this, the YANG module allow such configuration via /ntp/access-
access-rule itself is configured via [I-D.ietf-netmod-acl-model]. rules. The access-rule itself is configured via [RFC8519].
6. Key Management 6. Key Management
As per [RFC1305], when authentication is enabled, NTP employs a As per [RFC1305] and [RFC5905], when authentication is enabled, NTP
crypto-checksum, computed by the sender and checked by the receiver, employs a crypto-checksum, computed by the sender and checked by the
together with a set of predistributed algorithms, and cryptographic receiver, together with a set of predistributed algorithms, and
keys indexed by a key identifier included in the NTP message. This cryptographic keys indexed by a key identifier included in the NTP
key-id is 32-bits unsigned integer that MUST be configured on the NTP message. This key-id is 32-bits unsigned integer that MUST be
peers before the authentication could be used. For this reason, this configured on the NTP peers before the authentication could be used.
YANG modules allow such configuration via /ntp/authentication/ For this reason, this YANG modules allow such configuration via
authentication-keys/. Further at the time of configuration of NTP /ntp/authentication/authentication-keys/. Further at the time of
association (for example unicast-server), the key-id is specefied. configuration of NTP association (for example unicast-server), the
key-id is specefied.
7. NTP YANG Module 7. NTP YANG Module
<CODE BEGINS> file "ietf-ntp@2018-12-17.yang" <CODE BEGINS> file "ietf-ntp@2019-06-26.yang"
module ietf-ntp { module ietf-ntp {
yang-version 1.1; yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-ntp"; namespace "urn:ietf:params:xml:ns:yang:ietf-ntp";
prefix "ntp";
prefix "ntp"; import ietf-yang-types {
import ietf-yang-types { prefix "yang";
prefix "yang"; reference "RFC 6991: Common YANG Data Types";
reference "RFC 6991"; }
}
import ietf-inet-types { import ietf-inet-types {
prefix "inet"; prefix "inet";
reference "RFC 6991"; reference "RFC 6991: Common YANG Data Types";
} }
import ietf-interfaces { import ietf-interfaces {
prefix "if"; prefix "if";
reference "RFC 8343"; reference "RFC 8343: A YANG Data Model for Interface Management";
} }
import iana-crypt-hash { import iana-crypt-hash {
prefix "ianach"; prefix "ianach";
reference "RFC 7317"; reference "RFC 7317: A YANG Data Model for System Management";
} }
import ietf-key-chain { import ietf-key-chain {
prefix "key-chain"; prefix "key-chain";
reference "RFC 8177"; reference "RFC 8177: YANG Data Model for Key Chains";
} }
import ietf-access-control-list { import ietf-access-control-list {
prefix "acl"; prefix "acl";
reference "RFC XXXX"; reference "RFC 8519: YANG Data Model for Network Access Control
} Lists (ACLs)";
}
/* Note: The RFC Editor will replace XXXX with the number assigned import ietf-routing-types {
to the RFC once draft-ietf-netmod-acl-model becomes an RFC.*/ prefix "rt-types";
reference "RFC 8294: Common YANG Data Types for the Routing Area";
import ietf-routing-types { }
prefix "rt-types";
reference "RFC 8294";
} organization
"IETF NTP (Network Time Protocol) Working Group";
organization contact
"IETF NTP (Network Time Protocol) Working Group"; "WG Web: <http://tools.ietf.org/wg/ntp/>
WG List: <mailto: ntpwg@lists.ntp.org
Editor: Eric Wu
<mailto:eric.wu@huawei.com>
Editor: Anil Kumar S N
<mailto:anil.ietf@gmail.com>
Editor: Yi Zhao
<mailto:yi.z.zhao@ericsson.com>
Editor: Dhruv Dhody
<mailto:dhruv.ietf@gmail.com>
Editor: Ankit Kumar Sinha
<mailto:ankit.ietf@gmail.com>";
description
"This document defines a YANG data model for Network Time Protocol
(NTP) implementations. The data model includes configuration data
and state data.
contact Copyright (c) 2019 IETF Trust and the persons identified
"WG Web: <http://tools.ietf.org/wg/ntp/> as authors of the code. All rights reserved.
WG List: <mailto: ntpwg@lists.ntp.org
Editor: Eric Wu
<mailto:eric.wu@huawei.com>
Editor: Anil Kumar S N
<mailto:anil.ietf@gmail.com>
Editor: Yi Zhao
<mailto:yi.z.zhao@ericsson.com>
Editor: Dhruv Dhody
<mailto:dhruv.ietf@gmail.com>
Editor: Ankit Kumar Sinha
<mailto:ankit.ietf@gmail.com>";
description
"This document defines a YANG data model for Network Time Protocol
(NTP) implementations. The data model includes configuration data
and state data.
Copyright (c) 2018 IETF Trust and the persons identified Redistribution and use in source and binary forms,
as authors of the code. All rights reserved. with or without modification, is permitted pursuant to,
and subject to the license terms contained in, the
Simplified BSD License set forth in Section 4.c of the
IETF Trust's Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
Redistribution and use in source and binary forms, This version of this YANG module is part of RFC XXXX;
with or without modification, is permitted pursuant to, see the RFC itself for full legal notices.";
and subject to the license terms contained in, the
Simplified BSD License set forth in Section 4.c of the
IETF Trust's Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC YYYY; revision 2019-06-26 {
see the RFC itself for full legal notices."; description
"Initial revision.";
reference
"RFC XXXX: A YANG Data Model for NTP.";
}
revision 2018-12-17 { /* Note: The RFC Editor will replace XXXX with the number assigned
description to this document once it becomes an RFC.*/
"Updated revision.";
reference
"RFC YYYY: A YANG Data Model for NTP.";
}
/* Note: The RFC Editor will replace YYYY with the number assigned /* Typedef Definitions */
to this document once it becomes an RFC.*/
/* Typedef Definitions */ typedef ntp-stratum {
type uint8 {
range "1..16";
}
description
"The level of each server in the hierarchy is defined by
a stratum. Primary servers are assigned with stratum
one; secondary servers at each lower level are assigned with
one stratum greater than the preceding level";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
typedef ntp-stratum { typedef ntp-version {
type uint8 { type uint8;
range "1..16"; default "3";
} description
description "The current NTP version supported by corresponding
"The level of each server in the hierarchy is defined by association.";
a stratum. Primary servers are assigned with stratum }
one; secondary servers at each lower level are assigned with
one stratum greater than the preceding level";
}
typedef ntp-version {
type uint8 {
range "1..4";
}
default "3";
description
"The current NTP version supported by corresponding
association.";
}
typedef ntp-minpoll { typedef ntp-minpoll {
type uint8 { type uint8 {
range "4..17"; range "4..17";
} }
default "6"; default "6";
description description
"The minimum poll exponent for this NTP association."; "The minimum poll exponent for this NTP association.";
} reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
typedef ntp-maxpoll { typedef ntp-maxpoll {
type uint8 { type uint8 {
range "4..17"; range "4..17";
} }
default "10"; default "10";
description description
"The maximum poll exponent for this NTP association."; "The maximum poll exponent for this NTP association.";
} reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
typedef access-mode { typedef access-mode {
type enumeration { type enumeration {
enum peer { enum peer {
value "0"; value "0";
description description
"Enables the full access authority. Both time "Enables the full access authority. Both time
request and control query can be performed request and control query can be performed
on the local NTP service, and the local clock on the local NTP service, and the local clock
can be synchronized with the remote server."; can be synchronized with the remote server.";
} }
enum server { enum server {
value "1"; value "1";
description description
"Enables the server access and query. "Enables the server access and query.
Both time requests and control query can be Both time requests and control query can be
performed on the local NTP service, but the performed on the local NTP service, but the
local clock cannot be synchronized with the local clock cannot be synchronized with the
remote server."; remote server.";
} }
enum synchronization { enum synchronization {
value "2"; value "2";
description description
"Enables the server to access. "Enables the server to access.
Only time request can be performed on the Only time request can be performed on the
local NTP service."; local NTP service.";
} }
enum query { enum query {
value "3"; value "3";
description description
"Enables the maximum access limitation. "Enables the maximum access limitation.
Control query can be performed only on the Control query can be performed only on the
local NTP service."; local NTP service.";
} }
} }
description description
"This defines NTP access modes."; "This defines NTP access modes.";
} }
typedef unicast-configuration-type { typedef unicast-configuration-type {
type enumeration { type enumeration {
enum server { enum server {
value "0"; value "0";
description description
"Use client association mode. This device "Use client association mode. This device
will not provide synchronization to the will not provide synchronization to the
configured NTP server."; configured NTP server.";
} }
enum peer { enum peer {
value "1"; value "1";
description description
"Use symmetric active association mode. "Use symmetric active association mode.
This device may provide synchronization This device may provide synchronization
to the configured NTP server."; to the configured NTP server.";
} }
} }
description description
"This defines NTP unicast mode of operation."; "This defines NTP unicast mode of operation.";
} }
typedef association-mode { typedef association-mode {
type enumeration { type enumeration {
enum client { enum client {
value "0"; value "0";
description description
"Use client association mode(mode 3). "Use client association mode(mode 3).
This device will not provide synchronization This device will not provide synchronization
to the configured NTP server."; to the configured NTP server.";
} }
enum active { enum active {
value "1"; value "1";
description description
"Use symmetric active association mode(mode 1). "Use symmetric active association mode(mode 1).
This device may synchronize with its NTP peer, This device may synchronize with its NTP peer,
or provide synchronization to configured NTP peer."; or provide synchronization to configured NTP peer.";
} }
enum passive { enum passive {
value "2"; value "2";
description description
"Use symmetric passive association mode(mode 2). "Use symmetric passive association mode(mode 2).
This device has learned this association dynamically. This device has learned this association dynamically.
This device may synchronize with its NTP peer."; This device may synchronize with its NTP peer.";
} }
enum broadcast { enum broadcast {
value "3"; value "3";
description description
"Use broadcast mode(mode 5). "Use broadcast mode(mode 5).
This mode defines that its either working This mode defines that its either working
as broadcast-server or multicast-server."; as broadcast-server or multicast-server.";
} }
enum broadcast-client { enum broadcast-client {
value "4"; value "4";
description description
"This mode defines that its either working "This mode defines that its either working
as broadcast-client or multicast-client."; as broadcast-client or multicast-client.";
} }
} }
description description
"The NTP association modes."; "The NTP association modes.";
} }
typedef ntp-clock-status { typedef ntp-clock-status {
type enumeration { type enumeration {
enum synchronized { enum synchronized {
value "0"; value "0";
description description
"Indicates that the local clock has been "Indicates that the local clock has been
synchronized with an NTP server or synchronized with an NTP server or
the reference clock."; the reference clock.";
} }
enum unsynchronized { enum unsynchronized {
value "1"; value "1";
description description
"Indicates that the local clock has not been "Indicates that the local clock has not been
synchronized with any NTP server."; synchronized with any NTP server.";
} }
} }
description description
"This defines NTP clock status."; "This defines NTP clock status.";
} }
typedef ntp-sync-state { typedef ntp-sync-state {
type enumeration { type enumeration {
enum clock-not-set { enum clock-not-set {
value "0"; value "0";
description description
"Indicates the clock is not updated."; "Indicates the clock is not updated.";
} }
enum freq-set-by-cfg { enum freq-set-by-cfg {
value "1"; value "1";
description description
"Indicates the clock frequency is set by "Indicates the clock frequency is set by
NTP configuration."; NTP configuration.";
} }
enum clock-set { enum clock-set {
value "2"; value "2";
description description
"Indicates the clock is set."; "Indicates the clock is set.";
} }
enum freq-not-determined { enum freq-not-determined {
value "3"; value "3";
description description
"Indicates the clock is set but the frequency "Indicates the clock is set but the frequency
is not determined."; is not determined.";
} }
enum clock-synchronized { enum clock-synchronized {
value "4"; value "4";
description description
"Indicates that the clock is synchronized"; "Indicates that the clock is synchronized";
} }
enum spike { enum spike {
value "5"; value "5";
description description
"Indicates a time difference of more than 128 "Indicates a time difference of more than 128
milliseconds is detected between NTP server milliseconds is detected between NTP server
and client clock. The clock change will take and client clock. The clock change will take
effect in XXX seconds."; effect in XXX seconds.";
} }
} }
description description
"This defines NTP clock sync states."; "This defines NTP clock sync states.";
} }
/* features */ /* features */
feature ntp-port { feature ntp-port {
description description
"Support for NTP port configuration"; "Support for NTP port configuration";
reference "RFC1305 - 3.2.7 Parameters"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature authentication { feature authentication {
description description
"Support for NTP symmetric key authentication"; "Support for NTP symmetric key authentication";
reference "RFC1305 - 3.2.6 Authentication Variables"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature access-rules { feature access-rules {
description description
"Support for NTP access control"; "Support for NTP access control";
reference "RFC1305 - 3.6 Access Control Issues"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature unicast-configuration { feature unicast-configuration {
description description
"Support for NTP client/server or active/passive "Support for NTP client/server or active/passive
in unicast"; in unicast";
reference "RFC1305 - 3.3 Modes of Operation"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature broadcast-server { feature broadcast-server {
description description
"Support for broadcast server"; "Support for broadcast server";
reference "RFC1305 - 3.3 Modes of Operation"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature broadcast-client { feature broadcast-client {
description description
"Support for broadcast client"; "Support for broadcast client";
reference "RFC1305 - 3.3 Modes of Operation"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature multicast-server { feature multicast-server {
description description
"Support for multicast server"; "Support for multicast server";
reference "RFC1305 - 3.3 Modes of Operation"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature multicast-client { feature multicast-client {
description description
"Support for multicast client"; "Support for multicast client";
reference "RFC1305 - 3.3 Modes of Operation"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature manycast-server { feature manycast-server {
description description
"Support for manycast server"; "Support for manycast server";
reference "RFC5905 - 3.1 Dynamic Server Discovery"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
feature manycast-client { feature manycast-client {
description description
"Support for manycast client"; "Support for manycast client";
reference "RFC5905 - 3.1 Dynamic Server Discovery"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
/* Groupings */ }
grouping authentication-key {
description
"To define an authentication key for a Network Time
Protocol (NTP) time source.";
leaf key-id {
type uint32 {
range "1..max";
}
description
"Authentication key identifier.";
}
leaf algorithm {
type identityref {
base key-chain:crypto-algorithm;
}
description
"Authentication algorithm.";
}
leaf key {
type ianach:crypt-hash;
description
"The key";
}
leaf istrusted {
type boolean;
description
"Key-id is trusted or not";
}
}
grouping authentication { /* Groupings */
description grouping authentication-key {
"Authentication."; description
choice authentication-type { "To define an authentication key for a Network Time
description Protocol (NTP) time source.";
"Type of authentication."; leaf key-id {
type uint32 {
range "1..max";
}
description
"Authentication key identifier.";
}
leaf algorithm {
type identityref {
base key-chain:crypto-algorithm;
}
description
"Authentication algorithm.";
}
leaf key {
type ianach:crypt-hash;
description
"The key";
}
leaf istrusted {
type boolean;
description
"Key-id is trusted or not";
}
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
case symmetric-key { grouping authentication {
leaf key-id { description
type leafref { "Authentication.";
path "/ntp:ntp/ntp:authentication/" choice authentication-type {
+ "ntp:authentication-keys/ntp:key-id"; description
} "Type of authentication.";
description case symmetric-key {
"Authentication key id referenced in this leaf key-id {
association."; type leafref {
} path "/ntp:ntp/ntp:authentication/"
} + "ntp:authentication-keys/ntp:key-id";
} }
} description
"Authentication key id referenced in this
association.";
}
}
}
}
grouping statistics { grouping statistics {
description description
"NTP packet statistic."; "NTP packet statistic.";
leaf packet-sent {
type yang:counter32;
description
"The total number of NTP packets delivered to the
transport service by this NTP entity for this
association.
Discountinuities in the value of this counter can occur
upon cold start or reinitialization of the NTP entity, the
management system and at other times as indicated by
discontinuities in the value of sysUpTime.";
}
leaf packet-sent-fail {
type yang:counter32;
description
"The number of times NTP packets sending failed.";
}
leaf packet-received {
type yang:counter32;
description
"The total number of NTP packets delivered to the
NTP entity from this association.
Discountinuities in the value of this counter can occur
upon cold start or reinitialization of the NTP entity, the
management system and at other times as indicated by
discontinuities in the value of sysUpTime.";
}
leaf packet-dropped {
type yang:counter32;
description
"The total number of NTP packets that were delivered
to this NTP entity from this association and this entity
was not able to process due to an NTP protocol error.
Discountinuities in the value of this counter can occur
upon cold start or reinitialization of the NTP entity, the
management system and at other times as indicated by
discontinuities in the value of sysUpTime.";
}
}
grouping common-attributes { leaf packet-sent {
description type yang:counter32;
"NTP common attributes for configuration."; description
leaf minpoll { "The total number of NTP packets delivered to the
type ntp-minpoll; transport service by this NTP entity for this
description association.
"The minimum poll interval used in this association."; Discountinuities in the value of this counter can occur
} upon cold start or reinitialization of the NTP entity, the
leaf maxpoll { management system and at other times as indicated by
type ntp-maxpoll; discontinuities in the value of sysUpTime.";
description }
"The maximum poll interval used in this association."; leaf packet-sent-fail {
} type yang:counter32;
leaf port { description
if-feature ntp-port; "The number of times NTP packets sending failed.";
type inet:port-number { }
range "123 | 1025..max"; leaf packet-received {
} type yang:counter32;
default "123"; description
description "The total number of NTP packets delivered to the
"Specify the port used to send NTP packets."; NTP entity from this association.
} Discountinuities in the value of this counter can occur
leaf version { upon cold start or reinitialization of the NTP entity, the
type ntp-version; management system and at other times as indicated by
description discontinuities in the value of sysUpTime.";
"NTP version."; }
} leaf packet-dropped {
} type yang:counter32;
description
"The total number of NTP packets that were delivered
to this NTP entity from this association and this entity
was not able to process due to an NTP protocol error.
Discountinuities in the value of this counter can occur
upon cold start or reinitialization of the NTP entity, the
management system and at other times as indicated by
discontinuities in the value of sysUpTime.";
}
}
grouping association-ref { grouping common-attributes {
description description
"Reference to NTP association mode"; "NTP common attributes for configuration.";
leaf associations-address { leaf minpoll {
type leafref { type ntp-minpoll;
path "/ntp:ntp/ntp:associations/ntp:address"; description
} "The minimum poll interval used in this association.";
description }
"Indicates the association's address leaf maxpoll {
which result in clock synchronization."; type ntp-maxpoll;
} description
leaf associations-local-mode { "The maximum poll interval used in this association.";
type leafref { }
path "/ntp:ntp/ntp:associations/ntp:local-mode"; leaf port {
} if-feature ntp-port;
description type inet:port-number {
"Indicates the association's local-mode range "123 | 1025..max";
which result in clock synchronization."; }
} default "123";
leaf associations-isconfigured { description
type leafref { "Specify the port used to send NTP packets.";
path "/ntp:ntp/ntp:associations/" }
+ "ntp:isconfigured"; leaf version {
} type ntp-version;
description description
"The association was configured or dynamic "NTP version.";
which result in clock synchronization."; }
} reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
/* Configuration data nodes */ }
container ntp {
presence
"NTP is enabled and system should attempt to
synchronize the system clock with an NTP server
from the 'ntp/associations' list.";
description
"Configuration parameters for NTP.";
leaf port {
if-feature ntp-port;
type inet:port-number {
range "123 | 1025..max";
}
default "123";
description
"Specify the port used to send and receive NTP packets.";
}
container refclock-master {
presence
"NTP master clock is enabled.";
description
"Configures the local clock of this device as NTP server.";
leaf master-stratum {
type ntp-stratum;
default "16";
description
"Stratum level from which NTP
clients get their time synchronized.";
}
} grouping association-ref {
container authentication { description
description "Reference to NTP association mode";
"Configuration of authentication."; leaf associations-address {
leaf auth-enabled { type leafref {
type boolean; path "/ntp:ntp/ntp:associations/ntp:address";
default false; }
description description
"Controls whether NTP authentication is enabled "Indicates the association's address
or disabled on this device."; which result in clock synchronization.";
} }
list authentication-keys { leaf associations-local-mode {
key "key-id"; type leafref {
uses authentication-key; path "/ntp:ntp/ntp:associations/ntp:local-mode";
description }
"List of authentication keys."; description
} "Indicates the association's local-mode
} which result in clock synchronization.";
}
leaf associations-isconfigured {
type leafref {
path "/ntp:ntp/ntp:associations/"
+ "ntp:isconfigured";
}
description
"The association was configured or dynamic
which result in clock synchronization.";
}
}
container access-rules { /* Configuration data nodes */
description container ntp {
"Configuration to control access to NTP service presence
by using NTP access-group feature. "NTP is enabled and system should attempt to
The access-mode identifies how the acl is synchronize the system clock with an NTP server
applied with NTP."; from the 'ntp/associations' list.";
list access-rule { description
key "access-mode"; "Configuration parameters for NTP.";
description leaf port {
"List of access rules."; if-feature ntp-port;
leaf access-mode { type inet:port-number {
type access-mode; range "123 | 1025..max";
description }
"NTP access mode. The defination of each possible values: default "123";
peer(0): Both time request and control query can be description
performed. "Specify the port used to send and receive NTP packets.";
server(1): Enables the server access and query. }
synchronization(2): Enables the server access only. container refclock-master {
query(3): Enables control query only."; presence
} "NTP master clock is enabled.";
leaf acl { description
type leafref { "Configures the local clock of this device as NTP server.";
path "/acl:acls/acl:acl/acl:name"; leaf master-stratum {
} type ntp-stratum;
description default "16";
"Control access configuration to be used."; description
} "Stratum level from which NTP
reference clients get their time synchronized.";
"RFC 1305"; }
}
container authentication {
description
"Configuration of authentication.";
leaf auth-enabled {
type boolean;
default false;
description
"Controls whether NTP authentication is enabled
or disabled on this device.";
}
list authentication-keys {
key "key-id";
uses authentication-key;
description
"List of authentication keys.";
}
}
} container access-rules {
} description
"Configuration to control access to NTP service
by using NTP access-group feature.
The access-mode identifies how the acl is
applied with NTP.";
list access-rule {
key "access-mode";
description
"List of access rules.";
leaf access-mode {
type access-mode;
description
"NTP access mode. The defination of each possible values:
peer(0): Both time request and control query can be
performed.
server(1): Enables the server access and query.
synchronization(2): Enables the server access only.
query(3): Enables control query only.";
}
leaf acl {
type leafref {
path "/acl:acls/acl:acl/acl:name";
}
description
"Control access configuration to be used.";
}
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
}
container clock-state { container clock-state {
config "false"; config "false";
description description
"Clock operational state of the NTP."; "Clock operational state of the NTP.";
container system-status { container system-status {
description description
"System status of NTP."; "System status of NTP.";
leaf clock-state { leaf clock-state {
type ntp-clock-status; type ntp-clock-status;
mandatory true; mandatory true;
description description
"The state of system clock. The definition of each "The state of system clock. The definition of each
possible value is: possible value is:
synchronized(0): Indicates local clock is synchronized. synchronized(0): Indicates local clock is synchronized.
unsynchronized(1): Indicates local clock is not unsynchronized(1): Indicates local clock is not
synchronized."; synchronized.";
} }
leaf clock-stratum { leaf clock-stratum {
type ntp-stratum; type ntp-stratum;
mandatory true; mandatory true;
description description
"The NTP entity's own stratum value. Should be a stratum "The NTP entity's own stratum value. Should be a stratum
of syspeer + 1 (or 16 if no syspeer)."; of syspeer + 1 (or 16 if no syspeer).";
} reference
leaf clock-refid { "RFC 5905: Network Time Protocol Version 4: Protocol and
type union { Algorithms Specification";
type inet:ipv4-address; }
type binary { leaf clock-refid {
length "4"; type union {
} type inet:ipv4-address;
type string { type binary {
length "4"; length "4";
} }
} type string {
mandatory true; length "4";
description }
"IPv4 address or first 32 bits of the MD5 hash of }
the IPv6 address or reference clock of the peer to mandatory true;
which clock is synchronized."; description
} "IPv4 address or first 32 bits of the MD5 hash of
the IPv6 address or reference clock of the peer to
which clock is synchronized.";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
uses association-ref { uses association-ref {
description description
"Reference to Association."; "Reference to Association.";
}
} leaf nominal-freq {
leaf nominal-freq { type decimal64 {
type decimal64 { fraction-digits 4;
fraction-digits 4; }
} units Hz;
units Hz; mandatory true;
mandatory true; description
description "The nominal frequency of the
"The nominal frequency of the local clock.";
local clock."; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
leaf actual-freq { Algorithms Specification";
type decimal64 { }
fraction-digits 4; leaf actual-freq {
} type decimal64 {
units Hz; fraction-digits 4;
mandatory true; }
description units Hz;
"The actual frequency of the mandatory true;
local clock."; description
} "The actual frequency of the
leaf clock-precision { local clock.";
type uint8; reference
units Hz; "RFC 5905: Network Time Protocol Version 4: Protocol and
mandatory true; Algorithms Specification";
description }
"Clock precision of this system in integer format leaf clock-precision {
(prec=2^(-n)). A value of 5 would mean 2^-5 = 31.25 ms."; type uint8;
} units Hz;
leaf clock-offset { mandatory true;
type decimal64 { description
fraction-digits 3; "Clock precision of this system in integer format
} (prec=2^(-n)). A value of 5 would mean 2^-5 = 31.25 ms.";
units milliseconds; reference
description "RFC 5905: Network Time Protocol Version 4: Protocol and
"The time offset to the current selected reference time Algorithms Specification";
source e.g., '0.032' or '1.232'."; }
} leaf clock-offset {
leaf root-delay { type decimal64 {
type decimal64 { fraction-digits 3;
fraction-digits 3; }
} units milliseconds;
units milliseconds; description
description "The time offset to the current selected reference time
"Total delay along the path to root clock."; source e.g., '0.032' or '1.232'.";
} reference
leaf root-dispersion { "RFC 5905: Network Time Protocol Version 4: Protocol and
type decimal64 { Algorithms Specification";
fraction-digits 3; }
} leaf root-delay {
units milliseconds; type decimal64 {
description fraction-digits 3;
"The dispersion between the local clock
and the root clock, e.g., '6.927'.";
}
leaf reference-time {
type yang:date-and-time;
description
"The reference timestamp.";
}
leaf sync-state {
type ntp-sync-state;
mandatory true;
description
"The synchronization status of
the local clock.";
}
}
}
list unicast-configuration {
key "address type";
description
"List of NTP unicast-configurations.";
leaf address {
type inet:host;
description
"Address of this association.";
}
leaf type {
type unicast-configuration-type;
description
"Use client association mode. This device
will not provide synchronization to the
configured NTP server.";
}
container authentication{
description
"Authentication used for this association.";
uses authentication;
}
leaf prefer {
type boolean;
default "false";
description
"Whether this association is preferred or not.";
}
leaf burst {
type boolean;
default "false";
description
"If set, a series of packets are sent instead of a single
packet within each synchronization interval to achieve faster
synchronization.";
}
leaf iburst {
type boolean;
default "false";
description
"If set, a series of packets are sent instead of a single
packet within the initial synchronization interval to achieve
faster initial synchronization.";
}
leaf source {
type if:interface-ref;
description
"The interface whose IP address is used by this association
as the source address.";
}
uses common-attributes {
description
"Common attributes like port, version, min and max
poll.";
}
}
list associations {
key "address local-mode isconfigured";
config "false";
description
"List of NTP associations. Here address, local-mode
and isconfigured is required to uniquely identify
a particular association. Lets take following examples -
1) If RT1 acting as broadcast server, }
and RT2 acting as broadcast client, then RT2 units milliseconds;
will form dynamic association with address as RT1, description
local-mode as client and isconfigured as false. "Total delay along the path to root clock.";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
leaf root-dispersion {
type decimal64 {
fraction-digits 3;
}
units milliseconds;
description
"The dispersion between the local clock
and the root clock, e.g., '6.927'.";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
leaf reference-time {
type yang:date-and-time;
description
"The reference timestamp.";
}
leaf sync-state {
type ntp-sync-state;
mandatory true;
description
"The synchronization status of
the local clock.";
}
}
}
list unicast-configuration {
key "address type";
description
"List of NTP unicast-configurations.";
leaf address {
type inet:host;
description
"Address of this association.";
}
leaf type {
type unicast-configuration-type;
description
"Use client association mode. This device
will not provide synchronization to the
configured NTP server.";
}
container authentication{
description
"Authentication used for this association.";
uses authentication;
}
leaf prefer {
type boolean;
default "false";
description
"Whether this association is preferred or not.";
}
leaf burst {
type boolean;
default "false";
description
"If set, a series of packets are sent instead of a single
packet within each synchronization interval to achieve
faster synchronization.";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
leaf iburst {
type boolean;
default "false";
description
"If set, a series of packets are sent instead of a single
packet within the initial synchronization interval to
achieve faster initial synchronization.";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
leaf source {
type if:interface-ref;
description
"The interface whose IP address is used by this association
as the source address.";
}
uses common-attributes {
description
"Common attributes like port, version, min and max
poll.";
}
}
list associations {
key "address local-mode isconfigured";
config "false";
description
"List of NTP associations. Here address, local-mode
and isconfigured is required to uniquely identify
a particular association. Lets take following examples -
2) When RT2 is configured 1) If RT1 acting as broadcast server,
with unicast-server RT1, then RT2 will form and RT2 acting as broadcast client, then RT2
association with address as RT1, local-mode as client will form dynamic association with address as RT1,
and isconfigured as true. local-mode as client and isconfigured as false.
Thus all 3 leaves are needed as key to unique identify 2) When RT2 is configured
the association."; with unicast-server RT1, then RT2 will form
association with address as RT1, local-mode as client
and isconfigured as true.
leaf address { Thus all 3 leaves are needed as key to unique identify
type inet:host; the association.";
description leaf address {
"The address of this association. Represents the IP type inet:host;
address of a unicast/multicast/broadcast address."; description
} "The address of this association. Represents the IP
leaf local-mode { address of a unicast/multicast/broadcast address.";
type association-mode; }
description leaf local-mode {
"Local mode of this NTP association."; type association-mode;
} description
leaf isconfigured { "Local mode of this NTP association.";
type boolean; }
description leaf isconfigured {
"Indicates if this association is configured or type boolean;
dynamically learned."; description
} "Indicates if this association is configured or
leaf stratum { dynamically learned.";
type ntp-stratum; }
description leaf stratum {
"The association stratum value."; type ntp-stratum;
} description
leaf refid { "The association stratum value.";
type union { reference
type inet:ipv4-address; "RFC 5905: Network Time Protocol Version 4: Protocol and
type binary { Algorithms Specification";
length "4"; }
} leaf refid {
type string { type union {
length "4"; type inet:ipv4-address;
} type binary {
} length "4";
description }
"The refclock driver ID, if available. type string {
-- a refclock driver ID like '127.127.1.0' for local clock length "4";
sync }
-- uni/multi/broadcast associations will look like '20.1.1.1' }
-- sync with primary source will look like 'DCN', 'NIST', description
'ATOM'"; "The refclock driver ID, if available.
reference -- a refclock driver ID like '127.127.1.0' for local clock
"RFC 1305"; sync
} -- uni/multi/broadcast associations will look like
leaf authentication{ '20.1.1.1'
type leafref { -- sync with primary source will look like 'DCN', 'NIST',
path "/ntp:ntp/ntp:authentication/" 'ATOM'";
+ "ntp:authentication-keys/ntp:key-id"; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
description Algorithms Specification";
"Authentication Key used for this association."; }
} leaf authentication{
leaf prefer { type leafref {
type boolean; path "/ntp:ntp/ntp:authentication/"
default "false"; + "ntp:authentication-keys/ntp:key-id";
description }
"Indicates if this association is preferred."; description
} "Authentication Key used for this association.";
leaf peer-interface { }
type if:interface-ref; leaf prefer {
description type boolean;
"The interface which is used for communication."; default "false";
} description
uses common-attributes { "Indicates if this association is preferred.";
description }
"Common attributes like port, version, min and leaf peer-interface {
max poll."; type if:interface-ref;
} description
leaf reach { "The interface which is used for communication.";
type uint8; }
description uses common-attributes {
"The reachability of the configured description
server or peer."; "Common attributes like port, version, min and
} max poll.";
leaf unreach { }
type uint8; leaf reach {
description type uint8;
"The unreachability of the configured description
server or peer."; "The reachability of the configured
} server or peer.";
leaf poll { reference
type uint8; "RFC 5905: Network Time Protocol Version 4: Protocol and
units seconds; Algorithms Specification";
description }
"The polling interval for current association"; leaf unreach {
} type uint8;
leaf now { description
type uint32; "The unreachability of the configured
units seconds; server or peer.";
description reference
"The time since the NTP packet was "RFC 5905: Network Time Protocol Version 4: Protocol and
not received or last synchronized."; Algorithms Specification";
} }
leaf offset { leaf poll {
type decimal64 { type uint8;
fraction-digits 3; units seconds;
} description
units milliseconds; "The polling interval for current association";
description reference
"The offset between the local clock "RFC 5905: Network Time Protocol Version 4: Protocol and
and the peer clock, e.g., '0.032' or '1.232'"; Algorithms Specification";
} }
leaf delay { leaf now {
type decimal64 { type uint32;
fraction-digits 3; units seconds;
} description
units milliseconds; "The time since the NTP packet was
description not received or last synchronized.";
"The network delay between the local clock reference
and the peer clock."; "RFC 5905: Network Time Protocol Version 4: Protocol and
} Algorithms Specification";
leaf dispersion { }
type decimal64 { leaf offset {
fraction-digits 3; type decimal64 {
} fraction-digits 3;
units milliseconds; }
description units milliseconds;
"The root dispersion between the local clock description
"The offset between the local clock
and the peer clock, e.g., '0.032' or '1.232'";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
leaf delay {
type decimal64 {
fraction-digits 3;
}
units milliseconds;
description
"The network delay between the local clock
and the peer clock."; and the peer clock.";
} reference
leaf originate-time { "RFC 5905: Network Time Protocol Version 4: Protocol and
type yang:date-and-time; Algorithms Specification";
description }
"This is the local time, in timestamp format, leaf dispersion {
when latest NTP packet was sent to peer(T1)."; type decimal64 {
reference fraction-digits 3;
"RFC 1305"; }
} units milliseconds;
leaf receive-time { description
type yang:date-and-time; "The root dispersion between the local clock
description and the peer clock.";
"This is the local time, in timestamp format, reference
when latest NTP packet arrived at peer(T2). "RFC 5905: Network Time Protocol Version 4: Protocol and
If the peer becomes unreachable the value is set to zero."; Algorithms Specification";
reference }
"RFC 1305"; leaf originate-time {
} type yang:date-and-time;
leaf transmit-time { description
type yang:date-and-time; "This is the local time, in timestamp format,
description when latest NTP packet was sent to peer(T1).";
"This is the local time, in timestamp format, reference
at which the NTP packet departed the peer(T3). "RFC 5905: Network Time Protocol Version 4: Protocol and
If the peer becomes unreachable the value is set to zero."; Algorithms Specification";
reference }
"RFC 1305"; leaf receive-time {
} type yang:date-and-time;
leaf input-time { description
type yang:date-and-time; "This is the local time, in timestamp format,
description when latest NTP packet arrived at peer(T2).
"This is the local time, in timestamp format, If the peer becomes unreachable the value is set to zero.";
when the latest NTP message from the peer arrived(T4). reference
If the peer becomes unreachable the value is set to zero."; "RFC 5905: Network Time Protocol Version 4: Protocol and
reference Algorithms Specification";
"RFC 1305"; }
} leaf transmit-time {
container ntp-statistics { type yang:date-and-time;
description description
"Per Peer packet send and receive statistics."; "This is the local time, in timestamp format,
uses statistics { at which the NTP packet departed the peer(T3).
description If the peer becomes unreachable the value is set to zero.";
"NTP send and receive packet statistics."; reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
} Algorithms Specification";
} }
leaf input-time {
type yang:date-and-time;
description
"This is the local time, in timestamp format,
when the latest NTP message from the peer arrived(T4).
If the peer becomes unreachable the value is set to zero.";
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
container ntp-statistics {
description
"Per Peer packet send and receive statistics.";
uses statistics {
description
"NTP send and receive packet statistics.";
}
}
}
container interfaces { container interfaces {
description description
"Configuration parameters for NTP interfaces."; "Configuration parameters for NTP interfaces.";
list interface { list interface {
key "name"; key "name";
description description
"List of interfaces."; "List of interfaces.";
leaf name { leaf name {
type if:interface-ref; type if:interface-ref;
description description
"The interface name."; "The interface name.";
} }
container broadcast-server { container broadcast-server {
presence presence
"NTP broadcast-server is configured"; "NTP broadcast-server is configured";
description description
"Configuration of broadcast server."; "Configuration of broadcast server.";
leaf ttl { leaf ttl {
type uint8; type uint8;
description description
"Specifies the time to live (TTL) for a "Specifies the time to live (TTL) for a
broadcast packet."; broadcast packet.";
} }
container authentication{ container authentication{
description description
"Authentication used for this association."; "Authentication used for this association.";
uses authentication; uses authentication;
}
uses common-attributes {
description
"Common attribute like port, version, min and
max poll.";
}
}
container broadcast-client { }
presence uses common-attributes {
"NTP broadcast-client is configured."; description
description "Common attribute like port, version, min and
"Configuration of broadcast-client."; max poll.";
} }
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
list multicast-server { container broadcast-client {
key "address"; presence
description "NTP broadcast-client is configured.";
"Configuration of multicast server."; description
leaf address { "Configuration of broadcast-client.";
type rt-types:ip-multicast-group-address; reference
description "RFC 5905: Network Time Protocol Version 4: Protocol and
"The IP address to send NTP multicast packets."; Algorithms Specification";
} }
leaf ttl {
type uint8;
description
"Specifies the time to live (TTL) for a
multicast packet.";
}
container authentication{
description
"Authentication used for this association.";
uses authentication;
}
uses common-attributes {
description
"Common attributes like port, version, min and
max poll.";
}
}
list multicast-client {
key "address";
description
"Configuration of multicast-client.";
leaf address {
type rt-types:ip-multicast-group-address;
description
"The IP address of the multicast group to
join.";
}
}
list manycast-server {
key "address";
description
"Configuration of manycast server.";
leaf address {
type rt-types:ip-multicast-group-address;
description
"The multicast group IP address to receive
manycast client messages.";
}
reference
"RFC 5905";
}
list manycast-client {
key "address";
description
"Configuration of manycast-client.";
leaf address {
type rt-types:ip-multicast-group-address;
description
"The group IP address that the manycast client
broadcasts the request message to.";
}
container authentication{
description
"Authentication used for this association.";
uses authentication;
}
leaf ttl {
type uint8;
description
"Specifies the maximum time to live (TTL) for
the expanding ring search.";
}
leaf minclock {
type uint8;
description
"The minimum manycast survivors in this
association.";
}
leaf maxclock {
type uint8;
description
"The maximum manycast candidates in this
association.";
} list multicast-server {
leaf beacon { key "address";
type uint8; description
description "Configuration of multicast server.";
"The maximum interval between beacons in this leaf address {
association."; type rt-types:ip-multicast-group-address;
} description
uses common-attributes { "The IP address to send NTP multicast packets.";
description }
"Common attributes like port, version, min and leaf ttl {
max poll."; type uint8;
} description
reference "Specifies the time to live (TTL) for a
"RFC 5905"; multicast packet.";
} }
} container authentication{
} description
container ntp-statistics { "Authentication used for this association.";
config "false"; uses authentication;
description }
"Total NTP packet statistics."; uses common-attributes {
uses statistics { description
description "Common attributes like port, version, min and
"NTP send and receive packet statistics."; max poll.";
} }
} reference
} "RFC 5905: Network Time Protocol Version 4: Protocol and
} Algorithms Specification";
<CODE ENDS> }
list multicast-client {
key "address";
description
"Configuration of multicast-client.";
leaf address {
type rt-types:ip-multicast-group-address;
description
"The IP address of the multicast group to
join.";
}
}
list manycast-server {
key "address";
description
"Configuration of manycast server.";
leaf address {
type rt-types:ip-multicast-group-address;
description
"The multicast group IP address to receive
manycast client messages.";
}
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
list manycast-client {
key "address";
description
"Configuration of manycast-client.";
leaf address {
type rt-types:ip-multicast-group-address;
description
"The group IP address that the manycast client
broadcasts the request message to.";
}
container authentication{
description
"Authentication used for this association.";
uses authentication;
}
leaf ttl {
type uint8;
description
"Specifies the maximum time to live (TTL) for
the expanding ring search.";
}
leaf minclock {
type uint8;
description
"The minimum manycast survivors in this
association.";
}
leaf maxclock {
type uint8;
description
"The maximum manycast candidates in this
association.";
}
leaf beacon {
type uint8;
description
"The maximum interval between beacons in this
association.";
}
uses common-attributes {
description
"Common attributes like port, version, min and
max poll.";
}
reference
"RFC 5905: Network Time Protocol Version 4: Protocol and
Algorithms Specification";
}
}
}
container ntp-statistics {
config "false";
description
"Total NTP packet statistics.";
uses statistics {
description
"NTP send and receive packet statistics.";
}
}
}
}
<CODE ENDS>
8. Usage Example 8. Usage Example
This section include examples for illustration purporses.
8.1. Unicast association 8.1. Unicast association
Below is the example on how to configure a preferred unicast server This example describes how to configure a preferred unicast server
present at 192.0.2.1 running at port 1025 with authentication-key 10 present at 192.0.2.1 running at port 1025 with authentication-key 10
and version 4 and version 4
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<unicast-configuration> <unicast-configuration>
<address>192.0.2.1</address> <address>192.0.2.1</address>
<type>server</type> <type>server</type>
<prefer>true</prefer> <prefer>true</prefer>
skipping to change at page 33, line 29 skipping to change at page 36, line 36
</symmetric-key> </symmetric-key>
</authentication> </authentication>
</unicast-configuration> </unicast-configuration>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
An example with IPv6 would used the an IPv6 address (say 2001:DB8::1) An example with IPv6 would used the an IPv6 address (say 2001:DB8::1)
in the "address" leaf with no change in any other data tree. in the "address" leaf with no change in any other data tree.
Below is the example on how to get unicast configuration This example is for retriving unicast configurations -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:unicast-configuration> <sys:unicast-configuration>
</sys:unicast-configuration> </sys:unicast-configuration>
</sys:ntp> </sys:ntp>
</filter> </filter>
</get> </get>
skipping to change at page 34, line 39 skipping to change at page 37, line 45
<packet-sent-fail>0</packet-sent-fail> <packet-sent-fail>0</packet-sent-fail>
<packet-received>20</packet-received> <packet-received>20</packet-received>
<packet-dropped>0</packet-dropped> <packet-dropped>0</packet-dropped>
</ntp-statistics> </ntp-statistics>
</unicast-configuration> </unicast-configuration>
</ntp> </ntp>
</data> </data>
8.2. Refclock master 8.2. Refclock master
Below is the example on how to configure reference clock with stratum This example describes how to configure reference clock with stratum
8 8 -
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<refclock-master> <refclock-master>
<master-stratum>8</master-stratum> <master-stratum>8</master-stratum>
</refclock-master> </refclock-master>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
Below is the example on how to get reference clock configuration This example describes how to get reference clock configuration -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:refclock-master> <sys:refclock-master>
</sys:refclock-master> </sys:refclock-master>
</sys:ntp> </sys:ntp>
</filter> </filter>
</get> </get>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<refclock-master> <refclock-master>
<master-stratum>8</master-stratum> <master-stratum>8</master-stratum>
</refclock-master> </refclock-master>
</ntp> </ntp>
</data> </data>
8.3. Authentication configuration 8.3. Authentication configuration
Below is the example on how to enable authentication and configure This example describes how to enable authentication and configure
trusted authentication key 10 with mode as md5 and key as abcd trusted authentication key 10 with mode as md5 and key as 'abcd' -
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<authentication> <authentication>
<auth-enabled>true</auth-enabled> <auth-enabled>true</auth-enabled>
<authentication-keys> <authentication-keys>
<key-id>10</key-id> <key-id>10</key-id>
<algorithm>md5</algorithm> <algorithm>md5</algorithm>
<key>abcd</key> <key>abcd</key>
<istrusted>true</istrusted> <istrusted>true</istrusted>
</authentication-keys> </authentication-keys>
</authentication> </authentication>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
Below is the example on how to get authentication related This example describes how to get authentication related
configuration configuration -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:authentication> <sys:authentication>
</sys:authentication> </sys:authentication>
</sys:ntp> </sys:ntp>
</filter> </filter>
</get> </get>
skipping to change at page 37, line 7 skipping to change at page 40, line 7
<algorithm>md5</algorithm> <algorithm>md5</algorithm>
<key>abcd</key> <key>abcd</key>
<istrusted>true</istrusted> <istrusted>true</istrusted>
</authentication-keys> </authentication-keys>
</authentication> </authentication>
</ntp> </ntp>
</data> </data>
8.4. Access configuration 8.4. Access configuration
Below is the example on how to configure access mode "peer" This example describes how to configure access mode "peer" associated
associated with acl 2000. with acl 2000 -
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<access-rules> <access-rules>
<access-rule> <access-rule>
<access-mode>peer</access-mode> <access-mode>peer</access-mode>
<acl>2000</acl> <acl>2000</acl>
</access-rule> </access-rule>
</access-rules> </access-rules>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
Below is the example on how to get access related configuration This example describes how to get access related configuration -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:access-rules> <sys:access-rules>
</sys:access-rules> </sys:access-rules>
</sys:ntp> </sys:ntp>
</filter> </filter>
</get> </get>
skipping to change at page 37, line 50 skipping to change at page 40, line 50
<access-rule> <access-rule>
<access-mode>peer</access-mode> <access-mode>peer</access-mode>
<acl>2000</acl> <acl>2000</acl>
</access-rule> </access-rule>
</access-rules> </access-rules>
</ntp> </ntp>
</data> </data>
8.5. Multicast configuration 8.5. Multicast configuration
Below is the example on how to configure multicast-server with This example describes how to configure multicast-server with address
address as "224.1.1.1", port as 1025 and authentication keyid as 10 as "224.1.1.1", port as 1025 and authentication keyid as 10 -
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<interfaces> <interfaces>
<interface> <interface>
<name>Ethernet3/0/0</name> <name>Ethernet3/0/0</name>
<multicast-server> <multicast-server>
skipping to change at page 38, line 28 skipping to change at page 41, line 28
</symmetric-key> </symmetric-key>
</authentication> </authentication>
<port>1025</port> <port>1025</port>
</multicast-server> </multicast-server>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
Below is the example on how to get multicast-server related This example describes how to get multicast-server related
configuration configuration -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:interfaces> <sys:interfaces>
<sys:interface> <sys:interface>
<sys:multicast-server> <sys:multicast-server>
</sys:multicast-server> </sys:multicast-server>
</sys:interface> </sys:interface>
</sys:interfaces> </sys:interfaces>
</sys:ntp> </sys:ntp>
skipping to change at page 39, line 40 skipping to change at page 42, line 40
<minpoll>6</minpoll> <minpoll>6</minpoll>
<maxpoll>10</maxpoll> <maxpoll>10</maxpoll>
<port>1025</port> <port>1025</port>
<version>3</version> <version>3</version>
</multicast-server> </multicast-server>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</data> </data>
Below is the example on how to configure multicast-client with This example describes how to configure multicast-client with address
address as "224.1.1.1" as "224.1.1.1" -
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<interfaces> <interfaces>
<interface> <interface>
<name>Ethernet3/0/0</name> <name>Ethernet3/0/0</name>
<multicast-client> <multicast-client>
<address>224.1.1.1</address> <address>224.1.1.1</address>
</multicast-client> </multicast-client>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
Below is the example on how to get multicast-client related This example describes how to get multicast-client related
configuration configuration -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:interfaces> <sys:interfaces>
<sys:interface> <sys:interface>
<sys:multicast-client> <sys:multicast-client>
</sys:multicast-client> </sys:multicast-client>
</sys:interface> </sys:interface>
</sys:interfaces> </sys:interfaces>
skipping to change at page 41, line 7 skipping to change at page 44, line 7
<multicast-client> <multicast-client>
<address>224.1.1.1</address> <address>224.1.1.1</address>
</multicast-client> </multicast-client>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</data> </data>
8.6. Manycast configuration 8.6. Manycast configuration
Below is the example on how to configure manycast-client with address This example describes how to configure manycast-client with address
as "224.1.1.1", port as 1025 and authentication keyid as 10 as "224.1.1.1", port as 1025 and authentication keyid as 10 -
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<interfaces> <interfaces>
<interface> <interface>
<name>Ethernet3/0/0</name> <name>Ethernet3/0/0</name>
skipping to change at page 41, line 34 skipping to change at page 44, line 34
</symmetric-key> </symmetric-key>
</authentication> </authentication>
<port>1025</port> <port>1025</port>
</manycast-client> </manycast-client>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
Below is the example on how to get manycast-client related This example describes how to get manycast-client related
configuration configuration -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:interfaces> <sys:interfaces>
<sys:interface> <sys:interface>
<sys:manycast-client> <sys:manycast-client>
</sys:manycast-client> </sys:manycast-client>
</sys:interface> </sys:interface>
</sys:interfaces> </sys:interfaces>
</sys:ntp> </sys:ntp>
skipping to change at page 42, line 42 skipping to change at page 45, line 42
<beacon>6</beacon> <beacon>6</beacon>
<minpoll>6</minpoll> <minpoll>6</minpoll>
<maxpoll>10</maxpoll> <maxpoll>10</maxpoll>
<port>1025</port> <port>1025</port>
</manycast-client> </manycast-client>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</data> </data>
Below is the example on how to configure manycast-server with address This example describes how to configure manycast-server with address
as "224.1.1.1" as "224.1.1.1" -
<edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<target> <target>
<running/> <running/>
</target> </target>
<config> <config>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<interfaces> <interfaces>
<interface> <interface>
<name>Ethernet3/0/0</name> <name>Ethernet3/0/0</name>
<manycast-server> <manycast-server>
<address>224.1.1.1</address> <address>224.1.1.1</address>
</manycast-server> </manycast-server>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</config> </config>
</edit-config> </edit-config>
Below is the example on how to get manycast-server related This example describes how to get manycast-server related
configuration configuration -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:interfaces> <sys:interfaces>
<sys:interface> <sys:interface>
<sys:manycast-server> <sys:manycast-server>
</sys:manycast-server> </sys:manycast-server>
</sys:interface> </sys:interface>
</sys:interfaces> </sys:interfaces>
skipping to change at page 44, line 7 skipping to change at page 47, line 7
<manycast-server> <manycast-server>
<address>224.1.1.1</address> <address>224.1.1.1</address>
</manycast-server> </manycast-server>
</interface> </interface>
</interfaces> </interfaces>
</ntp> </ntp>
</data> </data>
8.7. Clock state 8.7. Clock state
Below is the example on how to get clock current state This example describes how to get clock current state -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:clock-state> <sys:clock-state>
</sys:clock-state> </sys:clock-state>
</sys:ntp> </sys:ntp>
</filter> </filter>
</get> </get>
skipping to change at page 44, line 47 skipping to change at page 47, line 47
<reference-time>10-10-2017 07:33:55.258 Z+05:30\ <reference-time>10-10-2017 07:33:55.258 Z+05:30\
</reference-time> </reference-time>
<sync-state>clock-synchronized</sync-state> <sync-state>clock-synchronized</sync-state>
</system-status> </system-status>
</clock-state> </clock-state>
</ntp> </ntp>
</data> </data>
8.8. Get all association 8.8. Get all association
Below is the example on how to get all association present This example describes how to get all association present in the
system -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:associations> <sys:associations>
</sys:associations> </sys:associations>
</sys:ntp> </sys:ntp>
</filter> </filter>
</get> </get>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
skipping to change at page 46, line 7 skipping to change at page 49, line 7
<packet-sent-fail>0</packet-sent-fail> <packet-sent-fail>0</packet-sent-fail>
<packet-received>20</packet-received> <packet-received>20</packet-received>
<packet-dropped>0</packet-dropped> <packet-dropped>0</packet-dropped>
</ntp-statistics> </ntp-statistics>
</associations> </associations>
</ntp> </ntp>
</data> </data>
8.9. Global statistic 8.9. Global statistic
Below is the example on how to get clock current state This example describes how to get clock current state -
<get> <get>
<filter type="subtree"> <filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:ntp-statistics> <sys:ntp-statistics>
</sys:ntp-statistics> </sys:ntp-statistics>
</sys:ntp> </sys:ntp>
</filter> </filter>
</get> </get>
skipping to change at page 46, line 37 skipping to change at page 49, line 37
</data> </data>
9. IANA Considerations 9. IANA Considerations
This document registers a URI in the "IETF XML Registry" [RFC3688]. This document registers a URI in the "IETF XML Registry" [RFC3688].
Following the format in RFC 3688, the following registration has been Following the format in RFC 3688, the following registration has been
made. made.
URI: urn:ietf:params:xml:ns:yang:ietf-ntp URI: urn:ietf:params:xml:ns:yang:ietf-ntp
Registrant Contact: The NTP WG of the IETF. 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 a YANG module in the "YANG Module Names" This document registers a YANG module in the "YANG Module Names"
registry [RFC6020]. registry [RFC6020].
Name: ietf-ntp Name: ietf-ntp
Namespace: urn:ietf:params:xml:ns:yang:ietf-ntp Namespace: urn:ietf:params:xml:ns:yang:ietf-ntp
Prefix: ntp Prefix: ntp
Reference: RFC YYYY Reference: RFC XXXX
Note: The RFC Editor will replace YYYY with the number assigned to Note: The RFC Editor will replace XXXX with the number assigned to
this document once it becomes an RFC. this document once it becomes an RFC.
10. Security Considerations 10. Security Considerations
The YANG module specified in this document defines a schema for data The YANG module specified in this document defines a schema for data
that is designed to be accessed via network management protocols such that is designed to be accessed via network management protocols such
as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
is the secure transport layer, and the mandatory-to-implement secure is the secure transport layer, and the mandatory-to-implement secure
transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
is HTTPS, and the mandatory-to-implement secure transport is TLS is HTTPS, and the mandatory-to-implement secure transport is TLS
skipping to change at page 48, line 21 skipping to change at page 51, line 21
11. Acknowledgments 11. Acknowledgments
The authors would like to express their thanks to Sladjana Zoric, The authors would like to express their thanks to Sladjana Zoric,
Danny Mayer, Harlan Stenn, Ulrich Windl, Miroslav Lichvar, and Danny Mayer, Harlan Stenn, Ulrich Windl, Miroslav Lichvar, and
Maurice Angermann for their review and suggestions. Maurice Angermann for their review and suggestions.
12. References 12. References
12.1. Normative References 12.1. Normative References
[I-D.ietf-netmod-acl-model]
Jethanandani, M., Agarwal, S., Huang, L., and D. Blair,
"Network Access Control List (ACL) YANG Data Model",
draft-ietf-netmod-acl-model-21 (work in progress),
November 2018.
[RFC1305] Mills, D., "Network Time Protocol (Version 3) [RFC1305] Mills, D., "Network Time Protocol (Version 3)
Specification, Implementation and Analysis", RFC 1305, Specification, Implementation and Analysis", RFC 1305,
DOI 10.17487/RFC1305, March 1992, DOI 10.17487/RFC1305, March 1992,
<https://www.rfc-editor.org/info/rfc1305>. <https://www.rfc-editor.org/info/rfc1305>.
[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, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
skipping to change at page 50, line 13 skipping to change at page 53, line 9
<https://www.rfc-editor.org/info/rfc8341>. <https://www.rfc-editor.org/info/rfc8341>.
[RFC8343] Bjorklund, M., "A YANG Data Model for Interface [RFC8343] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 8343, DOI 10.17487/RFC8343, March 2018, Management", RFC 8343, DOI 10.17487/RFC8343, March 2018,
<https://www.rfc-editor.org/info/rfc8343>. <https://www.rfc-editor.org/info/rfc8343>.
[RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol
Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018,
<https://www.rfc-editor.org/info/rfc8446>. <https://www.rfc-editor.org/info/rfc8446>.
[RFC8519] Jethanandani, M., Agarwal, S., Huang, L., and D. Blair,
"YANG Data Model for Network Access Control Lists (ACLs)",
RFC 8519, DOI 10.17487/RFC8519, March 2019,
<https://www.rfc-editor.org/info/rfc8519>.
12.2. Informative References 12.2. Informative References
[RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for [RFC7317] Bierman, A. and M. Bjorklund, "A YANG Data Model for
System Management", RFC 7317, DOI 10.17487/RFC7317, August System Management", RFC 7317, DOI 10.17487/RFC7317, August
2014, <https://www.rfc-editor.org/info/rfc7317>. 2014, <https://www.rfc-editor.org/info/rfc7317>.
[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, DOI 10.17487/RFC8342, March 2018, (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018,
<https://www.rfc-editor.org/info/rfc8342>. <https://www.rfc-editor.org/info/rfc8342>.
 End of changes. 104 change blocks. 
1292 lines changed or deleted 1442 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/