PTP commands

ptp

Syntax

ptp

Context

config>system

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure parameters for IEEE 1588-2008, Precision Time Protocol (PTP).

anno-rx-timeout

Syntax

anno-rx-timeout count

no anno-rx-timeout

Context

config>system>ptp

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP announce receipt timeout count in the Announce message.

The no form of this command reverts the count to the default value.

Default

anno-rx-timeout 3

Parameters

count

Specifies the PTP announce receipt timeout count.

Values

2 to 10

clock

Syntax

clock

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure the source of frequency reference for PTP.

freq-source

Syntax

freq-source freq-source

no freq-source

Context

config>system>ptp>clock

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command provides a stable frequency reference obtained through one of the line references (SyncE) for the PTP clock. This is achieved by specifying ssu as the frequency source for PTP. This mode of operation where PTP is used only for time recovery and SyncE is used for frequency recovery is known as PTP hybrid mode.

If set to ssu, PTP runs in hybrid mode (if PTP is also in a no shutdown state), using the recovered frequency provided by the central clock through the configured reference (SyncE). When this parameter is set to ssu, PTP cannot be configured as a reference in the ref-order. The CLI blocks this configuration. The reverse is also true; that is, if PTP is configured under ref-order, this parameter cannot be set to ssu.

If set to ptp, PTP runs in pure mode, potentially being configured as a frequency reference in ref-order.

Note:

If the freq-source value is changed, the system must be rebooted after the configuration changes are saved in order for the new value to take effect.

The no form of this command reverts to the default value.

Default

freq-source ptp

Parameters

freq-source

Specifies if PTP is used for frequency and time recovery or only for time recovery. If ptp is specified, PTP is used for both frequency and time recovery. If ssu is specified, PTP is used only for time recovery.

The ptp option is not supported on the 7210 SAS-Dxp 12p ETR.

Values

ptp, ssu

clock-type

Syntax

clock-type boundary

clock-type ordinary slave

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the type of clock. The clock-type can only be changed when PTP is shut down.

Default

clock-type ordinary slave

Parameters

boundary

Keyword to configure the clock as a boundary clock capable of functioning as both a timeTransmitter and timeReceiver concurrently.

ordinary slave

Keyword to configure the clock as an ordinary PTP timeReceiver. This keyword is not supported on the 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, and 7210 SAS-Dxp 24p.

domain

Syntax

domain domain-value

no domain

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP domain.

Note:
  • Some profiles may require a domain number in a restricted range. It is up to the operator to ensure that the value aligns with what is expected within the profile.

  • Available domain numbers are restricted by the profile that is supported on the specific 7210 SAS platform.

  • The 7210 SAS-Dxp 12p ETR supports only the G.8275.1 profile and corresponding domain numbers.

  • The IEC/IEEE 61850-9-3 and C37.238-2017 profiles and corresponding domain numbers are supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

The domain can be changed only if PTP is shut down.

If the PTP profile is changed, the domain is changed to the default domain for the new PTP profile.

The no form of this command reverts to the default configuration.

Default

domain 0 (ieee1588-2008 or iec-61850-9-3-2016)

domain 4 (g8265dot1-2010)

domain 24 (g8275dot1-2014)

domain 254 (c37dot238-2017)

Parameters

domain-value

Specifies the PTP domain.

Values

0 to 255 (ieee1588-2008, g8265dot1-2010, iec-61850-9-3-2016, or c37dot238-2017)

24 to 43 (g8275dot1-2014)

local-priority

Syntax

local-priority priority

local-priority local-priority (under the peer context)

Context

config>system>ptp

config>system>ptp>peer (supported only on 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C)

config>system>ptp>port (supported only on 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C)

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the local priority used to choose between PTP timeTransmitters in the best timeTransmitter clock algorithm (BTCA). This setting is relevant when the profile is set to g8265dot1-2010 or g8275dot1-2014. The parameter is ignored when the profile is set to ieee1588-2008.

The value 1 is the highest priority and 255 is the lowest priority.

For g8265dot1-2010, this command sets the priority to select between timeTransmitter clocks with the same quality.

For g8275dot1-2014, this command sets the value of the local priority associated with the Announce messages received from the external clocks (ptp>peer or ptp>port), or the local clock (PTP).

Note:

The 7210 SAS-Dxp 12p ETR supports only the G8275.1 profile.

Default

local-priority 128

Parameters

priority

Specifies the value of the local priority.

Values

1 to 255

log-anno-interval

Syntax

log-anno-interval log-interval

no log-anno-interval

Context

config>system>ptp

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP Announce interval.

This command applies only when the profile is set to g8275dot1-2014, iec-61850-9-3-2016, or c37dot238-2017.

Note: The IEC/IEEE 61850-9-3 and C37.238-2017 profiles are supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p

The no form of this command reverts to the default value.

Default

