Ieee1588v2DeviceGenProtocolParams Object


Description:

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

Parents: EmulatedDeviceGenParams, HostGenParams, RouterGenParams

Children: DeviceGenLinkedStep

Ieee1588v2DeviceGenProtocolParams Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AnnounceReceiptTimeout

Announce Receipt Timeout

Type: u8

Default: 3

Range: 2 - 255

ClockIdentity

PTP Clock Identity

Type: u64

Default: 0xACDE480000000000

ClockIdentityStep

PTP Clock Identity Step

Type: u64

Default: 0x0000000000000001

DelayMechanism

Delay Mechanism

Type: enum

Default: REQUEST_RESPONSE

Possible Values:

Value Description
REQUEST_RESPONSE

End to end delay calculation mechanism

PEER_DELAY

Peer to peer delay calculation mechanism.

DomainNum

PTP Domain Number.

Type: u8

Default: 0

DomainNumStep

PTP Domain Number Step.

Type: u8

Default: 0

EnableUnicastNegotiation

Enable/Disable Unicast Negotiation.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables PTP UnicastNegotiation.

FALSE

Disables PTP UnicastNegotiation.

Encap

Encapsulation

Type: enum

Default: UDP_IPV4

Possible Values:

Value Description
UDP_IPV4

UDP IPv4

UDP_IPV6

UDP IPv6

ETHERNET

Ethernet.

LogAnnounceInterval

Log Announce Interval

Type: s8

Default: 0

Range: -128 - 127

LogMinDelayRequestInterval

Log Minimum Delay Request Interval

Type: s8

Default: 0

Range: -128 - 127

LogSyncInterval

Log Sync Interval

Type: s8

Default: 0

Range: -128 - 127

MessagingMode

Messaging Mode

Type: enum

Default: Multicast

Possible Values:

Value Description
MULTICAST

All messages are exchanged with multicast address

UNICAST

All messages are exchanged with Unicast address.

MIXED

Announce, Sync, Follow up messages are multicast and delay request, delay response are unicast

MulticastMACAddr

Multicast MAC Address

Type: enum

Default: DEFAULT_MAC

Possible Values:

Value Description
DEFAULT_MAC

Multicast MAC address will be configured to default as per spec.

PRIMARY_MAC

Multicast MAC address will be configured to Primary MAC.

PDELAY_MAC

Multicast MAC address will be configured to Pdelay MAC.

PortNum

PTP Port Number

Type: u16

Default: 1

Priority1

PTP Priority1

Type: u8

Default: 128

Priority1Step

PTP Priority1 Step

Type: u8

Default: 0

Priority2

PTP Priority2

Type: u8

Default: 128

Priority2Step

PTP Priority2 Step

Type: u8

Default: 0

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.

SlaveOnly

PTP SlaveOnly.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enables PTP SlaveOnly.

FALSE

Disables PTP SlaveOnly.

StepMode

Step Mode

Type: enum

Default: TWO_STEP

Possible Values:

Value Description
ONE_STEP

One Step, no follow up message exchange

TWO_STEP

Two Step, follow up messages are exchanged

UnicastIpv4AddrType

Unicast Ipv4 Address Type

Type: enum

Default: UNICAST_IP_LIST

Possible Values:

Value Description
UNICAST_IP_LIST

Unicast Ip type for both IPv4 and IPv6 master port address, list shall be entered by the user

UNICAST_IP_INCREMENT

Unicast Ip type for both IPv4 and IPv6 master port address, list shall be created based on start, step and count properties

UnicastIpv6AddrType

Unicast Ipv6 Address Type

Type: enum

Default: UNICAST_IP_LIST

Possible Values:

Value Description
UNICAST_IP_LIST

Unicast Ip type for both IPv4 and IPv6 master port address, list shall be entered by the user

UNICAST_IP_INCREMENT

Unicast Ip type for both IPv4 and IPv6 master port address, list shall be created based on start, step and count properties

UnicastMasterPortIpv4AddrCount

Ipv4 Addr Count, to genearted uincast master port Ipv4 address list

Type: u32

Default: 1

UnicastMasterPortIpv4AddrList

Unicast Master Port Ipv4 Address List

Type: ip

Default: 192.0.1.0

UnicastMasterPortIpv4AddrPortStep

Unicast Master Port Ipv4 Address Port Step. If this is 0, devices on all the ports, shall have same unicast Ipv4 address list

Type: ip

Default: 0.0.0.0

UnicastMasterPortIpv4AddrStart

Ipv4 Strating Address, to genearted uincast master port Ipv4 address list

Type: ip

Default: 192.0.1.0

UnicastMasterPortIpv4AddrStep

Ipv4 Address Step, to genearted uincast master port Ipv4 address list

Type: ip

Default: 0.0.0.1

UnicastMasterPortIpv6AddrCount

Ipv6 Addr Count, to genearted uincast master port Ipv6 address list

Type: u64

Default: 1

UnicastMasterPortIpv6AddrList

Unicast Master Port Ipv6 Address List

Type: ipv6

Default: 2000::1

UnicastMasterPortIpv6AddrPortStep

Unicast Master Port Ipv6 Address Port Step. If this is 0, devices on all the ports, shall have same unicast Ipv6 address list

Type: ipv6

Default: ::

UnicastMasterPortIpv6AddrStart

Ipv6 Starting Address,to genearted uincast master port Ipv6 address list

Type: ipv6

Default: 2000::1

UnicastMasterPortIpv6AddrStep

Ipv6 Address Step, to genearted uincast master port Ipv6 address list

Type: ipv6

Default: ::1

Ieee1588v2DeviceGenProtocolParams Read-Only Attributes

There are no read-only attributes.