Ieee8021asClockConfig Object

Description:

Ieee8021asClockConfig

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Result children (automatically created): Ieee8021asClockResult, Ieee8021asClockSynchronizationResult, Ieee8021asMsgIntervalResults, Ieee8021asMsgRateResult, Ieee8021asParentClockInfoResult, Ieee8021asRecoveredClockQualityResult, Ieee8021asTimePropertiesResult

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	Mpls Control Plane Binding Result
SlaveStreamBlock (Ieee8021asSlaveModeStreamBlock)	StreamBlock	Ieee 8021as SlaveMode StreamBlock
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	PrimaryPath
ResultChild (ResultChild)	Ieee8021asClockResult, Ieee8021asClockSynchronizationResult, Ieee8021asMsgIntervalResults, Ieee8021asMsgRateResult, Ieee8021asParentClockInfoResult, Ieee8021asRecoveredClockQualityResult, Ieee8021asTimePropertiesResult	Use this to connect a results object to an object.
TimeComparisonPair (TimeComparisonPairSrcProtocol)	TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair	Source device device againt which Time of day is compared
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).

Ieee8021asClockConfig Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AnnounceReceiptTimeout

The time at which announce receipt timeout occurs

Type: u8

Default: 3

Range: 3 - 255

AutomotiveProfile

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

Run gPTP in Automotive Profile

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	select Automotive Profile
FALSE	deselect Automotive Profile

CableDelay

Cable Delay used while calculating T1 and T4 time error

Type: string

Default: 0.0

ClockAccuracy

Indicates how accurate the clock is.

Type: enum

Default: LESS_001_0US

Possible Values:

Value	Description
LOCAL_CLOCK_ACCURACY	LOCAL_CLOCK_ACCURACY
LESS_025_0NS	LESS_025_0NS
LESS_100_0NS	LESS_100_0NS
LESS_250_0NS	LESS_250_0NS
LESS_001_0US	LESS_001_0US
LESS_002_5US	LESS_002_5US
LESS_010_0US	LESS_010_0US
LESS_025_0US	LESS_025_0US
LESS_100_0US	LESS_100_0US
LESS_250_0US	LESS_250_0US
LESS_001_0MS	LESS_001_0MS
LESS_002_5MS	LESS_002_5MS
LESS_010_0MS	LESS_010_0MS
LESS_025_0MS	LESS_025_0MS
LESS_100_0MS	LESS_100_0MS
LESS_250_0MS	LESS_250_0MS
LESS_001_0S	LESS_001_0S
LESS_010_0S	LESS_010_0S
GREATER_010_0S	GREATER_010_0S

ClockClass

The clockClass attribute denotes the traceability of the synchronized time distributed by a ClockMaster when it is the grandmaster.

Type: u8

Default: 248

ClockIdentity

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

The ClockIdentity type identifies a time-aware system

Type: u64

Default: 0xACDE480000000000

ConfigCorrectionField

To enable/disable configuring the correction fields

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	enable Configure Correction
FALSE	disable Configure Correction

CrcTimeFlags

CRC Time Flags

Type: enum

Default: BIT_MASK_0x01

Possible Values:

Value	Description
BIT_MASK_0x01	The messageLength value inside the Follow_Up Message Header is considered from CRC Time calculation
BIT_MASK_0x02	The domainNumber value inside the Follow_Up Message Header is considered from CRC Time calculation
BIT_MASK_0x04	The correctionField value inside the Follow_Up Message Header is considered from CRC Time calculation
BIT_MASK_0x08	The sourcePortIdentity value inside the Follow_Up Message Header is considered from CRC Time calculation
BIT_MASK_0x10	The sequenceId value inside the Follow_Up Message Header is considered from CRC Time calculation
BIT_MASK_0x20	The preciseOriginTimestamp value inside the Follow_Up Message Header is considered from CRC Time calculation
BIT_MASK_0x40	Reserved
BIT_MASK_0x60	Reserved

CumulativeScaledRateOffset

Cumulative Scaled Rate Offset

Type: u32

