ptp
config>system
This command enables the context to create or modify PTP timing parameters.
clock clock-id [create]
no clock
config>system>ptp
This command creates a PTP clock, which can be set to a master, slave, boundary, or transparent clock using the clock-type command. The clock-id can be a numeric value (1 to 16) or it can be the keyword csm.
Use the numeric value for PTP clocks that transmit and receive PTP messages using IPv4 or IPv6 encapsulation. On the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-A, 7705 SAR-Ax, 7705 SAR-Wx, and 7705 SAR-X, only one PTP instance can be master, slave, or boundary.
Use the csm keyword when the PTP clock transmits and receives PTP messages using Ethernet encapsulation. Ethernet-encapsulated PTP messages are processed on the CSM module or CSM functional block.
The no form of the command deletes a PTP clock when the clock-id is set to a numeric value. The CSM PTP clock cannot be removed.
specifies the clock ID of this PTP instance
keyword required when first creating the configuration context for a clock-id of 1 to 16. When the context is created, you can navigate into the context without the create keyword. The create keyword is not required when the clock-id is csm.
alternate-profile profile-name [create]
no alternate-profile profile-name
config>system>ptp>clock
This command configures an alternate profile to be used for PTP messaging. An alternate profile can be used at the edge of a network to provide PTP time or frequency distribution outward to external PTP clocks.
The alternate profile name cannot be ‟primary” because that is reserved for the primary profile.
The alternate profile cannot be removed if any PTP ports or peers are enabled and using it; the ports or peers must first be shut down.
The no form of the command removes the alternate profile configuration.
n/a
the name of the alternate profile, up to 64 characters
keyword required when first creating the alternate profile. When the alternate profile is created, you can navigate into the context without the create keyword.
domain domain-value
no domain
config>system>ptp>clock>alternate-profile
This command defines the PTP device domain as an integer for the alternate profile. A domain consists of one device or multiple PTP devices communicating with each other as defined by the protocol. A PTP domain defines the scope of PTP message communication, state, operations, datasets, and timescale. A domain is configured because it is possible that a deployment could require two PTP instances within a single network element to be programmed with different domain values.
The domain value cannot be changed if any PTP ports or peers are enabled and using the alternate profile.
The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.
0 when the alternate profile is configured as iec-61850-9-3-2016
254 when the alternate profile is configured as c37dot238-2017
specifies the PTP device domain value
initial-time-inaccuracy initial-time-inaccuracy
no initial-time-inaccuracy
config>system>ptp>clock>alternate-profile
This command sets the time inaccuracy value, representing the total time inaccuracy from the grand master clock to the parent clock. This value is added to the mandatory IEEE_C37_238 TLV.
This command is applicable only when the alternate profile is configured as c37dot238-2017.
The no form of this command returns the configuration to the default value.
0
specifies the total inaccuracy on the network in nanoseconds, to be added to the IEEE_C37_238 TLV
log-anno-interval log-anno-interval
no log-anno-interval
config>system>ptp>clock>alternate-profile
This command configures the Announce message interval used for multicast messages in the alternate profile. For multicast messages on PTP Ethernet ports, this command configures the message interval used for Announce messages transmitted by the local node. This value has no impact on the interval between executions of the BMCA within the node; that interval is controlled by the log-anno-interval value defined for the primary profile.
The no form of this command returns the configuration to the default value.
0 (1 packet/s)
specifies the expected interval between the reception of Announce messages. This parameter is specified as the logarithm to the base 2, in seconds.
profile {iec-61850-9-3-2016 | c37dot238-2017}
no profile
config>system>ptp>clock>alternate-profile
This command defines the specification rules to be used by the PTP alternate profile. The profile cannot be changed if there are any PTP ports or peers enabled and using the alternate profile; the ports or peers must first be shut down.
The no form of this command removes the profile configuration from the alternate profile.
no profile
configures the PTP alternate profile to follow the IEEE 1588-2008 specification rules
configures the PTP alternate profile to follow the C37.238-2017 specification rules
anno-rx-timeout number-of-timeouts
no anno-rx-timeout
config>system>ptp>clock
config>system>ptp>clock>ptp-port
This command defines the number of Announce timeouts that need to occur on a PTP slave port or boundary clock port in slave mode before communication messages with a master clock are deemed lost and the master clock is considered not available. One timeout in this context is equal to the Announce interval in seconds, calculated using the logarithm 2^log-anno-interval.
The no form of this command returns the configuration to the default value.
3
specifies the number of timeouts that need to occur before communication messages to a master clock are deemed lost and the master clock is considered not available
clock-mda mda-id
no clock-mda
config>system>ptp>clock
This command configures the adapter card slot that performs the IEEE 1588v2 clock recovery. On the 7705 SAR-M, 7705 SAR-H, 7705 SAR-Hc, 7705 SAR-A, 7705 SAR-Ax, and 7705 SAR-Wx, this slot is always 1/1. On the 7705 SAR-X, this slot is always either 1/2 or 1/3.
This command is only available when the clock-id parameter value is 1 to 16.
The no form of this command clears the clock recovery adapter card.
n/a
slot/mda
clock-type {ordinary {master | slave} | boundary | transparent-e2e}
no clock-type
config>system>ptp>clock
This command configures the type of clock. The no form of the command returns the configuration to the default (ordinary slave). The clock type can only be changed when PTP is shut down.
To enable transparent clock processing at the node level, configure a PTP clock with the transparent-e2e clock type. The transparent-e2e clock type is only available for a PTP clock that transmits and receives PTP messages using IPv4 encapsulation.
ordinary slave
configures the clock as an ordinary PTP master
configures the clock as an ordinary PTP slave
configures the clock as a boundary clock capable of functioning as both a master and slave concurrently
configures the clock as a transparent clock. This option is only used for a PTP clock that transmits and receives PTP messages using IPv4 encapsulation, and is only available for the following: 7705 SAR-M, 7705 SAR-A, 7705 SAR-Ax, 7705 SAR-Wx, and 7705 SAR-X.
domain domain-value
no domain
config>system>ptp>clock
This command defines the PTP device domain as an integer. A domain consists of one device or multiple PTP devices communicating with each other as defined by the protocol. A PTP domain defines the scope of PTP message communication, state, operations, datasets, and timescale. A domain is configured because it is possible that a deployment could require two PTP instances within a single network element to be programmed with different domain values.
The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.
0 when the profile is configured as ieee1588-2008, itu-telecom-freq, or iec-61850-9-3-2016
24 when the profile is configured as g8275dot1-2014
44 when the profile is configured as g8275dot2-2016
254 when the profile is configured as c37dot238-2017
specifies the PTP device domain value
[no] dynamic-peers
config>system>ptp>clock
This command allows a slave clock to connect to the master clock without the master being aware of it. Once connected, the master clock or boundary clock assigns the slave a PTP port and/or peer ID dynamically.
This command is only available when the clock-id parameter value is 1 to 16.
Dynamic peers are not stored in the configuration file. If a master clock with dynamic peers goes down and comes back up, the slave clocks renegotiate to it and are reassigned resources on the master clock or boundary clock.
The no form of this command disables dynamic peers. In this case, the user must manually program any slave peer clocks into the master clock or boundary clock in order for those clocks to accept those slaves.
no dynamic-peers
freq-source {ptp | ssu}
no freq-source
config>system>ptp>clock
This command specifies the administrative frequency source to use for the PTP clock. This selection influences the operational frequency source selected by the system for the PTP clock. If PTP is only used for time of day and the node SSU is being synchronized through a better frequency source externally (for example, through the external timing input port) or through line timing (for example, through a synchronous Ethernet or T1/E1 port), SSU may be configured as the frequency source for the PTP clock. This option allows PTP to use the SSU frequency where available.
This command is only available when the clock-id parameter value is 1 to 16.
The no form of the command returns the configuration to the default setting.
ptp
configures the PTP clock to use PTP as the frequency source
configures the PTP clock to use the SSU as the frequency source
local-priority priority
no local-priority
config>system>ptp>clock
config>system>ptp>clock>port
config>system>ptp>clock>ptp-port
This command configures the local priority used to choose between PTP masters in the best master clock algorithm (BMCA). If the PTP profile is set to ieee1588-2008 or itu-telecom-freq, this parameter is ignored. The priority of the port or local clock can only be configured if the PTP profile is set to g8275dot1-2014 or g8275dot2-2016. The value of the highest priority is 1 and the value of the lowest priority is 255.
The no form of this command returns the configuration to the default value.
128
specifies the local priority for choosing the PTP master for the BMCA
log-anno-interval log-anno-interval
no log-anno-interval
config>system>ptp>clock
config>system>ptp>clock>ptp-port
This command configures the Announce message interval used for unicast and multicast messages.
For unicast messages, this command defines the Announce message interval that is requested during unicast negotiation to any peer. This controls the Announce message rate sent from remote peers to the local node. It does not affect the Announce message rate that may be sent from the local node to remote peers. Remote peers may request an Announce message rate anywhere within the acceptable grant range.
For multicast messages on PTP Ethernet ports, this command configures the message interval used for Announce messages transmitted by the local node.
This value also defines the interval between executions of the BMCA within the node. To minimize BMCA-driven reconfigurations, the IEEE Std 1588-2008 recommends that the Announce message interval be consistent across the entire IEEE 1588 network. The Announce message interval cannot be changed unless PTP is shut down.
The log-anno-interval is calculated using the binary logarithm of the value of the interval in seconds before message reception. For example, for an Announce message interval of 8 packets/s (one packet every 0.125 seconds), set this field to log(base2) (0.125) = –3.
The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.
1 (1 packet every 2 s) when the profile is configured as ieee1588-2008
1 (1 packet every 2 s) when the profile is configured as itu-telecom-freq for a clock-id of 1 to 16 (this profile does not apply when the clock-id is csm)
–3 (8 packets/s) when the profile is configured as g8275dot1-2014 or g8275dot2-2016 (this profile does not apply when the clock-id is csm)
0 (1 packet/s) when the profile is configured as iec-61850-9-3-2016 or c37dot238-2017 and the clock-id is csm (these profiles do not apply when the clock-id is 1 to 16)
specifies the expected interval between the reception of Announce messages. This parameter is specified as the logarithm to the base 2, in seconds.
network-type {sdh | sonet}
no network-type
config>system>ptp>clock
This command determines whether to use SDH or SONET values for encoding synchronous status messages. This command only applies to synchronous Ethernet ports and is not configurable on SONET/SDH ports. This command is only available when the clock-id parameter is defined as csm.
sdh
specifies the values used are as defined in ITU-T G.781 Option 1
specifies the values used are as defined in ITU-T G.781 Option 2
port port-id [create]
no port port-id
config>system>ptp>clock
This command configures PTP over Ethernet on the physical port, so that PTP messages are sent and received over the port using Ethernet encapsulation. There are two reserved multicast addresses allocated for PTP messages (see Annex F of IEEE Std 1588- 2008 and the address command). Either address can be configured for the PTP messages sent through this port. The adapter card, module, or fixed platform containing the specified port cannot be deprovisioned while the port is configured for PTP. A port configured for dot1q or qinq encapsulation can be configured as the physical port for PTP over Ethernet. The encapsulation type and the Ethernet port type cannot be changed when PTP Ethernet multicast operation is configured on the port.
This command is only available when the clock-id parameter is defined as csm.
n/a
specifies the physical port in the format slot/mda/port
address {01:1b:19:00:00:00 | 01:80:c2:00:00:0e}
no address
config>system>ptp>clock>port
This command configures the MAC address to be used as the multicast destination MAC address for transmitted PTP messages. The IEEE Std 1588-2008 Annex F defines the two reserved addresses for PTP messages as:
01-1B-19-00-00-00 for all messages except peer delay messages
01-80-C2-00-00-0E for peer delay messages
The system accepts PTP messages received using either destination MAC address, regardless of the address configured by this command.
The no form of this command returns the address to the default value.
01:1b:19:00:00:00
log-delay-interval log-delay-interval
no log-delay-interval
config>system>ptp>clock>port
This command configures the minimum interval between multicast Delay_Req or PDelay messages for PTP with Ethernet encapsulation. This parameter is applied on a per-port basis and does not apply to peers. PTP slave ports use this interval unless the parent port indicates a longer interval. PTP master ports advertise this interval to external slave ports as the minimum acceptable interval for Delay_Req or PDelay messages from those slave ports. The 7705 SAR supports the IEEE 1588 requirement that a port in slave mode check the logMessageInterval field of received multicast Delay_Resp or PDelay messages. If the value of the logMessageInterval field for those messages is greater than the value configured locally to generate Delay_Req or PDelay messages, the slave port must use the longer interval for generating Delay_Req or PDelay messages.
The log-delay-interval is calculated using the binary logarithm of the value of the interval in seconds.
The log-delay-interval is only applicable when the clock-id is csm. For PTP with IP encapsulation (clock-id is 1 to 16), the value configured for the log-sync-interval is also used as the interval for Delay_Req or PDelay messages.
The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.
–6 when the profile is configured as ieee1588-2008
–4 when the profile is configured as g8275dot1-2014
0 when the profile is configured as iec-61850-9-3-2016 or c37dot238-2017
specifies the expected interval between the receipt of Delay_Req or PDelay messages
log-sync-interval log-sync-interval
no log-sync-interval
config>system>ptp>clock>port
config>system>ptp>clock>ptp-port
This command configures the interval between transmission of synchronization packets for a PTP port in a master state. For PTP with IP encapsulation (clock-id is 1 to 16), this value is also used as the interval for Delay_Req messages for this clock.
The no form of this command returns the configuration to the default value. The default value varies depending on the configuration of the profile command.
–6 when the profile is configured as ieee1588-2008
–6 when the profile is configured as itu-telecom-freq for a clock-id of 1 to 16 (this profile does not apply when the clock-id is csm)
–4 when the profile is configured as g8275dot1-2014 or g8275dot2-2016 (this profile does not apply when the clock-id is csm)
0 when the profile is configured as iec-61850-9-3-2016 or c37dot238-2017 and the clock-id is csm (these profiles do not apply when the clock-id is 1 to 16)
specifies the expected interval between the reception of synchronization messages
master-only{true | false}
config>system>ptp>clock>port
config>system>ptp>clock>ptp-port
This command prevents the local port from ever entering the slave state. This ensures that the 7705 SAR never draws synchronization from an attached external device.
This command only applies when the profile command is set to g8275dot1-2014 or g8275dot2-2016.
If the clock-type command is set to ordinary slave, the master-only value is set to false and cannot be changed. Similarly, if the clock-type command is set to ordinary master, the master-only value is set to true and cannot be changed.
true (when the PTP clock-type is set to boundary)
profile {primary | name}
config>system>ptp>clock>port
This command assigns the profile to be used for communications with the port or peer.
If primary profile is specified, the PTP port uses the profile configured by the profile command in the config>system>ptp>clock context. If an alternate profile name is specified, the PTP port uses the alternate profile configured by the profile command in the config>system>ptp>clock>alternate-profile context. The alternate profile must already be created.
primary
the system uses the primary profile configured in the config>system>ptp>clock context
specifies the name of an existing alternate profile to use
time-inaccuracy-override time-inaccuracy-override
no time-inaccuracy-override
config>system>ptp>clock>port
This command overrides the system-generated value for the PTP clock’s time inaccuracy with a specified value. The clock’s time inaccuracy value is added to the total time inaccuracy value in IEEE_C37_238 TLVs sent to downstream clocks in Announce messages. If there is no time inaccuracy override configured, the system uses 50 ns as the default for boundary clocks.
This command is applicable only for boundary clocks and only when the profile is configured as c37dot238-2017.
The no form of this command removes the time inaccuracy override value.
no time-inaccuracy-override
specifies the time inaccuracy of the PTP clock in nanoseconds, to be added to the total time inaccuracy in the IEEE_C37_238 TLV
priority1 priority-value
no priority1
config>system>ptp>clock
This command configures the first priority value of the local clock. This value is used by the BMCA 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.
When the profile command is set to g8275dot1-2014 or g8275dot2-2016, the priority1 value is set to the default value of 128 and cannot be changed.
The no form of the command returns the configuration to the default value.
128
specifies the priority1 value of the local clock
priority2 priority-value
no priority2
config>system>ptp>clock
This command configures the second priority value of the local clock. This value is used by the BMCA 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.
When the profile command is set to g8275dot1-2014 or g8275dot2-2016 and the clock-type is configured as ordinary slave, the priority2 value is set to the default value of 255 and cannot be changed.
The no form of the command returns the configuration to the default value.
128, when the clock type is configured as ordinary master or boundary
255, when the clock type is configured as ordinary slave
specifies the priority2 value of the local clock
profile {c37dot238-2017| iec-61850-9-3-2016 | ieee1588-2008 | itu-telecom-freq | g8275dot1-2014 | g8275dot2-2016}
no profile
config>system>ptp>clock
This command defines the specification rules to be used by PTP. Configuring the profile changes the BMCA and SSM/QL mappings to match the settings in the specification. The profile can only be changed when PTP is shut down. Changing the profile changes the domain to the default value of the new profile.
The no form of the command returns the configuration to the default setting.
ieee1588-2008
configures the PTP profile to follow the ITU G.8275.1 specification rules
configures the PTP profile to follow the ITU G.8275.2 specification rules; this option is only available when the clock-id parameter value is 1 to 16
configures the PTP profile to follow the IEEE 1588-2008 specification rules
configures the PTP profile to follow the ITU G.8265.1 specification rules; this option is only available when the clock-id parameter value is 1 to 16
configures the PTP profile to follow the IEC/IEEE 61850-9-3 specification rules; this option is only available when the clock-id parameter value is csm
configures the PTP profile to follow the C37.238-2017 specification rules; this option is only available when the clock-id parameter value is csm
ptp-port port-id
config>system>ptp>clock
This command configures an IEEE 1588v2 logical port in the system. It also enables the context to configure parameters for IEEE 1588v2. PTP ports are created when the clock type is set with the clock-type command.
This command is only available when the clock-id parameter value is 1 to 16.
When the clock type is set to ordinary slave, one port with 2 peers is created. When the clock type is set to ordinary master, one port with 50 peers is created. When the clock type is set to boundary clock, 50 ports each with 1 peer are created.
n/a
specifies the PTP port ID
peer peer-id
config>system>ptp>clock>ptp-port
This command enables the context to configure parameters associated with remote PTP peers such as grand master clocks.
For ordinary slave clocks, 2 peers are automatically created. For ordinary master clocks, 50 peers are automatically created. For boundary clocks, 1 peer per PTP port is automatically created.
The no form of the command removes the IP address from the PTP peer.
n/a
specifies the PTP peer ID
ip-address {ip-address | ipv6-address}
no ip-address
config>system>ptp>clock>ptp-port>peer
This command configures a remote PTP peer address and enables the context to configure parameters for the remote PTP peer.
Up to two remote PTP peers may be configured on a PTP port.
The no form of the command removes the IP address from the PTP peer.
n/a
specifies the IPv4 or IPv6 address of the remote peer
[no] unicast-negotiate
config>system>ptp>clock>ptp-port
This command specifies whether the slave clock is to initiate a unicast request to the master clock or wait for Announce and Synchronization messages from the master clock.
The no form of this command disables unicast-negotiate. In this case, the user must specify the slave clock information when configuring the 7705 SAR master node in order for communication between the slave clock and master clock to take place.
unicast-negotiate
source-interface ip-int-name
no source-interface
config>system>ptp>clock
This command defines the IP interface that provides the IEEE 1588 packets to the clock recovery mechanism on the adapter card or port. The interface must be PTP-enabled.
This command only applies when the clock-id parameter value is 1 to 16.
If the ip-int-name refers to a loopback or system address, the remote peer can send packets toward any network IP interface. If theip-int-name refers to an interface that is associated with a physical port or VLAN, the remote peer must send packets to ingress on that particular IP interface.
n/a
specifies the IP interface used by the PTP slave clock
[no] tx-while-sync-uncertain
config>system>ptp>clock
This command enables or disables the transmission of Announce messages to downstream clocks if the PTP network has not yet stabilized. In some cases, it may be important for a downstream boundary clock or slave clock to know whether the PTP network has stabilized or is still ‟synchronization uncertain”.
To indicate the synchronization certainty state, the synchronizationUncertain flag in the Announce message is set to TRUE if the clock is in a ‟synchronization uncertain” state and is set to FALSE if the clock is in a ‟synchronization certain” state.
However, because the synchronizationUncertain flag is newly agreed upon in standards, most base station slave clocks do not look at this bit. Therefore, in order to ensure that the downstream clocks are aware of the state of the network, the PTP clock may be configured to transmit Announce and Sync messages only if the clock is in a ‟synchronization certain” state. This is done using the no form of this command.
tx-while-sync-uncertain
[no] use-node-time
config>system>ptp>clock
This command determines whether the PTP clock will generate event messages based on system time.
The use-node-time command allows a router with a PTP master or boundary clock to distribute ToD/phase from the system time referenced from GNSS or another configured PTP clock. Note that a router with a single PTP clock configured as a boundary clock with multiple peers does not require use-node-time to enable ToD/phase distribution capability. For a 7705 SAR with an active GNSS receiver port, PTP boundary clocks in use-node-time mode will function similar to a grand master clock with GNSS traceability.
This command only applies to master or boundary clocks when:
no use-node-time
use-node-time when the profile for the master clock is configured as g8275dot1-2014