ieee1588-ptp-ms

Organization:

IEEE 1588 Working Group

Module:

ieee1588-ptp-ms

Version:

2023-08-14

File:

ieee1588-ptp-ms.yang

Abstract:

This YANG module defines a data model for the configuration and state of IEEE Std 1588 clocks. IEEE Std 1588 specifies the Preci...

Contact:

Web: https://sagroups.ieee.org/1588/
E-mail: 1588officers@listserv.ieee.org

Postal: C/O IEEE 1588 Working Group Chair
IEEE Standards Association
445 Hoes Lane
Piscataway, NJ 08854
USA

Check for an additional details:

YANG Catalog

Description:

This YANG module defines a data model for the configuration
and state of IEEE Std 1588 clocks. IEEE Std 1588 specifies the
Precision Time Protocol (PTP).

The nodes in this YANG module are designed for compatibility
with ietf-ptp.yang, the YANG data model for IEEE Std 1588-2008,
as specified in IETF RFC 8575.

NOTE regarding default value:
PTP's concept of 'initialization value' is analogous to YANG's
concept of a 'default value'. According to 8.1.3.4 of
IEEE Std 1588-2019, the initialization value for configuration
is specified in IEEE Std 1588, but that value can be overridden
by a PTP Profile specification, or by the product that
implements PTP. This makes it challenging to repeat the
specification of initialization value using a YANG 'default'
statement, because there is no straightforward mechanism for
a PTP Profile's (or product's) YANG module to import this
module and override its YANG default. Since a YANG management
client can read the default value from the operational
datastore, there is no need to re-specify the default in YANG.
The implementer of PTP refers to the relevant PTP
specifications for the default (not YANG modules).
Therefore, this YANG module avoids use of the YANG 'default'
statement.

NOTE regarding IEEE Std 1588 classification:
8.1.2 of IEEE Std 1588-2019 specifies a classification of
each data set member, which corresponds to a leaf in YANG.
The relationship between 1588 classification and
YANG 'config' (i.e., whether the leaf is read-write) is:
- 1588 static: The leaf is 'config false' (read-only).
- 1588 configurable: The leaf is 'config true', which is
the default value for a YANG leaf.
- 1588 dynamic: A judgement is made on a member-by-member
basis. If the member corresponds to the first item of
8.1.2.1.2 of IEEE Std 1588-2019 (i.e., value from protocol
only, such as log of protocol behavior), the YANG leaf
is 'config false'. Otherwise, the member's value can be
provided by an entity outside PTP (e.g., NETCONF or
RESTCONF client), and therefore the YANG leaf is
'config true'.

NOTE regarding terminology (two YANG modules):
To accommodate the need by some organizations to use the
original terminology specified by IEEE Std 1588, and the
need by some other organizations to use the alternative
terminology specified in 4.4 of IEEE Std 1588g-2022,
two YANG modules are provided by IEEE Std 1588e (MIB and
YANG Data Models). For a detailed explanation, see 15.4.2.11
of IEEE Std 1588e.
This module uses the original terminology specified by
IEEE Std 1588 (master/slave).