draft-ietf-ntp-yang-data-model-01.txt   draft-ietf-ntp-yang-data-model-02.txt 
Network Working Group N. Wu Network Working Group N. Wu
Internet-Draft Huawei Internet-Draft Huawei
Intended status: Standards Track A. Kumar S N Intended status: Standards Track A. Kumar S N
Expires: May 1, 2018 RtBrick Inc. Expires: September 6, 2018 RtBrick Inc.
Y. Zhao Y. Zhao
Ericsson Ericsson
D. Dhody D. Dhody
A. Sinha
Huawei Huawei
October 28, 2017 A. Sinha
RtBrick Inc.
March 5, 2018
A YANG Data Model for NTP A YANG Data Model for NTP
draft-ietf-ntp-yang-data-model-01 draft-ietf-ntp-yang-data-model-02
Abstract Abstract
This document defines a YANG data model for Network Time Protocol This document defines a YANG data model for Network Time Protocol
implementations. The data model includes configuration data and (NTP) implementations. The data model includes configuration data
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",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP "OPTIONAL" in this document are to be interpreted as described in BCP
14 [RFC2119] [RFC8174] when, and only when, they appear in all 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
Status of This Memo Status of This Memo
skipping to change at page 1, line 46 skipping to change at page 1, line 47
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 May 1, 2018. This Internet-Draft will expire on September 6, 2018.
Copyright Notice Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the Copyright (c) 2018 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(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 . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
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
2. NTP data model . . . . . . . . . . . . . . . . . . . . . . . 3 2. NTP data model . . . . . . . . . . . . . . . . . . . . . . . 3
3. Relationship with NTPv4-MIB . . . . . . . . . . . . . . . . . 6 3. Relationship with NTPv4-MIB . . . . . . . . . . . . . . . . . 6
4. Relationship with RFC7317 . . . . . . . . . . . . . . . . . . 7 4. Relationship with RFC 7317 . . . . . . . . . . . . . . . . . 7
5. NTP YANG Module . . . . . . . . . . . . . . . . . . . . . . . 8 5. NTP YANG Module . . . . . . . . . . . . . . . . . . . . . . . 8
6. Usage Example . . . . . . . . . . . . . . . . . . . . . . . . 27 6. Usage Example . . . . . . . . . . . . . . . . . . . . . . . . 28
6.1. Unicast association . . . . . . . . . . . . . . . . . . . 27 6.1. Unicast association . . . . . . . . . . . . . . . . . . . 28
6.2. Refclock master . . . . . . . . . . . . . . . . . . . . . 29 6.2. Refclock master . . . . . . . . . . . . . . . . . . . . . 29
6.3. Authentication configuration . . . . . . . . . . . . . . 30 6.3. Authentication configuration . . . . . . . . . . . . . . 30
6.4. Access configuration . . . . . . . . . . . . . . . . . . 31 6.4. Access configuration . . . . . . . . . . . . . . . . . . 32
6.5. Multicast configuration . . . . . . . . . . . . . . . . . 32 6.5. Multicast configuration . . . . . . . . . . . . . . . . . 32
6.6. Manycast configuration . . . . . . . . . . . . . . . . . 35 6.6. Manycast configuration . . . . . . . . . . . . . . . . . 36
6.7. Clock state . . . . . . . . . . . . . . . . . . . . . . . 38 6.7. Clock state . . . . . . . . . . . . . . . . . . . . . . . 39
6.8. Get all association . . . . . . . . . . . . . . . . . . . 38 6.8. Get all association . . . . . . . . . . . . . . . . . . . 39
6.9. Global statistic . . . . . . . . . . . . . . . . . . . . 40 6.9. Global statistic . . . . . . . . . . . . . . . . . . . . 41
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 40 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 41
8. Security Considerations . . . . . . . . . . . . . . . . . . . 41 8. Security Considerations . . . . . . . . . . . . . . . . . . . 42
9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 41 9. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 43
10. References . . . . . . . . . . . . . . . . . . . . . . . . . 41 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.1. Normative References . . . . . . . . . . . . . . . . . . 41 10.1. Normative References . . . . . . . . . . . . . . . . . . 43
10.2. Informative References . . . . . . . . . . . . . . . . . 42 10.2. Informative References . . . . . . . . . . . . . . . . . 44
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 42 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 44
1. Introduction 1. Introduction
This document defines a YANG [RFC6020] data model for Network Time This document defines a YANG [RFC6020] 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 VRF binding, and also such as access rules, authentication and VPN Routing and Forwarding
associations of NTP in different modes and parameters of per- (VRF) binding, and also associations of NTP in different modes and
interface. It also provides information about running state of NTP parameters of per-interface. It also provides information about
implementations. running state of NTP implementations.
1.1. Operational State 1.1. Operational State
NTP Operational State is included in the same tree as NTP NTP Operational State is included in the same tree as NTP
configuration, consistent with Network Management Datastore configuration, consistent with Network Management Datastore
Architecture [I-D.ietf-netmod-revised-datastores]. NTP current state Architecture [I-D.ietf-netmod-revised-datastores]. NTP current state
and statistics are also maintained in the operational state. and statistics are also maintained in the operational state.
Additionally, the operational state also include the associations Additionally, the operational state also include the associations
state. state.
skipping to change at page 3, line 35 skipping to change at page 3, line 35
A simplified graphical representation of the data model is used in A simplified graphical representation of the data model is used in
this document. This document uses the graphical representation of this document. This document uses the graphical representation of
data models defined in [I-D.ietf-netmod-yang-tree-diagrams]. data models defined in [I-D.ietf-netmod-yang-tree-diagrams].
2. NTP data model 2. NTP data model
This document defines the YANG module "ietf-ntp", which has the This document defines the YANG module "ietf-ntp", which has the
following structure: following structure:
module: ietf-ntp module: ietf-ntp
+--rw ntp! +--rw ntp!
+--rw port? uint16 +--rw port? uint16 {ntp-port}?
+--rw refclock-master! +--rw refclock-master!
| +--rw master-stratum? ntp-stratum | +--rw master-stratum? ntp-stratum
+--rw authentication +--rw authentication
| +--rw auth-enabled? boolean | +--rw auth-enabled? boolean
| +--rw trusted-keys* [key-id] | +--rw trusted-keys* [key-id]
| | +--rw key-id -> /ntp/authentication/authentication-keys/key-id | | +--rw key-id leafref
| +--rw authentication-keys* [key-id] | +--rw authentication-keys* [key-id]
| +--rw key-id uint32 | +--rw key-id uint32
| +--rw algorithm? identityref | +--rw algorithm? identityref
| +--rw password? ianach:crypt-hash | +--rw password? ianach:crypt-hash
+--rw access-rules +--rw access-rules
| +--rw access-rule* [access-mode] | +--rw access-rule* [access-mode]
| +--rw access-mode access-modes | +--rw access-mode access-modes
| +--rw acl? -> /acl:access-lists/acl/acl-name | +--rw acl? -> /acl:access-lists/acl/name
+--ro clock-state +--ro clock-state
| +--ro system-status | +--ro system-status
| +--ro clock-state ntp-clock-status | +--ro clock-state ntp-clock-status
| +--ro clock-stratum ntp-stratum | +--ro clock-stratum ntp-stratum
| +--ro clock-refid union | +--ro clock-refid union
| +--ro associations-address? -> /ntp/associations/address | +--ro associations-address?
| +--ro associations-local-mode? -> /ntp/associations/local-mode | | -> /ntp/associations/address
| +--ro associations-isConfigured? -> /ntp/associations/isConfigured | +--ro associations-local-mode?
| +--ro nominal-freq decimal64 | | -> /ntp/associations/local-mode
| +--ro actual-freq decimal64 | +--ro associations-isConfigured?
| +--ro clock-precision uint8 | | -> /ntp/associations/isConfigured
| +--ro clock-offset? decimal64 | +--ro nominal-freq decimal64
| +--ro root-delay? decimal64 | +--ro actual-freq decimal64
| +--ro root-dispersion? decimal64 | +--ro clock-precision uint8
| +--ro reference-time? yang:date-and-time | +--ro clock-offset? decimal64
| +--ro sync-state ntp-sync-state | +--ro root-delay? decimal64
+--rw unicast* [address type] | +--ro root-dispersion? decimal64
| +--rw address inet:host | +--ro reference-time? yang:date-and-time
| +--rw type unicast-configuration-type | +--ro sync-state ntp-sync-state
| +--rw authentication +--rw unicast-configuration* [address type]
| | +--rw (authentication-type)? | +--rw address inet:host
| | +--:(symmetric-key) | +--rw type unicast-configuration-type
| | +--rw key-id? -> /ntp/authentication/authentication-keys/key-id | +--rw authentication
| +--rw prefer? boolean | | +--rw (authentication-type)?
| +--rw burst? boolean | | +--:(symmetric-key)
| +--rw iburst? boolean | | +--rw key-id? leafref
| +--rw source? if:interface-ref | +--rw prefer? boolean
| +--rw minpoll? ntp-minpoll | +--rw burst? boolean
| +--rw maxpoll? ntp-maxpoll | +--rw iburst? boolean
| +--rw port? uint16 | +--rw source? if:interface-ref
| +--rw version? ntp-version | +--rw minpoll? ntp-minpoll
+--ro associations* [address local-mode isConfigured] | +--rw maxpoll? ntp-maxpoll
| +--ro address inet:host | +--rw port? uint16 {ntp-port}?
| +--ro local-mode association-modes | +--rw version? ntp-version
| +--ro isConfigured boolean +--ro associations* [address local-mode isConfigured]
| +--ro stratum? ntp-stratum | +--ro address inet:host
| +--ro refid? union | +--ro local-mode association-modes
| +--ro authentication? -> /ntp/authentication/authentication-keys/key-id | +--ro isConfigured boolean
| +--ro prefer? boolean | +--ro stratum? ntp-stratum
| +--ro peer-interface? if:interface-ref | +--ro refid? union
| +--ro minpoll? ntp-minpoll | +--ro authentication?
| +--ro maxpoll? ntp-maxpoll | | -> /ntp/authentication/authentication-keys/key-id
| +--ro port? uint16 | +--ro prefer? boolean
| +--ro version? ntp-version | +--ro peer-interface? if:interface-ref
| +--ro reach? uint8 | +--ro minpoll? ntp-minpoll
| +--ro unreach? uint8 | +--ro maxpoll? ntp-maxpoll
| +--ro poll? uint8 | +--ro port? uint16 {ntp-port}?
| +--ro now? uint32 | +--ro version? ntp-version
| +--ro offset? decimal64 | +--ro reach? uint8
| +--ro delay? decimal64 | +--ro unreach? uint8
| +--ro dispersion? decimal64 | +--ro poll? uint8
| +--ro originate-time? yang:date-and-time | +--ro now? uint32
| +--ro receive-time? yang:date-and-time | +--ro offset? decimal64
| +--ro transmit-time? yang:date-and-time | +--ro delay? decimal64
| +--ro input-time? yang:date-and-time | +--ro dispersion? decimal64
| +--ro ntp-statistics | +--ro originate-time? yang:date-and-time
| +--ro packet-sent? yang:counter32 | +--ro receive-time? yang:date-and-time
| +--ro packet-sent-fail? yang:counter32 | +--ro transmit-time? yang:date-and-time
| +--ro packet-received? yang:counter32 | +--ro input-time? yang:date-and-time
| +--ro packet-dropped? yang:counter32 | +--ro ntp-statistics
+--rw interfaces | +--ro packet-sent? yang:counter32
| +--rw interface* [name] | +--ro packet-sent-fail? yang:counter32
| +--rw name if:interface-ref | +--ro packet-received? yang:counter32
| +--rw broadcast-server! | +--ro packet-dropped? yang:counter32
| | +--rw ttl? uint8 +--rw interfaces
| | +--rw authentication | +--rw interface* [name]
| | | +--rw (authentication-type)? | +--rw name if:interface-ref
| | | +--:(symmetric-key) | +--rw broadcast-server!
| | | +--rw key-id? -> /ntp/authentication/authentication-keys/key-id | | +--rw ttl? uint8
| | +--rw minpoll? ntp-minpoll | | +--rw authentication
| | +--rw maxpoll? ntp-maxpoll | | | +--rw (authentication-type)?
| | +--rw port? uint16 | | | +--:(symmetric-key)
| | +--rw version? ntp-version | | | +--rw key-id? leafref
| +--rw broadcast-client! | | +--rw minpoll? ntp-minpoll
| +--rw multicast-server* [address] | | +--rw maxpoll? ntp-maxpoll
| | +--rw address rt-types:ip-multicast-group-address | | +--rw port? uint16 {ntp-port}?
| | +--rw ttl? uint8 | | +--rw version? ntp-version
| | +--rw authentication | +--rw broadcast-client!
| | | +--rw (authentication-type)? | +--rw multicast-server* [address]
| | | +--:(symmetric-key) | | +--rw address
| | | +--rw key-id? -> /ntp/authentication/authentication-keys/key-id | | | rt-types:ip-multicast-group-address
| | +--rw minpoll? ntp-minpoll | | +--rw ttl? uint8
| | +--rw maxpoll? ntp-maxpoll | | +--rw authentication
| | +--rw port? uint16 | | | +--rw (authentication-type)?
| | +--rw version? ntp-version | | | +--:(symmetric-key)
| +--rw multicast-client* [address] | | | +--rw key-id? leafref
| | +--rw address rt-types:ip-multicast-group-address | | +--rw minpoll? ntp-minpoll
| +--rw manycast-server* [address] | | +--rw maxpoll? ntp-maxpoll
| | +--rw address rt-types:ip-multicast-group-address | | +--rw port? uint16 {ntp-port}?
| +--rw manycast-client* [address] | | +--rw version? ntp-version
| +--rw address rt-types:ip-multicast-group-address | +--rw multicast-client* [address]
| +--rw authentication | | +--rw address rt-types:ip-multicast-group-address
| | +--rw (authentication-type)? | +--rw manycast-server* [address]
| | +--:(symmetric-key) | | +--rw address rt-types:ip-multicast-group-address
| | +--rw key-id? -> /ntp/authentication/authentication-keys/key-id | +--rw manycast-client* [address]
| +--rw ttl? uint8 | +--rw address
| +--rw minclock? uint8 | | rt-types:ip-multicast-group-address
| +--rw maxclock? uint8 | +--rw authentication
| +--rw beacon? uint8 | | +--rw (authentication-type)?
| +--rw minpoll? ntp-minpoll | | +--:(symmetric-key)
| +--rw maxpoll? ntp-maxpoll | | +--rw key-id? leafref
| +--rw port? uint16 | +--rw ttl? uint8
| +--rw version? ntp-version | +--rw minclock? uint8
+--ro ntp-statistics | +--rw maxclock? uint8
+--ro packet-sent? yang:counter32 | +--rw beacon? uint8
+--ro packet-sent-fail? yang:counter32 | +--rw minpoll? ntp-minpoll
+--ro packet-received? yang:counter32 | +--rw maxpoll? ntp-maxpoll
+--ro packet-dropped? yang:counter32 | +--rw port? uint16 {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, interfaces, system rules, authentication, associations, unicast configurations,
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 in If the device implements the NTPv4-MIB [RFC5907], data nodes from
container ntp and ntp-state from YANG module can be mapped to table YANG module can be mapped to table entries in NTPv4-MIB.
entries in NTPv4-MIB.
The following tables list the YANG data nodes with corresponding The following tables list the YANG data nodes with corresponding
objects in the NTPv4-MIB. objects in the NTPv4-MIB.
+--------------------------+--------------------------+ +--------------------------+--------------------------+
| YANG data nodes in /ntp/ | NTPv4-MIB objects | | YANG data nodes in /ntp/ | NTPv4-MIB objects |
+--------------------------+--------------------------+ +--------------------------+--------------------------+
| ntp-enabled | ntpEntStatusCurrentMode | | ntp-enabled | ntpEntStatusCurrentMode |
+--------------------------+--------------------------+ +--------------------------+--------------------------+
skipping to change at page 7, line 34 skipping to change at page 7, line 34
| offset | ntpAssocOffset | | offset | ntpAssocOffset |
| delay | ntpAssocStatusDelay | | delay | ntpAssocStatusDelay |
| dispersion | ntpAssocStatusDispersion | | dispersion | ntpAssocStatusDispersion |
| ntp-statistics/packet-sent | ntpAssocStatOutPkts | | ntp-statistics/packet-sent | ntpAssocStatOutPkts |
| ntp-statistics/packet-received | ntpAssocStatInPkts | | ntp-statistics/packet-received | ntpAssocStatInPkts |
| ntp-statistics/packet-dropped | ntpAssocStatProtocolError | | ntp-statistics/packet-dropped | ntpAssocStatProtocolError |
+---------------------------------------+---------------------------+ +---------------------------------------+---------------------------+
YANG NTP State Data Nodes and Related NTPv4-MIB Objects YANG NTP State Data Nodes and Related NTPv4-MIB Objects
4. Relationship with RFC7317 4. Relationship with RFC 7317
This section describes the relationship with NTP definition in This section describes the relationship with NTP definition in
Section 3.2 System Time Management of [RFC7317] . YANG data nodes in Section 3.2 System Time Management of [RFC7317] . YANG data nodes in
/ntp/ also supports interface related configurations which is not /ntp/ also supports per-interface configurations which is not
supported in /system/ntp supported in /system/ntp
+---------------------------+--------------------------------+ +-------------------------------+--------------------------------+
| YANG data nodes in /ntp/ | YANG data nodes in /system/ntp | | YANG data nodes in /ntp/ | YANG data nodes in /system/ntp |
+---------------------------+--------------------------------+ +-------------------------------+--------------------------------+
| ntp-enabled | enabled | | ntp-enabled | enabled |
| unicast | server | | unicast-configuration | server |
| | server/name | | | server/name |
| unicast/address | server/transport/udp/address | | unicast-configuration/address | server/transport/udp/address |
| unicast/port | server/transport/udp/port | | unicast-configuration/port | server/transport/udp/port |
| unicast/type | server/association-type | | unicast-configuration/type | server/association-type |
| unicast/iburst | server/iburst | | unicast-configuration/iburst | server/iburst |
| unicast/prefer | server/prefer | | unicast-configuration/prefer | server/prefer |
+---------------------------+--------------------------------+ +-------------------------------+--------------------------------+
YANG NTP Configuration Data Nodes and counterparts in RFC7317 Objects YANG NTP Configuration Data Nodes and counterparts in RFC 7317
Objects
5. NTP YANG Module 5. NTP YANG Module
<CODE BEGINS> file "ietf-ntp@2017-10-28.yang" <CODE BEGINS> file "ietf-ntp@2018-03-05.yang"
module ietf-ntp { module ietf-ntp {
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";
} }
import ietf-inet-types { import ietf-inet-types {
prefix "inet"; prefix "inet";
} }
import ietf-interfaces { import ietf-interfaces {
prefix "if"; prefix "if";
} }
import iana-crypt-hash { import iana-crypt-hash {
prefix ianach; prefix "ianach";
} }
import ietf-key-chain { import ietf-key-chain {
prefix "key-chain"; prefix "key-chain";
} }
import ietf-access-control-list { import ietf-access-control-list {
prefix "acl"; prefix "acl";
} }
import ietf-routing-types { import ietf-routing-types {
prefix "rt-types"; prefix "rt-types";
} }
organization organization
"IETF NTP (Network Time Protocol) Working Group"; "IETF NTP (Network Time Protocol) Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/ntp/> "WG Web: <http://tools.ietf.org/wg/ntp/>
WG List: <mailto: ntpwg@lists.ntp.org WG List: <mailto: ntpwg@lists.ntp.org
WG Chair: Karen O'Donoghue Editor: Eric Wu
<mailto: odonoghue@isoc.org> <mailto:eric.wu@huawei.com>
Editor: Eric Wu Editor: Anil Kumar S N
<mailto:eric.wu@huawei.com> <mailto:anil.ietf@gmail.com>
Editor: Anil Kumar S N Editor: Yi Zhao
<mailto:anil.ietf@gmail.com> <mailto:yi.z.zhao@ericsson.com>
Editor: Yi Zhao Editor: Dhruv Dhody
<mailto:yi.z.zhao@ericsson.com> <mailto:dhruv.ietf@gmail.com>
Editor: Dhruv Dhody Editor: Ankit Kumar Sinha
<mailto:dhruv.ietf@gmail.com> <mailto:ankit.ietf@gmail.com>";
Editor: Ankit Kumar Sinha description
<mailto:ankit.ietf@gmail.com>"; "This YANG module defines essential components for the
description management of a routing subsystem.
"This YANG module defines essential components for the
management of a routing subsystem.
Copyright (c) 2017 IETF Trust and the persons identified Copyright (c) 2018 IETF Trust and the persons identified
as authors of the code. All rights reserved. as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, Redistribution and use in source and binary forms,
with or without modification, is permitted pursuant to, with or without modification, is permitted pursuant to,
and subject to the license terms contained in, the and subject to the license terms contained in, the
Simplified BSD License set forth in Section 4.c of the Simplified BSD License set forth in Section 4.c of the
IETF Trust's Legal Provisions Relating to IETF Documents IETF Trust's Legal Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; This version of this YANG module is part of RFC XXXX;
see the RFC itself for full legal notices."; see the RFC itself for full legal notices.";
revision 2017-10-28 { revision 2018-03-05 {
description description
"Updated revision."; "Updated revision.";
reference reference
"RFC XXXX: A YANG Data Model for NTP Management"; "RFC XXXX: A YANG Data Model for NTP Management";
} }
/* Typedef Definitions */ /* Typedef Definitions */
typedef ntp-stratum {
type uint8 {
range "1..16";
}
description
"The level of each server in the hierarchy is defined by
a stratum number. Primary servers are assigned stratum
one; secondary servers at each lower level are assigned
stratum numbers one greater than the preceding level";
}
typedef ntp-version { typedef ntp-stratum {
type uint8 { type uint8 {
range "1..4"; range "1..16";
} }
default "3"; description
description "The level of each server in the hierarchy is defined by
"The current NTP version supported by corresponding a stratum number. Primary servers are assigned stratum
association."; one; secondary servers at each lower level are assigned
} stratum numbers one greater than the preceding level";
}
typedef ntp-minpoll { typedef ntp-version {
type uint8 { type uint8 {
range "4..17"; range "1..4";
} }
default "6"; default "3";
description description
"The minimum poll exponent for this NTP association."; "The current NTP version supported by corresponding
} association.";
}
typedef ntp-maxpoll { typedef ntp-minpoll {
type uint8 { type uint8 {
range "4..17"; range "4..17";
}
default "6";
description
"The minimum poll exponent for this NTP association.";
}
typedef ntp-maxpoll {
type uint8 {
range "4..17";
}
default "10";
description
"The maximul poll exponent for this NTP association.";
}
typedef access-modes {
type enumeration {
enum peer {
value "0";
description
"Sets the fully access authority. Both time
request and control query can be performed
on the local NTP service, and the local clock
can be synchronized to the remote server.";
}
enum server {
value "1";
description
"Enables the server access and query.
Both time requests and control query can be
performed on the local NTP service, but the
local clock cannot be synchronized to the
remote server.";
}
enum synchronization {
value "2";
description
"Enables the server to access.
Only time request can be performed on the
local NTP service.";
}
enum query {
value "3";
description
"Sets the maximum access limitation.
Control query can be performed only on the
local NTP service.";
}
}
description
"This defines NTP acess modes.";
}
typedef unicast-configuration-type {
type enumeration {
enum server {
value "0";
description
"Use client association mode. This device
will not provide synchronization to the
configured NTP server.";
}
enum peer {
value "1";
description
"Use symmetric active association mode.
This device may provide synchronization
to the configured NTP server.";
}
}
description
"This defines NTP unicast mode of operation.";
}
typedef association-modes {
type enumeration {
enum client {
value "0";
description
"Use client association mode(mode 3).
This device will not provide synchronization
to the configured NTP server.";
}
enum active {
value "1";
description
"Use symmetric active association mode(mode 1).
This device may synchronize with its NTP peer,
or provide synchronization to configured NTP peer.";
}
enum passive {
value "2";
description
"Use symmetric passive association mode(mode 2).
This device has learnt this asso dynamically.
This device may synchronize with its NTP peer.";
}
enum broadcast {
value "3";
description
"Use broadcast mode(mode 5).
This mode defines that its eigther working
as broadcast-server or multicast-server.";
}
enum broadcast-client {
value "4";
description
"This mode defines that its eigther working
as broadcast-client or multicast-client.";
}
}
description
"This defines NTP association modes.";
}
typedef ntp-clock-status {
type enumeration {
enum synchronized {
value "0";
description
"Indicates that the local clock has been
synchronized with an NTP server or
the reference clock.";
}
enum unsynchronized {
value "1";
description
"Indicates that the local clock has not been
synchronized with any NTP server.";
}
}
description
"This defines NTP clock status.";
}
typedef ntp-sync-state {
type enumeration {
enum clock-not-set {
value "0";
description
"Indicates the clock is not updated.";
}
enum freq-set-by-cfg {
value "1";
description
"Indicates the clock frequency is set by
NTP configuration.";
}
enum clock-set {
value "2";
description
"Indicates the clock is set.";
}
enum freq-not-determined {
value "3";
description
"Indicates the clock is set but the frequency
is not determined.";
}
enum clock-synchronized {
value "4";
description
"Indicates that the clock is synchronized";
}
enum spike {
value "5";
description
"Indicates a time difference of more than 128
milliseconds is detected between NTP server
and client clock. The clock change will take
effect in XXX seconds.";
}
}
description
"This defines NTP clock sync states.";
}
/* feature */
feature ntp-port {
description
"Indicates that the device supports the configuration of
the port for NTP.
This is a 'feature', since many implementations do not
support any port other than the default port.";
} }
default "10";
description
"The maximul poll exponent for this NTP association.";
}
typedef access-modes { /* Groupings */
type enumeration { grouping authentication-key {
enum peer { description
value "0"; "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 password {
type ianach:crypt-hash;
description "Clear or encrypted mode for password text.";
}
}
grouping authentication-type-param {
description
"Authentication type.";
choice authentication-type {
description
"Type of authentication.";
case symmetric-key {
leaf key-id {
type leafref {
path "/ntp:ntp/ntp:authentication/"
+ "ntp:authentication-keys/ntp:key-id";
}
description
"Authentication key id referenced in this
association.";
}
}
}
}
grouping statistics {
description
"NTP packet statistic.";
leaf packet-sent {
type yang:counter32;
description
"Indicates the total number of packets sent.";
}
leaf packet-sent-fail {
type yang:counter32;
description
"Indicates the number of times packet
sending failed.";
}
leaf packet-received {
type yang:counter32;
description
"Indicates the total number of packets received.";
}
leaf packet-dropped {
type yang:counter32;
description
"Indicates the number of packets dropped.";
}
}
grouping comman-attributes {
description
"NTP common attributes for configuration.";
leaf minpoll {
type ntp-minpoll;
description
"The minimum poll interval used in this association.";
}
leaf maxpoll {
type ntp-maxpoll;
description
"The maximul poll interval used in this association.";
}
leaf port {
if-feature ntp-port;
type uint16 {
range "123 | 1025..max";
}
default "123";
description
"Specify the port used to send NTP packets.";
}
leaf version {
type ntp-version;
description
"NTP version.";
}
}
grouping association-ref {
description
"Reference to NTP association node";
leaf associations-address {
type leafref {
path "/ntp:ntp/ntp:associations/ntp:address";
}
description
"Indicates the association address
which result in clock synchronization.";
}
leaf associations-local-mode {
type leafref {
path "/ntp:ntp/ntp:associations/ntp:local-mode";
}
description
"Indicates the association local-mode
which result in clock synchronization.";
}
leaf associations-isConfigured {
type leafref {
path "/ntp:ntp/ntp:associations/"
+ "ntp:isConfigured";
}
description
"Indicates the association was configured or
dynamic which result in clock synchronization.";
}
}
/* Configuration data nodes */
container ntp {
presence
"NTP is enable";
description
"Configuration parameters for NTP.";
leaf port {
if-feature ntp-port;
type uint16 {
range "123 | 1025..max";
}
default "123";
description
"Specify the port used to send NTP packets.";
}
container refclock-master {
presence
"NTP master clock is enable";
description
"Configures the device as NTP server.";
leaf master-stratum {
type ntp-stratum;
default "16";
description
"Stratum level from which NTP
clients get their time synchronized.";
}
}
container authentication {
description description
"Sets the fully access authority. Both time "Configuration of authentication.";
request and control query can be performed leaf auth-enabled {
on the local NTP service, and the local clock type boolean;
can be synchronized to the remote server."; default false;
description
"Controls whether NTP authentication is enabled
or disabled on this device.";
}
list trusted-keys {
key "key-id";
description
"List of keys trusted by NTP.";
leaf key-id {
type leafref {
path "/ntp:ntp/ntp:authentication/"
+ "ntp:authentication-keys/ntp:key-id";
}
description
"The key trusted by NTP.";
}
}
list authentication-keys {
key "key-id";
uses authentication-key;
description
"List of authentication key.";
}
} }
enum server {
value "1"; container access-rules {
description description
"Enables the server access and query. "Configuration of access rules.";
Both time requests and control query can be list access-rule {
performed on the local NTP service, but the key "access-mode";
local clock cannot be synchronized to the description
remote server."; "List of access rules.";
leaf access-mode {
type access-modes;
description
"NTP access mode.";
}
leaf acl {
type leafref {
path "/acl:access-lists/acl:acl/acl:name";
}
description
"NTP ACL.";
}
}
} }
enum synchronization {
value "2"; container clock-state {
config "false";
description description
"Enables the server to access. "Operational state of the NTP.";
Only time request can be performed on the
local NTP service."; container system-status {
description
"System status of NTP.";
leaf clock-state {
type ntp-clock-status;
mandatory true;
description "Indicates the state of system clock.";
}
leaf clock-stratum {
type ntp-stratum;
mandatory true;
description
"Indicates the stratum of the reference clock.";
}
leaf clock-refid {
type union {
type inet:ipv4-address;
type binary {
length "4";
}
type string {
length "4";
}
}
mandatory true;
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.";
}
uses association-ref {
description
"Reference to Association node";
}
leaf nominal-freq {
type decimal64 {
fraction-digits 4;
}
mandatory true;
description
"Indicates the nominal frequency of the
local clock, in Hz.";
}
leaf actual-freq {
type decimal64 {
fraction-digits 4;
}
mandatory true;
description
"Indicates the actual frequency of the
local clock, in Hz.";
}
leaf clock-precision {
type uint8;
mandatory true;
description
"Precision of the clock of this system
in Hz.(prec=2^(-n))";
}
leaf clock-offset {
type decimal64 {
fraction-digits 4;
}
description
"Offset of clock to synchronized peer,
in milliseconds.";
}
leaf root-delay {
type decimal64 {
fraction-digits 2;
}
description
"Total delay along path to root clock,
in milliseconds.";
}
leaf root-dispersion {
type decimal64 {
fraction-digits 2;
}
description
"Indicates the dispersion between the local clock
and the master reference clock, in milliseconds.";
}
leaf reference-time {
type yang:date-and-time;
description
"Indicates reference timestamp.";
}
leaf sync-state {
type ntp-sync-state;
mandatory true;
description
"Indicates the synchronization status of
the local clock.";
}
}
} }
enum query { list unicast-configuration {
value "3"; key "address type";
description
"list of unicast-configuration.";
leaf address {
type inet:host;
description description
"Sets the maximum access limitation. "The address of this association.";
Control query can be performed only on the
local NTP service.";
} }
} leaf type {
description type unicast-configuration-type;
"This defines NTP acess modes.";
}
typedef unicast-configuration-type {
type enumeration {
enum server {
value "0";
description description
"Use client association mode. This device "Type for this NTP configuration";
will not provide synchronization to the
configured NTP server.";
} }
enum peer { container authentication{
value "1";
description description
"Use symmetric active association mode. "Authentication type.";
This device may provide synchronization uses authentication-type-param;
to the configured NTP server.";
} }
} leaf prefer {
description type boolean;
"This defines NTP unicast mode of operation."; default "false";
}
typedef association-modes {
type enumeration {
enum client {
value "0";
description description
"Use client association mode(mode 3). "Whether this association is preferred.";
This device will not provide synchronization
to the configured NTP server.";
} }
enum active { leaf burst {
value "1"; type boolean;
default "false";
description description
"Use symmetric active association mode(mode 1). "Sends a series of packets instead of a single packet
This device may synchronize with its NTP peer, within each synchronization interval to achieve faster
or provide synchronization to configured NTP peer."; synchronization.";
} }
enum passive { leaf iburst {
value "2"; type boolean;
default "false";
description description
"Use symmetric passive association mode(mode 2). "Sends a series of packets instead of a single packet
This device has learnt this asso dynamically. within the initial synchronization interval to achieve
This device may synchronize with its NTP peer."; faster initial synchronization.";
} }
enum broadcast { leaf source {
value "3"; type if:interface-ref;
description description
"Use broadcast mode(mode 5). "The interface whose ip address this association used
This mode defines that its eigther working as source address.";
as broadcast-server or multicast-server.";
} }
enum broadcast-client { uses comman-attributes {
value "4";
description description
"This mode defines that its eigther working "Common attribute like port, version, min and max
as broadcast-client or multicast-client."; poll.";
} }
} }
description list associations {
"This defines NTP association modes."; key "address local-mode isConfigured";
} config "false";
description
typedef ntp-clock-status { "list of NTP association.";
type enumeration { leaf address {
enum synchronized { type inet:host;
value "0";
description description
"Indicates that the local clock has been "The address of this association.";
synchronized with an NTP server or
the reference clock.";
} }
enum unsynchronized { leaf local-mode {
value "1"; type association-modes;
description description
"Indicates that the local clock has not been "Local mode for this NTP association.";
synchronized with any NTP server.";
} }
} leaf isConfigured {
description type boolean;
"This defines NTP clock status.";
}
typedef ntp-sync-state {
type enumeration {
enum clock-not-set {
value "0";
description description
"Indicates the clock is not updated."; "Whether this association is configured or
dynamically learnt.";
} }
enum freq-set-by-cfg { leaf stratum {
value "1"; type ntp-stratum;
description description
"Indicates the clock frequency is set by "Indicates the stratum of the reference clock.";
NTP configuration.";
} }
enum clock-set { leaf refid {
value "2"; type union {
type inet:ipv4-address;
type binary {
length "4";
}
type string {
length "4";
}
}
description description
"Indicates the clock is set."; "Reference clock type or address for the peer.";
} }
enum freq-not-determined { leaf authentication{
value "3"; type leafref {
path "/ntp:ntp/ntp:authentication/"
+ "ntp:authentication-keys/ntp:key-id";
}
description description
"Indicates the clock is set but the frequency "Authentication Key used for this association.";
is not determined.";
} }
enum clock-synchronized { leaf prefer {
value "4"; type boolean;
default "false";
description description
"Indicates that the clock is synchronized"; "Whether this association is preferred.";
} }
enum spike { leaf peer-interface {
value "5"; type if:interface-ref;
description description
"Indicates a time difference of more than 128 "The interface which is used for communication.";
milliseconds is detected between NTP server
and client clock. The clock change will take
effect in XXX seconds.";
} }
} uses comman-attributes {
description description
"This defines NTP clock sync states."; "Common attribute like port, version, min and
} max poll.";
/* 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 leaf reach {
"Authentication key identifier."; type uint8;
} description
leaf algorithm { "Indicates the reachability of the configured
type identityref { server or peer.";
base key-chain:crypto-algorithm;
} }
description leaf unreach {
"Authentication algorithm."; type uint8;
} description
leaf password { "Indicates the unreachability of the configured
type ianach:crypt-hash; server or peer.";
description "Clear or encrypted mode for password text.";
}
}
grouping authentication-type-param {
description
"Authentication type.";
choice authentication-type {
description
"Type of authentication.";
case symmetric-key {
leaf key-id {
type leafref {
path "/ntp:ntp/ntp:authentication/"
+ "ntp:authentication-keys/ntp:key-id";
}
description
"Authentication key id referenced in this
association.";
}
} }
} leaf poll {
} type uint8;
description
grouping statistics { "Indicates the polling interval for current,
description in seconds.";
"NTP packet statistic.";
leaf packet-sent {
type yang:counter32;
description
"Indicates the total number of packets sent.";
}
leaf packet-sent-fail {
type yang:counter32;
description
"Indicates the number of times packet
sending failed.";
}
leaf packet-received {
type yang:counter32;
description
"Indicates the total number of packets received.";
}
leaf packet-dropped {
type yang:counter32;
description
"Indicates the number of packets dropped.";
}
}
grouping comman-attributes {
description
"NTP common attributes for configuration.";
leaf minpoll {
type ntp-minpoll;
description
"The minimum poll interval used in this association.";
}
leaf maxpoll {
type ntp-maxpoll;
description
"The maximul poll interval used in this association.";
}
leaf port {
type uint16 {
range "123 | 1025..max";
} }
default "123"; leaf now {
description type uint32;
"Specify the port used to send NTP packets."; description
} "Indicates the time since the NTP packet was
leaf version { not received or last synchronized, in seconds.";
type ntp-version; }
description leaf offset {
"NTP version."; type decimal64 {
} fraction-digits 4;
}
grouping association-ref {
description
"Reference to NTP association node";
leaf associations-address {
type leafref {
path "/ntp:ntp/ntp:associations/ntp:address";
} }
description description
"Indicates the association address "Indicates the offset between the local clock
which result in clock synchronization."; and the superior reference clock.";
} }
leaf associations-local-mode { leaf delay {
type leafref { type decimal64 {
path "/ntp:ntp/ntp:associations/ntp:local-mode"; fraction-digits 2;
} }
description description
"Indicates the association local-mode "Indicates the delay between the local clock
which result in clock synchronization."; and the superior reference clock.";
} }
leaf associations-isConfigured { leaf dispersion {
type leafref { type decimal64 {
path "/ntp:ntp/ntp:associations/ntp:isConfigured"; fraction-digits 2;
} }
description description
"Indicates the association was configured or dynamic "Indicates the dispersion between the local
which result in clock synchronization."; clock and the superior reference clock.";
}
}
/* Configuration data nodes */
container ntp {
presence
"NTP is enable";
description
"Configuration parameters for NTP.";
leaf port {
type uint16 {
range "123 | 1025..max";
} }
default "123"; leaf originate-time {
description type yang:date-and-time;
"Specify the port used to send NTP packets.";
}
container refclock-master {
presence
"NTP master clock is enable";
description
"Configures the device as NTP server.";
leaf master-stratum {
type ntp-stratum;
default "16";
description description
"Stratum level from which NTP "Indicates packet originate timestamp(T1).";
clients get their time synchronized."; }
} leaf receive-time {
} type yang:date-and-time;
container authentication {
description
"Configuration of authentication.";
leaf auth-enabled {
type boolean;
default false;
description description
"Controls whether NTP authentication is enabled "Indicates packet receive timestamp(T2).";
or disabled on this device.";
} }
list trusted-keys { leaf transmit-time {
key "key-id"; type yang:date-and-time;
description description
"List of keys trusted by NTP."; "Indicates packet transmit timestamp(T3).";
leaf key-id {
type leafref {
path "/ntp:ntp/ntp:authentication/"
+ "ntp:authentication-keys/ntp:key-id";
}
description
"The key trusted by NTP.";
}
} }
list authentication-keys { leaf input-time {
key "key-id"; type yang:date-and-time;
uses authentication-key;
description description
"List of authentication key."; "Indicates packet input timestamp(T4).";
} }
} container ntp-statistics {
description
"Per Peer packet send and receive statistic.";
uses statistics {
description
"NTP send and receive packet statistic.";
}
}
}
container access-rules { container interfaces {
description description
"Configuration of access rules."; "Configuration parameters for NTP interfaces.";
list access-rule { list interface {
key "access-mode"; key "name";
description description
"List of access rules."; "List of interfaces.";
leaf access-mode { leaf name {
type access-modes; type if:interface-ref;
description
"The interface name.";
}
container broadcast-server {
presence
"NTP broadcast-server is configured";
description description
"NTP access mode."; "Configuration of broadcast server.";
} leaf ttl {
leaf acl { type uint8;
type leafref { description
path "/acl:access-lists/acl:acl/acl:acl-name"; "Specifies the time to live (TTL) of a
broadcast packet.";
} }
description container authentication{
"NTP ACL."; description
} "Authentication type.";
} uses authentication-type-param;
} }
uses comman-attributes {
container clock-state { description
config "false"; "Common attribute like port, version, min and
description max poll.";
"Operational state of the NTP."; }
}
container system-status {
description
"System status of NTP.";
leaf clock-state {
type ntp-clock-status;
mandatory true;
description "Indicates the state of system clock.";
}
leaf clock-stratum {
type ntp-stratum;
mandatory true;
description
"Indicates the stratum of the reference clock.";
}
leaf clock-refid {
type union {
type inet:ipv4-address;
type binary {
length "4";
}
type string {
length "4";
}
}
mandatory true;
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.";
}
uses association-ref {
description
"Reference to Association node";
}
leaf nominal-freq {
type decimal64 {
fraction-digits 4;
}
mandatory true;
description
"Indicates the nominal frequency of the
local clock, in Hz.";
}
leaf actual-freq {
type decimal64 {
fraction-digits 4;
}
mandatory true;
description
"Indicates the actual frequency of the
local clock, in Hz.";
}
leaf clock-precision {
type uint8;
mandatory true;
description
"Precision of the clock of this system
in Hz.(prec=2^(-n))";
}
leaf clock-offset {
type decimal64 {
fraction-digits 4;
}
description
"Offset of clock to synchronized peer,
in milliseconds.";
}
leaf root-delay {
type decimal64 {
fraction-digits 2;
}
description
"Total delay along path to root clock,
in milliseconds.";
}
leaf root-dispersion {
type decimal64 {
fraction-digits 2;
}
description
"Indicates the dispersion between the local clock
and the master reference clock, in milliseconds.";
}
leaf reference-time {
type yang:date-and-time;
description
"Indicates reference timestamp.";
}
leaf sync-state {
type ntp-sync-state;
mandatory true;
description
"Indicates the synchronization status of
the local clock.";
}
}
}
list unicast {
key "address type";
description
"list of unicast configuration.";
leaf address {
type inet:host;
description
"The address of this association.";
}
leaf type {
type unicast-configuration-type;
description
"Type for this NTP configuration";
}
container authentication{
description
"Authentication type.";
uses authentication-type-param;
}
leaf prefer {
type boolean;
default "false";
description
"Whether this association is preferred.";
}
leaf burst {
type boolean;
default "false";
description
"Sends a series of packets instead of a single packet
within each synchronization interval to achieve faster
synchronization.";
}
leaf iburst {
type boolean;
default "false";
description
"Sends a series of packets 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 this association used
as source address.";
}
uses comman-attributes {
description
"Common attribute like port, version, min and max poll.";
}
}
list associations {
key "address local-mode isConfigured";
config "false";
description
"list of NTP association.";
leaf address {
type inet:host;
description
"The address of this association.";
}
leaf local-mode {
type association-modes;
description
"Local mode for this NTP association.";
}
leaf isConfigured {
type boolean;
description
"Whether this association is configured or dynamically learnt.";
}
leaf stratum {
type ntp-stratum;
description
"Indicates the stratum of the reference clock.";
}
leaf refid {
type union {
type inet:ipv4-address;
type binary {
length "4";
}
type string {
length "4";
}
}
description
"Reference clock type or address for the peer.";
}
leaf authentication{
type leafref {
path "/ntp:ntp/ntp:authentication/"
+ "ntp:authentication-keys/ntp:key-id";
}
description
"Authentication Key used for this association.";
}
leaf prefer {
type boolean;
default "false";
description
"Whether this association is preferred.";
}
leaf peer-interface {
type if:interface-ref;
description
"The interface which is used for communication.";
}
uses comman-attributes {
description
"Common attribute like port, version, min and max poll.";
}
leaf reach {
type uint8;
description
"Indicates the reachability of the configured
server or peer.";
}
leaf unreach {
type uint8;
description
"Indicates the unreachability of the configured
server or peer.";
}
leaf poll {
type uint8;
description
"Indicates the polling interval for current,
in seconds.";
}
leaf now {
type uint32;
description
"Indicates the time since the NTP packet was
not received or last synchronized, in seconds.";
}
leaf offset {
type decimal64 {
fraction-digits 4;
}
description
"Indicates the offset between the local clock
and the superior reference clock.";
}
leaf delay {
type decimal64 {
fraction-digits 2;
}
description
"Indicates the delay between the local clock
and the superior reference clock.";
}
leaf dispersion {
type decimal64 {
fraction-digits 2;
}
description
"Indicates the dispersion between the local
clock and the superior reference clock.";
}
leaf originate-time {
type yang:date-and-time;
description
"Indicates packet originate timestamp(T1).";
}
leaf receive-time {
type yang:date-and-time;
description
"Indicates packet receive timestamp(T2).";
}
leaf transmit-time {
type yang:date-and-time;
description
"Indicates packet transmit timestamp(T3).";
}
leaf input-time {
type yang:date-and-time;
description
"Indicates packet input timestamp(T4).";
}
container ntp-statistics {
description
"Per Peer packet send and receive statistic.";
uses statistics {
description
"NTP send and receive packet statistic.";
}
}
}
container interfaces {
description
"Configuration parameters for NTP interfaces.";
list interface {
key "name";
description
"List of interfaces.";
leaf name {
type if:interface-ref;
description
"The interface name.";
}
container broadcast-server {
presence
"NTP broadcast-server is configured";
description
"Configuration of broadcast server.";
leaf ttl {
type uint8;
description
"Specifies the time to live (TTL) of a
broadcast packet.";
}
container authentication{
description
"Authentication type.";
uses authentication-type-param;
}
uses comman-attributes {
description
"Common attribute like port, version, min and max poll.";
}
}
container broadcast-client { container broadcast-client {
presence presence
"NTP broadcast-client is configured"; "NTP broadcast-client is configured";
description description
"Configuration of broadcast-client."; "Configuration of broadcast-client.";
} }
list multicast-server { list multicast-server {
key "address"; key "address";
description
"Configuration of multicast server.";
leaf address {
type rt-types:ip-multicast-group-address;
description description
"The IP address to send NTP multicast packets."; "Configuration of multicast server.";
} leaf address {
leaf ttl { type rt-types:ip-multicast-group-address;
type uint8; description
description "The IP address to send NTP multicast packets.";
"Specifies the time to live (TTL) of a }
multicast packet."; leaf ttl {
} type uint8;
container authentication{ description
description "Specifies the time to live (TTL) of a
"Authentication type."; multicast packet.";
uses authentication-type-param; }
} container authentication{
uses comman-attributes { description
description "Authentication type.";
"Common attribute like port, version, min and max poll."; uses authentication-type-param;
} }
} uses comman-attributes {
list multicast-client { description
key "address"; "Common attribute like port, version, min and
description max poll.";
"Configuration of multicast-client."; }
leaf address { }
type rt-types:ip-multicast-group-address; list multicast-client {
description key "address";
"The IP address of the multicast group to join."; description
} "Configuration of multicast-client.";
} leaf address {
list manycast-server { type rt-types:ip-multicast-group-address;
key "address"; description
description "The IP address of the multicast group to
"Configuration of manycast server."; join.";
leaf address { }
type rt-types:ip-multicast-group-address; }
description list manycast-server {
"The multicast group IP address to receive key "address";
manycast client messages ."; description
} "Configuration of manycast server.";
} leaf address {
list manycast-client { type rt-types:ip-multicast-group-address;
key "address"; description
description "The multicast group IP address to receive
"Configuration of manycast-client."; manycast client messages .";
leaf address { }
type rt-types:ip-multicast-group-address; }
description list manycast-client {
"The group IP address that the manycast client key "address";
broadcasts the request message to."; description
} "Configuration of manycast-client.";
container authentication{ leaf address {
description type rt-types:ip-multicast-group-address;
"Authentication type."; description
uses authentication-type-param; "The group IP address that the manycast client
} broadcasts the request message to.";
leaf ttl { }
type uint8; container authentication{
description description
"Specifies the maximum time to live (TTL) for "Authentication type.";
the expanding ring search."; uses authentication-type-param;
} }
leaf minclock { leaf ttl {
type uint8; type uint8;
description description
"The minimum manycast survivors in this "Specifies the maximum time to live (TTL) for
association."; the expanding ring search.";
} }
leaf maxclock { leaf minclock {
type uint8; type uint8;
description description
"The maximum manycast candidates in this "The minimum manycast survivors in this
association."; association.";
} }
leaf beacon { leaf maxclock {
type uint8; type uint8;
description description
"The maximum interval between beacons in this "The maximum manycast candidates in this
association."; association.";
} }
uses comman-attributes { leaf beacon {
description type uint8;
"Common attribute like port, version, min and max poll."; description
"The maximum interval between beacons in this
association.";
}
uses comman-attributes {
description
"Common attribute like port, version, min and
max poll.";
}
}
} }
} }
} container ntp-statistics {
} config "false";
/* Operational state data */ description
"Total NTP packet statistic.";
uses statistics {
description
"NTP send and receive packet statistic.";
}
container ntp-statistics { }
config "false";
description
"Total NTP packet statistic.";
uses statistics {
description
"NTP send and receive packet statistic.";
}
} }
} }
}
<CODE ENDS> <CODE ENDS>
6. Usage Example 6. Usage Example
6.1. Unicast association 6.1. Unicast association
Below is the example on how to configure a preferred unicast server Below is the example on how to configure a preferred unicast server
present at 1.1.1.1 running at port 1025 with authentication-key 10 present at 1.1.1.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">
<target> <edit-config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<running/> <target>
</target> <running/>
<config> </target>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <config>
<unicast> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<address>1.1.1.1</address> <unicast-configuration>
<type>server</type> <address>1.1.1.1</address>
<prefer>true</prefer> <type>server</type>
<version>4</version> <prefer>true</prefer>
<port>1025</port> <version>4</version>
<authentication> <port>1025</port>
<symmetric-key> <authentication>
<key-id>10</key-id> <symmetric-key>
</symmetric-key> <key-id>10</key-id>
</authentication> </symmetric-key>
</unicast> </authentication>
</ntp> </unicast-configuration>
</config> </ntp>
</edit-config> </config>
</edit-config>
Below is the example on how to get unicast configuration Below is the example on how to get unicast 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:unicast> <sys:unicast-configuration>
</sys:unicast> </sys:unicast-configuration>
</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">
<unicast> <unicast-configuration>
<address>1.1.1.1</address> <address>1.1.1.1</address>
<type>server</type> <type>server</type>
<authentication> <authentication>
<symmetric-key> <symmetric-key>
<key-id>10</key-id> <key-id>10</key-id>
</symmetric-key> </symmetric-key>
</authentication> </authentication>
<prefer>true</prefer> <prefer>true</prefer>
<burst>false</burst> <burst>false</burst>
<iburst>true</iburst> <iburst>true</iburst>
<source/> <source/>
<minpoll>6</minpoll> <minpoll>6</minpoll>
<maxpoll>10</maxpoll> <maxpoll>10</maxpoll>
<port>1025</port> <port>1025</port>
<version>4</version> <version>4</version>
<stratum>9</stratum> <stratum>9</stratum>
<refid>20.1.1.1</refid> <refid>20.1.1.1</refid>
<reach>255</reach> <reach>255</reach>
<unreach>0</unreach> <unreach>0</unreach>
<poll>128</poll> <poll>128</poll>
<now>10</now> <now>10</now>
<offset>0.025</offset> <offset>0.025</offset>
<delay>0.5</delay> <delay>0.5</delay>
<dispersion>0.6</dispersion> <dispersion>0.6</dispersion>
<originate-time>10-10-2017 07:33:55.253 Z+05:30</originate-time> <originate-time>10-10-2017 07:33:55.253 Z+05:30
<receive-time>10-10-2017 07:33:55.258 Z+05:30</receive-time> </originate-time>
<transmit-time>10-10-2017 07:33:55.300 Z+05:30</transmit-time> <receive-time>10-10-2017 07:33:55.258 Z+05:30
<input-time>10-10-2017 07:33:55.305 Z+05:30</input-time> </receive-time>
<ntp-statistics> <transmit-time>10-10-2017 07:33:55.300 Z+05:30
<packet-sent>20</packet-sent> </transmit-time>
<packet-sent-fail>0</packet-sent-fail> <input-time>10-10-2017 07:33:55.305 Z+05:30
<packet-received>20</packet-received> </input-time>
<packet-dropped>0</packet-dropped> <ntp-statistics>
</ntp-statistics> <packet-sent>20</packet-sent>
</unicast> <packet-sent-fail>0</packet-sent-fail>
</ntp> <packet-received>20</packet-received>
</data> <packet-dropped>0</packet-dropped>
</ntp-statistics>
</unicast-configuration>
</ntp>
</data>
6.2. Refclock master 6.2. Refclock master
Below is the example on how to configure reference clock with stratum Below is the example on 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 Below is the example on how to get reference clock configuration
<get>
<filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:refclock-master>
</sys:refclock-master>
</sys:ntp>
</filter>
</get>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <get>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <filter type="subtree">
<refclock-master> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<master-stratum>8</master-stratum> <sys:refclock-master>
</refclock-master> </sys:refclock-master>
</ntp> </sys:ntp>
</data> </filter>
</get>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<refclock-master>
<master-stratum>8</master-stratum>
</refclock-master>
</ntp>
</data>
6.3. Authentication configuration 6.3. Authentication configuration
Below is the example on how to enable authentication and configure Below is the example on how to enable authentication and configure
authentication key 10 with mode as md5 and password as abcd authentication key 10 with mode as md5 and password 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> <password>abcd</password>
<password>abcd</password> </authentication-keys>
</authentication-keys> </authentication>
</authentication> </ntp>
</ntp> </config>
</config> </edit-config>
</edit-config>
Below is the example on how to get authentication related Below is the example on how to get authentication related
configuration configuration
<get>
<filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:authentication>
</sys:authentication>
</sys:ntp>
</filter>
</get>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <get>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <filter type="subtree">
<authentication> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<auth-enabled>false</auth-enabled> <sys:authentication>
<trusted-keys/> </sys:authentication>
<authentication-keys> </sys:ntp>
<key-id>10</key-id> </filter>
<algorithm>md5</algorithm> </get>
<password>abcd</password>
</authentication-keys> <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
</authentication> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
</ntp> <authentication>
</data> <auth-enabled>false</auth-enabled>
<trusted-keys/>
<authentication-keys>
<key-id>10</key-id>
<algorithm>md5</algorithm>
<password>abcd</password>
</authentication-keys>
</authentication>
</ntp>
</data>
6.4. Access configuration 6.4. Access configuration
Below is the example on how to configure acess type peer associated Below is the example on how to configure acess type peer 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 Below is the example on how to get access related configuration
<get>
<filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:access-rules>
</sys:access-rules>
</sys:ntp>
</filter>
</get>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <get>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <filter type="subtree">
<access-rules> <sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<access-rule> <sys:access-rules>
<access-mode>peer</access-mode> </sys:access-rules>
<acl>2000</acl> </sys:ntp>
</access-rule> </filter>
</access-rules> </get>
</ntp>
</data> <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<access-rules>
<access-rule>
<access-mode>peer</access-mode>
<acl>2000</acl>
</access-rule>
</access-rules>
</ntp>
</data>
6.5. Multicast configuration 6.5. Multicast configuration
Below is the example on how to configure multicast-server with Below is the example on how to configure multicast-server with
address as 224.1.1.1, port as 1025 and authentication keyid as 10 address 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> <address>224.1.1.1</address>
<address>224.1.1.1</address> <authentication>
<authentication> <symmetric-key>
<symmetric-key> <key-id>10</key-id>
<key-id>10</key-id> </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 Below is the example on how to get multicast-server related
configuration configuration
<get>
<filter type="subtree">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:interfaces>
<sys:interface>
<sys:multicast-server>
</sys:multicast-server>
</sys:interface>
</sys:interfaces>
</sys:ntp>
</filter>
</get>
<get> <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<filter type="subtree"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<sys:ntp xmlns:sys="urn:ietf:params:xml:ns:yang:ietf-ntp"> <interfaces>
<sys:interfaces> <interface>
<sys:interface> <name>Ethernet3/0/0</name>
<sys:multicast-server> <multicast-server>
</sys:multicast-server> <address>224.1.1.1</address>
</sys:interface> <ttl>224.1.1.1</ttl>
</sys:interfaces> <authentication>
</sys:ntp> <symmetric-key>
</filter> <key-id>10</key-id>
</get> </symmetric-key>
</authentication>
<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <minpoll>6</minpoll>
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <maxpoll>10</maxpoll>
<interfaces> <port>1025</port>
<interface> <version>3</version>
<name>Ethernet3/0/0</name> </multicast-server>
<multicast-server> </interface>
<address>224.1.1.1</address> </interfaces>
<ttl>224.1.1.1</ttl> </ntp>
<authentication> </data>
<symmetric-key>
<key-id>10</key-id>
</symmetric-key>
</authentication>
<minpoll>6</minpoll>
<maxpoll>10</maxpoll>
<port>1025</port>
<version>3</version>
</multicast-server>
</interface>
</interfaces>
</ntp>
</data>
Below is the example on how to configure multicast-client with Below is the example on how to configure multicast-client with
address as 224.1.1.1 address 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 Below is the example on 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>
</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">
<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>
</data> </data>
6.6. Manycast configuration 6.6. Manycast configuration
Below is the example on how to configure manycast-client with address Below is the example on 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>
<manycast-client> <manycast-client>
<address>224.1.1.1</address> <address>224.1.1.1</address>
<authentication> <authentication>
<symmetric-key> <symmetric-key>
<key-id>10</key-id> <key-id>10</key-id>
</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 Below is the example on 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>
</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">
<interfaces> <interfaces>
<interface> <interface>
<name>Ethernet3/0/0</name> <name>Ethernet3/0/0</name>
<manycast-client> <manycast-client>
<address>224.1.1.1</address> <address>224.1.1.1</address>
<authentication> <authentication>
<symmetric-key> <symmetric-key>
<key-id>10</key-id> <key-id>10</key-id>
</symmetric-key> </symmetric-key>
</authentication> </authentication>
<ttl>255</ttl> <ttl>255</ttl>
<minclock>3</minclock> <minclock>3</minclock>
<maxclock>10</maxclock> <maxclock>10</maxclock>
<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 Below is the example on 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 Below is the example on 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>
</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">
<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>
</data> </data>
6.7. Clock state 6.7. Clock state
Below is the example on how to get clock current state Below is the example on 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>
<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">
<clock-state> <clock-state>
<system-status> <system-status>
<clock-state>synchronized</clock-state> <clock-state>synchronized</clock-state>
<clock-stratum>7</clock-stratum> <clock-stratum>7</clock-stratum>
<clock-refid>1.1.1.1</clock-refid> <clock-refid>1.1.1.1</clock-refid>
<associations-address>1.1.1.1</associations-address> <associations-address>1.1.1.1
<associations-local-mode>client</associations-local-mode> </associations-address>
<associations-isConfigured>yes</associations-isConfigured> <associations-local-mode>client
<nominal-freq>100.0</nominal-freq> </associations-local-mode>
<actual-freq>100.0</actual-freq> <associations-isConfigured>yes
<clock-precision>18</clock-precision> </associations-isConfigured>
<clock-offset>0.025</clock-offset> <nominal-freq>100.0</nominal-freq>
<root-delay>0.5</root-delay> <actual-freq>100.0</actual-freq>
<root-dispersion>0.8</root-dispersion> <clock-precision>18</clock-precision>
<reference-time>10-10-2017 07:33:55.258 Z+05:30</reference-time> <clock-offset>0.025</clock-offset>
<sync-state>clock-synchronized</sync-state> <root-delay>0.5</root-delay>
</system-status> <root-dispersion>0.8</root-dispersion>
</clock-state> <reference-time>10-10-2017 07:33:55.258 Z+05:30
</ntp> </reference-time>
</data> <sync-state>clock-synchronized</sync-state>
</system-status>
</clock-state>
</ntp>
</data>
6.8. Get all association 6.8. Get all association
Below is the example on how to get all association present Below is the example on how to get all association present
<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">
<ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp"> <ntp xmlns="urn:ietf:params:xml:ns:yang:ietf-ntp">
<associations> <associations>
<address>1.1.1.1</address> <address>1.1.1.1</address>
<stratum>9</stratum> <stratum>9</stratum>
<refid>20.1.1.1</refid> <refid>20.1.1.1</refid>
<local-mode>client</local-mode> <local-mode>client</local-mode>
<isConfigured>true</isConfigured> <isConfigured>true</isConfigured>
<authentication-key>10</authentication-key> <authentication-key>10</authentication-key>
<prefer>true</prefer> <prefer>true</prefer>
<peer-interface>Ethernet3/0/0</peer-interface> <peer-interface>Ethernet3/0/0</peer-interface>
<minpoll>6</minpoll> <minpoll>6</minpoll>
<maxpoll>10</maxpoll> <maxpoll>10</maxpoll>
<port>1025</port> <port>1025</port>
<version>4</version> <version>4</version>
<reach>255</reach> <reach>255</reach>
<unreach>0</unreach> <unreach>0</unreach>
<poll>128</poll> <poll>128</poll>
<now>10</now> <now>10</now>
<offset>0.025</offset> <offset>0.025</offset>
<delay>0.5</delay> <delay>0.5</delay>
<dispersion>0.6</dispersion> <dispersion>0.6</dispersion>
<originate-time>10-10-2017 07:33:55.253 Z+05:30</originate-time> <originate-time>10-10-2017 07:33:55.253 Z+05:30
<receive-time>10-10-2017 07:33:55.258 Z+05:30</receive-time> </originate-time>
<transmit-time>10-10-2017 07:33:55.300 Z+05:30</transmit-time> <receive-time>10-10-2017 07:33:55.258 Z+05:30
<input-time>10-10-2017 07:33:55.305 Z+05:30</input-time> </receive-time>
<ntp-statistics> <transmit-time>10-10-2017 07:33:55.300 Z+05:30
<packet-sent>20</packet-sent> </transmit-time>
<packet-sent-fail>0</packet-sent-fail> <input-time>10-10-2017 07:33:55.305 Z+05:30
<packet-received>20</packet-received> </input-time>
<packet-dropped>0</packet-dropped> <ntp-statistics>
</ntp-statistics> <packet-sent>20</packet-sent>
</associations> <packet-sent-fail>0</packet-sent-fail>
</ntp> <packet-received>20</packet-received>
</data> <packet-dropped>0</packet-dropped>
</ntp-statistics>
</associations>
</ntp>
</data>
6.9. Global statistic 6.9. Global statistic
Below is the example on how to get clock current state Below is the example on 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>
<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">
<ntp-statistics> <ntp-statistics>
<packet-sent>30</packet-sent> <packet-sent>30</packet-sent>
<packet-sent-fail>5</packet-sent-fail> <packet-sent-fail>5</packet-sent-fail>
<packet-received>20</packet-received> <packet-received>20</packet-received>
<packet-dropped>2</packet-dropped> <packet-dropped>2</packet-dropped>
</ntp-statistics> </ntp-statistics>
</ntp> </ntp>
</data> </data>
7. IANA Considerations 7. 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 NETMOD WG of the IETF. Registrant Contact: The NETMOD WG of the IETF.
skipping to change at page 41, line 7 skipping to change at page 42, line 7
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 XXXX Reference: RFC XXXX
8. Security Considerations 8. Security Considerations
The YANG module defined in this memo is designed to be accessed via The YANG module specified in this document defines a schema for data
the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the that is designed to be accessed via network management protocols such
secure transport layer and the mandatory-to-implement secure as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer
transport is SSH [RFC6242]. The NETCONF access control model is the secure transport layer, and the mandatory-to-implement secure
[RFC6536] provides the means to restrict access for particular transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer
NETCONF users to a pre-configured subset of all available NETCONF is HTTPS, and the mandatory-to-implement secure transport is TLS
protocol operations and content. [RFC5246].
There are a number of data nodes defined in the YANG module which are The NETCONF access control model [RFC6536] provides the means to
restrict access for particular NETCONF or RESTCONF users to a
preconfigured subset of all available NETCONF or RESTCONF protocol
operations and content.
There are a number of data nodes defined in this YANG module that are
writable/creatable/deletable (i.e., config true, which is the writable/creatable/deletable (i.e., config true, which is the
default). These data nodes may be considered sensitive or vulnerable default). These data nodes may be considered sensitive or vulnerable
in some network environments. Write operations (e.g., <edit-config>) in some network environments. Write operations (e.g., edit-config)
to these data nodes without proper protection can have a negative to these data nodes without proper protection can have a negative
effect on network operations. effect on network operations. These are the subtrees and data nodes
and their sensitivity/vulnerability:
/ntp/port - This data node specify the port number to be used to
send NTP packets. Unexpected changes could lead to disruption
and/or network misbehavior.
/ntp/authentication and /ntp/access-rules - The entries in the
list include the authentication and access control configurations.
Car should be taken while setting these parameters.
/ntp/unicast-configuration - The entries in the list include all
unicast configurations (server or peer mode), and indirectly
creates or modify the NTP associations. Unexpected changes could
lead to disruption and/or network misbehavior.
/ntp/interfaces/interface - The entries in the list inclide all
per-interface configurations related to broadcast, multicast and
manycast mode, and indirectly creates or modify the NTP
associations. Unexpected changes could lead to disruption and/or
network misbehavior.
Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability:
/ntp/associations - The entries in the list includes all active
NTP associations of all modes. Unauthorized access to this needs
to be curtailed.
9. Acknowledgments 9. 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 and Miroslav Lichvar for Danny Mayer, Harlan Stenn, Ulrich Windl, Miroslav Lichvar, and
their review and suggestions. Maurice Angermann for their review and suggestions.
10. References 10. References
10.1. Normative References 10.1. Normative References
[I-D.ietf-netmod-yang-tree-diagrams] [I-D.ietf-netmod-yang-tree-diagrams]
Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft- Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft-
ietf-netmod-yang-tree-diagrams-02 (work in progress), ietf-netmod-yang-tree-diagrams-06 (work in progress),
October 2017. February 2018.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004, DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>. <https://www.rfc-editor.org/info/rfc3688>.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246,
DOI 10.17487/RFC5246, August 2008,
<https://www.rfc-editor.org/info/rfc5246>.
[RFC5905] Mills, D., Martin, J., Ed., Burbank, J., and W. Kasch, [RFC5905] Mills, D., Martin, J., Ed., Burbank, J., and W. Kasch,
"Network Time Protocol Version 4: Protocol and Algorithms "Network Time Protocol Version 4: Protocol and Algorithms
Specification", RFC 5905, DOI 10.17487/RFC5905, June 2010, Specification", RFC 5905, DOI 10.17487/RFC5905, June 2010,
<https://www.rfc-editor.org/info/rfc5905>. <https://www.rfc-editor.org/info/rfc5905>.
[RFC5907] Gerstung, H., Elliott, C., and B. Haberman, Ed., [RFC5907] Gerstung, H., Elliott, C., and B. Haberman, Ed.,
"Definitions of Managed Objects for Network Time Protocol "Definitions of Managed Objects for Network Time Protocol
Version 4 (NTPv4)", RFC 5907, DOI 10.17487/RFC5907, June Version 4 (NTPv4)", RFC 5907, DOI 10.17487/RFC5907, June
2010, <https://www.rfc-editor.org/info/rfc5907>. 2010, <https://www.rfc-editor.org/info/rfc5907>.
skipping to change at page 42, line 24 skipping to change at page 44, line 19
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>. <https://www.rfc-editor.org/info/rfc6242>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012, DOI 10.17487/RFC6536, March 2012,
<https://www.rfc-editor.org/info/rfc6536>. <https://www.rfc-editor.org/info/rfc6536>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<https://www.rfc-editor.org/info/rfc8040>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
10.2. Informative References 10.2. Informative References
[I-D.ietf-netmod-revised-datastores] [I-D.ietf-netmod-revised-datastores]
Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K.,
and R. Wilton, "Network Management Datastore and R. Wilton, "Network Management Datastore
Architecture", draft-ietf-netmod-revised-datastores-05 Architecture", draft-ietf-netmod-revised-datastores-10
(work in progress), October 2017. (work in progress), January 2018.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[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>.
Authors' Addresses Authors' Addresses
Nan Wu Nan Wu
Huawei Huawei
Huawei Bld., No.156 Beiqing Rd. Huawei Bld., No.156 Beiqing Rd.
Beijing 100095 Beijing 100095
China China
Email: eric.wu@huawei.com Email: eric.wu@huawei.com
Anil Kumar S N Anil Kumar S N
RtBrick Inc. RtBrick Inc.
Bangalore, Kanataka 560037 Bangalore, Kanataka
India India
Email: anil.ietf@gmail.com Email: anil.ietf@gmail.com
Yi Zhao Yi Zhao
Ericsson Ericsson
China Digital Kingdom Bld., No.1 WangJing North Rd. China Digital Kingdom Bld., No.1 WangJing North Rd.
Beijing 100102 Beijing 100102
China China
skipping to change at page 43, line 36 skipping to change at page 45, line 28
Dhruv Dhody Dhruv Dhody
Huawei Huawei
Divyashree Techno Park, Whitefield Divyashree Techno Park, Whitefield
Bangalore, Kanataka 560066 Bangalore, Kanataka 560066
India India
Email: dhruv.ietf@gmail.com Email: dhruv.ietf@gmail.com
Ankit kumar Sinha Ankit kumar Sinha
Huawei RtBrick Inc.
Divyashree Techno Park, Whitefield Bangalore, Kanataka
Bangalore, Kanataka 560066
India India
Email: ankit.ietf@gmail.com Email: ankit.ietf@gmail.com
 End of changes. 146 change blocks. 
1502 lines changed or deleted 1580 lines changed or added

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