Default: 0

CustomClockAccuracy

Indicates the accuracy of custom clock

Type: u8

Default: 35

Range: 0 - 255

CustomTlv

Hex dump of any TLV.

Type: u8

Default: 0

DataIdList

Data Id List used to pick data id for CRC calculation.

Type: u8

Default: 0

DelayAnnounce

Interval in milli seconds, this interval is added to log announce interval to get the final interval between two announce messages. Delaying announce message after log announce interval

Type: u32

Default: 0

DelayFollowUp

Time in milliseconds to delay sending follow up message after sending sync message.

Type: u32

Default: 0

DelayMechanism

The type of delay mechanism used

Type: enum

Default: PEER_DELAY

Possible Values:

Value	Description
PEER_DELAY	PEER_DELAY
NONE	No Delay Mechanism.

DelayPdelayResp

Time in milliseconds to delay sending pdelay resp message after receiving pdelay request message.

Type: u32

Default: 0

DelayPdelayRespFollowUp

Time in milliseconds to delay sending pdelay resp follow up message after sending pdelay response message.

Type: u32

Default: 0

DelayRequestCorrectionField

The value of correction for pdelay request message

Type: s64

Default: 0

DelayResponseCorrectionField

The value of correction for pdelay response message

Type: s64

Default: 0

DelaySync

Interval in milli seconds, this interval is added to log sync interval to get the final interval between two sync messages. Delaying sync message after log sync interval

Type: u32

Default: 0

DomainNum

Another gPTP attribute

Type: u8

Default: 0

EnableAutosarTlv

Enable/Disable AUTOSAR TLV

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enables AUTOSAR TLV.
FALSE	Disables AUTOSAR TLVy.

EnableClockQualityMeasurements

Feature flag for recovered clock quality measurements

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	True
FALSE	False

EnableCrcSecured

Enable/Disable CRC Secured

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	CRC shall be calculated at Tx side and Validated at Rx side.
FALSE	CRC shall not be calculated or Validated.

EnableMessageIntervalRequestTlv

On enabling this flag Message Interval Request Tlv is sent

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Sending Message Interval Request Signaling Message
FALSE	Disable Sending Message Interval Request Signaling Message

EnableSignaling

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

Exchange Signaling message between Master and Slave, Signaling Message Carries Message Interval Request TLV to adjust the rate at which Sync messages are exchanged in Automotive profile

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Sending Signaling Message
FALSE	Disable Sending Signaling Message

Encap

The type of header used for encapsulation.

Type: enum

Default: ETHERNET

Possible Values:

Value	Description
ETHERNET	ETHERNET encapsulation

Flags

PTP Flags

Type: enum

Default: 0

Possible Values:

Value	Description
FREQUENCY_TRACEABLE	Frequency Traceable Flag.
TIME_TRACEABLE	Time Traceable Flag.
LEAP_59	Leap 59 Flag.
LEAP_61	Leap 61 Flag.

FollowUpCorrectionField

The value of correction for FollowUp message

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.

Indicates if the frequency that determines clockSlaveTime is traceable to a primary reference or not.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Frequency Traceable true
FALSE	Frequency Traceable fale

GptpProfile

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

Indicates the Type of gPTP profile

Type: enum

Default: Default

Possible Values:

Value	Description
DEFAULT	Default Profile of gPTP operates in two step mode and master selection is based on BMCA
IEEE8021AS_AUTOMOTIVE	Automotive profile of the gPTP operates in two step mode and master selection is based on manual configuration
IEEE8021AS_REV	gPTP revised profile can operate in both one step and two step mode and master selection is based on BMCA

Ieee1588v2Device

Current port's IEEE 1588v2 device from which ingress time extracted

Type: handle

Default: 0

Ieee8021asClockIdentity

Clock Identity

Type: u64

Default: null

Ieee8021asProfile

Profiles of Ieee802.1AS

Type: enum

Default: IEEE8021AS_2011

Possible Values:

