Configuring Synchronous Ethernet ESMC and SSM

Table 1. Feature History

Feature Name

Release Information

Feature Description

Synchronous Ethernet ESMC and SSM

 Cisco IOS XE Bengaluru 17.4.1

Effective Cisco IOS XE Bengaluru 17.4.1, the Cisco NCS 520 Ethernet Access Device support Synchronization Status Message (SSM) and Ethernet Synchronization Message Channel (ESMC) for synchronous ethernet clock synchronization.

Synchronous Ethernet is an extension of Ethernet designed to provide the reliability found in traditional SONET/SDH and T1/E1 networks to Ethernet packet networks by incorporating clock synchronization features.

Clock Selection Modes

The Cisco Router supports two clock selection modes, which are described in the following sections.

QL-Enabled Mode

In QL-enabled mode, the router considers the following parameters when selecting a clock source:

  • Clock quality level (QL)

  • Clock availability

  • Priority

QL-Disabled Mode

In QL-disabled mode, the router considers the following parameters when selecting a clock source:

  • Clock availability

  • Priority


Note
You can use override the default clock selection by using the commands described in Specifying a Clock Source and Disabling a Clock Source sections.

Managing Clock Selection

You can manage clock selection by changing the priority of the clock sources; you can also influence clock selection by modifying the following clock properties:

  • Hold-Off Time: If a clock source goes down, the router waits for a specific hold-off time before removing the clock source from the clock selection process. By default, the value of hold-off time is 300 ms.

  • Wait to Restore: The amount of time that the router waits before including a newly active synchronous Ethernet clock source in clock selection. The default value is 300 seconds.

  • Force Switch: Forces a switch to a clock source regardless of clock availability or quality.

  • Manual Switch: Manually selects a clock source, provided the clock source has a equal or higher quality level than the current source.

For more information about how to use these features, see the Specifying a Clock Source and Disabling a Clock Source sections.

Restrictions and Usage Guidelines

The following restrictions apply when configuring Synchronous Ethernet SSM and ESMC:

  • To use the network-clock synchronization ssm option command, ensure that the router configuration does not include the following:

    • Input clock source

    • Network clock quality level

    • Network clock source quality source (Synchronous Ethernet interfaces)

  • The network-clock synchronization ssm option command must be compatible with the network-clock eec command in the configuration.

  • To use the network-clock synchronization ssm option command, ensure that a network clocking configuration applied to the Sychronous Ethernet interfaces and timing port interfaces.

  • It is recommended that you do not configure multiple input sources with the same priority as the TSM (Switching message delay).

  • You can configure a maximum of two clock sources on interface modules.

Specifying a Clock Source

The following sections describe how to specify a synchronous Ethernet clock source during the clock selection process:

Selecting a Specific Clock Source

To select a specific interface as a synchronous Ethernet clock source, use the network-clock switch manual command in global configuration mode.


Note
The new clock source must be of higher quality than the current clock source; otherwise the router does not select the new clock source.

Command

Purpose 

network-clock switch manual  external  R0 


Router(config)# network-clock switch manual external r0 crc4

Manually selects a synchronization source, provided the source is available and is within the range. 

network-clock clear switch  {t0  | external  slot/card/port  [10m  | 2m
]}


Router(config)# network-clock clear switch t0

Disable a clock source selection.

Forcing a Clock Source Selection

To force the router to use a specific synchronous Ethernet clock source, use the network-clock switch force command in global configuration mode.


Note
This command selects the new clock regardless of availability or quality.

Command

Purpose 

network-clock switch force  external  R0  


Router# network-clock switch force r0

Forces the router to use a specific synchronous Ethernet clock source, regardless of clock quality or availability. 

network-clock clear switch  {t0  | external  slot/card/port  [10m  | 2m
]}


Router# network-clock clear switch t0

Disable a clock source selection.

Disabling Clock Source Specification Commands

To disable a network-clock switch manual or network-clock switch force configuration and revert to the default clock source selection process, use the network-clock clear switch command.

