ptpProperties

ptpProperties - configure .

SYNOPSIS

ptpProperties sub-command options

DESCRIPTION

There are five types of PTP devices, as follows:

All PTP devices are identified by a clockIdentity attribute. In addition, ordinary and boundary clocks are characterized by the following attributes:

STANDARD OPTIONS
announceInterval

The mean time interval between successive Announce messages. (default = 0)

announceReceipt

The number of announceInterval that has to pass without receipt of an Announce message before the occurrence of the Announce Receipt Timeout event. (default = 0)

badCrcPercent

Percent of follow-up messages sent with bad CRC. (default = 0)

badTimeStampPercent

Percent of follow-up messages sent with bad timestamp. Bad timestamp = good tmestamp + timestamp error. (default = 0)

clockAccuracy

Defines the accuracy of a clock. (default = ptpAccuracy25ns)

Option

Value

Usage

ptpAccuracy25ns

32

accuracy 25 nanoseconds

ptpAccuracy100ns

33

accuracy 100 ns

ptpAccuracy250ns

34

accuracy 250 ns

ptpAccuracy1us

35

accuracy 1 microsecond

ptpAccuracy2p5us

36

accuracy 2.5 microseconds

ptpAccuracy10us

37

accuracy 10 microseconds

ptpAccuracy25us

38

accuracy 25 microseconds

ptpAccuracy100us

39

accuracy 100 microseconds

ptpAccuracy250us

40

accuracy 250 microseconds

ptpAccuracy1ms

41

accuracy 1 millisecond

ptpAccuracy2p5ms

42

accuracy 2.5 milliseconds

ptpAccuracy10ms

43

accuracy 10 milliseconds

ptpAccuracy25ms

44

accuracy 25 milliseconds

ptpAccuracy100ms

45

accuracy 100 milliseconds

ptpAccuracy250ms

46

accuracy 250 milliseconds

ptpAccuracy1s

47

accuracy 1 second

ptpAccuracy10s

48

accuracy 10 seconds

ptpAccuracyGreater10s

49

accuracy greater than 10 seconds

ptpAccuracyUnknown

254

accuracy unknown

clockClass

Defines a clock's TAI traceability. The clockClass attribute of an ordinary or boundary clock denotes the traceability of the time or frequency distributed by the grandmaster clock. (default = 0)

clockId

Clock identity, identifies a clock. (default = '00 00 00 00 00 00 00 00')

delayMechanism

Configure the the delay mechanism. (default = ptpE2E)

Option

Value

Usage

ptpE2E

1

End-to-end

ptpDisabled

254

Disabled

delayRequest

The minimum permitted mean time interval between successive Delay_Req messages, sent by a slave to a specific port on the master. (default = 0)

domainNumber

The domain is identified by an integer in the range of 0 to 255. (default = 0)

dropDelayResponsePercent

Defines how many delay response messages to be dropped. Drop delay response messages expressed as percentage of received delay request messges. Normally, delay response is sent by the master corresponding to each delay request massage received. For negative testing, you can configure Ixia port to drop the delay response message to see how the DUT behaves. (default = 0)

dropFollowUpPercent

Defines how many follow-up messages to be dropped. Drop follow-up messages expressed as percent of sync messages. Normally, a follow-up message is sent out corresponding to each sync message. For negative testing, you can configure Ixia port to drop the follow-up message to see how the DUT behaves. (default = 0)

enableClockMaster

If true, configures Ixia port in master mode. (default = 0)

portNumber

An index identifying a specific PTP port on a PTP node. (default = 0)

priority1

A user configurable designation that a clock belongs to an ordered set of clocks from which a master is selected. (default = 0)

priority2

A user configurable designation that provides finer grained ordering among otherwise equivalent clocks. (default = 0)

startOffset

Defines the clock offset in nanoseconds. Master sends PTP messages with Start Offset added to the clock. (default = 0)

syncInterval

The mean time interval between successive Sync messages. (default = 0)

timestampError

The time error between a slave and a master ordinary or boundary clock. (default = 0)

COMMANDS

The ptpProperties command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.

ptpProperties cget option

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the ptpProperties command.

ptpProperties config option value

Modify the configuration options of the port. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for port.

ptpProperties setDefault

Sets to IxTclHal default values for all configuration options.

EXAMPLES

See example under ptp command.

SEE ALSO

ptp, ptpAnnounce, ptpDelayRequest, ptpDelayResponse, ptpDiscoveredInfo, ptpProperties, ptpFollowUp, ptpSync.