Value	Description
IEEE8021AS_2011	Profile as Ieee802.1AS-2011.
IEEE8021AS_2020	Profile as Ieee802.1AS-2020.
AVNU_AUTOMOTIVE	Profile as AVnu-Automotive.
AUTOSAR_TIME_SYNC	Profile as AUTOSAR-TimeSync.

IngressTimeOffset

added to the ingress PTP timestamp

Type: string

Default: 0.0

Leap59

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

a Boolean variable whose value is TRUE if the last minute of the current UTC day, relative to the current grandmaster, contains 59 s, and FALSE if the last minute of the current UTC day does not contain 59 s.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Leap 59 true
FALSE	Leap 59 false

Leap61

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

Boolean variable whose value is TRUE if the last minute of the current UTC day, relative to the current grandmaster, contains 61 s, and FALSE if the last minute of the current UTC day does not contain 61 s

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Leap 61 true
FALSE	Leap 61 false

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	Enum Leap Selection
LEAP61	LEAP61
NONE	NONE

LogAnnounceInterval

The logarithm to base 2 of the mean time interval, in seconds, between the sending of successive Announce messages

Type: s8

Default: 0

Range: -128 - 127

LogGptpCapableMessageInterval

The logarithm to base 2 of the mean time interval, in seconds, between the sending of successive gPTP capable TLV signalling message.

Type: s8

Default: 0

Range: -128 - 127

LogMinDelayRequestInterval

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

The logarithm to base 2 of the mean time interval, in seconds, between the sending of successive pdelay request messages

Type: s8

Default: 0

Range: -128 - 127

LogMinPdelayRequestInterval

LogMinPdelayRequestInterval

Type: s8

Default: 0

Range: -128 - 127

LogSyncInterval

The logarithm to base 2 of the mean time interval, in seconds, between the sending of successive Sync messages

Type: s8

Default: 0

Range: -128 - 127

MasterClockSelectionMethod

Method used for selcting Master clock

Type: enum

Default: BMCA

Possible Values:

Value	Description
NONE	NONE
BMCA	BMCA

NeighborPropDelayThresh

The propagation time threshold, above which a port is not considered capable of participating in the IEEE 802.1AS protocol when step mode is two step.

Type: u64

Default: 800

NeighborPropDelayThreshForOneStep

The propagation time threshold, above which a port is not considered capable of participating in the IEEE 802.1AS protocol when step mode is one step.

Type: u64

Default: null

OffsetScaledLogVariance

Offset scaled log variance value

Type: u16

Default: 65535

Range: 0 - 65535

OperLogSyncInterval

The logarithm to base 2 of the mean time interval, in seconds, between the sending of successive Sync messages after Intial Sync between Master and slave is done

Type: s8

Default: 0

OrganizationId

Organization ID

Type: u32

Default: 16777215

Range: 0 - 16777215

OriginTimestampDeviationUsecNsec

Delta time used to manipulate T1

Type: string

Default: 0.0

PathSequenceClockIdList

List of clock Ids that shall be sent in announce message path trace TLV

Type: u64

Default: 0

PdelayRespFollowUpCorrectionField

Pdelay Response Follow Up Correction Field

Type: s64

Default: 0

PortNum

The portNumber value for a port on a time-aware system

Type: u16

Default: 1

Priority1

Priority1 is used in the execution of the BMCA

Type: u8

Default: 128

Priority2

Priority1 is used in the execution of the BMCA

Type: u8

Default: 128

ReverseSyncDomainNum

Reverse Sync Domain Number to identify reverse sync mssages

Type: u8

Default: 1

RxSyncCntForMessageTlv

Number of sync messages to be received before sending Message interval TLV

Type: u32

Default: 2

Range: 2 - 65536

SlaveOnly

The timeaware system can be made slaveonly

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Make the node slave only
FALSE	can be slave or a master

StepMode

Step mode of clock

Type: enum

Default: TWO_STEP

Possible Values:

Value	Description
ONE_STEP	one step mode
TWO_STEP	two step mode

StepsRemoved

Steps Removed

Type: u16

Default: 0

SyncCorrectionField

