System Management Configuration Guide, Cisco Catalyst IE3x00 Rugged, IE3400 Heavy Duty, and ESS3300 Series Switches
System Management Configuration Guide, Cisco Catalyst IE3x00 Rugged, IE3400 Heavy Duty, and ESS3300 Series Switches
Describes the ability to troubleshoot and monitor PTP performance on a network with a Cisco IE Switch.
PTP serviceability is a troubleshooting and monitoring capability that
enables display of PTP message counters and error counters,
provides timestamp offset and mean path delay maximum and minimum values,
displays histogram of offset and mean path delay values, and
supports PTP alarms for network monitoring.
To display counter information for PTP messages sent and received on all interfaces, use the show ptp port counters messages command. To display counters for a specific interface, enter show ptp port counters messages interface .
NAT1# show ptp port counters messages
GigabitEthernet1/1
Transmit Receive
1680 Sync 47 Sync
15 Delay_Req 0 Delay_Req
0 Pdelay_Req 0 Pdelay_Req
0 Pdelay_Resp 0 Pdelay_Resp
1680 Follow_Up 47 Follow_Up
0 Delay_Resp 15 Delay_Resp
0 Pdelay_Resp_Follow_Up 0 Pdelay_Resp_Follow_Up
841 Announce 47 Announce
0 Signaling 0 Signaling
0 Management 0 Management
NAT2# show ptp port gi1/2 counters messages
GigabitEthernet1/2
Transmit Receive
0 Sync 7848 Sync
242 Delay_Req 0 Delay_Req
0 Pdelay_Req 0 Pdelay_Req
0 Pdelay_Resp 0 Pdelay_Resp
0 Follow_Up 7848 Follow_Up
0 Delay_Resp 242 Delay_Resp
0 Pdelay_Resp_Follow_Up 0 Pdelay_Resp_Follow_Up
0 Announce 3929 Announce
0 Signaling 0 Signaling
0 Management 0 Management
This table describes the command output.
Enter clear PTP port counters messages to clear the message counters for all interfaces.
To clear the counters for specific port, enter clear PTP port interface_name counters messages .
| Port |
The port type and number (for example, Gi1/3). |
| Transmit, Receive |
The direction of the data displayed in the table. |
| Sync |
Event message tagged with a timestamp when data packets reach or leave a port and used to synchronize ordinary and boundary clocks. |
| Delay_Req |
Delay request—Event message tagged with a timestamp when data packets reach or leave a port and used to synchronize ordinary and boundary clocks. |
| Pdelay_Req |
Peer delay request—Event message tagged with a timestamp when data packets reach or leave a port and used to measure the link delay in transparent clocks. |
| Pdelay_Resp |
Peer delay response—Event message tagged with a timestamp when data packets reach or leave a port and used to measure the link delay in transparent clocks. |
| Follow_Up |
General message (not tagged with a timestamp) used to synchronize ordinary and boundary clocks. |
| Delay_Resp |
Delay response—General message used to synchronize ordinary and boundary clocks. The time source conveys the timestamp t4 to the time recipient by embedding it in a Delay_Resp message. |
| Pdelay_Resp_Follow_Up |
Peer delay response follow up—General message (not tagged with a timestamp) used to measure the link delay in transparent clocks. |
| Announce |
General message (not tagged with a timestamp) used to establish a time source-time recipient hierarchy. |
| Signaling |
Message used to transport a sequence of one or more TLV entities. Signaling messages are transmitted from one clock to one or more other clocks. |
| Management |
Messages used to access attributes and to generate certain events defined in the PTP standard. |
PTP errors include field mismatch errors, unexpected messages, duplicate messages, and generic errors. To display counter information for PTP errors that occurred on all interfaces, use the show ptp port counters errors command. To display counters for a specific interface, enter show ptp port counters errors interface .
NAT2# show ptp port counters errors
GigabitEthernet1/1
0 Sanity check failed 0 Blocked port
0 Timestamp get failed 0 ParentId invalid
0 Vlan mismatch 0 GmcId invalid
0 Domain mismatch 0 SequenceId invalid
0 Sync fault 0 Unmatched Follow_Up
0 Duplicate Sync 0 Unmatched Delay_Resp
0 Duplicate Announce 0 Unmatched Pdelay_Resp
0 Send error 0 Unmatched Pdelay_Resp_Follow_Up
0 Misc error 0 Rogue master Sync
0 Rogue master Follow_Up 0 Rogue master Announce
NAT2# show ptp port gi1/2 counters errors
GigabitEthernet1/2
0 Sanity check failed 0 Blocked port
0 Timestamp get failed 0 ParentId invalid
0 Vlan mismatch 0 GmcId invalid
0 Domain mismatch 0 SequenceId invalid
0 Sync fault 0 Unmatched Follow_Up
0 Duplicate Sync 0 Unmatched Delay_Resp
0 Duplicate Announce 0 Unmatched Pdelay_Resp
0 Send error 0 Unmatched Pdelay_Resp_Follow_Up
0 Misc error 0 Rogue master Sync
0 Rogue master Follow_Up 0 Rogue master Announce
The command output is described in the table below.
Enter clear ptp port counters errors to clear the error counters for all interfaces.
To clear the error counters for specific port, enter clear ptp port interface_name counters errors .
| Port |
The port type and number. |
| Sanity check failed |
The PTP message header field(s) of ingress PTP packets are invalid. |
| Timestamp get failed |
The timestamp for PTP messages is generated by the hardware. The timestamp error counter is incremented when the software is unable to fetch the timestamp for a given PTP message. The PTP messages that have a timestamp are SYNC, Delay_Req, Pdelay_Req, and Pdelay_Resp. |
| VLAN mismatch |
The VLAN ID of ingress PTP messages is different from the VLAN ID configured in the ptp vlan command. |
| Domain mismatch |
(Applicable only in Boundary Clock mode) The domain number field of ingress PTP messages is different from the configured PTP clock domain (the PTP domain number configured in the ptp domain command). |
| SYNC fault |
The PTP clock offset value has exceeded the "SYNC limit" value configured on the PTP time recipient port (the value configured for ptp sync limit on the interface, which is in the PTP SLAVE state). |
| Duplicate SYNC |
The number of duplicate PTP SYNC messages received by the switch. (Duplicates are identified by checking the PTP sequence number on received messages.) |
| Duplicate announce |
The number of duplicate PTP Announce messages received by the switch. (Duplicates are identified by checking the PTP sequence number on received messages.) |
| Send error |
The number of PTP messages that could not be sent due to failures. PTP software might fail to send PTP messages due to reasons such as memory allocation failure, failure to obtain the correct outgoing interface information, etc. |
| Misc error |
The number of miscellaneous errors that have occurred in the PTP protocol. Any error other than the ones listed above is classified as a miscellaneous error. |
| Rogue master Follow_Up |
The number of dropped incoming follow up messages for rogue packets. |
| Blocked port |
The PTP messages (except Peer-Delay messages) are received on REP/STP blocked ports. |
| ParentId invalid |
(Applicable only in Boundary Clock mode) The source port identity of ingress PTP messages is different from parent port identity of the local PTP clock. |
| GMCId invalid |
(Applicable only in Boundary Clock mode) The grandmaster clock identity of ingress announce messages has an invalid value (the grandmaster clock identity of ingress announce messages is the same as the clock identity of the local PTP clock). |
| SequenceId invalid |
(Applicable only in Boundary Clock mode) The sequence ID field of ingress PTP messages has an invalid value (the sequence ID of the follow-up message is different from the sequence ID of the preceding SYNC message). |
| Unmatched Follow_Up |
The switch received a Follow up message when there was no outstanding SYNC message for which it expected a Follow up. |
| Unmatched Delay_Resp |
Unmatched Delay Response—The switch received a Delay Response without sending a Delay Request. |
| Unmatched Pdelay_Resp |
Unmatched Peer Delay Response—The switch received a Peer Delay Response message without sending a Peer Delay Request. |
| Unmatched Pdelay_Resp_Follow_Up |
Unmatched Peer Delay Response Follow up—The switch received a Peer Delay Response Follow up message without sending a Peer Delay Request. |
| Rogue master SYNC |
The number of dropped incoming SYNC messages for rogue packets. |
| Rogue master Announce |
The number of dropped incoming Announce messages for rogue packets. |
The PTP offset value is the measured offset of the clock from the time source clock, in nanoseconds. The mean path delay is the average time, in nanoseconds, taken by PTP frames to travel between time source and time recipient. You can display the historical maximum and minimum values for the offset from the time source and mean path delay when the switch operates in GMC-BC (Grandmaster Boundary Clock) or BC (Boundary Clock) modes. You can also display a histogram of offset, delay, and time errors, where the historical values of the field specified are divided into bins to show the data distribution.
High offset and delay values can indicate a problem. For example, these values may increase when a device goes down in the network and the link to the time source is available but not viable. Ideally, offset and delay values should be as small as possible. Some PTP modes or profiles might cause higher offset values. Offsets can be negative.
Offset and delay values are shown for these periods: the last day, the past 5 seconds, 15 seconds, 1 minute, 5 minutes, 15 minutes, 1 hour, 5 hours, 15 hours, 1 day (same as last day), 5 days, 15 days, and more than fifteen days.
If the switch is the time source or grandmaster clock, these values are zero.
The commands to show historical maximum and minimum values for the offset from time source and mean path delay are supported for both PTP Default Profile and Power Profile.
The commands to show time error data apply to p2ptransparent or e2etransparent clock modes.
To display the historical maximum and minimum values for the mean path delay, enter show PTP history delay , as shown in this example:
NAT1#sh ptp history delay
5 seconds 15 seconds 1 minute 5 minutes
Max mean path delay(ns): 0 0 0 0
Min mean path delay(ns): 0 0 0 0
15 minutes 1 hour 5 hours 15 hours
Max mean path delay(ns): 0 0 0 0
Min mean path delay(ns): 0 0 0 0
1 day 5 days 15 days >15 days
Max mean path delay(ns): 12154 12154 12154 12154
Min mean path delay(ns): 0 0 0 0
NAT1#
To display the historical maximum and minimum values for time error data when the clock mode is p2ptransparent or e2etransparent, enter show PTP history time-error , as shown in this example:
NAT2#sh ptp history time-error
5 seconds 15 seconds 1 minute 5 minutes
Max time error(ns): 0 0 0 0
Min time error(ns): -35260 -36487 -36487 0
15 minutes 1 hour 5 hours 15 hours
Max time error(ns): 0 0 0 0
Min time error(ns): 0 0 0 0
1 day 5 days 15 days >15 days
Max time error(ns): 0 0 0 0
Min time error(ns): 0 0 0 0
NAT2#
To display a histogram of PTP offset, delay, or time-error data, enter the show ptp histogram [delay|time-error] command. Data is shown for the last 60 seconds, the last hour, and the last 24 hours. Values are divided into ranges of 0 to 20 nanoseconds, 20 to 50 nanoseconds, 50 to 100 nanoseconds, 100 to 250 nanoseconds, 250 to 500 nanoseconds, 500 to 1000 nanoseconds, 1000 to 10,000 nanoseconds, and greater than 10,000 nanoseconds. Offset and time-error values are further classified as negative or positive.
Offset—Available when the clock mode is boundary; displays histogram for offset from time source.
Delay—Available when the clock mode is boundary or GMC-boundary; displays histogram of mean path delay data.
Time-error—Available when the clock mode is p2ptransparent or e2etransparent; displays histogram of data for time-error (frequency error * residence time).
This example shows the histogram for time error data.
NAT2#sh ptp histogram time-error
Time Error (in nanoseconds)
Last 60 seconds:
286 270 264 240 211 201 172
137 129 105 83 38 -5 -48
-69 -97 -148 -208 -229 -266 -336
-357 -427 -451 -500 -567 -664 -705
-772 -840 -910 -1022 -1071 -1165 -1262
-1435 -1489 -1592 -1757 -1836 -1969 -2199
-2263 -2498 -2578 -2735 -3013 -3106 -3311
-3509 -3718 -3936 -4183 -4596 -4729 -5020
-5338 -5650 -6121 -6282
Time Error range Positive Negative
---------------- -------- --------
0-20ns 0 1
20-50ns 1 1
50-100ns 1 2
100-250ns 7 3
250-500ns 3 6
500-1us 0 6
1-10us 0 29
>10us 0 0
Last 60 minutes:
-208 -3106 -16704 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0
Time Error range Positive Negative
---------------- -------- --------
0-20ns 57 0
20-50ns 0 0
50-100ns 0 0
100-250ns 0 1
250-500ns 0 0
500-1us 0 0
1-10us 0 1
>10us 0 1
Last 24 hours:
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0 0 0 0 0
0 0 0
Time Error range Positive Negative
---------------- -------- --------
0-20ns 24 0
20-50ns 0 0
50-100ns 0 0
100-250ns 0 0
250-500ns 0 0
500-1us 0 0
1-10us 0 0
>10us 0 0
NAT2#
Enter clear ptp history to clear the offset, delay, and time error historical statistics.
Enter clear ptp histogram to clear the offset, delay, and time error histogram statistics.
Commands that you can use to debug PTP are listed in this table.
| debug ptp messages [message-type] |
Enables debugging of PTP messages. You can specify message-type to filter out the logs based on the PTP message type:
|
| debug ptp error |
Enables debugging of PTP errors. |
| debug ptp bmc |
Enables debugging of the PTP Best Master Clock Algorithm. |
| debug ptp event |
Enables debugging of PTP state event. |
PTP alarms are system notifications that help you manage and monitor PTP on the switch by alerting you to specific events or state changes related to PTP operation. PTP alarms:
can be configured to trigger external alarm relay outputs and send system messages to a syslog server.
are raised only once for the first 5-minute interval after bootup and subsequently once every 30 minutes.
are disabled by default and are damped during continuous state changes such as port or parent flapping.
PTP alarm monitoring starts 5 minutes after bootup. The alarm is raised only once for the first 5-minute interval and subsequently once for an interval of 30 minutes. Alarms are damped when there is continuous state change, such as PTP port state flapping or PTP parent flapping.
This table describes the types of PTP alarms:
| Alarm |
Alarm Type |
Clock Mode Supported |
Description |
|---|---|---|---|
| PTP SLAVE port state change |
Minor |
Boundary and transparent clock modes |
This alarm is raised when the PTP port state changes from “SLAVE” to any of the following PTP port states: Initializing, Faulty, Disabled, Listening, Pre_Master, Master, Passive, or Uncalibrated. A system message is generated when the PTP port state transitions between Slave and Passive Slave. This alarm remains raised until you clear the alarm. |
| PTP PASSIVE_SLAVE port state change |
Minor |
Boundary and transparent clock modes |
This alarm is raised when the PTP port state changes from “PASSIVE-SLAVE” to any of the following PTP port states: Initializing, Faulty, Disabled, Listening, Pre_Master, Master, Passive, or Uncalibrated. A system message is generated when the PTP port state transitions between Slave and Passive Slave. |
| PTP Parent change |
Minor |
Boundary clock mode |
This alarm is raised when there is a change in PTP parent. This alarm remains raised until you clear the alarm. |
| PTP Time Property Clock Synchronized |
Minor |
Transparent clock mode |
This alarm is raised when the PTP Clock Time Property “Clock Syntonized” field changes from TRUE to FALSE. This alarm is cleared when the “Clock Syntonized” field changes from FALSE to TRUE. |
To enable and configure the global PTP alarms:
| 1. | Use the enable command to enable the privileged EXEC mode. Example:Enter your password if prompted. |
|
| 2. | Use the configure terminal command to enter global configuration mode. Example: |
|
| 3. | Use the alarm facility ptp enable command to enable PTP alarms. Example: |
|
| 4. | Use the alarm facility ptp notifies command to enable notifications to be sent to an SNMP server. Example: |
|
| 5. | Use the alarm facility ptp relay major command to configure the association of PTP alarms to a relay. Example: |
|
| 6. | Use the alarm facility ptp relay major command to send PTP alarm traps to a syslog server. Example: |
Switch# configure terminal
Switch(config)# alarm facility ptp enable
Switch(config)# alarm facility ptp syslog
Switch(config)# end
Switch# show alarm settings
…..
…..
…..
PTP
Alarm Enabled
Relay MIN
Notifies Enabled
Syslog Enabled
Switch# show facility-alarm status
Source Severity Description Relay Time
Switch MINOR 32 PTP Clock Parent change NONE Mar 09 2022 01:23:45
GigabitEthernet1/0/21 MINOR 5 PTP SLAVE port state changed NONE Mar 09 2022 01:23:45
GigabitEthernet1/0/21 MINOR 6 PTP PASSIVE_SLAVE port state chan NONE Mar 09 2022 01:23:45