This module defines types and identities used in OpenConfig models related to Precision Time Protocol (PTP).
IEEE code is subject to the following copyright and license: Copyright (c) 2020 by The Institute of Electrical and Electronics Engineers, Inc. All rights reserved.
openconfig-extensions
description:
Identifies unique entities within a PTP Network,
e.g. a PTP Instance or an entity of a common service.
The identity is an 8-octet array, constructed according
to specifications in IEEE Std 1588, using an
organization identifier from the IEEE Registration
Authority.
Each octet is represented in YANG as a pair of
hexadecimal characters, using uppercase for a letter.
Each octet in the array is separated by the dash
character.
type: string
description:
Time interval, expressed in nanoseconds, multiplied by 2^16.
Positive or negative time intervals outside the maximum range
of this data type shall be encoded as the largest positive and
negative values of the data type, respectively.
type: int64
description:
Enumeration for the type of PTP Instance.
Values for this enumeration are specified by the IEEE 1588
standard exclusively.
type: enumeration
description:
Type definition for options when setting the unicast-multicast
attribute in the default data set
type: enumeration
description:
The propagation-delay measuring option used by the
port. Values for this enumeration are specified
by the IEEE Std 1588 standard exclusively.
type: enumeration
description:
The current state of the protocol engine associated
with the port. Values for this enumeration are specified
by the IEEE Std 1588 standard exclusively.
type: enumeration
description:
Type definition for options when setting the network transport
attribute in the default data set
type: enumeration
description:
Type definition for options when setting the domain-profile
attribute in the default data set
type: enumeration
description:
Enumeration for the source of time used by the Grandmaster
PTP Instance.
YANG identity is used so that a PTP Profile's YANG augment
can assign values, using numeric range F0 to FE hex.
description:
Enumeration that denotes the traceability, synchronization
state and expected performance of the time or frequency
distributed by the Grandmaster PTP Instance.
IEEE Std 1588 does not specify a name for each clock-class,
but the names below are intended to be as intuitive as possible.
YANG identity is used so that a PTP Profile's YANG augment
can assign values using a numeric range designated for use by
alternate PTP Profiles.
description:
Enumeration that indicates the expected accuracy of a
PTP Instance when it is the Grandmaster PTP Instance,
or in the event it becomes the Grandmaster PTP Instance.
The value shall be conservatively estimated by the PTP
Instance to a precision consistent with the value of the
selected clock-accuracy and of the next lower enumerated
value, for example, for clockAccuracy = 23 hex, between
250 ns and 1000 ns.
IEEE Std 1588 does not specify a name for each clock-accuracy,
but the names below are intended to be as intuitive as possible.
YANG identity is used so that a PTP Profile's YANG augment
can assign values, using numeric range 80 to FD hex.
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).
IEEE code is subject to the following copyright and license: Copyright (c) 2020 by The Institute of Electrical and Electronics Engineers, Inc. All rights reserved.
ietf-interfaces
openconfig-extensions
openconfig-ptp-types
description:
Contains all YANG nodes for the PTP data sets. This hierarchy can be
augmented with YANG nodes for a specific vendor or PTP Profile.
nodetype: container (rw)
description:
YANG container that is used to get all PTP Instances. YANG does not
allow get of all elements in a YANG list, so a YANG container wrapping
the YANG list is provided for that purpose. The naming convention uses
plural for the wrapping YANG container, and singular for the YANG list.
nodetype: container (rw)
description:
List of one or more PTP Instances in the product (PTP Node). Each
PTP Instance represents a distinct instance of PTP implementation
(i.e. distinct Ordinary Clock, Boundary Clock, or Transparent Clock),
maintaining a distinct time. PTP Instances may be created or deleted
dynamically in implementations that support dynamic create/delete.
nodetype: list (rw)
list keys: [id]
description:
The instance list is indexed using a number that is unique per PTP
Instance within the PTP Node, applicable to the management context
only (i.e. not used in PTP messages). The domain-number of the PTP
Instance is not used as the key to instance-list, since it is possible
for a PTP Node to contain multiple PTP Instances using the same
domain-number.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for PTP instance.
nodetype: container (rw)
description:
The instance list is indexed using a number that is unique per PTP
Instance within the PTP Node, applicable to the management context
only (i.e. not used in PTP messages). The domain-number of the PTP
Instance is not used as the key to instance-list, since it is possible
for a PTP Node to contain multiple PTP Instances using the same
domain-number.
nodetype: leaf (rw)
type: uint32
description:
Operational state data for PTP instance.
nodetype: container (ro)
description:
The instance list is indexed using a number that is unique per PTP
Instance within the PTP Node, applicable to the management context
only (i.e. not used in PTP messages). The domain-number of the PTP
Instance is not used as the key to instance-list, since it is possible
for a PTP Node to contain multiple PTP Instances using the same
domain-number.
nodetype: leaf (ro)
type: uint32
description:
Current data set state data of PTP instance.
nodetype: container (rw)
description:
Operational state current data set of PTP instance.
nodetype: container (ro)
description:
The number of PTP Communication Paths traversed
between this PTP Instance and the Grandmaster
PTP Instance.
nodetype: leaf (ro)
type: uint16
description:
The current value of the time difference between
a Master PTP Instance and a Slave PTP Instance as
computed by the Slave PTP Instance.
NOTE - When a PTP Profile requires a Boundary
Clock to transfer offset information internally
from Slave PTP Port to Master PTP Port(s), this value
effectively returns the offset from the Grandmaster
PTP Instance.
nodetype: leaf (ro)
type: oc-ptp-types:time-interval
description:
In IEEE Std 1588-2008, currentDS.meanDelay was called
currentDS.meanPathDelay. While the specification of
this member is retained in the current standard, the
member is renamed to currentDS.meanDelay. This change
is consistent with other changes that ensure clarity
and consistency of naming, where
- 'path' is associated with the
request-response mechanism
- 'link' is associated with the
peer-to-peer delay mechanism
nodetype: leaf (ro)
type: oc-ptp-types:time-interval
description:
Time properties data set of PTP instance.
nodetype: container (rw)
description:
Configuration data of time properties data set.
nodetype: container (rw)
description:
Specified as
nodetype: leaf (rw)
type: int16
description:
The value of current-utc-offset-valid shall be true
if the values of current-utc-offset, leap59, and leap61
are known to be correct, otherwise it shall be false.
NOTE - The constraint for leap59 and leap61 did not
exist in IEEE Std 1588-2008, and for compatibility,
corresponding when statements were not included below.
nodetype: leaf (rw)
type: boolean
description:
If the timescale is PTP, a true value for leap59
shall indicate that the last minute of the
current UTC day contains 59 seconds.
If the timescale is not PTP, the value shall be
false.
nodetype: leaf (rw)
type: boolean
description:
If the timescale is PTP, a true value for leap61 shall indicate
that the last minute of the current UTC day contains 61 seconds.
If the timescale is not PTP, the value shall be false.
nodetype: leaf (rw)
type: boolean
description:
The value of time-traceable shall be true if the timescale is
traceable to a primary reference; otherwise, the value shall be
false. The uncertainty specifications appropriate to the
evaluation of whether traceability to a primary reference is
achieved should be defined in the applicable PTP Profile. In
the absence of such a definition the value of time-traceable is
implementation specific.
nodetype: leaf (rw)
type: boolean
description:
The value of time-traceable shall be true if the frequency
determining the timescale is traceable to a primary reference;
otherwise, the value shall be false.
The uncertainty specifications appropriate to the evaluation
of whether traceability to a primary reference is achieved
should be defined in the applicable PTP Profile. In the absence
of such a definition the value of frequency-traceable is
implementation specific.
nodetype: leaf (rw)
type: boolean
description:
If ptp-timescale is true, the timescale of the Grandmaster PTP
Instance is PTP, which is the elapsed time since the PTP epoch
measured using the second defined by International Atomic Time (TAI).
If ptp-timescale is false, the timescale of the Grandmaster PTP
Instance is ARB, which is the elapsed time since an arbitrary epoch.
nodetype: leaf (rw)
type: boolean
description:
The source of time used by the Grandmaster
PTP Instance.
nodetype: leaf (rw)
type: identityref
description:
Operational state data of time properties data set.
nodetype: container (ro)
description:
Specified as
nodetype: leaf (ro)
type: int16
description:
The value of current-utc-offset-valid shall be true
if the values of current-utc-offset, leap59, and leap61
are known to be correct, otherwise it shall be false.
NOTE - The constraint for leap59 and leap61 did not
exist in IEEE Std 1588-2008, and for compatibility,
corresponding when statements were not included below.
nodetype: leaf (ro)
type: boolean
description:
If the timescale is PTP, a true value for leap59
shall indicate that the last minute of the
current UTC day contains 59 seconds.
If the timescale is not PTP, the value shall be
false.
nodetype: leaf (ro)
type: boolean
description:
If the timescale is PTP, a true value for leap61 shall indicate
that the last minute of the current UTC day contains 61 seconds.
If the timescale is not PTP, the value shall be false.
nodetype: leaf (ro)
type: boolean
description:
The value of time-traceable shall be true if the timescale is
traceable to a primary reference; otherwise, the value shall be
false. The uncertainty specifications appropriate to the
evaluation of whether traceability to a primary reference is
achieved should be defined in the applicable PTP Profile. In
the absence of such a definition the value of time-traceable is
implementation specific.
nodetype: leaf (ro)
type: boolean
description:
The value of time-traceable shall be true if the frequency
determining the timescale is traceable to a primary reference;
otherwise, the value shall be false.
The uncertainty specifications appropriate to the evaluation
of whether traceability to a primary reference is achieved
should be defined in the applicable PTP Profile. In the absence
of such a definition the value of frequency-traceable is
implementation specific.
nodetype: leaf (ro)
type: boolean
description:
If ptp-timescale is true, the timescale of the Grandmaster PTP
Instance is PTP, which is the elapsed time since the PTP epoch
measured using the second defined by International Atomic Time (TAI).
If ptp-timescale is false, the timescale of the Grandmaster PTP
Instance is ARB, which is the elapsed time since an arbitrary epoch.
nodetype: leaf (ro)
type: boolean
description:
The source of time used by the Grandmaster
PTP Instance.
nodetype: leaf (ro)
type: identityref
description:
The default data set of the PTP Instance.
nodetype: container (rw)
description:
The IEEE Std 1588 clockQuality of the PTP Instance.
PTP Instances with better quality are more likely to
become the Grandmaster PTP Instance.
nodetype: container (rw)
description:
Config state data of clock-quality
nodetype: container (rw)
description:
The clockClass denotes the traceability of the time
or frequency distributed by the clock.
nodetype: leaf (rw)
type: identityref
description:
The clockAccuracy indicates the accuracy of the clock
(Local Clock of the PTP Instance).
nodetype: leaf (rw)
type: identityref
description:
The offsetScaledLogVariance indicates the stability of the
clock (Local Clock of the PTP Instance). It provides an
estimate of the variations of the clock from a linear timescale
when it is not synchronized to another clock using the
protocol.
nodetype: leaf (rw)
type: uint16
description:
Operational state data of clock-quality
nodetype: container (ro)
description:
The clockClass denotes the traceability of the time
or frequency distributed by the clock.
nodetype: leaf (ro)
type: identityref
description:
The clockAccuracy indicates the accuracy of the clock
(Local Clock of the PTP Instance).
nodetype: leaf (ro)
type: identityref
description:
The offsetScaledLogVariance indicates the stability of the
clock (Local Clock of the PTP Instance). It provides an
estimate of the variations of the clock from a linear timescale
when it is not synchronized to another clock using the
protocol.
nodetype: leaf (ro)
type: uint16
description:
Config state data of default data set of the clock
nodetype: container (rw)
description:
The IEEE Std 1588 priority1 of the PTP Instance.
Since priority1 is one of the first comparisons
performed by the Best Master Clock Algorithm (BMCA),
this leaf's configuration can be used to explicitly
select a Grandmaster PTP Instance.
Lower values take precedence.
The value of priority1 shall be configurable to any
value in the range 0 to 255, unless restricted by
limits established by the applicable PTP Profile.
nodetype: leaf (rw)
type: uint8
description:
The IEEE Std 1588 priority2 of the PTP Instance.
The priority2 member is compared by the Best Master
Clock Algorithm (BMCA) after priority1 and clockQuality.
Lower values take precedence.
The value of priority2 shall be configurable to any
value in the range 0 to 255, unless restricted by
limits established by the applicable PTP Profile.
nodetype: leaf (rw)
type: uint8
description:
The IEEE Std 1588 domainNumber of the PTP Instance.
A domain consists of one or more PTP Instances
communicating with each other as defined by the
protocol. A domain shall define the scope of PTP message
communication, state, operations, data sets, and
timescale. Therefore, each domain represents a distinct
time.
Within a PTP Network, a domain is identified by two
data set members: domainNumber and sdoId.
The domainNumber is the primary mechanism for end users
and system integrators to isolate the operation of a
PTP Instance from PTP messages used in other domains.
The value of the domainNumber shall be configurable
to values permitted in IEEE Std 1588, unless the
allowed values are further restricted by the applicable
PTP Profile.
nodetype: leaf (rw)
type: uint8
description:
The value of slave-only shall be true if the
PTP Instance is a slave-only PTP Instance
(false for non-slave-only).
The slave-only member can be true for Ordinary Clocks
only.
When slave-only is true, the PTP Instance implements
special behavior in the context of the state machines
that determine port-state.
nodetype: leaf (rw)
type: boolean
description:
The type of PTP Instance.
This leaf is read-only unless support for write is
explicitly specified by the applicable PTP Profile or
product specification.
nodetype: leaf (rw)
type: oc-ptp-types:instance-type
description:
The IEEE Std 1588 sdoId of the PTP Instance.
A domain consists of one or more PTP Instances
communicating with each other as defined by the
protocol. A domain shall define the scope of PTP message
communication, state, operations, data sets, and
timescale. Therefore, each domain represents a distinct
time.
Within a PTP Network, a domain is identified by two
data set members: domainNumber and sdoId.
The sdoId of a domain is a 12-bit integer in the
closed range 0 to 4095.
The sdoId member is the primary mechanism for providing
isolation of PTP Instances operating a PTP Profile
specified by a Standards Development Organization (SDO),
from other PTP Instances operating a PTP Profile
specified by a different SDO.
nodetype: leaf (rw)
type: uint16
description:
The network transport used for communication
nodetype: leaf (rw)
type: oc-ptp-types:network-transport-enumeration
description:
Whether the network transport uses unicast or
multicast communication
nodetype: leaf (rw)
type: oc-ptp-types:unicast-multicast-enumeration
description:
The method to be used when comparing data sets during
the Best Master Clock Algorithm.
nodetype: leaf (rw)
type: oc-ptp-types:domain-profile-enumeration
description:
Operational state data of default data set of the clock
nodetype: container (ro)
description:
The IEEE Std 1588 priority1 of the PTP Instance.
Since priority1 is one of the first comparisons
performed by the Best Master Clock Algorithm (BMCA),
this leaf's configuration can be used to explicitly
select a Grandmaster PTP Instance.
Lower values take precedence.
The value of priority1 shall be configurable to any
value in the range 0 to 255, unless restricted by
limits established by the applicable PTP Profile.
nodetype: leaf (ro)
type: uint8
description:
The IEEE Std 1588 priority2 of the PTP Instance.
The priority2 member is compared by the Best Master
Clock Algorithm (BMCA) after priority1 and clockQuality.
Lower values take precedence.
The value of priority2 shall be configurable to any
value in the range 0 to 255, unless restricted by
limits established by the applicable PTP Profile.
nodetype: leaf (ro)
type: uint8
description:
The IEEE Std 1588 domainNumber of the PTP Instance.
A domain consists of one or more PTP Instances
communicating with each other as defined by the
protocol. A domain shall define the scope of PTP message
communication, state, operations, data sets, and
timescale. Therefore, each domain represents a distinct
time.
Within a PTP Network, a domain is identified by two
data set members: domainNumber and sdoId.
The domainNumber is the primary mechanism for end users
and system integrators to isolate the operation of a
PTP Instance from PTP messages used in other domains.
The value of the domainNumber shall be configurable
to values permitted in IEEE Std 1588, unless the
allowed values are further restricted by the applicable
PTP Profile.
nodetype: leaf (ro)
type: uint8
description:
The value of slave-only shall be true if the
PTP Instance is a slave-only PTP Instance
(false for non-slave-only).
The slave-only member can be true for Ordinary Clocks
only.
When slave-only is true, the PTP Instance implements
special behavior in the context of the state machines
that determine port-state.
nodetype: leaf (ro)
type: boolean
description:
The type of PTP Instance.
This leaf is read-only unless support for write is
explicitly specified by the applicable PTP Profile or
product specification.
nodetype: leaf (ro)
type: oc-ptp-types:instance-type
description:
The IEEE Std 1588 sdoId of the PTP Instance.
A domain consists of one or more PTP Instances
communicating with each other as defined by the
protocol. A domain shall define the scope of PTP message
communication, state, operations, data sets, and
timescale. Therefore, each domain represents a distinct
time.
Within a PTP Network, a domain is identified by two
data set members: domainNumber and sdoId.
The sdoId of a domain is a 12-bit integer in the
closed range 0 to 4095.
The sdoId member is the primary mechanism for providing
isolation of PTP Instances operating a PTP Profile
specified by a Standards Development Organization (SDO),
from other PTP Instances operating a PTP Profile
specified by a different SDO.
nodetype: leaf (ro)
type: uint16
description:
The network transport used for communication
nodetype: leaf (ro)
type: oc-ptp-types:network-transport-enumeration
description:
Whether the network transport uses unicast or
multicast communication
nodetype: leaf (ro)
type: oc-ptp-types:unicast-multicast-enumeration
description:
The method to be used when comparing data sets during
the Best Master Clock Algorithm.
nodetype: leaf (ro)
type: oc-ptp-types:domain-profile-enumeration
description:
When set to true, the PTP Instance is two-step,
otherwise the PTP Instance is one-step.
This data set member is no longer used. However,
the twoStepFlag of the PTP common header is used.
One step or two step egress behavior is allowed to
be specified per PTP Port, or per PTP Instance.
Management of the one/two step egress behavior of
a PTP Port is not provided by this standard, but
can be specified as extensions to the data sets by a
PTP Profile or a product specification.
nodetype: leaf (ro)
type: boolean
description:
The IEEE Std 1588 clockIdentity of the PTP Instance.
nodetype: leaf (ro)
type: oc-ptp-types:clock-identity
description:
The number of PTP Ports on the PTP Instance.
For an Ordinary Clock, the value shall be one.
nodetype: leaf (ro)
type: uint16
description:
Provides data learned from the parent of this PTP Instance (i.e.
master port on the other side of the path/link).
nodetype: container (rw)
description:
Operational state data of parent data set
nodetype: container (ro)
description:
The IEEE Std 1588 portIdentity of the PTP Port on the
Master PTP Instance that issues the Sync messages
used in synchronizing this PTP Instance.
nodetype: container (ro)
description:
IEEE Std 1588 clockIdentity.
nodetype: leaf (ro)
type: oc-ptp-types:clock-identity
description:
IEEE Std 1588 portNumber.
If portNumber is unavailable, the value 0 can
be used, or this leaf can be omitted from the
operational datastore.
nodetype: leaf (ro)
type: uint16
description:
When set to true, the values of
parent-ds/observed-parent-offset-scaled-log-variance
and
parent-ds/observed-parent-clock-phase-change-rate
have been measured and are valid.
nodetype: leaf (ro)
type: boolean
description:
Estimate of the variance of the phase offset of the
Local PTP Clock of the Parent PTP Instance as measured
with respect to the Local PTP Clock in the Slave PTP
Instance. This measurement is optional, but if not made,
the value of parent-ds/parent-stats shall be false.
nodetype: leaf (ro)
type: uint16
description:
Estimate of the phase change rate of the
Local PTP Clock of the Parent PTP Instance as measured
by the Slave PTP Instance using its Local PTP Clock.
If the estimate exceeds the capacity of its data type,
this value shall be set to 7FFF FFFF (base 16) or
8000 0000 (base 16), as appropriate. A positive sign
indicates that the phase change rate in the
Parent PTP Instance is greater than that in the
Slave PTP Instance. The measurement of this value is
optional, but if not measured, the value of
parent-ds/parent-stats shall be false.
nodetype: leaf (ro)
type: int32
description:
The IEEE Std 1588 clockIdentity of the Grandmaster PTP
Instance.
nodetype: leaf (ro)
type: oc-ptp-types:clock-identity
description:
The IEEE Std 1588 clockQuality of the Grandmaster PTP
Instance.
nodetype: container (ro)
description:
The clockClass denotes the traceability of the time
or frequency distributed by the clock.
nodetype: leaf (ro)
type: identityref
description:
The clockAccuracy indicates the accuracy of the clock
(Local Clock of the PTP Instance).
nodetype: leaf (ro)
type: identityref
description:
The offsetScaledLogVariance indicates the stability of the
clock (Local Clock of the PTP Instance). It provides an
estimate of the variations of the clock from a linear timescale
when it is not synchronized to another clock using the
protocol.
nodetype: leaf (ro)
type: uint16
description:
The IEEE Std 1588 priority1 of the Grandmaster PTP
Instance.
nodetype: leaf (ro)
type: uint8
description:
The IEEE Std 1588 priority2 of the Grandmaster PTP
Instance.
nodetype: leaf (ro)
type: uint8
description:
YANG container that is used to get all PTP Ports
in the PTP Instance.
YANG does not allow get of all elements in a YANG list,
so a YANG container wrapping the YANG list is provided for
that purpose. The naming convention uses plural for the
wrapping YANG container, and singular for the YANG list.
nodetype: container (rw)
description:
List of data for each PTP Port in the PTP Instance.
While the PTP Instance is disabled, it is possible to
have zero PTP Ports (i.e., ports not yet created).
While the PTP Instance is enabled, an Ordinary Clock
will have one PTP Port, and a Boundary Clock or
Transparent Clock will have more than one PTP Port.
nodetype: list (rw)
list keys: [port-index]
description:
The port list is indexed using a number that is
unique per PTP Port within the PTP Instance,
applicable to the management context only
(i.e., not used in PTP messages).
nodetype: leaf (list key) (rw)
type: leafref
description:
Config state data of port data set of the clock
nodetype: container (rw)
description:
The port list is indexed using a number that is
unique per PTP Port within the PTP Instance,
applicable to the management context only
(i.e., not used in PTP messages).
nodetype: leaf (rw)
type: uint16
description:
Reference to the configured underlying IETF YANG
interface that is used by this PTP Port for
transport of PTP messages. Among other data,
physical identifiers for the interface
(e.g., MAC address) can be obtained using this
reference.
nodetype: leaf (rw)
type: if:interface-ref
description:
operational state data of port data set of the clock
nodetype: container (ro)
description:
The port list is indexed using a number that is
unique per PTP Port within the PTP Instance,
applicable to the management context only
(i.e., not used in PTP messages).
nodetype: leaf (ro)
type: uint16
description:
Reference to the configured underlying IETF YANG
interface that is used by this PTP Port for
transport of PTP messages. Among other data,
physical identifiers for the interface
(e.g., MAC address) can be obtained using this
reference.
nodetype: leaf (ro)
type: if:interface-ref
description:
Primary data set for the PTP Port.
nodetype: container (rw)
description:
Configuration data of port data set of the clock
nodetype: container (rw)
description:
Logarithm to the base 2 of the mean IEEE Std 1588
announceInterval, the time interval between
successive Announce messages sent by a PTP Port.
nodetype: leaf (rw)
type: int8
description:
The integral multiple of IEEE Std 1588
announceInterval that must pass without receipt of
an Announce message before the occurrence of the
event ANNOUNCE_RECEIPT_TIMEOUT_EXPIRES. The range
shall be 2 to 255 subject to further restrictions of
the applicable PTP Profile. While 2 is permissible,
normally the value should be at least 3.
nodetype: leaf (rw)
type: uint8
description:
Logarithm to the base 2 of the mean IEEE Std 1588
syncInterval, the time interval between successive
Sync messages, when transmitted as multicast
messages. The rates for unicast transmissions are
negotiated separately on a per PTP Port basis and
are not constrained by this leaf.
nodetype: leaf (rw)
type: int8
description:
The path delay measuring mechanism used by the PTP
Port in computing
nodetype: leaf (rw)
type: oc-ptp-types:delay-mechanism-enumeration
description:
Logarithm to the base 2 of the IEEE Std 1588
minPdelayReqInterval, the minimum permitted
mean time interval between successive Pdelay_Req
messages sent over a PTP Link.
nodetype: leaf (rw)
type: int8
description:
The PTP major version in use on the PTP Port.
NOTE - This indicates the version of the
IEEE 1588 standard, and not the version of an
applicable PTP Profile.
nodetype: leaf (rw)
type: uint8
description:
Logarithm to the base 2 of the IEEE Std 1588
minDelayReqInterval, the minimum permitted
mean time interval between successive Delay_Req
messages sent by a Slave PTP Instance.
nodetype: leaf (rw)
type: int8
description:
Whether the network transport uses unicast or
multicast communication
nodetype: leaf (rw)
type: oc-ptp-types:unicast-multicast-enumeration
description:
Operational state data of port data set of the clock
nodetype: container (ro)
description:
Logarithm to the base 2 of the mean IEEE Std 1588
announceInterval, the time interval between
successive Announce messages sent by a PTP Port.
nodetype: leaf (ro)
type: int8
description:
The integral multiple of IEEE Std 1588
announceInterval that must pass without receipt of
an Announce message before the occurrence of the
event ANNOUNCE_RECEIPT_TIMEOUT_EXPIRES. The range
shall be 2 to 255 subject to further restrictions of
the applicable PTP Profile. While 2 is permissible,
normally the value should be at least 3.
nodetype: leaf (ro)
type: uint8
description:
Logarithm to the base 2 of the mean IEEE Std 1588
syncInterval, the time interval between successive
Sync messages, when transmitted as multicast
messages. The rates for unicast transmissions are
negotiated separately on a per PTP Port basis and
are not constrained by this leaf.
nodetype: leaf (ro)
type: int8
description:
The path delay measuring mechanism used by the PTP
Port in computing
nodetype: leaf (ro)
type: oc-ptp-types:delay-mechanism-enumeration
description:
Logarithm to the base 2 of the IEEE Std 1588
minPdelayReqInterval, the minimum permitted
mean time interval between successive Pdelay_Req
messages sent over a PTP Link.
nodetype: leaf (ro)
type: int8
description:
The PTP major version in use on the PTP Port.
NOTE - This indicates the version of the
IEEE 1588 standard, and not the version of an
applicable PTP Profile.
nodetype: leaf (ro)
type: uint8
description:
Logarithm to the base 2 of the IEEE Std 1588
minDelayReqInterval, the minimum permitted
mean time interval between successive Delay_Req
messages sent by a Slave PTP Instance.
nodetype: leaf (ro)
type: int8
description:
Whether the network transport uses unicast or
multicast communication
nodetype: leaf (ro)
type: oc-ptp-types:unicast-multicast-enumeration
description:
Current state of the protocol engine associated
with this PTP Port.
nodetype: leaf (ro)
type: oc-ptp-types:port-state-enumeration
description:
In IEEE Std 1588-2008, this data set member was
called portDS.peerMeanPathDelay. While the
specification of this member is retained in the
current standard, the member is renamed to
portDS.meanLinkDelay (i.e., ../mean-link-delay).
This change is consistent with other changes that
ensure clarity and consistency of naming, where
- 'path' is associated with the
request-response mechanism
- 'link' is associated with the
peer-to-peer delay mechanism
nodetype: leaf (ro)
type: oc-ptp-types:time-interval
description:
This default data set was specified in
IEEE Std 1588-2008, and under some interpretations,
it applied to all domains, which in turn means that it
represents multiple Transparent Clocks.
In IEEE Std 1588-2019, this data set is specified as
applying to the PTP Node (all domains), but the data set is
deprecated. For new designs, the standard recommends that
Transparent Clocks use the PTP Instance data sets
(i.e., /ptp/instances/instance[]), such that each
Transparent Clock supports a single PTP Instance and
domain.
nodetype: container (rw)
description:
Top-level container for configuration data of transparent clock.
nodetype: container (rw)
description:
The propagation delay measuring mechanism (e2e or p2p).
nodetype: leaf (rw)
type: oc-ptp-types:delay-mechanism-enumeration
description:
The domainNumber of the primary syntonization domain.
nodetype: leaf (rw)
type: uint8
description:
When set to true, the clock is a two-step clock;
otherwise,the clock is a one-step clock.
nodetype: leaf (rw)
type: boolean
description:
Top-level container for operational state data of transparent clock.
nodetype: container (ro)
description:
The propagation delay measuring mechanism (e2e or p2p).
nodetype: leaf (ro)
type: oc-ptp-types:delay-mechanism-enumeration
description:
The domainNumber of the primary syntonization domain.
nodetype: leaf (ro)
type: uint8
description:
When set to true, the clock is a two-step clock;
otherwise,the clock is a one-step clock.
nodetype: leaf (ro)
type: boolean
description:
The clockIdentity of the local clock.
nodetype: leaf (ro)
type: oc-ptp-types:clock-identity
description:
The number of PTP Ports of the device.
nodetype: leaf (ro)
type: uint16
description:
YANG container that is used to get all ports of the
IEEE Std 1588 transparentClockPortDS.
YANG does not allow get of all elements in a YANG list,
so a YANG container wrapping the YANG list is provided for
that purpose. The naming convention uses plural for the
wrapping YANG container, and singular for the YANG list.
nodetype: container (rw)
description:
This list of Transparent Clock port data sets was specified
in IEEE Std 1588-2008, and under some interpretations,
it applied to all domains, which in turn means that it
represents multiple Transparent Clocks.
In IEEE Std 1588-2019, this list is specified as
applying to the PTP Node (all domains), but the list is
deprecated. For new designs, the standard recommends that
Transparent Clocks use the PTP Instance data sets
(i.e., /ptp/instances/instance[]), such that each
Transparent Clock supports a single PTP Instance
and domain.
nodetype: list (rw)
list keys: [port-index]
description:
The port list is indexed using a number that is
unique per PTP Port within the PTP Instance,
applicable to the management context only
(i.e., not used in PTP messages).
nodetype: leaf (list key) (rw)
type: leafref
description:
Top-level container for configuration data of transparent clock port.
nodetype: container (rw)
description:
The port list is indexed using a number that is
unique per PTP Port within the PTP Instance,
applicable to the management context only
(i.e., not used in PTP messages).
nodetype: leaf (rw)
type: uint16
description:
Reference to the configured underlying IETF YANG
interface that is used by this PTP Port for
transport of PTP messages. Among other data,
physical identifiers for the interface
(e.g., MAC address) can be obtained using this
reference.
nodetype: leaf (rw)
type: if:interface-ref
description:
Top-level container for operational state data of transparent clock port.
nodetype: container (ro)
description:
The port list is indexed using a number that is
unique per PTP Port within the PTP Instance,
applicable to the management context only
(i.e., not used in PTP messages).
nodetype: leaf (ro)
type: uint16
description:
Reference to the configured underlying IETF YANG
interface that is used by this PTP Port for
transport of PTP messages. Among other data,
physical identifiers for the interface
(e.g., MAC address) can be obtained using this
reference.
nodetype: leaf (ro)
type: if:interface-ref
description:
IEEE Std 1588 transparentClockPortDS.
nodetype: container (rw)
description:
Configuration data of transparent clock port data set.
nodetype: container (rw)
description:
The logarithm to the base 2 of the
minPdelayReqInterval (minimum permitted mean time
interval between successive Pdelay_Req messages).
nodetype: leaf (rw)
type: int8
description:
Shall be true if the port is faulty and false
if the port is operating normally.
nodetype: leaf (rw)
type: boolean
description:
The network transport used for communication
nodetype: leaf (rw)
type: oc-ptp-types:network-transport-enumeration
description:
Operational state data of transparent clock port data set.
nodetype: container (ro)
description:
The logarithm to the base 2 of the
minPdelayReqInterval (minimum permitted mean time
interval between successive Pdelay_Req messages).
nodetype: leaf (ro)
type: int8
description:
Shall be true if the port is faulty and false
if the port is operating normally.
nodetype: leaf (ro)
type: boolean
description:
The network transport used for communication
nodetype: leaf (ro)
type: oc-ptp-types:network-transport-enumeration
description:
The IEEE Std 1588 portIdentity of this port.
nodetype: container (ro)
description:
IEEE Std 1588 clockIdentity.
nodetype: leaf (ro)
type: oc-ptp-types:clock-identity
description:
IEEE Std 1588 portNumber.
If portNumber is unavailable, the value 0 can
be used, or this leaf can be omitted from the
operational datastore.
nodetype: leaf (ro)
type: uint16
description:
An estimate of the current one-way propagation delay
on the link when the delayMechanism is P2P; otherwise,
it is zero.
nodetype: leaf (ro)
type: oc-ptp-types:time-interval