Command

Purpose

network-clock clear switch {t0 | external slot/card/port [10m | 2m ]} 


Router# network-clock clear switch t0

Disable a clock source selection.

Disabling a Clock Source

The following sections describe how to manage the synchronous Ethernet clock sources that are available for clock selection:

Locking Out a Clock Source

To prevent the router from selecting a specific synchronous Ethernet clock source, use the network-clock set lockout command in global configuration mode.

Command

Purpose 

network-clock set lockout   {interface  interface_name  slot/card/port  | external  R0 


Router(config)# network-clock set lockout interface GigabitEthernet 0/0/0

Prevents the router from selecting a specific synchronous Ethernet clock source. 

network-clock clear lockout  {interface  interface_name  slot/card/port  | external  R0 

Router(config)# network-clock clear lockout interface GigabitEthernet 0/0/0

Disable a lockout configuration on a synchronous Ethernet clock source.

Restoring a Clock Source

To restore a clock in a lockout condition to the pool of available clock sources, use the network-clock clear lockout command in global configuration mode.

Command

Purpose 

network-clock clear lockout  {interface  interface_name  slot/card/port  | external  external  R0 




Router(config)# network-clock clear lockout interface GigabitEthernet 0/0/0

Forces the router to use a specific synchronous Ethernet clock source, regardless of clock quality or availability.

Verifying the Configuration

You can use the following commands to verify your configuration:

  • show esmc—Displays the ESMC configuration.
  • show esmc detail—Displays the details of the ESMC parameters at the global and interface levels.
  • show network-clock synchronization—Displays the router clock synchronization state.
  • show network-clock synchronization detail—Displays the details of network clock synchronization parameters at the global and interface levels.

Troubleshooting

The table below list the debug commands that are available for troubleshooting the SyncE configuration on the Cisco Router:


Caution

We recommend that you do not use debug commands without TAC supervision.

Table 2. SyncE Debug Commands

Debug Command

Purpose 


debug platform network-clock

Debugs issues related to the network clock, such as alarms, OOR, active-standby sources not selected correctly, and so on. 


debug network-clock

Debugs issues related to network clock selection. 


debug esmc error

debug esmc event

debug esmc packet [interface <interface name>]

debug esmc packet rx [interface <interface name>]

debug esmc packet tx [interface <interface name>]

Verify the ESMC packets are transmitted and received with proper quality-level values.

The table below provides the information about troubleshooting your configuration.

Table 3. Troubleshooting Scenarios

Problem

Solution

Clock selection

  • Verify that there are no alarms on the interfaces using the show network-clock synchronization detail command.

  • Ensure that the nonrevertive configurations are in place.

  • Reproduce the issue and collect the logs using the debug network-clock errors, debug network-clock event, and debug network-clock sm commands. Contact Cisco Technical Support if the issue persists.

Incorrect QL values

  • Ensure that there is no framing mismatch with the SSM option.

  • Reproduce the issue using the debug network-clock errors and debug network-clock event commands.

Alarms

  • Reproduce the issue using the debug platform network-clock command. Alternatively, enable the debug network-clock event and debug network-clock errors commands.

Incorrect clock limit set or queue limit disabled mode

  • Verify that there are no alarms on the interfaces using the show network-clock synchronization detail command.

  • Use the show network-clock synchronization command to confirm if the system is in revertive mode or nonrevertive mode and verify the non-revertive configurations.

  • Reproduce the current issue and collect the logs using the debug network-clock errors, debug network-clock event, and debug network-clock sm commands.

Incorrect QL values when you use the show network-clock synchronization detail command.

  • Use the network clock synchronization SSM (option 1 |option 2 ) command to confirm that there is no framing mismatch. Use the show run interface command to validate the framing for a specific interface. For the SSM option 1, framing should be SDH or E1, and for SSM option 2, it should be T1.

  • Reproduce the issue using the debug network-clock errors and debug network-clock event commands.