Ieee1588v2ClockConfig Object

Description:

Configure IEEE 1588v2 (Precision Time Protocol) on a device.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: Ieee1588v2CumulativeClockStateCount, Ieee1588v2CustomMessage, Ieee1588v2SessionDetails

Result children (automatically created): ClockSyncFilteredResults, ClockSynchronizationResult, ForeignMasterClockResults, Ieee1588v2ClockResult, Ieee1588v2CumulativeClockStateCount, Ieee1588v2MsgRateResult, ParentClockInfoResult, TimePropertiesResult, UnicastNegotiationResults

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	Mpls ControlPlane BindingResult
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	PrimaryPath
ResultChild (ResultChild)	ClockSyncFilteredResults, ClockSynchronizationResult, ForeignMasterClockResults, Ieee1588v2ClockResult, Ieee1588v2CumulativeClockStateCount, Ieee1588v2MsgRateResult, ParentClockInfoResult, TimePropertiesResult, UnicastNegotiationResults	Use this to connect a results object to an object.
SlaveStreamBlock (SlaveModeStreamBlock)	StreamBlock	Slave Mode StreamBlock
TimeComparisonPair (TimeComparisonPairSrcProtocol)	TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair	Source device device againt which Time of day is compared
Ieee1588v2UnicastRequest (UnicastNegotiation)	Ieee1588v2UnicastRequest	UnicastNegotiation
UsesIf (UsesIf)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

Ieee1588v2ClockConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AnnounceReceiptTimeout

Number of seconds that has to pass without receipt of an Announce message to time out.

Type: u8

Default: 3

Range: 2 - 255

CableDelay

Cable Delay used while calculating T1 and T4 time error

Type: string

Default: 0.0

ClockAccuracy

Accuracy of the clock using IEEE 1588 defined values.

Type: enum

Default: LESS_001_0US

Possible Values:

Value	Description
LOCAL_CLOCK_ACCURACY	0 - Local clock accuracy.
LESS_025_0NS	0x20 - 25 nanoseconds
LESS_100_0NS	0x21 - 100 nanoseconds
LESS_250_0NS	0x22 - 250 nanoseconds
LESS_001_0US	0x23 - 1 microsecond
LESS_002_5US	0x24 - 2.5 microseconds
LESS_010_0US	0x25 - 10 microseconds
LESS_025_0US	0x26 - 25 microseconds
LESS_100_0US	0x27 - 100 microseconds
LESS_250_0US	0x28 - 250 microseconds
LESS_001_0MS	0x29 - 1 millisecond
LESS_002_5MS	0x2A - 2.5 milliseconds
LESS_010_0MS	0x2B - 10 milliseconds
LESS_025_0MS	0x2C - 25 milliseconds
LESS_100_0MS	0x2D - 100 milliseconds
LESS_250_0MS	0x2E - 250 milliseconds
LESS_001_0S	0x2F - 1 second
LESS_010_0S	0x30 - 10 seconds
GREATER_010_0S	0x31 - More than 10 seconds
UNKNOWN	0xFE - Unknown

ClockClass

Clock class describes the traceability of the clock.

Type: u8

Default: 248

ClockIdentity

Clock identity for the device.

Type: u64

Default: 0xACDE480000000000

ClockIdentityStep

ClockIdentity Step value across devices within block when device count is more than 1

Type: u64

Default: 1

ConfigCorrectionField

Use user-defined correction fields.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use user-defined correction fields.
FALSE	Do not use user-defined correction fields.

CustomClockAccuracy

Custom (non-enumerated) clock accuracy.

Type: u8

Default: 35

Range: 0 - 255

CustomMulticastMacAddr

User defined Multicast MAC

Type: mac

Default: 01:1B:19:00:00:00

DelayMechanism

Delay mechanism used.

Type: enum

Default: REQUEST_RESPONSE

Possible Values:

Value	Description
REQUEST_RESPONSE	Request response
PEER_DELAY	Peer delay
NONE	Delay mechanism messages are not sent

DelayRequestCorrectionField

User-defined correction field for Delay_Req messages.

Type: s64

Default: 0

DelayResponseCorrectionField

User-defined correction field for Delay_Resp messages.

Type: s64

Default: 0

DomainNum

Domain for the device.

Type: u8

Default: 0

DomainNumStep

DomainNum Step value across devices within block when device count is more than 1

Type: u8

Default: 1

EnableUnicastNegotiation

Enable unicast negotiation. The clock is configured as a unicast grantor.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable unicast negotiation.
FALSE	Disable unicast negotiation.

Encap

Encapsulation protocol.

Type: enum

Default: UDP_IPV4

Possible Values:

Value	Description
UDP_IPV4	UDP/IPv4
UDP_IPV6	UDP/IPv6
ETHERNET	Ethernet

Flags

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

PTP Flags

Type: enum

Default: PtpTimescale

Possible Values:

Value	Description
PtpAlternateMaster	PTP Alternate Master Flag.
FrequencyTraceable	Frequency Traceable Flag.
TimeTraceable	Time Traceable Flag.
PtpTimescale	Ptp Timescale Flag.
LEAP59	Leap 59 Flag.
LEAP61	Leap 61 Flag.

