OcNOS-SP : Timing and Synchronization Guide : Synchronous Ethernet Command Reference : SyncE Commands
SyncE Commands
This chapter describes the Synchronous Ethernet configuration commands:
• mode
1000Base-T mode
Use this command to set the 1000Base-T mode as master or slave. Applicable for broncos phy ports.
Use no form of this command to unset this configuration and set default value as auto
Command Syntax
1000Base-T (master|slave)
no 1000Base-T
Parameters
Master
Configure 1000Base-T mode to master
slave
Configure 1000Base-T mode to slave
Default
The default value is auto.
Command Mode
Interface Synchronous Ethernet mode
Applicability
This command was introduced in OcNOS version 4.1.
Example
(config)#interface ge1
(config-if)#
(config-if)#synce
(config-if-synce)#1000Base-T master
 
clock-selection mode
Use this command to set whether to use the Quality Level (QL) as a criteria when selecting a clock.
Use the no form of this command to set the QL to its default (ql-enabled).
Command Syntax
clock-selection mode (ql-enabled|ql-disabled)
no clock-selection
Parameters
ql-enabled
Use the quality level as a criteria when selecting a clock
ql-disabled
Do not use the quality level as a criteria when selecting a clock
Default
The default value is ql-enabled.
Command Mode
Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#synce
(config-synce)#clock-selection mode ql-enabled
 
(config-synce)#no clock-selection
 
clock-source-id
Use this command to set the clock source ID for Synchronous Ethernet interface.
Use the no form of this command to unset this value.
Note: Assign the same clock source ID if interfaces are connected to same clock source.
Command Syntax
clock-source-id <1-255>
no clock-source-id
Parameters
<1-255>
Clock Source ID.
Command Mode
Interface Synchronous Ethernet Mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#configure terminal
(config)#interface xe1
(config-if)#synce
(config-if-synce)#clock-source-id 1
debug synce
Use this command to turn on debugging.
Use the no form of this command to turn off debugging
Command Syntax
debug synce (event|recvd|trans|all)
no debug synce (event|recvd|trans|all)
Parameters
event
Enable event debugs
recvd
Enable receive debugs
trans
Enable transmit debugs
all
Enable all debugs
Command Mode
Exec mode and Privileged Exec mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#debug synce event
(config)#debug synce recvd
(config)#debug synce trans
(config)#no debug synce event
(config)#no debug synce recvd
(config)#no debug synce trans
dpll3-select
Use this command to select dpll3 as fixed input 10MHZ-IN.
Use no form of this command to unset this configuration.
Command syntax
dpll3-select 10mhz-in
no dpll3-select
Command Mode
Configure Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 4.0. Applicable only for UFI-S9500-30XS board.
Examples
(config)#synce
(config-synce)#dpll3-select 10mhz-in
hold-off
Use this command to set the hold-off time in milliseconds. The hold-off time ensures that short activation of signal fail is not passed to the selection process.
Use the no form of this command to set the default value (300 milliseconds).
Command syntax
hold-off <300-1800>
no hold-off
Parameters
<300-1800>
Hold-off time in milliseconds
Default
The default value is 300 milliseconds.
Command Mode
Interface Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
(config)#interface eth1
(config-if)#synce
(config-if-synce)#hold-off 500
 
(config-if-synce)#no hold-off
 
holdover
Use this command to set Synchronous holdover.
Use no form of this command to disable holdover.
Command Syntax
holdover (<0-1440>|)
no holdover
Parameters
<0-1440>
Synchronous holdover range in minutes.
Command Mode
Synchronous Ethernet Mode
Default
Default Synchronous holdover is 10 minutes.
Applicability
This command was introduced in OcNOS version 4.0. Applicable only for 10MHz out interface.
Example
#configure terminal
(config)#synce
(config-synce)#holdover 2
input-source
Use this command to set an input timing source. Synchronization packets are received from this source and sent to the clock selection algorithm.
Use the no form of this command to delete an input source.
Command Syntax
input-source <0-255>
no input-source
Parameters
<0-255>
Priority: 1 is the highest, 255 is the lowest; 0 means the source will not be considered by the clock selection algorithm
Default
The default value is 0 meaning the interface will not be considered by the clock selection algorithm.
Command Mode
Interface Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#interface eth1
(config-if)#synce
(config-if-synce)#input-source 1
 
mode
Use this command to configure the interface as synchronous or non-synchronous:
• Synchronous interfaces extract the frequency of their input signal from synchronization packets and passes them to their internal clocks.
• Non-synchronous interfaces do not participate in the synchronization process.
Use the no form of this command to set the mode to its default (non-synchronous).
Command Syntax
mode (synchronous | non-synchronous)
no mode
Parameters
synchronous
Synchronous mode
non-synchronous
Non-synchronous mode
Default
The default value is non-synchronous.
Command Mode
Interface Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#interface eth1
(config-if)#synce
(config-if-synce)#mode synchronous
 