log-anno-interval -3 (g8275dot1-2014)

log-anno-interval 0 (iec-61850-9-3-2016 or c37dot238-2017)

Parameters

log-interval

Specifies the PTP Announce interval, in seconds, as the logarithm to the base 2.

Values

–3, where –3 = 0.125 s (g8275dot1-2014)

–3 to 4, where –3 = 0.125 s, –2 = 0.25 s, –1 = 1 s, 1 = 2 s, 2 = 4 s, 3 = 8 s, 4 = 16 s (iec-61850-9-3-2016 or c37dot238-2017)

log-sync-interval

Syntax

log-sync-interval value

no log-sync-interval

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the PTP Sync and PTP Delay-Req message rate that a PTP timeReceiver requests of a PTP timeTransmitter. The value specified is used as the rate for both PTP Sync and Delay-Req messages. The user can set a lower packet rate, typically when using SyncE for frequency and PTP, for time only.

This command applies only if the profile is set to ieee1588-2008 or g8265dot1-2010. It does not apply when g8275dot1-2014 is configured. When the profile is set to g8275dot1-2014, the value is set to –4 (16 packets/s) and cannot be changed.

Note:
  • The 7210 SAS-Dxp 12p ETR supports only the G8275.1 profile.

  • The IEC/IEEE 61850-9-3 and C37.238-2017 profiles are supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.
  • For the 7210 SAS-D ETR, it is recommended that the packet rate be set to either –4 or –3.

For multicast messages used on PTP Ethernet ports, this command configures the message interval used for synchronization messages transmitted by the local node when the port is in the timeTransmitter state.

The no form of this command reverts to the default value for the profile.

Default

log-sync-interval –6 (64 pps) for ieee1588-2008 or g8265dot1-2010

log-sync-interval –4 (16 pps) for g8275dot1-2014

log-sync-interval 0 (1 pps) for iec-61850-9-3-2016 or c37dot238-2017

Parameters

value

Specifies the rate for both PTP Sync and Delay-Req messages.

Values

–6 to –3, where –6 = 64 packets/s, –5 = 32 packets/s, –4 = 16 packets/s, –3 = 8 packets/s (for the ieee1588-2008 or g8265dot1-2010 profiles)

–4, where –4 = 16 packets/s (for the g8275dot1-2014 profile)

–6 to 0, where –6 = 64 packets/s, –5 = 32 packets/s, –4 = 16 packets/s, –3 = 8 packets/s, –2 = 4 packets/s, –1 = 2 packets/s, 0 = 1 packet/s (for the iec-61850-9-3-2016 or c37dot238-2017 profiles)

network-type

Syntax

network-type {sdh | sonet}

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the codeset used to encode the QL values into PTP clockClass values when the profile is configured for G.8265.1. The codeset is defined in G.8265.1, Table 1.

This setting only applies to the range of values observed in the clockClass values transmitted out of the node in Announce messages. The 7210 SAS supports the reception of any valid value in G.8265.1, Table 1.

Default

nework-type sdh

Parameters

sdh

Specifies the values used on a G.781 Option 1 compliant network.

sonet

Specifies the values used on a G.781 Option 2 compliant network.

peer

Syntax

peer ip-address [create]

no peer ip-address

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure parameters associated with remote PTP peers.

Note:

The maximum supported number of PTP peers depends on the supported PTP PPS rate on 7210 SAS platforms. Contact a Nokia representative for more information.

If the clock-type is ordinary slave or boundary, and PTP is not shut down, the last peer cannot be deleted. This prevents the user from having PTP enabled without any peer configured and enabled.

The no form of this command deletes the specified peer.

Parameters

ip-address

Specifies the IPv4 address of the remote peer.

Values

a.b.c.d

create

Keyword to create the peer.

shutdown

Syntax

[no] shutdown

Context

configure>system>ptp>peer

Platforms

7210 SAS-D ETR, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command disables a specific PTP peer. Shutting down a peer sends cancel unicast negotiation messages on any established unicast sessions. When the peer is shut down, all received packets from the peer are ignored.

If the clock-type is ordinary slave or boundary, and PTP is not shut down, the last enabled peer cannot be shut down. This prevents the user from having PTP enabled without any peer configured and enabled.

The no form of this command enables a specific PTP peer.

Default

no shutdown

port

Syntax

port port-id [create]

no port port-id

Context

config>system>ptp

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

Commands in this context configure PTP over Ethernet on the physical port. The PTP process transmits and receives PTP messages through the port using Ethernet encapsulation (as opposed to UDP/IPv4 encapsulation).

The frames are transmitted with no VLAN tags even if the port is configured for dot1q or QinQ modes for encap-type. In addition, the received frames from the external PTP clock must also be untagged.

There are two reserved multicast addresses allocated for PTP messages. See IEEE 1588-2008 Annex F and the address command for more information. Either address can be configured for the PTP messages sent through this port.