The value of correction for sync message

Type: s64

Default: 0

TimeSrc

The type of source of time used by a ClockMaster.

Type: enum

Default: INTERNAL_OSCILLATOR

Possible Values:

Value	Description
ATOMIC_CLOCK	ATOMIC_CLOCK
GPS	GPS
TERRESTRIAL_RADIO	TERRESTRIAL_RADIO
PTP	PTP
NTP	NTP
HAND_SET	HAND_SET
OTHER	OTHER
INTERNAL_OSCILLATOR	INTERNAL_OSCILLATOR
GPTP_PROFILE240	GPTP_PROFILE240
GPTP_PROFILE241	GPTP_PROFILE241
GPTP_PROFILE242	GPTP_PROFILE242
GPTP_PROFILE243	GPTP_PROFILE243
GPTP_PROFILE244	GPTP_PROFILE244
GPTP_PROFILE245	GPTP_PROFILE245
GPTP_PROFILE246	GPTP_PROFILE246
GPTP_PROFILE247	GPTP_PROFILE247
GPTP_PROFILE248	GPTP_PROFILE248
GPTP_PROFILE249	GPTP_PROFILE249
GPTP_PROFILE250	GPTP_PROFILE250
GPTP_PROFILE251	GPTP_PROFILE251
GPTP_PROFILE252	GPTP_PROFILE252
GPTP_PROFILE253	GPTP_PROFILE253
GPTP_PROFILE254	GPTP_PROFILE254

TimeTraceable

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

Indicates if both clockSlaveTime and currentUtcOffset relative to the current grandmaster are traceable to a primary reference or not

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Time Traceable true
FALSE	Time Traceable false

TsnTranslator

Select TSN translator mode either None or 5G NW-TT/DS-TT

Type: enum

Default: None

Possible Values:

Value	Description
NONE	TSN Translator type is None
NW_TT	TSN Translator type is NW_TT
DS_TT	TSN Translator type is DS_TT

TxDelayResponseFrameDroppedPercentage

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

The percentage of Delay response Tx frames to be dropped.

Type: u8

Default: 0

Range: 0 - 100

TxFollowUpFrameDroppedPercentage

The percentage of Follow Up Tx frames to be dropped.

Type: u8

Default: 0

Range: 0 - 100

UnicastDiscovery

To enable/disable Unicast Discovery

Type: enum

Default: DISABLED

Possible Values:

Value	Description
DISABLED	DISABLED
ENABLED	ENABLED

UseCustomClockAccuracy

Use custom clock accuracy

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use custom clock accuracy
FALSE	Do not use custom clock accuracy

UsePartialBlockState

using the 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: 37

Ieee8021asClockConfig Read-Only Attributes

Read-Only Attribute

Description

AutosarTlvSubTlvs

AUTOSAR TLV Sub-TLVs

Type: enum

Default: TIME_SECURED

Possible Values:

Value	Description
TIME_SECURED	Time Secured Sub TLV is sent in AUTOSAR TLV

ClockState

State of the gPTP clock.

Type: enum

Default: IEEE8021AS_STATE_NONE

Possible Values:

Value	Description
IEEE8021AS_STATE_NONE	No state detected.
IEEE8021AS_STATE_INITIALIZING	Initializing data sets, hardware, and communication facilities.
IEEE8021AS_STATE_FAULTY	Multiple Pdelay_Resp messages were received.
IEEE8021AS_STATE_DISABLED	Does not implement the delay mechanism.
IEEE8021AS_STATE_LISTENING	Waiting for the announceReceiptTimeout to expire or to receive an Announce message from a master.
IEEE8021AS_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.
IEEE8021AS_STATE_MASTER	Operating as the master clock.
IEEE8021AS_STATE_PASSIVE	Not the master on the path. Not synchronizing to a master.
IEEE8021AS_STATE_UNCALIBRATED	One or more master ports have been detected in the domain.
IEEE8021AS_STATE_SLAVE	Synchronizing to the selected master port.
IEEE8021AS_STATE_LINK_DOWN	Link is down.