(config-if-synce)#no mode
 
output-source
Use this command to use an Ethernet interface as a timing output source.
Use the no form of this command to stop using an Ethernet interface as a timing output source.
Command Syntax
output-source
no output-source
Parameters
None
Command Mode
Interface Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#interface eth1
(config-if)#synce
(config-if-synce)#output-source
 
quality-level
Use this command to set the quality level (QL) for the timing source.
Use the no form of this command unconfigure quality-level on a port.
Command Syntax
quality-level QL_VAL
no quality-level
Parameters
QL_VAL
Quality level. The quality level you can specify depends on setting of the synce-interface command. See ITU-T Rec. G.781 for details.
QL_PRC
Primary Reference Clock
QL_SSU_A
Types I or V slave clock
QL_SSU_B
Type VI slave clock
QL_SEC
SDH Equipment Clock
QL_DNU
Do not use this signal for synchronization
QL_STU
Synchronized – traceability unknown
QL_ST2
Traceable to stratum 2
QL_ST3E
Traceable to stratum 3E
QL_SMC
Traceable to SONET clock self timed
QL_PROV
Provisionable by the network operator
Command Mode
Interface Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
(config)#interface eth1
(config-if)#synce
(config-if-synce)#quality-level QL_PRC
 
synce (configure mode)
Use this command to configure Synchronous Ethernet.
This command changes the mode from configure mode to configure Synchronous Ethernet mode and initializes the global Synchronous Ethernet parameters.
Use no form of this command to disable synce.
Command Syntax
synce
no synce
Parameters
None
Command Mode
Configure mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#synce
(config-synce)
synce (interface mode)
Use this command to enable Synchronous Ethernet for an interface.
This command changes the mode from interface mode to interface Synchronous Ethernet mode.
This command does not automatically start synchronization distribution. You must explicitly give the mode command, specifying the synchronous option.
Use the no form of this command disable Synchronous Ethernet for an interface.
Command Syntax
synce
no synce
Parameters
None
Command Mode
Interface mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#interface eth1
(config-if)#synce
(config-if-synce)#
 
synce-interface
Use this command to enable Synchronous Ethernet for both GPS and 10MHz interfaces as input interfaces. This command changes the mode from interface mode to Synchronous interface Ethernet mode.
Use no form of this command to delete synce interface.
Note: Bits-e1 Applicable only for UFI-S9500-30XS, UFI-S9500-22XST, AS7316-26XB boards.
Note: Bits-t1 Applicable only for UFI-S9500-30XS, UFI-S9500-22XST boards.
Command Syntax
synce-interface (gps | 10mhz-in|ptp|bits-t1|bits-e1)
no synce-interface (gps | 10mhz-in|ptp |bits-t1|bits-e1)
Parameters
gps
Input interface as GPS
10mhz-in
Input interface as 10MHz
ptp
PTP interface as input-source
bits-t1
bits-t1 interface as input-source
bits-e1
bits-e1 interface as input-source
Command Mode
Interface mode
Applicability
This command was introduced in OcNOS version 4.0.
Example
(config)#interface eth1
(config-if)#synce-interface gps
(config-synce-if)#
 
(config)#synce-interface bits-t1
(config-synce-if)#
synchronization option
Use this command to set the synchronization option for the internal clock that is locked in frequency to an incoming signal.
Use the no form of this command to set the default synchronization option (1).
Command Syntax
synchronization option (1 | 2)
no synchronization option
Parameters
1
Networks optimized for the 2048 kbit/s hierarchy
2
Networks optimized for the 1544 kbit/s hierarchy that includes the rates 1544 kbit/s, 6312 kbit/s, and 44 736 kbit/s
Default
The default value is 1.
Command Mode
Configure Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Example
(config)#synce
(config-synce)#synchronization option 2
 
(config-synce)#no synchronization option
 
wait-to-restore
Use this command to set the wait-to-restore timer in minutes. The wait-to-restore time ensures that a synchronization source that previously failed is considered by the selection process again only if it is fault free for a certain time.
Use the no form of this command to set the default wait-to-restore time (5 minutes).
Command syntax
wait-to-restore <0-12>
no wait-to-restore
Parameters
<0-12>
Wait-to-restore time in minutes
Default
The default value is 5 minutes.
Command Mode
Interface Synchronous Ethernet mode
Applicability
This command was introduced before OcNOS version 1.3.
Examples
(config)#interface eth1
(config-if)#synce
(config-if-synce)#wait-to-restore 1
 
(config-if-synce)#no wait-to-restore