This command applies only if the PTP profile is set to g8275dot1-2014, iec-61850-9-3-2016 or c37dot238-2017.

Changing the encapsulation or the port type of the Ethernet port is not permitted when PTP Ethernet multicast operation is configured on the port. To change the encapsulation or port type, the physical port must be shut down.

The no form of this command deletes the specified port.

Parameters

port-id

Specifies a physical port in the format slot/mda/port.

create

Keyword to create a port.

address

Syntax

address {01:1b:19:00:00:00 | 01:80:c2:00:00:0e}

Context

config>system>ptp>port

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the MAC address to be used as the multicast destination address for transmitted PTP messages.

This command applies only if profile is set to g8275dot1-2014, iec-61850-9-3-2016 or c37dot238-2017.

The IEEE 1588-2008 Annex F defines two reserved addresses for PTP messages, as follows:

  • 01-1B-19-00-00-00 — for all messages except peer delay mechanism messages

  • 01-80-C2-00-00-0E — for peer delay mechanism messages

The system accepts PTP messages received using either destination MAC address, regardless of the address configured by this command.

Default

address 01:1b:19:00:00:00

master-only

Syntax

master-only {true | false}

Context

config>system>ptp>port

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command prevents the local port from ever entering the timeReceiver state. This can be used to ensure that the 7210 SAS never draws synchronization from the attached external device.

This command applies only if profile is set to g8275dot1-2014.

Parameters

true

Keyword to prevent the local port from entering the timeReceiver state.

false

Keyword to allow the local port to enter the timeReceiver state or timeTransmitter state.

shutdown

Syntax

[no] shutdown

Context

configure>system>ptp>port

Platforms

7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command disables a specific PTP port. When the PTPT port is shut down, all PTP Ethernet messages are dropped on the IOM. They are not counted in the PTP message statistics. No PTP packets are transmitted by the node toward this port.

If the clock-type is ordinary slave or boundary, and PTP is not shut down, the last enabled port cannot be shut down. This prevents the user from having PTP enabled without any means to synchronize the local clock to a parent clock.

This command applies only if profile is set to g8275dot1-2014, iec-61850-9-3-2016, or c37dot238-2017.

The no form of this command enables a specific PTP port.

Default

no shutdown

priority1

Syntax

priority1 priority

no priority1

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the priority1 value of the local clock. This command applies only if the profile is set to ieee-1588-2008, iec-61850-9-3-2016, or c37dot238-2017. This value is used by the BTCA to determine which clock should provide timing for the network. It is also used as the advertised value in Announce messages and as the local clock value in data set comparisons.

The no form of this command reverts to the default value.

Default

priority1 128

Parameters

priority

Specifies the value of the priority1 field.

Values

0 to 255

priority2

Syntax

priority2 priority

no priority2

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the priority2 value of the local clock. This parameter is only used when the profile is set to ieee1588-2008, g8275dot1-2014, iec-61850-9-3-2016, or c37dot238-2017.

This value is used by the BTCA to determine which clock should provide timing for the network. It is also used as the advertised value in Announce messages and as the local clock value in data set comparisons.

The no form of this command reverts to the default value.

Default

priority2 128

Parameters

priority

Specifies the value of the priority2 field.

Values

0 to 255

profile

Syntax

profile {g8265dot1-2010 | ieee1588-2008 | g8275dot1-2014 | iec-61850-9-3-2016 | c37dot238-2017}

Context

config>system>ptp

Platforms

7210 SAS-D ETR, 7210 SAS-Dxp 12p ETR, 7210 SAS-Dxp 16p, 7210 SAS-Dxp 24p, 7210 SAS-K 2F1C2T, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C

Description

This command configures the profile for the internal PTP clock. This profile defines the BTCA behavior.

The profile cannot be changed unless PTP is shut down.

When the profile is changed, the domain is changed to the default value for the new profile. On the 7210 SAS platforms, a profile change requires a node reboot. See Configuration guidelines and restrictions for PTP for more information.

Descriptions for commands in the config>system>ptp context indicate whether the command is applicable based on the configured profile.

Default

profile g8265dot1-2010

Parameters

g8265dot1-2010

Specifies to conform to the ITU-T G.8265.1 specification.

ieee1588-2008

Specifies to conform to the 2008 version of the IEEE 1588 standard.

g8275dot1-2014

Specifies to conform to the ITU-T G.8275.1 specification. This profile is supported only on the 7210 SAS-Dxp 12p ETR, 7210 SAS-K 2F6C4T, and 7210 SAS-K 3SFP+ 8C.

iec-61850-9-3-2016

Specifies to conform to the IEC/IEEE 61850-9-3 specification. This profile is supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.

c37dot238-2017

Specifies to conform to the C37.238-2017 specification. This profile is supported only on the 7210 SAS-Dxp 16p and 7210 SAS-Dxp 24p.