PTP commands

ptp

Syntax

ptp

Context

config>system

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

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

anno-rx-timeout

Syntax

anno-rx-timeout count

no anno-rx-timeout

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

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

Note:

When the G.8275.1 profile is configured, the 7210 SAS supports a count value of 3 only.

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-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

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-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

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

If the frequency reference is set to ssu, PTP is running in hybrid mode (if PTP is also in a no shutdown state) using the recovered frequency provided by the central clock through either of the configured references (SyncE or BITS, whichever is configured as a reference for the central clock). In this setting, 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 the frequency reference is set to ptp, PTP runs in pure mode, potentially being configured as a frequency reference in ref-order.

Note:

See Configuration guidelines and restrictions for PTP for more information about command usage.

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

Default

freq-source ptp

Parameters

freq-source

Specifies whether 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.

Values

ptp, ssu

clock-type

Syntax

clock-type boundary

clock-type ordinary slave

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

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

When changing the clock-type to or from a boundary clock on the 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Mxp, and 7210 SAS-T platforms, the node must be rebooted for the change to take effect.

Default

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.

domain

Syntax

domain domain

no domain

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

This command configures the PTP domain.

The domain cannot be modified unless PTP is shut down.

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

The no form of this command reverts to the default configuration.The default value depends on the configured profile.

Default

0 for ieee1588-2008

4 for g8265dot1-2010

24 for g8275dot1-2014

Parameters

domain

Specifies the PTP domain.

Values

0 to 255 for ieee1588-2008

0 to 255 for g8265dot1-2010

24 to 43 for g8275dot1-2014

local-priority

Syntax

local-priority priority

Context

config>system>ptp

config>system>ptp>peer

config>system>ptp>port

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

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 localPriority associated with the Announce messages received from the external clocks (ptp>peer or ptp>port), or the local clock (PTP).

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-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

This command configures the PTP Announce interval.

Note:

When the G.8275.1 profile is configured, the 7210 SAS supports a log-interval value of –3 only. The system automatically changes the value to –3 when this profile is configured.

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

Default

log-anno-interval 1

Parameters

log-interval

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

Values

–3 to 4, where –3 = 0.125 s, –2 = 0.25 s, –1 = 0.5 s, 0 = 1 s, 1 = 2 s, 2 = 4 s, 3 = 8 s, 4 = 16 s

log-sync-interval

Syntax

log-sync-interval values

no log-sync-interval

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

This command configures the message interval used for transmission of multicast synchronization messages.

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.

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 the message interval to the default value.

Default

–6 (64 packets/s) for ieee1588-2008

–6 (64 packets/s) for g8265dot1-2010

–4 (16 packets/s) for g8275dot1-2014

Parameters

values

Specifies the message interval, in log form.

Values

–6 to –3, where –6 = 64 packets/s, –5 = 32 packets/s, –4 = 16 packets/s, –3 = 8 packets/s

network-type

Syntax

network-type {sdh | sonet}

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-T (network and access-uplink)

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 configuration 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.

This command applies only if the PTP profile is set to g8265dot1-2010.

Default

network-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-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-T (network and access-uplink)

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-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-T (network and access-uplink)

Description

This command disables or enables 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.

Default

no shutdown

port

Syntax

port port-id [create]

no port port-id

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

This command configures 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, as defined in IEEE 1588-2008 Annex F (see 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.

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 PTP port.

Parameters

port-id

Specifies a physical port.

Values

slot/mda/port

create

Keyword to create the PTP port.

address

Syntax

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

Context

config>system>ptp>port

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

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

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

The IEEE Std 1588-2008 Annex F defines two reserved addresses for PTP messages:

  • 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

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

master-only

Syntax

master-only {true | false}

Context

config>system>ptp>port

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

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 only applies if the profile is set to g8275dot1-2014.

If the clock-type command is set to ordinary slave, the master-only value is set the false.

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

config>system>ptp>port

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

This command disables or enables a specific PTP port. When the PTP 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 only applies if the profile is set to g8275dot1-2014.

The no form of this command disables the specific PTP port.

Default

no shutdown

Special Cases

PTP Protocol Handling

Applies only to the 7210 SAS-Mxp. When the first instance of the PTP protocol is created and the no shutdown command is issued in the base routing instance, resources are allocated to enable CPU processing of the protocol. The resources are deallocated when the last instance is removed from the configuration using the shutdown command.

priority1

Syntax

priority1 priority-value

no priority1

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-T (network and access-uplink)

Description

This command configures the priority1 value of the local clock. This parameter is only used when the profile is set to ieee1588-2008. 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-value

Specifies the value of the priority1 field.

Values

0 to 255

priority2

Syntax

priority2 priority-value

no priority2

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

This command configures the priority2 value of the local clock. This parameter is only used when the profile is set to ieee1588-2008 or g8275dot1-2014. 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-value

Specifies the value of the priority2 field.

Values

0 to 255

profile

Syntax

profile {g8265dot1-2010 | ieee1588-2008 | g8275dot1-2014}

Context

config>system>ptp

Platforms

7210 SAS-Mxp, 7210 SAS-R6, 7210 SAS-R12, 7210 SAS-Sx 1/10GE (standalone), 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 (standalone), 7210 SAS-T (network and access-uplink)

Description

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

Note:

The 7210 SAS-Sx 10/100GE 64SFP+ 4QSFP28 supports only the G.8275.1 profile.

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 some 7210 SAS platforms, a profile change requires a node reboot. See Configuration guidelines and restrictions for PTP for more information.

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

Default

profile g826dot1-2010

Parameters

g8265dot1-2010

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

ieee1588-2008

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

g8275dot1-2014

Keyword to conform to the ITU-T G.8275.1 specification.