FollowUpCorrectionField

User-defined correction field for Follow_Up messages.

Type: s64

Default: 0

FrequencyTraceable

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Boolean indicating the traceability of the frequency.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Frequency determining the timescale is traceable to a primary reference.
FALSE	Frequency determining the timescale is not traceable to a primary reference.

Ieee1588v2Flags

Ieee1588v2 Flags

Type: enum

Default: PTP_TIMESCALE|CURRENT_UTC_OFFSET_VALID

Possible Values:

Value	Description
ALTERNATE_MASTER	PTP Alternate Master Flag.
FREQUENCY_TRACEABLE	Frequency Traceable Flag.
TIME_TRACEABLE	Time Traceable Flag.
PTP_TIMESCALE	Ptp Timescale Flag.
LEAP_59	Leap 59 Flag.
LEAP_61	Leap 61 Flag.
CURRENT_UTC_OFFSET_VALID	Current Utc Offset Valid Flag.

Leap59

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Whether to use Leap 59 to adjust the clock.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Last minute of the current UTC day contains only 59 seconds.
FALSE	Last minute of the current UTC day contains 60 seconds.

Leap61

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Whether to use Leap 61 to adjust the clock.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Last minute of the current UTC day contains 61 seconds.
FALSE	Last minute of the current UTC day contain only 60 seconds.

LeapFlag

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

LeapFlag

Type: enum

Default: None

Possible Values:

Value	Description
LEAP59	EnumLeapSelection
LEAP61	LEAP61
NONE	NONE

LogAnnounceInterval

Logarithm, base 2, of the interval between announce messages in seconds.

Type: s8

Default: 0

Range: -128 - 127

LogMinDelayRequestInterval

Logarithm, base 2, of the minimum permitted mean time interval between successive Delay_Req messages. For multicast and unicast without negotiation, this value is converted into frames per seconds and used for the transmit rate.

Type: s8

Default: 0

Range: -128 - 127

LogSyncInterval

Logarithm, base 2, of the interval between sync messages in seconds.

Type: s8

Default: 0

Range: -128 - 127

MasterClockSelectionMethod

Method for selecting the master clock.

Type: enum

Default: BMCA

Possible Values:

Value	Description
NONE	No master clock selection.
BMCA	Best Master Clock Algorithm is used.
ALTERNATE_BMCA	Alternate BMCA Method.

MasterOnly

Clock is set to Master only.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Clock is set to Master only.
FALSE	Clock can move to any state.

MessagingMode

Messaging Mode

Type: enum

Default: Multicast

Possible Values:

Value	Description
MULTICAST	All packets sent on Multicast address.
UNICAST	All packets sent on Unicast address.
MIXED	Delay request and delay response sent on Unicast address, all other packets sent on multicast address.

MulticastMACAddr

List of PTP multicast MAC addresses.

Type: enum

Default: DEFAULT_MAC

Possible Values:

Value	Description
DEFAULT_MAC	Default MAC address as per IEEE spec
PRIMARY_MAC	Primary MAC address
PDELAY_MAC	Pdelay MAC address
CUSTOM_MAC	User defined MAC for all messages.

OffsetScaledLogVariance

Precision of a clock.

Type: u16

Default: 65535

Range: 0 - 65535

OriginTimestampDeviation

Delta time used to manipulate T1

Type: string

Default: 0.0

PortNum

Clock port number.

Type: u16

Default: 1

Priority1

Priority 1 level of the device.

Type: u8

Default: 128

Priority1Step

Priority1 Step value across devices within block when device count is more than 1

Type: u8

Default: 1

Priority2

Priority 2 level of the device.

Type: u8

Default: 128

Priority2Step

Priority2 Step value across devices within block when device count is more than 1

Type: u8

Default: 1

PtpProfile

PTP Profile Attribute Type

Type: enum

Default: Default

Possible Values:

Value	Description
DEFAULT	PTP Default profile.
IEEE1588V2_SMPTE	PTP SMPTE profile.
IEEE1588V2_AES67	PTP AES67 profile.
IEEE1588V2_ENTERPRISE	PTP Enterprise profile.
IEEE1588V2_TELECOM_8275_1	PTP Telecom 8275.1 profile.
IEEE1588V2_TELECOM_8275_2	PTP Telecom 8275.2 profile.
IEEE1588V2_TELECOM_8265_1	PTP Telecom 8265.1 profile.

ScaleMode

Performance level of the protocol.

Type: enum

Default: NORMAL

Possible Values:

Value	Description
NORMAL	Normal performance, with all results.
GEN_TX_NO_RESULTS	Scale mode: Improve scale performance by transmitting packets using the generator, and reducing results collected.

SlaveOnly

Prevent the clock from becoming a master.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Clock may not become a master.
FALSE	Clock may become a master.

StepMode

Stepping mode used by the protocol.

Type: enum

Default: TWO_STEP

Possible Values:

Value	Description
ONE_STEP	Timestamp is provided in the first message.
TWO_STEP	Timestamp is provided in a subsequent follow up message.

stepsRemoved

Steps Removed

Type: u16

Default: 0

Range: 0 - 255

SyncCorrectionField

User-defined correction field for Sync messages.

Type: s64

Default: 0

TimeSrc

Time source of the clock.

Type: enum

Default: INTERNAL_OSCILLATOR

Possible Values:

Value	Description
ATOMIC_CLOCK	Time source is an atomic clock.
GPS	Time source is GPS.
TERRESTRIAL_RADIO	Time source is a terrestrial radio distribution system.
PTP	Time source is a PTP-based source external to the domain.
NTP	Time source is an NTP or SNTP server.
HAND_SET	Time source is a human interface based on observation of an international standards source of time to within the claimed clock accuracy.
OTHER	A time source not covered by the other options.
INTERNAL_OSCILLATOR	Time source is a device whose frequency is not based on atomic resonance nor calibrated against international standards for frequency, and whose time is based on a free-running oscillator with epoch determined in an arbitrary or unknown manner.
PTP_PROFILE240	PTP profile 240.
PTP_PROFILE241	PTP profile 241.
PTP_PROFILE242	PTP profile 242.
PTP_PROFILE243	PTP profile 243.
PTP_PROFILE244	PTP profile 244.
PTP_PROFILE245	PTP profile 245.
PTP_PROFILE246	PTP profile 246.
PTP_PROFILE247	PTP profile 247.
PTP_PROFILE248	PTP profile 248.
PTP_PROFILE249	PTP profile 249.
PTP_PROFILE250	PTP profile 250.
PTP_PROFILE251	PTP profile 251.
PTP_PROFILE252	PTP profile 252.
PTP_PROFILE253	PTP profile 253.
PTP_PROFILE254	PTP profile 254.

TimeTraceable

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Boolean indicating the traceability of the time.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Time is traceable to a primary reference.
FALSE	Time is not traceable to a primary reference.

Ttl

Ttl

Type: u8

Default: 1

Range: 1 - 255

TxAnnounceFrameDroppedPercentage

Number of Announce packets to be dropped

Type: u8

Default: 0

Range: 0 - 100

TxDelayResponseFrameDroppedPercentage

Percentage of Delay_Resp messages to drop.

Type: u8

Default: 0

Range: 0 - 100

TxFollowUpFrameDroppedPercentage

Percentage of Follow_Up messages to drop.

Type: u8

Default: 0

Range: 0 - 100

TxSyncFrameDroppedPercentage

Number of Sync packets to be dropped

Type: u8

Default: 0

Range: 0 - 100

UnicastDiscovery

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Enable unicast discovery and request. Configures the clock for static unicast (when EnableUnicastNegotiation is false) or as a unicast requestor (when EnableUnicastNegotiation is true).

Type: enum

Default: DISABLED

Possible Values:

Value	Description
DISABLED	Disable unicast discovery.
ENABLED	Enable unicast discovery.

UnicastMasterPortIpv4AddrList

List of IPv4 addresses for unicast master clocks.

Type: ip

Default: 192.0.1.0

UnicastMasterPortIpv6AddrList

List of IPv6 addresses for unicast master clocks.

Type: ipv6

Default: 2000::1

UseCustomClockAccuracy

Use the value of CustomClockAccuracy instead of ClockAccuracy (which is limited to an enumeration).

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use the CustomClockAccuracy value.
FALSE	Use the enumerated ClockAccuracy value.

UsePartialBlockState

Whether to use partial block state.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use partial block state.
FALSE	Do not use partial block state.

UtcOffset

UtcOffset

Type: u8

Default: 36

Ieee1588v2ClockConfig Read-Only Attributes

Read-Only Attribute

Description

ClockState

Current state of the clock.

Type: enum

Default: IEEE1588_STATE_NONE

Possible Values:

Value	Description
IEEE1588_STATE_NONE	No state detected.
IEEE1588_STATE_INITIALIZING	Initializing data sets, hardware, and communication facilities.
IEEE1588_STATE_FAULTY	Multiple Pdelay_Resp messages were received.
IEEE1588_STATE_DISABLED	Does not implement the delay mechanism.
IEEE1588_STATE_LISTENING	Waiting for the announceReceiptTimeout to expire or to receive an Announce message from a master.
IEEE1588_STATE_PRE_MASTER	No Announce message was received within the required time. Allowing changes to propagate from points in the system between the local clock and possible masters visible from the port before assuming the Master state.
IEEE1588_STATE_MASTER	Operating as the master clock.
IEEE1588_STATE_PASSIVE	Not the master on the path. Not synchronizing to a master.
IEEE1588_STATE_UNCALIBRATED	One or more master ports have been detected in the domain.
IEEE1588_STATE_SLAVE	Synchronizing to the selected master port.
IEEE1588_STATE_LINK_DOWN	Port link is down
IEEE1588_STATE_NOT_APPLICABLE	For Device block state is shown as Not applicable.