0% found this document useful (0 votes)
2K views

OSA 5401 User Manual 12.1.1

Uploaded by

ammazork
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
2K views

OSA 5401 User Manual 12.1.1

Uploaded by

ammazork
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 157

User Manual

OSA 5401 Syncplug™

Product Release: 12.1.1


Document Issue: A
Document Number: 80000072503
Oscilloquartz: An ADVA Company

Copyright © 2001-2023 Oscilloquartz: An ADVA Company


All rights reserved. Hardware and software mentioned in this document includes software developed by
Oscilloquartz: An ADVA Company ("Oscilloquartz: An ADVA Company"), the Apache Software Foundation
(http://www.apache.org), Teodor Danciu (http://jasperreports.sourceforge.net), and/or other open source
software.

libnetconf - Copyright and Permission Notice


Copyright (c) 2012-2014 CESNET, z.s.p.o.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the Company nor the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written permission.

This software is provided "as is", and any express or implied warranties, including, but not limited to, the
implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the
company or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential
damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or
profits; or business interruption) however caused and on any theory of liability, whether in contract, strict
liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if
advised of the possibility of such damage.

Patents
The content described in this document may be covered by patents or pending patent applications of
Oscilloquartz: An ADVA Company. The furnishing of this document does not give you any license to these
patents.

Disclaimers
Nothing in this document shall be construed as granting any license or rights with respect to its content or the
patents and trademarks mentioned above. The content of this document may include technical inaccuracies or
typographical errors, and is subject to change at any time without notice. Reliance on this content is at the
relying party's sole risk and will not create any liability or obligation for Oscilloquartz: An ADVA Company. Any
references in this document to publications and/or Internet sites that are not from Oscilloquartz: An
ADVA Company are provided for convenience only and do not in any manner serve as an endorsement of
those publications and/or Internet sites. The materials within those publications and/or Internet sites are not
part of the materials for any Oscilloquartz: An ADVA Company information, product, or service, and use of
those publications and/or Internet sites is at your own risk.

THE CONTENT OF THIS DOCUMENT IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ADVA OPTICAL NETWORKING, ITS AFFILIATES,

OSA 5401 R12.1.1 User Manual - Issue: A 2


Oscilloquartz: An ADVA Company

EMPLOYEES, OFFICERS OR ITS SUPPLIERS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND BASED ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
DOCUMENT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE SAME APPLIES FOR ANY
HARDWARE OR SOFTWARE COVERED BY THIS DOCUMENT, UNLESS A SIGNED AGREEMENT WITH ADVA
OPTICAL NETWORKING OR THE APPLICABLE PRODUCT LIABILITY LAW EXPRESSLY STATES OTHERWISE.

Oscilloquartz: An ADVA Company


Fraunhoferstr. 9a
82152 Martinsried/Muenchen
Germany
Phone +49(0)89-890665-0
Fax +49(0)89-890665-699
http://www.adva.com

OSA 5401 R12.1.1 User Manual - Issue: A 3


Contents
Contents 4

About This Guide 9


Documentation 10
Related Documentation 10
Accessing Documentation 10
Documentation Feedback 10
Obtaining Technical Assistance 11
Customer Portal 11
Technical Services 11
Contact ADVA Optical Networking 11
Safety Symbol and Message Conventions 13

Overview 15
Applications in Your Network 17
Versatile Deployment Options 17
Physical Description 17
OSA 5401 Syncplug™ 19
Physical Dimensions 20
SFP Interface 21
LED Indicator 21
Default Settings 22

Installing OSA 5401 Syncplug™ 23


Getting Started 23
Safety Precautions 24
Site Planning 25
Kit Contents 25
Roof Antenna Kits 26
Magnetic Antenna with 5m Cable 30
Lightning Protector Kit (EMP Kit) 32
Connection Cables 33
Materials Required 34
Inserting OSA 5401 Syncplug™ into a Hosting Device 35
Installing Optional Accessories 35

OSA 5401 R12.1.1 -User Manual - Issue: A 4


Oscilloquartz: An ADVA Company Contents

RF Antenna Installation 35
Roof Installation 37
Lightning Protection Installation 40

Upgrading the Software 43


Upgrading with SCP 44
Upgrading with TFTP 46

Provisioning Connectivity 47
Connecting to the OSA 5401 47
SSH Key Exchange Algorithm 49
Configuring Multi-Level User Access 49
Configuring IP Addresses and VLANs 51
DHCP4 and DHCP6 on Management Interface 51
IPv6 Routing 52
Default IP Address and VLAN Configuration 53
Changing IP Addresses and VLANs using CLI Commands 54
Configuring the IP Priority 56
Configuring Management Access Control List 57
Pinging an IP Address 58
Editing the Security Banner 58

Managing the OSA 5401 59


Resetting IPs, Usernames, and Passwords 60
Enabling/Disabling LEDs 61
Configuring Time-of-Day 61
Configuring Daylight Saving Time 61
Configuring Alarms and Events 62
Alarm Profile Notification Codes 63
Built-In Alarms 64
Built-In Events 67
Viewing Alarms and Events 67
Viewing the Alarm and Event History Log 67
Viewing Active and Supported Alarms 68
Assigning a New Alarm Notification Code 70
Configuring Synchronization 71
Viewing the Clock Reference Priorities 71
Configuring GNSS Clock Reference 72
Disabling a GNSS Clock Reference 73
Defining the RF Antenna Cable Delay 73

OSA 5401 R12.1.1 User Manual - Issue: A 5


Oscilloquartz: An ADVA Company Contents

Setting the GNSS Mode 73


Setting the GNSS Augmentation Mode 74
Setting Satellite Minimum 1 and Minimum 2 Thresholds 74
Setting GNSS Dynamic Mode 75
Setting Elevation and SNR Masks 75
Configuring GNSS Location Mode 76
Configuring GNSS Time Advance 77
Configuring GNSS Failure Suspension 77
Forcing the GNSS Antenna State to Connected 78
Configuring a Backup Clock for the GNSS 78
Configuring PTP Profiles 79
Configuring Master Clocks 80
Configuring Priority1 Values 80
Configuring Priority2 Values 81
Configuring Delay Asymmetry Compensations 81
Configuring Best Master Clock Algorithm for Master Clocks 82
Configuring Layer 2 PTP Master Clocks 82
Additional Layer 2 PTP Configuration Commands 83
Configuring Layer 3 PTP Master Clocks 83
Enabling Multicast Mode 84
Viewing Dynamic Remote Slaves 84
Additional Layer 3 PTP Configuration Commands 84
Configuring PTP Boundary Clocks 85
Configuring a Static L3 PTP Slave Entry 85
Configuring PTP Slave Clocks 86
Configuring Best Master Clock Algorithm for Slave Clocks 86
Configuring Layer2 PTP Slave Clocks 86
Enabling Layer 2 PTP Slave Clocks 87
Viewing the Layer 2 PTP Slave Clock Status 87
Configuring a Forwardable or Non-Forwardable Destination MAC Address 88
Configuring Layer 2 End-to-End Delay Asymmetry Compensation 88
Configuring Clock Mode 89
Configuring SyncE Assist Mode 89
Configuring Layer 3 PTP Slave Clocks 89
Defining Layer 3 PTP Modes 89
Configuring Delay Mechanism 90
Configuring Clock Mode 90
Configuring Requested Packet Rates 90
Configuring Acceptable Master Clocks and Delay Asymmetry 91

OSA 5401 R12.1.1 User Manual - Issue: A 6


Oscilloquartz: An ADVA Company Contents

Configuring Algorithm Mode 91


Configuring Local Priority 91
Configuring SyncE Assist Mode 92
Configuring SyncE Mode 92
Configuring NTP, TIME, and DAYTIME Servers 92
Configuring Syncjack™ 92
Syncjack Functions 93
Parallel Probing Setup 94
Probing a Third-Party Master Port 96
Active Probing of the Network 96
Configuring Raw Data Collection 97
Configuring Clock Probes for Clock Accuracy 98
Configuring PTP Clock Probes for Clock Analysis 100
Understanding Different PTP Clock Probes 101
Viewing Clock Probe Statuses 102
Backing Up and Restoring the Configuration File 103
Using CLI Configuration Files 104
Link Layer Discovery Protocol 105
ENC Network Manager Support 108
Initializing Service Time Counters 108
Viewing Ethernet Port Counters 109
Configuring Expected Clock Class 110
Configuring Holdover Time 110
Configuring CLK Port 111

Troubleshooting 112
Managing Faults using PTP Announce Messages 112

CLI Command Definitions 113


Command Tree 113
Global commands 120
Clock Type Configuration 123
L2 Master Configuration 124
L3 Master Configuration 126
GNSS Configuration 128
Primary IP Host Configuration 130
Port Configuration 131
System Configuration 132
SSH 133

OSA 5401 R12.1.1 User Manual - Issue: A 7


Oscilloquartz: An ADVA Company Contents

SNMP 135
SYSLOG 137
Radius 138
Alarms 139

Technical Specifications 140


PTP Features 141
PTP Master Modes of Operation 141
PTP Slave Modes of Operation 142
Ethernet Interface 142
Synchronous Ethernet (SyncE) 142
NTP Server 143
GNSS Receiver 143
OSA 5405-I External Antenna 144
Programmable Inputs and Outputs 144
Internal Oscillator 144
LED Indications 145
Management and Security 145
Regulatory and Standards Compliance 146
Power Consumption 146
Mean Time Between Failures 146
Environmental 147
Optional Accessories 147

Supported CLI and File Transfer Applications 148

Supported PTP Profiles and Parameters 149


L2 PTP Telecom Profiles 150
L2 PTP Power Profiles 151
L2 PTP Audio/Video Broadcasting and Automotive Systems Profile 152
L3 PTP Telecom Profiles 153
L3 PTP Broadcast Profiles 155

LAN Connector Pin Assignments 156

Mapping between Clock Classes and ESMC 157

OSA 5401 R12.1.1 User Manual - Issue: A 8


About This Guide
This guide details the installation and configuration instructions for the OSA 5401
Syncplug™ product: indoor unit.

When you configure the OSA 5401 Syncplug™ with a Network


Management System (NMS), we recommend to configure the NMS before
you complete the installation and configuration of the device. When you
use the ADVA ENC Network Manager, ensure the installation is configured
as explained in the ENC Network Manager Administrator Manual.

When you use a different NMS, perform the integration separately and use
the OSA 5401 Syncplug and OSA 5405 SyncReach SNMP User Guide as
reference.

OSA 5401 R12.1.1 -User Manual - Issue: A 9


Documentation
Related Documentation 10

Accessing Documentation 10

Documentation Feedback 10

Related Documentation
l OSA 5401 Syncplug and OSA 5405 SyncReach SNMP User Guide
l ENC Network Manager Administrator Manual

Accessing Documentation
Documentation Portal https://advadocs.com/

Documentation Feedback
We want our documentation to be as helpful as possible. Feedback is always welcome.

Email [email protected]
Mail ADVA Optical Networking SE
Technical Documentation
98617 Meiningen-Dreissigacker
Germany

OSA 5401 R12.1.1 -User Manual - Issue: A 10


Obtaining Technical Assistance
Product Maintenance Agreements and other customer assistance agreements are available
for Oscilloquartz: An ADVA Company products through your Oscilloquartz: An
ADVA Company distribution channel. Our service options include:

l 24 x7 telephone support
l Web-based support tools
l On-site support
l Technical training, both on-site and at ADVA facilities in Germany and the USA
l Expedited repair service
l Extended hardware warranty service

Customer Portal
You can use the customer portal to:

l Access company information and resources 24 x 7.


l Find information specific to your requirements, such as networking solutions,
services, and programs.
l Resolve technical issues by using online support services.
l Download and test software packages.
l Order ADVA Optical Networking training materials.

Access portal.advaoptical.com
Questions [email protected]

Technical Services
Technical services are available to customers who need technical assistance with an
Oscilloquartz: An ADVA Company product that is under warranty or covered by a
maintenance contract.

Online contact.advaoptical.com
Email [email protected]

Contact ADVA Optical Networking


ADVA Optical Networking Europe, Middle East and Africa
Martinsried/Munich, Germany

OSA 5401 R12.1.1 -User Manual - Issue: A 11


Oscilloquartz: An ADVA Company About This Guide

+49 (0)89 89 06 65 0

ADVA Optical Networking America


Norcross, GA, USA
+1 678 728 8600

ADVA Optical Networking Asia


Shenzhen, China
+86 755 8621 7400

http://www.advaoptical.com

OSA 5401 R12.1.1 User Manual - Issue: A 12


Oscilloquartz: An ADVA Company About This Guide

Safety Symbol and Message


Conventions
You will see these symbols throughout the documentation. All personnel should correctly
follow and not ignore any safety instructions.

Icon Meaning Description


Warning Means danger and alerts you to a situation that
could cause bodily injury. Before you work on any
equipment, be aware of the hazards involved and
be familiar with standard practices for preventing
accidents.
Electric Voltage Means danger and alerts you to risks caused by
Warning electricity that could result in death or serious
injury. Before you work on any equipment, be
aware of the hazards involved with electrical
circuitry and be familiar with standard practices for
preventing accidents.
Caution Alerts you to a potentially hazardous situation or
condition that may result in minor or moderate
injury.
Lifting Hazard Indicates a potentially hazardous situation or
Caution condition that may result in a personal injury or
damage to equipment due to the weight of an
object.
Skin Burn Caution Indicates the risk of possible skin burns. When
working with system components, be aware of
proper handling procedures.
Electrostatic Indicates the possibility of equipment damage due
Caution to electrostatic discharge (ESD). If the ESD-
prevention instructions are ignored or not followed
correctly, damage can occur.
Notice Indicates the risk of equipment damage,
malfunction, process interruption, or negative
impacts on surroundings.

OSA 5401 R12.1.1 User Manual - Issue: A 13


Oscilloquartz: An ADVA Company About This Guide

Icon Meaning Description


Documentation Advises of the importance of carefully reading all
instructions before proceeding or provides links to
additional information to read. Failure to do so may
result in personal injury or damage to equipment.
Waste Disposal Points out the importance of properly disposing of
Alert waste electrical or electronic equipment and its
components. Disregard of the instruction can
threaten the environment.
Note Indicates supplemental information or helpful
recommendations.

OSA 5401 R12.1.1 User Manual - Issue: A 14


Chapter 1

Overview
The OSA 5401 Syncplug™ small-form factor pluggable (SFP) delivers accurate and
affordable small-cell GNSS-based synchronization in the most space-restrictive
environments. The OSA 5401 provides a cost-effective migration path to deploy robust
phase and frequency synchronization near the network network edge. It offers flexible
deployment through integration into existing network elements.The timing-optimized,
dual-frequency GNSS receiver achieves excellent performance, even in urban canyons.
Design and network redundancy techniques provide resilience against local GNSS
congestion.

This resilience is achieved by the use of a built-in GNSS receiver for the Primary Reference
Time Clock (PRTC) and IEEE 1588v2 grandmaster (GM), boundary (BC), and slave clock (SC)
functionality. The OSA 5401 is compliant with the SFP multi-source agreement (MSA), and
additional space and power are unnecessary. In the event of a GNSS outage, multiple
fallback options are available such as a high-end Stratum 3E oscillator, SyncE, and Precision
Time Protocol (PTP). The OSA 5401 provides the decoupling of network element
development from GNSS receiver implementation. In addition, the Original Equipment
Manufacturer (OEM) product customization option for vendor branding is available. This
figure shows an example configuration.

OSA 5401 R12.1.1 -User Manual - Issue: A 15


Oscilloquartz: An ADVA Company Overview

OSA 5401 R12.1.1 User Manual - Issue: A 16


Oscilloquartz: An ADVA Company Overview

Applications in Your Network


These are the supported radio access network synchronization applications:

l Aggregation switch upgrades for delivering precise frequency and phase


synchronization through Layer 2 PTP, Layer 3 PTP, and SyncE.
l Additional timing resiliency and GNSS jamming protection at the radio base station
side.
l GNSS receiver upgrade for small cells and legacy 2G or 3G radio base station
equipment.
l The ability of the PTP boundary and slave clock to connect to existing network
elements, such as switches and microwaves.
l Low-touch provisioning and extended operating temperature range for maximum
deployment flexibility and simplified operations.
l PTP-to-Sync-E and Sync-E-to-PTP conversion.

Versatile Deployment Options


Specific deployment scenarios include:

l Small cell
l LTE
l LTE-TDD
l LTE-A
l 4G networks

The OSA 5401 also provides a cost-effective upgrade solution for legacy 2G and 3G
networks that support SDH replacement scenarios. The OSA 5401 functions as a
synchronous Ethernet source, as well as Grand Master, Boundary, and Slave Clock
functionality. It conforms to the IEEE1588 2008 PTP standard and the relevant industry
profile specifications. While the OSA 5401 supports the ITU-T telecoms profiles, it can also
support profiles from other industries.

Physical Description
The complete physical description of the OSA 5401 Syncplug™ is described in this section.
For a complete description of the technical specifications, see Technical Specifications.

OSA 5401 Syncplug™ 19

OSA 5401 R12.1.1 User Manual - Issue: A 17


Oscilloquartz: An ADVA Company Overview

Physical Dimensions 20

SFP Interface 21

LED Indicator 21

OSA 5401 R12.1.1 User Manual - Issue: A 18


Oscilloquartz: An ADVA Company Overview

OSA 5401 Syncplug™


You install the OSA 5401 by plugging it into an SFP socket of the hosting device, such as a
switch or a router. The front panel of the device contains:

l Connectors:
o PPS/CLK: PPS and Clock Out monitoring point for testing the clock quality and

synchronization.
o GNSS: External GNSS RF antenna.
l LED indicator: GNSS operations and general fault indication status.
l Handle: To remove the OSA 5401 from the SFP socket.

See Figure 1.

For more information abouton the LED, see LED Indicator.

Figure 1: OSA 5401 Syncplug™ Connectors with LEDs

OSA 5401 R12.1.1 User Manual - Issue: A 19


Oscilloquartz: An ADVA Company Overview

Physical Dimensions
Figure 2: OSA 5401 Physical Dimensions

OSA 5401 R12.1.1 User Manual - Issue: A 20


Oscilloquartz: An ADVA Company Overview

SFP Interface
This table describes the PIN assignments of OSA 5401 SFP interface.

Table 1: Pinouts of SFP


Function in SFP
Pin Name SFP Signal
host
1 VeeT Transmitter ground GND
2 TxFault Transmitter fault indication Not used
3 TxDisable Optical output disabled when high Not used
4 MOD-DEF Data for serial ID interface I2C data
(2)
5 MOD-DEF Clock for serial ID interface I2C clock
(1)
6 MOD-DEF Grounded by module to indicate presence Driven low
(0)
7 RateSelect Low selects reduced bandwidth (RS0) Not used
8 LOS High, indicates received optical power too Not used
low
9 RS1 Receiver ground (RS1) Not used
10 JTE Receiver ground Not used
11 VeeR Receiver ground GND
12 RD- Inverted received data RD-
13 RD+ Received data RD+
14 VeeR Receiver ground GND
15 VccR Receiver power (3.3 V) 3.3V
16 VccT Transmitter power (3.3 V) 3.3V
17 VeeT Transmitter ground GND
18 TD+ Transmit data TD+
19 TD- Inverted transmit data TD-
20 VeeT Transmitter ground GND

LED Indicator
OSA 5401 Syncplug™ has one LED indicator on the front panel. When a GNSS antenna is
plugged into the GNSS antenna connector and OSA 5401 is connected to a SFP socket, after

OSA 5401 R12.1.1 User Manual - Issue: A 21


Oscilloquartz: An ADVA Company Overview

approximately 10 seconds the Green LED begins to blink. The different states for the LED
indicator are described and explained in this table.

LEDs are enabled by default. For more information on disabling LEDs, see
Enabling/Disabling LEDs.

Table 2: LED Indicator - GNSS Operations and General Fault Indication status
LED State Description
Green double GNSS has been locked, but failed and one of these options is used
blinkflash as the backup:

l SyncE Holdover state (if GNSS enabled)


l APTS (if PTP slave enabled)
Green single flash Locked state (GNSS, PTP freq, PTP phase, Clk In,
SyncE-to-PTP if GNSS disabled)
Red single flash Tracking state
Red double flash OCXO holdover state
Red triple flash Freerun state
Red continuous Indicates an active alarm. To verify the problem, use the CLI
light command:
info alarms

info log

Alarms can also be verified using SNMP.

Default Settings
If the OSA 5401 uses the default factory settings, this device operates as a Layer-2 G.8275.1
grand master clock. To change the default configuration, the OSA 5401 requires an IP
address. When you assign an IP address to the unit, you can use both CLI and Layer-3
protocols, including PTP (clock) communication.

The unit has a factory default IP address of 192.168.0.2 for initial CLI operation. You can use
the CLI to configure a different IP address. You can also configure separate IP addresses for
management and Layer-3 PTP clock traffic. In these configurations, at least one of the
addresses must have a VLAN IP address (see Configuring IP Addresses and VLANs). After
the configuration process establishes IP communication, you can enable Layer-3 PTP
operations.

OSA 5401 R12.1.1 User Manual - Issue: A 22


Chapter 2

Installing OSA 5401


Syncplug™
OSA 5401 Syncplug™ is installed by plugging the device into an SFP socket of the hosting
device (such as a switch or router).

Prerequisite Step
Before continuing with the installation, ensure that you review the safety precautions (see
Safety Precautions).

When OSA 5401 Syncplug™ is configured with a Network Management


System (NMS), it is recommended to first configure the NMS before
completing the installation and configuration of OSA 5401. When using
the Adva Networking Managing System called ENC Network Manager,
ensure the installation is configured as explained in the ENC Network
Manager Administrator Manual.
When using a different NMS, the integration between the NMS and
OSA 5401 must be performed separately using the OSA 5401 Syncplug
and OSA 5405 SyncReach SNMP User Guide as a resource.

Getting Started 23

Inserting OSA 5401 Syncplug™ into a Hosting Device 35

Installing Optional Accessories 35

Getting Started
Before installing OSA 5401, ensure to read this section containing safety precautions, site
planning, and specification requirements specific to the installation.

OSA 5401 R12.1.1 -User Manual - Issue: A 23


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Safety Precautions 24

Site Planning 25

Kit Contents 25

Roof Antenna Kits 26

Magnetic Antenna with 5m Cable 30

Lightning Protector Kit (EMP Kit) 32

Connection Cables 33

Materials Required 34

Safety Precautions
This section provides safety precautions and recommendations that you must be aware of
and follow when you install the OSA 5401. To successfully install and commission the
OSA 5401, complete the steps in order.

Only qualified personnel should install the OSA 5401 equipment.

We recommend that ADVA train and authorize all personnel who install the
OSA 5401. The training necessary to install, operate, and service the
OSA 5401 includes these minimum requirements:

l Background information about optical fiber communication


systems.
l Guidance to safely use the OSA 5401 equipment.

To comply with the Telcordia GR-1089 NEBS standard for electromagnetic


compatibility and safety, use only shielded cables that are grounded on
both ends for Ethernet copper ports.

To avoid eye injury from debris, always wear safety glasses when working
with canned compressed air.

This product contains Electro-Static Sensitive Devices.

Appropriate anti-static handling precautions should be followed, such as


IEC 61340-5-1:1998.

OSA 5401 R12.1.1 User Manual - Issue: A 24


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Electromagnetic Interference and Electrical


The OSA 5401 is appropriate to install in network telecommunication facilities and network-
enabled capability (NEC) locations.

The OSA 5401 device:

l Meets Telcordia standard GR-1089-CORE, Issue 6, May 2011 regarding EMC and
electrical safety.
l Is appropriate to install as part of either a Common Bonding Network (BN) or an
Isolated Bonding Network (IBN).

Site Planning
OSA 5401 is meant for installation in a hosting device (such as a switch or router) with an
MSA-compatible SFP socket.

The Minimum distance with 90 degree SMA connector is the same as the pull-tab — 43 mm
from the edge of the SFP cage. The use of a straight connector requires additional space
that depends on the bending radius of the SMA cable.

The operating temperature is –-40 to +80°C (-104 to 176°F) with a humidity of between 5 to
95%, non-condensing.

Site Requirements
Depending on how the OSA 5401 is installed, the site requirements may vary. When using
optional accessories including an RF Antenna, roof antenna, or lightening protector, ensure
that you take into account the details as explained in Installing Optional Accessories.

Kit Contents
The OSA 5401 mounting kit contents are listed including the optional accessories available:

l OSA 5401 Syncplug™


l Optional accessories:
l GNSS (GPS/GLONASS/BEIDOU) antenna kits 10/20/60/120/150m
(32.8ft/65.6ft/ 196.85ft/ 393.7ft/492.1ft), including indoor and outdoor
cables, roof antenna, lighting protector and mounting kit
l Patch window antenna
l 1:2/1:4/1:8 GNSS (GPS/GLONASS) splitters
l RP-MMCX to BNC adapter cable

OSA 5401 R12.1.1 User Manual - Issue: A 25


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

For more information on the optional accessories kits and connectors,


see these sections:

l Roof Antenna Kits


l Magnetic Antenna with 5m Cable
l Lightning Protector Kit (EMP Kit)
l Connection Cables

Roof Antenna Kits


Recommended for cable lengths from 10, 20, and 120 meters.

OSA 5401 R12.1.1 User Manual - Issue: A 26


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Figure 3: GNSS Roof Antenna Kit for 540x

Table 3: Antenna Characteristics


PERFORMANCE
Input Voltage +2.8 to +6.0 Vdc
Power consumption < 25 mA (typical)
Impedance 50 Ω
Noise <2.0 dB (typical)
Gain GNSS: 40 dBi ± 4 dB

OSA 5401 R12.1.1 User Manual - Issue: A 27


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Frequency 1574 MHz (GPS) -1607 MHz


(Glonass)
Out-of-band rejection F0 = 1586MHz
F0 ±50MHz: ≥60dBc
F0 ±60MHz: ≥70dBc
VSWR ≤ 2.0 : 1
Polarization RHCP
ENVIRONMENTAL
Operating temperature -40° C to +85° C
Storing temperature -
PHYSICAL
Dimensions (H x Æ) 60 x 44 mm
Weight 50 gr
Connector TNC female
Cable delay 3.92ns/m

correct part number Order the following part number for receiving the antenna together
with the mounting accessories and 10m of antenna cable.

Figure 4: Cost effective Roof Antenna Kit for 540x

OSA 5401 R12.1.1 User Manual - Issue: A 28


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Table 4: Antenna Characteristics


PERFORMANCE
Input Voltage +3.0 to +5.0 Vdc
Power consumption < 40 mA
Impedance 50 Ω
Noise <1.5 dB
Gain GNSS: 40 dBi ± 3 dB
Frequency 1575.42 MHz (GPS) / 1602 MHz
(Glonass)
VSWR ≤ 2.0 : 1
Polarization RHCP
ENVIRONMENTAL
Operating -40° C to +80° C
temperature
Storing temperature -

PHYSICAL
Dimensions (H x Æ) 128.5 x 96.3 mm
Weight 220 gr
Connector N female
Antenna Cable (included with the antenna)
Cable length 10m
Cable type SRF400
Cable connectors N-male / TNC-male
Outer diameter 10.16 ±0.15mm
Minimum bending 103mm
radius
Operating frequency 1~3000MHz
Cable attenuation 0.226 / m (@2'000MHz)
Cable delay 25ns/m

For more information on installing a roof antenna, see Roof


Installation.

OSA 5401 R12.1.1 User Manual - Issue: A 29


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Magnetic Antenna with 5m Cable


A Magnetic Antenna, which includes a 5 meter cable, is recommended for testing purposes,
demos, or proofs of concepts.

Figure 5: Magnetic Antenna with Cable

Table 5: Antenna Characteristics


PERFORMANCE
Input Voltage +2.8 to +6.0 Vdc
Power consumption < 25 mA
Impedance 50 Ω
Noise <2.0 dB
Gain 26 dBi (typical) @ 3.0VDC
VSWR ≤ 1.5 : 1
ENVIRONMENTAL
Operating temperature -40° C to +85° C
Storing temperature -
PHYSICAL
Dimensions (L x d x H) 45 x 51 x 12 mm
Weight 120 gr
Connector SMA male
Cable and Connector
Length 5m
Connector SMA male

OSA 5401 R12.1.1 User Manual - Issue: A 30


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

For more information on an antenna installation, see RF


Antenna Installation.

OSA 5401 R12.1.1 User Manual - Issue: A 31


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Lightning Protector Kit (EMP Kit)


In application for GNSS, a lightning protector (LP) is usually placed at the entry of buildings,
which is the transition from lightning protection zone 0 (LPZ0) to LPZ1.

At this place, a protector that is able to handle partial lightning currents is to be used. Due
to the fact that GNSS antennas need DC voltages on the antenna line, only protectors with
DC transmitting capability can be employed.

The residual voltage of a gas capsule protector reaches up to several hundred volts during
some nanoseconds. To further reduce this high voltage to a harmless voltage of a few volts
(tolerated by a GNSS receiver), an additional protection circuit is needed. This lightning
protection combines the gas capsule protector and the fine protector.

The lightning protector used is a combination of a gas capsule with a decoupling network
and further voltage reducing network.

The gas capsule is to reduce the pulse energy of the input surge. The residual pulse then will
be further reduced by another suppression element such as varistors, suppressors diodes,
coils and capacitors. The second stage determines the residual output voltage. The
decoupling network is necessary to prevent that the second stage will not be acting before
the first stage (gas capsule) has ignited, because the second stage is not able to handle such
high energies.

In case of cable lengths of less than approx. 20 m to the GNSS receiver no further safety
measures are necessary. For longer cable distances, a further fine protector may be needed
to protect the receiver against induced voltages caused by magnetic coupling.

It also may be recommended to use a combined protector close to the active GNSS antenna
to protect its electronic circuit.

Grounding
The lightning protector can ground in three modes :

l With the screw in the top of the protectorLP.


l With the screws trough the LP to the bonding plate.
l With the nut and washer on connector (protected side) to the bonding bar.

The protector should be connected to the bonding facility by a sufficiently sized grounding
cable (AWG 6 / 16mm2 min.) as short distant as possible (0,5m max.)

Table 6: Characteristics
ELECTRICAL
Impedance 50 Ω

OSA 5401 R12.1.1 User Manual - Issue: A 32


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Frequency Range 0-2000 MHz


Insertion Loss <0.2 dB
Return Loss >20 dB
Power < 80W
DC bypass voltage +15VDC
Surge current 10 single / 5 multiple kA (test pulse 8/20
Handling capability μs)
Residual pulse 350 μJ typically (test pulse 4 kV 1.2/50 μs /
energy 2 kA 8/20 μs) main path - protected side
ENVIRONMENTAL
Operating -40oC to +85oC
temperature
Waterproof degree IP65 (according to IEC 60529, data refer to
2011/65/EU (RoHS) the coupled state) compliant
MECHANICAL
Weight 50g

For more information on a lightning protection installation,


see Lightning Protection Installation.

Connection Cables
LMR Cables
The Roof Antenna Kit is delivered with a 10 meter coaxial cable. All Oscilloquartz certified
cables are supplied with the specifications detailed in this table:

Table 7: Certified Cable Details


Attenuation at 1575 Minimum Bend Tensile Cable
MHz Radius Strength Delay
dB/100m dB/100ft
16.8 dB 5.1 dB 25.4mm 1 inch 72.6 106 3.92
kg lbs nsp/m

Additional cables and optional lengths of 20m, 60m, and 120m can be ordered separately.

Contact Oscilloquartz support for further optional


configurations other than 10+20m, 10+60m, and 10+120m.
(risk of dysfunction).

OSA 5401 R12.1.1 User Manual - Issue: A 33


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Cable length 120m is composed of an Antenna within the stock mast and one 120m
segment of LMR 400.

Several options are available to extend Antenna connection to longer segments. Cables
terminating outside a building should be waterproofed to prevent moisture and ice
damage.

All hanging cables in vertical conduits and riser closets should be supported by hangers to
relieve strain from the weight of the cable.

Cable Delay Calculation


PPS cable delay= 1/ (Velocity*c)

Velocity: 85%

c: light Speed

For example: 60m LMR 400 needs a change in the PPS Cable delay to: 236ns

Materials Required
These materials are required to complete the installation:

l Hosting device (such as a switch or router) with an MSA-compatible SFP socket.


l When using OSA 5401 as a Grandmaster Clock or Probe, a GNSS antenna is
required and should be installed prior to installation.

l When using OSA 5401 as a slave or boundary clock, a


GNSS antenna is not required.
l A GNSS antenna is available as an optional accessory (see
Magnetic Antenna with 5m Cable).

l When using optional accessories including a roof antenna or lightening protector,


ensure that you have all items as detailed in Roof Antenna Kits and Lightning
Protector Kit (EMP Kit).

OSA 5401 R12.1.1 User Manual - Issue: A 34


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Inserting OSA 5401 Syncplug™ into a


Hosting Device
Before completing the installation steps explained below, ensure that you take into
consideration the optional accessories that can be installed with OSA 5401 Syncplug™ as
detailed in Site Planning, and perform the Prerequisite Step.

Prerequisite Step
When using OSA 5401 Syncplug™ as a Grandmaster Clock or Probe, a GNSS antenna is
required and should be installed prior to installation (see Materials Required).

To insert OSA 5401 Syncplug™ into a hosting device:

1. Hold OSA 5401 Syncplug™ with the label facing up, and insert the back connector into
an MSA-compatible SFP socket on the hosting device (such as a switch or router).
2. Push the OSA 5401 Syncplug™ into the SFP socket, unit it clicks into place.
3. When using an antenna, connect the cable from the antenna to the GNSS Input
connector on the front panel of the OSA 5401 Syncplug™ (see Figure 1). Ensure to attach
the cable to the rack of the hosting device to relieve pressure on the connector, so the
cable does not break.
4. When installing other optional accessories, see Installing Optional Accessories.

OSA 5401 Syncplug™ can become very hot while in use. Use caution
when removing it from the SFP socket of the hosting device.

Installing Optional Accessories


Review the installation instructions for these optional accessories:

RF Antenna Installation 35

Roof Installation 37

Lightning Protection Installation 40

RF Antenna Installation
This section provides guidelines and recommendations for an RF Antenna installation.

OSA 5401 R12.1.1 User Manual - Issue: A 35


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Oscilloquartz is not liable for any damage caused by poor


installation.

Figure 6: Principle for the Antenna Installation

Roof Installations are more complex and require some form of LP, and weatherproofing.

Wall installations require Masonry mounting of a mast bracket and Wall Core Hole, possibly
covered with a Junction Box. Depending upon the height of the installation, a Wall Antenna
system requires LP.

Window Antenna installations depend upon the Window design, glaze composition and
coatings which may obstruct GNSS signals.

In general, a small handheld GPS receiver can be used to check Site visibility in Wall and
Window Installations to judge sky visibility and coverage. Survey for at least ¼ - ½ of the
GNSS constellation period (3 ~ 6 hours), at regular intervals, for visible satellite counts
above 5 in view, with levels above 36 dB CNo.

All installations require some form of site survey and planning prior to deployment.

OSA 5401 R12.1.1 User Manual - Issue: A 36


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Roof Installation
Figure 7: Roof Mounted Antenna Installation

OSA 5401 R12.1.1 User Manual - Issue: A 37


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Figure 8: Roof Antenna Cable Lengths & Distance

The active antenna should be grounded to the antenna tower. The antenna tower itself
must be connected to the roof lightning protection system at the bottom of the antenna
tower.

The antenna transmission lines are grounded to prevent lightning from creating a
difference of potential between the tower and the transmission lines. The length of the
cable between the lightning protector (LP) and the GNSS antenna must be shorter than 10
meters. Longer than 10 meters and the cable screen needs to be bonded to the down
conductor where it leaves the mast and bonded every 20 meters maximum.

The distance between the lightning ground line and the transmission line increases with the
length of the cable. The separation distance is calculated considering the length of the
transmission line cable between bonding points.

The formula of the separation distance is s = ki x kc / km x l(m). Description and examples


hereafter :

s = ki x kc / km x l(m)
ki is a function of the class of lightning protection system chosen (induction factor)

OSA 5401 R12.1.1 User Manual - Issue: A 38


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

kc is a function of the geometric arrangement (current splitting coefficient)

km is a function of the material in the point of proximity (material factor)

l(m) is the length of the air termination system or down–conductor system from the point
at which separation distance shall be determined to the next point of equipotential
bonding.

Example of calculation considering 20m cable length :


ki = 0.05, means protection level III (max. lightning current peak value 100 kA)

kc = 1, means one single lightning rod

km = 0.5, means material that has a lower insulating factor than air

l(m) = 20 m, because you need to ground the transmission line at least every 20 m

s = 0.05 x 1 / 0.5 x 20 = 2 m

Please note that the separation distance will be shorter with l(m) less than 20 m.

Example of calculation considering 5m cable length :

s = 0.05 x 1 / 0.5 x 5 = 0.5 m

Other Considerations:
The antenna must be mounted in an upward position within 5° of the vertical.

The antenna should be installed at the highest possible point available at the site. But not
higher than the lightning rod. This is to ensure that any surrounding obstacles (trees,
buildings or other installations, etc.) are not exceeding a 20° elevation angle.

To avoid influence of reflected waves, the antenna must be installed more than 2m (6.5ft)
away from metallic objects with a dimension greater then 20 cm.

Antenna installation should be avoided in close proximity with other receivers or


transmitters, to reduce the susceptibility of Radio Interference.

The Antenna mast must be securely strap-clamped to a main mast, at least 2m (6.5ft) above
the roof line or rampart wall, and the antenna dome must be above the main mast.

Never twist the Antenna with attached BNC or TNC connection; twist the smaller mounting
stock (white or gray plastic tube with threading) to thread it to the Antenna; twisting the
antenna dome will damage or break the coaxial connector.

Install conduit with liberal bend radius in each angle, about twice the coax bend radius limit
to allow the coax to be pulled easily without binding.

Always pull the coax through conduit with an extra leader-pilot string to allow other
replacement coax if damage to existing coax occurs

OSA 5401 R12.1.1 User Manual - Issue: A 39


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Use junction boxes at regular intervals to allow intermediate pulling access.

Always check for the presence of the + 5 Volt DC power from the Antenna connection
towards the Receiver unit during troubleshooting; absence of the (approximate) voltage.

Lightning Protection Installation


Figure 9: Antenna & Lightning Protection Assembly

Installation is conditioned by the coaxial cable length. If the length doesn’t exceed 10m
between the antenna and the building entry, the outside cable doesn't need to be
grounded. If the length exceeds 10m outside, the outside cable should be grounded every
20m with the cable grounding kit.

Inside the building, certain criteria should be respected:


l If cable length is lower than 10m between the outside cable arrival and the
equipment, the lightning protector can be a FP (Fine protection)
l If cable length is greater than 10m between the outside cable arrival and the
equipment, the lightning protector should be a lightning protector with only a gas
capsule.

OSA 5401 R12.1.1 User Manual - Issue: A 40


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Figure 10: Roof Antenna installations Ssolutions

For a completely efficient protection, it is important to mount the lightning protector in the
transition zone from one lightning protection zone (LPZ) to the next higher one.

The first and most important is the entry to the building. After the building entry, the surge
currents are drained to ground (if the surge protector is properly grounded) and further
cables can be connected to the receiver.

The lightning protector prevents the receiver equipment from damage by surges or ESD.

This type of connection is therefore needed due to the combination of a coarse and a fine
protection stage within the protector. The ‘protected side’ and the ‘unprotected side’
cannot be interchanged. It is essential to be aware of the devices to be protected and the
direction where the surge is coming from.

A second fine protector (as described in the roof antenna application) is then needed to
protect the GNSS receiver.

If it is not possible to install as many surge protectors for one antenna line, then special
attention to the conditions of antenna installation is required.

Other Considerations:
Lightning protection devices, must be installed as close as possible to the cable entry inside
the building. Furthermore, grounding of the various elements must be installed with low
resistance and low inductance conductors.

Must wherever possible be located in the unprotected zone in order to rule out inductive
interference.

OSA 5401 R12.1.1 User Manual - Issue: A 41


Oscilloquartz: An ADVA Company Installing OSA 5401 Syncplug™

Place the Lightning Protector in an Electrical Junction Conduit Box for maximum protection,
within an area that can be accessed to allow Gas capsule replacement.

Avoid looping or coiling excess cable on the interior demarcation of the roof.

Earth or Ground wires connected to the Lightning Protector must be as straight and short as
possible, connected to the nearest Building Earth Terminal point. (contact points must be
bare and free from dirt, dust and moisture).

Use sufficiently width grounding cable (≥ 16 mm2 / AWG 6)

Avoid bending the coaxial cable entrances to the Lightning Protector and observe the
minimum bend radius of the cable.

Conduit Entrances through a Wall Bore Hole must be angled to prevent water intrusion into
the Lightning Protection Junction Box

OSA 5401 R12.1.1 User Manual - Issue: A 42


Chapter 3

Upgrading the Software


You can use two different methods to upgrade from a previous product version to the
current version. We recommend that you upgrade the software using the Secure Copy
Protocol (SCP) whenever possible for a clean installation.

If you upgrade from a trial or demo version, after the upgrade run the admin factory-
defaults command to ensure that the system properly initializes the configuration.

It is not possible to upgrade the software while a Syncjack test is running.

Upgrading with SCP 44

Upgrading with TFTP 46

OSA 5401 R12.1.1 -User Manual - Issue: A 43


Upgrading with SCP
To upgrade from a previous version of the software to the current version using the SCP or
OpenSSH, follow the installation instructions in this section. The SCP upgrade is the
preferred method of installation.

We recommend that you upgrade with SCP whenever possible for a clean
installation. If you do not have OpenSSH/SCP, follow the TFTP instructions
(see Upgrading with TFTP).

Prerequisites
l Perform the upgrade according to the upgrade path detailed in the System
Upgrade table in the release notes.
l Verify whether the release notes have any special upgrade instructions specific to
the current version.

Upgrading OSA 5401 as an SCP Server


1. On your PC, start the SCP transfer. For example, if you use Cygwin in Windows, enter this
command using relative path (OSA-5401.12.1.1-XXX.bin):
scp -oKexAlgorithms=diffie-hellman-group14-sha1 OSA-5401.12.1.1-XXX.bin
[email protected]:.

2. After the SCP transfer completes, open the SSH connection and enter this command to
install the new software:
admin software install
Following the software install command, the device is rebooted.

If you upgrade from a trial or demo version, enter the admin factory-
defaults command to ensure that the system properly initializes the
configuration.

3. Open the CLI and enter the info command to verify that the new software is functional.

OSA 5401 R12.1.1 -User Manual - Issue: A 44


Oscilloquartz: An ADVA Company Upgrading the Software

Upgrading OSA 540X as a SCP Client


1. To start the SCP transfer, enter this command:
admin copy sw-upgrade scp 192.168.0.200 OSA-5401.12.1.1-XXX.bin

2. After the SCP transfer completes, open the SSH connection and enter this command to
install the new software:
back
admin software install
Following the software install command, the device is rebooted.

If you upgrade from a trial or demo version, enter the admin factory-
defaults command to ensure that the system properly initializes the
configuration.

3. Open the CLI and enter the info command to verify that the new software is functional.

OSA 5401 R12.1.1 User Manual - Issue: A 45


Oscilloquartz: An ADVA Company Upgrading the Software

Upgrading with TFTP


This section explains how to upgrade from a previous version of the product software to the
current version using the Trivial File Transfer Protocol (TFTP). You should perform a TFTP
upgrade only if you do not have OpenSSH/SCP. We recommend that you use SCP to
perform the upgrade (see Upgrading with SCP) if possible.

The software upgrade using TFTP was tested with these TFTP servers:

l Open TFTP 1.64


l Tftpd64 4.52
l Open TFTP 0.17.18-ubuntu

Prerequisite Steps
Before you upgrade from a previous version to the current version, you must perform these
prerequisite steps:

l Perform the upgrade according to the upgrade path detailed in the System
Upgrade table in the release notes.
l Verify whether the release notes have any special upgrade instructions specific to
the current version.

To upgrade from a previous version with TFTP:

1. To start the TFTP transfer, enter this command:


admin copy sw-upgrade tftp 192.168.0.200 OSA-5401.12.1.1-XXX.bin

During the upgrade, the CLI is unresponsive. An upgrade can take several
minutes depending on the network strength.

The CLI is unresponsive, and the session can close during the next 10
seconds.

2. After the TFTP transfer concludes, press Enter, and then enter this command to install
the new software:
back
software install
Following the software install command, the device is rebooted.
3. Open the CLI and enter the info command to verify that the new software is functional.

OSA 5401 R12.1.1 User Manual - Issue: A 46


Chapter 4

Provisioning Connectivity
You should provision connectivity to the OSA 5401 after installation. When you configure
the IPs and VLANs for handling management and L3 PTP (including clock or
synchronization) traffic, you must configure at least one IP address. In many cases, a
different IP address subnet for management is necessary, which requires an additional IP
address and VLAN configuration.

Connecting to the OSA 5401


You use the command line interface (CLI) to interface with the OSA 5401 from a terminal
that is connected to the PoE

For a list of supported clients, see Supported CLI and File Transfer Applications.

To connect to the OSA 5401 unit:

1. On a PC that supports either a Telnet or SSH client, such as TeraTerm or PuTTY, open a
terminal emulation window.
2. In the Host field, set the unit IP address.
The default is 192.168.0.2.
3. Set the TCP port#.
For SSH use TCP port 22. For Telnet use TCP port 23.

OSA 5401 R12.1.1 -User Manual - Issue: A 47


Oscilloquartz: An ADVA Company Provisioning Connectivity

An example is shown in this figure.

4. For SSH authentication, enter the user name and passphrase.


The default user name and passphrase is set as:
User name: root
Passphrase: ChgMeNOW
An example is shown in this figure.

Depending on the client, you may need to set local echo.

OSA 5401 R12.1.1 User Manual - Issue: A 48


Oscilloquartz: An ADVA Company Provisioning Connectivity

Supported SSH algorithms are Diffie-Hellman-Group1-SHA1, Diffie-


Hellman-Group14-SHA1 (key exchange), AES128-CBC/CTR, AES256-
CBC/CTR, 3DES-CBC/CTR (encryption), and HMAC-SHA2-256 (message
authentication code). For more information on the SSH algorithms
compatible clients, see Supported CLI and File Transfer Applications.

The OSA 5401 Syncplug™ supports four SSH sessions at a time. The device
blocks SSH logins and sessions when SCP file transfer is active. Inactive
SSH session timeout after 10 minutes.

5. Click OK.
The prompt ADVA--> displays.
6. To verify the connection, enter the info command, which displays the current software
version, clock state, and configured IP addresses.

When no response is returned, to troubleshoot the connectivity, look at


the cable connections to make sure they are securely connected, verify
replies to ping, and confirm that the Telnet/SSH client is supported.

SSH Key Exchange Algorithm


The system uses the Diffie-Hellman-Group14-SHA1 key-exchange algorithm by default. A
less secure option is the Diffie-Hellman-Group1-SHA1 algorithm.

To configure the SSH key-exchange algorithm:

configure management ssh kex-algorithm diffie-hellman-group1-sha1

Configuring Multi-Level User Access


Multi-level User Access allows you to configure two types of privilege levels for a SSH user –
superuser and retrieve. The privilege level is either configured locally for a SSH user or
remotely on a RADIUS server. The RADIUS server configuration is vendor specific.

l A Superuser is allowed to execute all CLI commands.


l A Retrieve user is allowed to view all CLI commands but can only execute show
commands.

To configure user privileges for a SSH user:

l A user privilege is configured at the time a new SSH user is created with this
command:

OSA 5401 R12.1.1 User Manual - Issue: A 49


Oscilloquartz: An ADVA Company Provisioning Connectivity

configure management ssh-user add [superuser | retrieve] <username> <password>

Once configured, you can see the list of SSH users and privilege levels using this command:

configure management ssh-user list

Sample Output:

root (superuser)
user1 (retrieve)

To configure user privileges for a remote (RADIUS) user:

l On the RADIUS server, add one of the vendor specific Attribute-Value Pair options
to the dictionary as detailed in Table 8.

Table 8: Vendor Specific Attribute Value Pair Options


Option 1:
Attribute-Value Pair Type 26 (Vendor-Specific)
Vendor ID 2544 (ADVA)
Type 102
Attribute Value Set one of these options:

l 5 (Root)
l 4 (Admin) for Superuser.
l Other values for Retrieve.
Option 2:
Attribute-Value Pair Type 26 (Vendor-Specific)
Vendor ID 18022 (Covaro)
Type 1
Attribute Value Set one of these options:

l 1 (Superuser)
l 4 (Retrieve)

OSA 5401 R12.1.1 User Manual - Issue: A 50


Oscilloquartz: An ADVA Company Provisioning Connectivity

Configuring IP Addresses and VLANs


Different network connectivity options are available for configuring IP addresses and VLANs
that can handle both management and L3 PTP clock traffic, see . Your network and system
requirements determine how the IPs and VLANs are configured. Before you make any
changes, it is important that you understand the required default and network
configurations needed to implement your changes.

OSA 5401 supports four logical interfaces: mgmt for management traffic, ptp1, ptp2, and
ptp3 for PTP traffic. For example, ptp1 for PTP slave clock and ptp2 for PTP master clock

l Management and ptp1 interfaces are always enabled and cannot be disabled by a
user.
l ptp2 and ptp3 interfaces are disabled by default.
l mgmt and ptp1 interfaces can be used with or without VLANs as follows:

Table 9: Network Connectivity Options for IP Addresses and VLANs


mgmt
ptp1 Interface Comments
Interface
No VLAN No VLAN IPv4 and IPv6 addresses must be equal, default
(untagged) (untagged) configuration.
VLAN X VLAN X IPv4 and IPv6 addresses must be equal.
(tagged) (tagged)
No VLAN VLAN Y IPv4 and IPv6 addresses must be different.
(untagged) (tagged)
VLAN Y No VLAN IPv4 and IPv6 addresses must be different.
(tagged) (untagged)
VLAN X VLAN Y IPv4 and IPv6 addresses must be different.
(tagged) (tagged)

l If you configure logical interfaces to different physical ports, you can untag or
configure them with the same VLAN ID.
l It is possible to configure ptp1, ptp2, and ptp3 with the same or different IP
addresses.

DHCP4 and DHCP6 on Management Interface


The system supports DHCP4 and DHCP6 on the logical mgmt interface. Both protocols are
enabled by default.

OSA 5401 R12.1.1 User Manual - Issue: A 51


Oscilloquartz: An ADVA Company Provisioning Connectivity

The OSA 5401 obtains IPv6 address from the stateful DHCPv6 server and IPv6 prefix and
IPv6 gateway from RA messages from local IPv6 router(s). If the system is not able to get RA
messages, it will use default prefix of 64 and is able to communicate on the local subnet
with a dynamic IP but need the RA message to communicate outside the local network
(subnet).

l DHCP client ID is the MAC address of the eth1 interface.


l DHCP4 sends one message per minute continously. There is no timeout.
l DHCP6 packet interval is random and the system keeps sending packets without
timeout.
l The default IPv4/IPv6 addresses are active if no IP address is provided by DHCP.

To enable or disable DHCP4 and DHCP6:

configure interface [ mgmt | mgmt+ptp1 ] dhcp [ ipv4 | ipv6] [enabled | disabled],


default=enabled

Static and dynamic IPv4/IPv6 addresses:

info

mgmt:
ipv4-dhcp : disabled
ipv6-dhcp : enabled
ipv6-dhcp-type : stateful
ipv4-address : 10.33.188.189/25
ipv4-default-gw : 10.33.188.129
ipv6-address : 2001:1200:1100:1000:0:0:0:017A/64 ( 0:0:0:0:0:0:0:0/64 )
ipv6-linklocal : FE80:0:0:0:0280:EAFF:FEE1:2910/64
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 4095
vlan-pcp : 7
ip-priority : none

IPv6 Routing
IPv6 addresses are routed according to RFC4193: Unique Local IPv6 Unicast Addresses and
RFC4291: IP Version 6 Addressing Architecture.

l Global Unicast Address — scope Internet, routed on Internet.


l Unique Local — scope Internal Network or VPN internally routed. Not routed on
Internet.
l Link Local — scope network link, not routed internally or externally.

OSA 5401 R12.1.1 User Manual - Issue: A 52


Oscilloquartz: An ADVA Company Provisioning Connectivity

Default IP Address and VLAN Configuration


The OSA 5401 Syncplug™ has a default IP address of 192.168.0.2 and no VLAN. The system
uses this IP address for both management and L3 PTP (Clock) traffic, as defined in the
running-config file, where vlan-id 4095 sets the VLAN as not in use (untagged).

To change the default settings, see Changing IP Addresses and VLANs using CLI
Commands.

management interface
ipv4-address : 192.168.0.2/24
ipv4-default-gw : 0.0.0.0
ipv6-address : :: not defined
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 4095
vlan-pcp : 7
ip-priority : none
port : eth1

interface: ptp1
ipv4-address : 192.168.0.2/24
ipv4-default-gw : 0.0.0.0
ipv6-address : :: not defined
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 4095
vlan-pcp : 7
ip-priority : none
port : eth1

interface: ptp2
ipv4-address : 0.0.0.0 not defined
ipv4-default-gw : 0.0.0.0
ipv6-address : :: not defined
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 0
vlan-pcp : 0
ip-priority : none
port : eth1

interface: ptp3
ipv4-address : 0.0.0.0 not defined
ipv4-default-gw : 0.0.0.0
ipv6-address : :: not defined
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 0
vlan-pcp : 0
ip-priority : none

OSA 5401 R12.1.1 User Manual - Issue: A 53


Oscilloquartz: An ADVA Company Provisioning Connectivity

port : eth1

Changing IP Addresses and VLANs using CLI


Commands
In most cases, you configure different IP addresses to handle management and Layer 3 PTP
(Clock) traffic. This section explains how to configure different IP addresses and VLANs
using CLI commands and includes example configuration details. Edit these commands
according to your requirements.

Prerequisites
When you configure different IP addresses, ensure that at least one IP address has a
configured VLAN.

To configure different IPs and VLANs for management and Layer 3 PTP (Clock) traffic:

1. Define different IP addresses and VLANs using the appropriate management and Layer 3
PTP (Clock) CLI commands:

These CLI commands contain example configuration details. Edit them


according to your system requirements.

The OSA 5401 learns about potential default gateways in neighboring


routers through periodic RA messages sent by the routers on the local
network if the default gateway is not manually configured. The prefix
length must be 64 bits.

There are no prefix length limitations if the default gateway is configured


manually.

Management
configure interface mgmt ip-address ipv4 192.168.1.100/24
configure interface mgmt default-gw ipv4 192.168.1.1
configure interface mgmt ip-address ipv6 2001:db8:efac:1:d0f8:6ff9:4302:7086/64
configure interface mgmt vlan-id 1
configure interface mgmt vlan-pcp 0

L3 PTP (Clock)
configure interface mgmt ip-address ipv4 192.168.2.100/24
configure interface mgmt default-gw ipv4 192.168.1.1
configure interface ptp1 ip-address ipv6 2001:db8:efac:1:d0f8:6ff9:4302:7086/64
configure interface ptp1 vlan-id 2
configure interface ptp1 vlan-pcp 7

OSA 5401 R12.1.1 User Manual - Issue: A 54


Oscilloquartz: An ADVA Company Provisioning Connectivity

2. Save the network configuration changes using the save-and-reconfig CLI


command. The running-config file is updated with the changes.

Change any invalid configuration settings that are reported during the
save operation.

For example, based on the example configuration details used in Step #1, the
running-config file is updated accordingly:
management interface
ipv4-address : 192.168.1.100/24
ipv4-default-gw : 192.168.1.1
ipv6-address : :: not defined
ipv6-default-gw : 0:0:0:0:0:0:0:0
ipv6-linklocal : FE80:1:0:0:280:EAFF:FE9E:3303
vlan-id : 1
vlan-pcp : 0
ip-priority : none
port : eth1

interface: ptp1
ipv4-address : 192.168.2.100/24
ipv4-default-gw : 192.168.2.1
ipv6-address : :: not defined
ipv6-linklocal : FE80:1:0:0:280:EAFF:FE9E:3303
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 2
vlan-pcp : 7
ip-priority : none
port : eth1
When a single IP address with a single VLAN for both management and Layer 3 PTP
traffic is required, you must apply identical configurations, shown in this example:
management interface
ipv4-address : 192.168.2.100/24
ipv4-default-gw : 192.168.2.1
ipv6-address : :: not defined
ipv6-linklocal : FE80:1:0:0:280:EAFF:FE9E:3303
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 4095
vlan-pcp : 7
ip-priority : none
port : eth1
interface: ptp1
ipv4-address : 192.168.2.100/24
ipv4-default-gw : 192.168.2.1
ipv6-address : :: not defined
ipv6-linklocal : FE80:1:0:0:280:EAFF:FE9E:3303

OSA 5401 R12.1.1 User Manual - Issue: A 55


Oscilloquartz: An ADVA Company Provisioning Connectivity

ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 4095
vlan-pcp : 7
ip-priority : none
port : eth1

Configuring the IP Priority


The system configures PTP and management interface by default to use the same IP
address. In most cases, separate networks handle PTP and management traffic. Depending
on your network configuration, you can define a different IP address for each interface.

For example, you can use a different VLAN for synchronization and use a dedicated network
for management, such as an IP address for Sync Messages (see Changing IP Addresses and
VLANs using CLI Commands). After you have configured the IPs and VLANs based on your
requirements, you can prioritize one type of traffic over another, such as PTP traffic over
management.

Configure the IP priority mode using CLI commands. By default, no IP priority mode handles
PTP or Management traffic (default=none). The available IP priority modes for each
interface include:

l DSCP bits: with a 0 to 56 range.


l ToS bits: with a 0 to 224 range, where the DS field is set as is.

Before you apply any new configuration, you must save the changes using
the save-and-reconfig command.

To configure the IP priority mode for an interface:

Use this CLI command for the specific interface, whose IP priority mode you want to
prioritize, and adjust them according to your requirements:

configure interface [mgmt | mgmt+ptp1 | ptp1 | ptp2 | ptp3] ip-priority [dscp | tos |
none] <value> [0-224]

For both PTP and management interfaces, the default priority is none.

OSA 5401 R12.1.1 User Manual - Issue: A 56


Oscilloquartz: An ADVA Company Provisioning Connectivity

Configuring Management Access


Control List
The system maintains an optional MGMT Access Control List (ACL) to restrict the IP
addresses accepted. When the ACL is active, management of the system is restricted only to
valid IP addresses contained in the ACL. PTP traffic is accepted. You can add up to 10
subnetworks or individual IP addresses to the ACL list.

The hosting device limits the load to OSA 5401 by blocking unnecessary
traffic.

ACL for management traffic (10 entries):

1. To add an ACL entry, use this CLI command:


configure system acl-entry N permit ipv4 <ipv4/ipv6 address / prefix>

2. To enable, disable or clear all ACL entries, use this command:


configure system acl [enable | disable | clear-entries], default = disable

Make sure you have added an entry that permits management traffic
from your PC before you enable the ACL.

3. To see the ACL entries, use this CLI command:


info acl
ID Action Network Address Prefix Control Hits
1 Permit 0.0.0.0 32 disabled 0
2 Permit 0.0.0.0 32 disabled 0
3 Permit 0.0.0.0 32 disabled 0
4 Permit 0.0.0.0 32 disabled 0
5 Permit 0.0.0.0 32 disabled 0
6 Permit 0.0.0.0 32 disabled 0
7 Permit 0.0.0.0 32 disabled 0
8 Permit 0.0.0.0 32 disabled 0
9 Permit 0.0.0.0 32 disabled 0
10 Permit 0.0.0.0 32 disabled 0
------------------------------------------------------------
Total 0
Permitted PTP Packets: 0
Dropped MGMT Packets : 0
All Received Packets : 5369

OSA 5401 R12.1.1 User Manual - Issue: A 57


Oscilloquartz: An ADVA Company Provisioning Connectivity

Pinging an IP Address
For any IPv4 or IPv6 address, you can ping the IP network to test the reachability of a host. It
is also possible to ping a DCN (eth0) port.

To ping an IP address:

Use this command:

ping [ mgmt | ptp1 | ptp2 | ptp3 | results ]

To ping 192.168.0.200 from mgmt interface:

ping mgmt 192.168.0.200

To see the results:

ADVA:ping--> results
ping results
Packets: Sent = 5, Received = 5
Approximate round trip times in milli-seconds:
Minimum = 0ms, Maximum = 1ms, Average = 0ms

Editing the Security Banner


A security banner message is displayed when you log into the CLI. The default message is:
"This is a private system. Unauthorized access or use may lead to prosecution." You can edit
the message up to 1024 characters.

To edit the security banner, use this command:

configure system security-banner [ add-line | delete ]

OSA 5401 R12.1.1 User Manual - Issue: A 58


Chapter 5

Managing the OSA 5401


The OSA 5401 can be managed using SSH/Telnet CLI commands. The full listing of the CLI
command definitions is available, see CLI Command Definitions. For fault management,
SNMP is supported.

In the current release, commands abbreviations are not supported for all
commands in the CLI.

For more information on SNMP, see the OSA 5401 Syncplug and the
OSA 5405 SyncReach SNMP User Guide.

Resetting IPs, Usernames, and Passwords 60

Enabling/Disabling LEDs 61

Configuring Time-of-Day 61

Configuring Daylight Saving Time 61

Configuring Alarms and Events 62

Configuring Synchronization 71

Configuring Syncjack™ 92

Backing Up and Restoring the Configuration File 103

Using CLI Configuration Files 104

Link Layer Discovery Protocol 105

ENC Network Manager Support 108

OSA 5401 R12.1.1 -User Manual - Issue: A 59


Oscilloquartz: An ADVA Company Managing the OSA 5401

Initializing Service Time Counters 108

Viewing Ethernet Port Counters 109

Configuring Expected Clock Class 110

Configuring Holdover Time 110

Configuring CLK Port 111

Resetting IPs, Usernames, and


Passwords
The OSA 5401 unit is always accessible through a Telnet/SSH client using the default IPv4 IP
address (192.168.0.2) without a VLAN connection for 60 seconds after restarting the system.
You can reset the IP address, username, and password of the OSA 5401 unit using this
connection. Once the system is up and running, the unit is accessible for 60 seconds
provided that the connection is still maintained. You then have five minutes to enter any CLI
command, such as SSH username or password reset, before the connection to the
Telnet/SSH client expires (see CLI Command Definitions).

If you forgot your valid username or password, you can log in as a Superuser using the
username 123 and password 123. An SSH session is open for 5 minutes and allows you to
modify settings such as remove and add SSH users.

OSA 5401 R12.1.1 User Manual - Issue: A 60


Oscilloquartz: An ADVA Company Managing the OSA 5401

Enabling/Disabling LEDs
The OSA 5401 has one LED indicator on the front panel (see LED Indicator). This LED is
enabled by default, but can be disabled and enabled depending on your system
requirements.

To disable/enable the LED on the front panel:

Use this CLI command (where the default is set to enable):

configure system leds [enable | disable] ;

Configuring Time-of-Day
The real-time clock (RTC) of the OSA 5401 unit is automatically set based on the Time-of-
Day received from the GNSS or PTP Slave Clock. When the GNSS or PTP Slave Clock is
unavailable, the RTC starts from 0. You can manually set the Time-of-Day and store it in the
configuration. The real-time clock is initialized with the stored value after restarting the unit.

To set the Time-of-Day and save the configuration, use this CLI command and define these
parameters:

l <day_and_time>: Date and time using the format YYYY.MM.DD.HH.MM.SS,


such as 2017.01.01.12.12.12.
l <timezone>: Timezone using the format hh:mm, such as 13:00, where the value is
between 12:00 to 13:45.

To set the timezone only and save the configuration:

admin daytime 0 <timezone>


save

Configuring Daylight Saving Time


You can edit Daylight Saving Time (DST) settings according to your system requirements.
DST is disabled by default. The system time uses the configured time zone and DST for all
system time references.

Alarms and events that occur after the time zone and DST changes get a new local time in
the alarm timestamp. If the time zone changes while the event or alarm is active, existing
alarms and events remain unchanged. Previous alarms and events in the alarm logs do not
change. The timestamp of the original event remains the same.

To set the daylight saving time:

OSA 5401 R12.1.1 User Manual - Issue: A 61


Oscilloquartz: An ADVA Company Managing the OSA 5401

admin daylight-saving-time control [enable | disable], default=disable

You must disable daylight saving time to configure these settings:

Set the daylight saving time offset:

admin daylight-saving-time utc-offset [ -12:00 , ... , +14:45 ]

Set the start day, month and time of the daylight saving time:

admin daylight-saving-time start-day [ day-number | last-weekday | weekday ]


default=sunday >= 7
daylight-saving-time start-day day-number [ 1,2,...,31 ]
daylight-saving-time start-day last-weekday [ sunday | monday | tuesday | wednesday |
thursday | friday | saturday ] ; default=sunday
daylight-saving-time start-day weekday [ sunday | monday | tuesday | wednesday |
thursday | friday | saturday ] ; default=sunday
admin daylight-saving-time start-month [ january | february | march | april | may | june
| july | august | september | october | november | december ] ; default=march
admin daylight-saving-time start-time [ 00:00 , 00:15 , ... , 23:45 ],default=02:00

Set the end day, month and time of the daylight saving time:

admin daylight-saving-time end-day [ day-number | last-weekday | weekday ] default=sunday


<= 7
daylight-saving-time end-day day-number [ 1,2,...,31 ]
daylight-saving-time end-day last-weekday [ sunday | monday | tuesday | wednesday |
thursday | friday | saturday ] ; default=sunday
admin daylight-saving-time end-day weekday [ sunday | monday | tuesday | wednesday |
thursday | friday | saturday ] ; default=sunday
admin daylight-saving-time end-month [ january | february | march | april | may | june |
july | august | september | october | november | december ] ; default=november
admin daylight-saving-time end-time [ 00:00 , 00:15 , ... , 23:45 ], default=03:00

Show the daylight saving time configuration:

admin daylight-saving-time status


Status: ON
RTC time: 2021-06-07 11:36:21
Date and time:2021-06-07 12:35:44 UTC+1
DST start: 2021-03-07 02:00:00 UTC+0
DST end: 2021-11-07 03:00:00 UTC+1

Configuring Alarms and Events


Alarms indicate that an error has occurred on the OSA 5401. Events notify you about
specific actions that occur in the system. The alarm and history log records each error and

OSA 5401 R12.1.1 User Manual - Issue: A 62


Oscilloquartz: An ADVA Company Managing the OSA 5401

action as a separate entry. The OSA 5401 has specific, built-in (or pre-configured) alarms
and events. You can use the command-line interface (CLI) to manage alarms and events.

The built-in alarms that ship with the OSA 5401 are customized to report about specific
conditions. These conditions are assigned with an alarm profile notification code (NC) that
indicate the severity of the alarm. You can adjust the severity of an alarm by changing the
alarm profile notification code. Depending on the alarm condition, different
troubleshooting options are available to resolve the problem.

Alarm Profile Notification Codes 63

Built-In Alarms 64

Built-In Events 67

Viewing Alarms and Events 67

Assigning a New Alarm Notification Code 70

Alarm Profile Notification Codes


The system assigns each alarm a profile notification code (NC) that indicates the severity of
the alarm. The options available for notification codes are shown in Table 10.

Table 10: Alarm Profile Notification Codes


NotificationCode Description
CR Critical: A severe, service-affecting condition has occurred that
requires immediate corrective action.
MJ Major: A serious disruption of service, or a malfunction or failure of an
important system function.
MN Minor: Trouble, or an issue, that does not seriously affect service to
customers, or trouble in functions that are not essential to the NE
operation.
NA Not Alarmed: A condition that the system reports only as an event
and that you can retrieve information about from the system.
NR Not Reported: A condition that the system does not report, but that
you can retrieve information about from the system.
CR Clear: The system does not use this value in an alarm profile. The
system uses this code only to report events.

OSA 5401 R12.1.1 User Manual - Issue: A 63


Oscilloquartz: An ADVA Company Managing the OSA 5401

Built-In Alarms
The built-in alarms in the OSA 5401 report on specific conditions that have an assigned
alarm-profile notification code. Table 11 lists the alarm conditions and their associated
probable cause, default notification code, and suggested troubleshooting procedure.

To change the severity of an alarm condition, you can assign it a new notification code
using the CLI (see Assigning a New Alarm Notification Code).

Table 11: Built-in Alarms


NSA Default
Condition Type Troubleshooting Procedure
Notification Code
Clock in Time Freerun NR Not applicable.
Clock in Time Holdover NR Not applicable.
Clock Time Not Traceable MJ Not applicable.
Clock in Frequency NR Not applicable.
Freerun
Clock in Frequency NR Not applicable.
Holdover
Clock Frequency Not MJ Not applicable.
Traceable
PTP - Clock Class MJ The system reports this alarm if the
Mismatch received clock class is greater than the
expected clock class value. Packets from a
grandmaster or a boundary clock that are
sending this clock class are dropped.
Jamming/interference MJ The system reports this alarm if the GNSS
detected receiver detects possible jamming or
interference.
Spoofing detected MJ The system reports this alarm if the GNSS
receiver detects possible spoofing.
Advanced Jamming NR The system reports this alarm if the
Detection advanced jamming detection algorithm
detects possible jamming.
Advanced Spoofing NR The system reports this alarm if the
Detection advanced spoofing detection algorithm
detects possible spoofing.

OSA 5401 R12.1.1 User Manual - Issue: A 64


Oscilloquartz: An ADVA Company Managing the OSA 5401

Table 11: Built-in Alarms


NSA Default
Condition Type Troubleshooting Procedure
Notification Code
MinSat1 Threshold MJ
Crossed
MinSat2 Threshold MJ
Crossed
Antenna error (open or MJ Ignore if the operational state is normal
short) (see Forcing the GNSS Antenna State to
Connected). If the operational state is not
normal:

l Verify the number of tracked satellites.


If zero, verify that the antenna cable is
securely connected to the antenna
input.
l Ensure that the required power of the
antenna is compatible (3.3V).
l Ensure that sufficient sky view is
available above the antenna.
l Replace the antenna.

PTP - Sync Timeout MN The system reports this alarm if the slave
did not receive the sync message for a
specified time period.
PTP - Announce Timeout MN The system reports this alarm if the slave
did not receive the announce message for
a specified time period.
PTP - Delay Response MN The system reports this alarm if the slave
Timeout did not receive the delay response
message for a specified time period.
PTP – Peer Delay NR The system reports this alarm if the slave
Response Timeout did not receive the peer delay response
message for a specified time period.
PTP - Loss of Announce NR The system did not receive the announce
message before the
announceReceiptTimeout message. Verify
and troubleshoot the clock reference.

OSA 5401 R12.1.1 User Manual - Issue: A 65


Oscilloquartz: An ADVA Company Managing the OSA 5401

Table 11: Built-in Alarms


NSA Default
Condition Type Troubleshooting Procedure
Notification Code
PTP - Loss of NR The software did not receive a
Synchronization sync/followup message before a
syncReceiptTimeout message, or did not
receive a DelayResponse message is
before a delRespReceiptTimeout message.
Verify and troubleshoot the clock
reference.
PTP - wrong domain MJ
SJ not locked to MJ Verify and troubleshoot the clock reference
reference (time) and the provisioning details.
SJ not locked to MJ Verify and troubleshoot the clock reference
reference (frequency) and the provisioning details.
SJ test reference fail MJ
SJ test source fail MJ
SJ test no message MJ
SJ max TE threshold MJ
exceeded
SJ constant TE threshold MJ
exceeded
SJ instant TE threshold MJ
exceeded
Equipment fault CR Hardware failure.
Equipment mismatch CR GNSS chip failure.
Failure suspended NR
Linked down CR

OSA 5401 R12.1.1 User Manual - Issue: A 66


Oscilloquartz: An ADVA Company Managing the OSA 5401

Built-In Events
The built-in events in the OSA 5401 report on specific actions that occur in the system. The
alarm and event history logs stores these events. Table 12 lists the built-in events,
descriptions, and suggested troubleshooting procedures.

Table 12: Built-in Events


Event Description Troubleshooting Procedure
System up System is up and running. Not applicable.
System reboot The system restarts because Not applicable.
of a software upgrade or an
administrative restart
command.
Telnet login User logged in successfully. Not applicable.
Telnet logoff User logged off. Not applicable.
SSH login User logged in successfully. Not applicable.
SSH logoff User logged off. Not applicable.
SSH authentication Incorrect username or Type the correct username and
fail. password. password.

Viewing Alarms and Events


To view alarms and events, you can use these CLI commands:

l info log: Displays the history of the alarms and events that the log contains (see
Viewing the Alarm and Event History Log).
l info alarms: Lists the active and supported alarms (see Viewing Active and
Supported Alarms).

Viewing the Alarm and Event History Log


You can view each entry in the alarm and event history log that have occurred since the last
restart of the OSA 5401. Each alarm and event entry contains a timestamp from the last
restart. The log can store up to 200 events. After it reaches the maximum limit, the system
overwrites previous log entries to display new items. The system clears the log after you
power off the device, but maintains the content after a restart.

To view the alarm and event history log:

Enter this command:

info log

OSA 5401 R12.1.1 User Manual - Issue: A 67


Oscilloquartz: An ADVA Company Managing the OSA 5401

Sample Output:

LOG:
Up Time Date/Time Description
-------- ------------------- ------------------------------------------
367 2017-06-02 07:15:32 EVT: 192.168.0.200: Telnet session started
282 2017-06-02 07:14:06 OFF: Clock Frequency Not Traceable
96 2017-06-02 07:11:00 OFF: Clock Time Not Traceable
96 2017-06-02 07:11:00 OFF: Clock in Frequency Freerun
2 1970-01-01 00:00:40 ON: PTP - Announce Timeout
2 1970-01-01 00:00:40 ON: PTP - Loss of Announce
0 1970-01-01 00:00:38 ON: Clock Frequency Not Traceable
0 1970-01-01 00:00:38 ON: PTP - Sync Timeout
0 1970-01-01 00:00:38 ON: PTP - Loss of Synchronization
0 1970-01-01 00:00:31 ON: Clock Time Not Traceable
0 1970-01-01 00:00:31 ON: Clock in Time Freerun
0 1970-01-01 00:00:31 EVT: System up

Viewing Active and Supported Alarms


The list of the active and supported alarms are available in a table format categorized by the
designated alarm-profile notification code (NC). Each item includes a brief description of
the condition. These two tables are provided:

l Active Alarms: Displays the current alarms that the system detected and their
corresponding timestamp. This list includes alarms that are not reported to the
Network Management System (NMS) and that are classified with an NR notification
code.
l Alarm Attributes: Lists all the alarms that the system can be report on, which are
the built-in alarms. For each alarm, the table includes these additional performance
parameter (PP) attributes:
l Loc: The location indicates that the performance parameter is a near-end
parameter. The system determines the location in relation to the
monitored entity, which means that the performance parameter occurred
locally to the entity or at the near end.
l Dir: The direction indicates whether the performance parameter is a
receive or transmit parameter. The direction is in relation to the monitored
entity.
l SA: Determines whether the alarm is marked as a service-affecting (SA)
critical alarm, which you should clear first. Next you should clear the major
service-affecting alarms, and then the minor service-affecting alarms. After
that, you should clear any remaining non-service-affecting (NSA) major
alarms, followed by any minor alarms.

To view the active and supported alarms:

OSA 5401 R12.1.1 User Manual - Issue: A 68


Oscilloquartz: An ADVA Company Managing the OSA 5401

Enter this command:

info alarms

Sample Output:

Active Alarms:
NC Description Date/Time
-- -------------------------------------- -------------------
MN PTP - Sync Timeout 1970-01-01 00:00:38
MN PTP - Announce Timeout 1970-01-01 00:00:40
NR PTP - Loss of Announce 1970-01-01 00:00:40
NR PTP - Loss of Synchronization 1970-01-01 00:00:38
Alarm Attributes: 1/3
NC Description Loc Dir SA
-- --------------------------------- ---- ------- ---
NR Clock in Time Freerun Near RCVONLY NSA
NR Clock in Time Holdover Near RCVONLY NSA
MJ Clock Time Not Traceable Near RCVONLY NSA
NR Clock in Frequency Freerun Near RCVONLY NSA
NR Clock in Frequency Holdover Near RCVONLY NSA
MJ Clock Frequency Not Traceable Near RCVONLY NSA
MJ Antenna error (open or short) Near RCVONLY NSA
MN PTP - Sync Timeout Near RCVONLY NSA
MN PTP - Announce Timeout Near RCVONLY NSA
MN PTP - Delay Response Timeout Near RCVONLY NSA
NR PTP - Loss of Announce Near RCVONLY NSA
NR PTP - Loss of Synchronization Near RCVONLY NSA
NR PTP - Clock Class Mismatch Near RCVONLY NSA
NR PTP - Wrong Domain Near RCVONLY NSA
NR PTP - Peer Delay Response Timeout Near RCVONLY NSA
MJ SJ not locked to reference (time) Near RCVONLY NSA
MJ SJ not locked to reference (freq) Near RCVONLY NSA
NR SJ Test Reference Fail Near RCVONLY NSA
NR SJ Test Source Fail Near RCVONLY NSA
NR SJ Test No Message Near RCVONLY NSA
NR SJ Max TE Threshold Exceeded Near RCVONLY NSA
NR SJ Constant TE Threshold Exceeded Near RCVONLY NSA
NR SJ Instant TE Threshold Exceeded Near RCVONLY NSA
CR Equipment fault Near RCVONLY NSA
CR Equipment mismatch Near RCVONLY NSA
CR SFP module mismatch Near RCVONLY NSA
CR SFP removed Near RCVONLY NSA
CR SFP transmit fault Near RCVONLY NSA
NR SFP not qualified Near RCVONLY NSA
MJ Jamming/Interference detected Near RCVONLY NSA
MJ Spoofing detected Near RCVONLY NSA
NR MinSat1 Threshold Crossed Near RCVONLY NSA
NR MinSat2 Threshold Crossed Near RCVONLY NSA

OSA 5401 R12.1.1 User Manual - Issue: A 69


Oscilloquartz: An ADVA Company Managing the OSA 5401

NR Spoofing detected - Pps Near RCVONLY NSA


NR Spoofing detected - Loc Near RCVONLY NSA
NR L1 Signals Available Only Near RCVONLY NSA
NR Advanced Jamming Detection Near RCVONLY NSA
NR Advanced Spoofing Detection Near RCVONLY NSA
NR Failure Suspended Near RCVONLY NSA
CR Link Down Near RCVONLY NSA

Assigning a New Alarm Notification Code


Depending on your system requirements, to change the severity of an alarm condition you
can assign it a new notification code.

l For more information about built-in alarms and the default


notification codes assigned to each alarm condition, see Built-In
Alarms.
l For a list of the supported notification codes, see Alarm Profile
Notification Codes.

To assign a new alarm notification code to an alarm condition:

Enter this command, where <alarm-type> is the alarm condition whose severity you want
to change, and <severity-level> is the new notification code you want to assign:

configure management alarm <alarm-type> severity <severity-level>

OSA 5401 R12.1.1 User Manual - Issue: A 70


Oscilloquartz: An ADVA Company Managing the OSA 5401

Configuring Synchronization
Configuring synchronization includes:

Viewing the Clock Reference Priorities 71

Configuring GNSS Clock Reference 72

Configuring PTP Profiles 79

Configuring Master Clocks 80

Configuring PTP Boundary Clocks 85

Configuring a Static L3 PTP Slave Entry 85

Configuring PTP Slave Clocks 86

Configuring SyncE Mode 92

Configuring NTP, TIME, and DAYTIME Servers 92

Viewing the Clock Reference Priorities


The OSA 5401 synchronizes to different time and frequency sources, referred to as clock
references. The system prioritizes the clock references from the strongest to the weakest in
case a clock reference becomes unavailable or invalid. This prioritization ensures that the
OSA 5401 can transition to a lower-ranking backup clock reference instead of to a holdover
state.

To configure the clock reference list:

Enter this command. The list of references must always end with ocxo:

configure clock references <references>

For example:

configure clock references gnss ptp ocxo

Default:

configure clock references gnss ptp synce sci ocxo

You must configure and enable a PTP slave clock to use the PTP Slave
Clock reference. For that reason, this option is disabled by default (see
).

OSA 5401 R12.1.1 User Manual - Issue: A 71


Oscilloquartz: An ADVA Company Managing the OSA 5401

To view the statuses of the clock reference priorities:

Enter this command:

info reference-clocks

Sample output:

1 GNSS Selected
2 L2 PTP Slave Disabled
2 L3 PTP Slave Disabled
3 SyncE Disabled
4 SCI Disabled
5 Local OCXO OK

Configuring GNSS Clock Reference


The OSA 5401 has a built-in global navigation satellite system (GNSS) receiver to manage
frequency and time reference. The device can use the GNSS as a clock reference, for
example, as a time- and frequency-based reference to the Grandmaster Clock.

You can disable the GNSS clock reference or change the GNSS mode depending on your
network configuration. When you connect the device to an external RF antenna, you can
account for antenna cable delays in the timing signal that the antenna delivers. In addition,
you can configure the location mode for the GNSS receiver. If you incorrectly deleted some
GNSS antenna models, you can force the GNSS antenna state to Connected. If the GNSS
fails, you can configure a backup clock.

Disabling a GNSS Clock Reference 73

Defining the RF Antenna Cable Delay 73

Setting the GNSS Mode 73

Setting the GNSS Augmentation Mode 74

Setting Satellite Minimum 1 and Minimum 2 Thresholds 74

Setting GNSS Dynamic Mode 75

Setting Elevation and SNR Masks 75

Configuring GNSS Location Mode 76

Configuring GNSS Time Advance 77

Configuring GNSS Failure Suspension 77

OSA 5401 R12.1.1 User Manual - Issue: A 72


Oscilloquartz: An ADVA Company Managing the OSA 5401

Forcing the GNSS Antenna State to Connected 78

Configuring a Backup Clock for the GNSS 78

Disabling a GNSS Clock Reference


The software enables GNSS and configures it as a clock reference by default. Depending on
your system configuration, for example, when you configure a boundary clock, you might
want to disable GNSS.

To disable a GNSS clock reference:

l Enter this command:

configure clock gnss shutdown

To re-enable the GNSS clock reference, enter this command:


configure clock gnss no shutdown

Defining the RF Antenna Cable Delay


Configure the antenna cable delay when you connect an external RF antenna. After you
connect the RF antenna, delays might occur in the timing signal that the antenna delivers to
the OSA 5401. You can configure the cable delay value to be from 0 to 9,999 nanoseconds
(ns), and the default is zero for no delay.

When you define the cable delay value, take into account the delay introduced by every
component starting from the antenna and all the way to the receiver (antenna, all cables,
line amplifiers, splitter, etc.).

For more information about the overall cable delay for each antenna
configuration, see RF Antenna Installation.

To define the RF antenna cable delay:

Enter this command, where the <range> value is 0 to 9999 ns with the default set to 0:

configure clock gnss antenna-delay <range>

Setting the GNSS Mode


Depending on your network configuration, you can change the default GNSS mode. After
you change GNSS modes, it can take time for the OSA 5401 to stabilize to the new mode.

OSA 5401 R12.1.1 User Manual - Issue: A 73


Oscilloquartz: An ADVA Company Managing the OSA 5401

During the stabilization period, some phase jumps can occur on the clock signals and affect
the displayed information.

The OSA 5401 supports these GNSS modes:

l GPS (default)
l Galileo (OSA 5401 hardware version 5.01)
l GLONASS
l BeiDou
l GPS+GLONASS
l GPS+BeiDou
l GPS+Galileo+BeiDou (OSA 5401 hardware version 5.01)
l GPS+Galileo+GLONASS (OSA 5401 hardware version 5.01)

To change the GNSS mode:

Enter this command, where <options> are any of the modes previously listed, and the
default is set to GPS):

configure clock gnss mode [ gps,glonass,beidou,galileo ] comma-delimited list ;


default=gps

Setting the GNSS Augmentation Mode


The OSA 5401 supports four GNSS augmentation modes:

l None (default)
l SBAS
l QZSS
l SBAS+QZSS

To change the GNSS augmentation mode:

Enter this command, where <options> is any of the available modes and the default is set
to none:

configure clock gnss augmentation <options>

Setting Satellite Minimum 1 and Minimum 2 Thresholds


Sat Min1 threshold – defines the first minimum (Min1) number of in-use satellite
thresholds. The range is 1 to 32 satellites. Default is 3 satellites.

Sat Min2 threshold – defines the second minimum (Min2) number of in-use satellite
thresholds.

OSA 5401 R12.1.1 User Manual - Issue: A 74


Oscilloquartz: An ADVA Company Managing the OSA 5401

The Sat Min2 threshold must be less than the Sat Min1 threshold, and cannot be set before
the Sat Min1 threshold is defined. The range is 1 to 32 satellites. The Sat Min1 threshold and
Sat Min1 threshold numbers are used to determine which alarm is raised if the number of
in-use GNSS satellites is below or above thresholds according to these conditions:

l When the number of valid satellites observed by the receiver is less than equal to
the Sat Min2 threshold, the Sat Min2 threshold alarm is raised.
l When the Sat Min2 threshold is less than the number of valid satellites observed by
the receiver, and the number of satellites is less than the Sat Min1 threshold, the
Sat Min1 threshold alarm is raised.
l When the Sat Min1 threshold is less than equal to the number of valid satellites
observed by the receiver, no alarm is raised. Default is 2 satellites.

To set the Sat Min1 and Min2 thresholds:

configure clock gnss satellites threshold [min-1 | min-2] <range>

Setting GNSS Dynamic Mode


The GNSS receiver is set to stationary mode when you configure the survey-in/fixed mode
and to automotive mode when you use navigation mode.

To set the GNSS dynamic model:

configure clock gnss dyn-model [portable | stationary | pedestrian | automotive | sea |


airborne_1g | airborne_2g | airborne_4g]

Setting Elevation and SNR Masks


In most cases, the OSA 5401 uses the optimal elevation and signal-to-noise ratio (SNR)
masks settings. You can also manually configure these masks depending on the location of
your device.

l Elevation: Sets the minimum elevation of a satellite above the horizon that the
navigation solution will use. Low elevation satellites can provide degraded accuracy
because of the long signal path through the atmosphere. This value is from 1 to 90
degrees, and the default is 5 degrees.
l SNR: Sets the minimum SNR of a satellite that the navigation solution will use. Low
SNR satellites can provide degraded accuracy. This value is from 1 to 60 dBHz, and
the default is 9 dBHz.

To set the minimum elevation of a satellite above the horizon:

l Enter this command, where the <range> value is from 1 to 90, and the default is 5:

configure clock gnss elevation <range>

OSA 5401 R12.1.1 User Manual - Issue: A 75


Oscilloquartz: An ADVA Company Managing the OSA 5401

To set the minimum SNR of a satellite:

l Enter this command, where the <range> value is from 1 to 60, and the default is 9:

configure clock gnss snr <range>

Configuring GNSS Location Mode


The GNSS receiver uses one of these location modes:

l navigation: If you install the OSA 5401 on a moving device, such as a vehicle or
on board a ship, use this mode.
l survey-in: (default) the OSA 5401 determines the stationary position of the
receiver based on the average results of all 3D position solutions over a three-hour
duration. After the system meets the requirements for both accuracy and time
period, the system automatically changes from survey-in mode to fixed mode.
o survey-in-minimum-duration: sets the minimum duration for the survey-

in in seconds. Default is 7200 seconds.


o survey-in-position-accuracy-limit: sets the minimum accuracy limit

for survey-in in millimeters. Default is 10,000 millimeters. The default typically


guarantees that the unit enters fixed mode within two hours and with the best
possible accuracy in the location.
The system enters fixed mode when both these thresholds are met.
l fixed: the device is aware of the position of the receiver, which is fixed. The
software calculates only the time and uses all available satellites for the calculation.
This mode also enables maximum time accuracy for single-satellite solutions. To
achieve timing accuracy in nanoseconds, the position of the receiver must be set
with an accuracy of more than one meter.

OSA 5401 R12.1.1 User Manual - Issue: A 76


Oscilloquartz: An ADVA Company Managing the OSA 5401

To configure the GNSS location mode:

1. Enter this command, where the <options> are any of the modes in the previous list,
and the default is survey-in:
configure clock gnss location mode <options>

2. When you configure a fixed mode, enter these commands to set the latitude and
longitude coordinates and the height values:

l configure clock gnss location latitude <range>: where the


default is 0, and the <range> is –90 to 90 degrees.
l configure clock gnss location longitude <range>: where
the default is 0, and the <range> is –180 to 180 degrees.
l configure clock gnss location altitude <range>: where the
default is 0, and the <range> is –900,000 to 900,000 cm.

Configuring GNSS Time Advance


Configure this property to compensate for the multipath delay. Default value is 0
nanoseconds.

Auto mode is not supported.

To configure Time Advance:

Enter this command to configure the time advance with 100 nanoseconds.

configure clock gnss time-advance fixed 100

Configuring GNSS Failure Suspension


Failure Suspend Time
Failure suspension allows to mask GNSS alarms during a GNSS outage so that the GNSS
remains an active clock reference until the failure-suspend-time expires.

To configure the failure suspend time:

configure clock gnss failure-suspend-time <3-86400>

Range: 3 — 86400 seconds, default value: 3 seconds.

Alarms While Failure Suspend


Disable to mask the GNSS alarms during the failure suspend time or select enabled to
report the GNSS alarms as usual during the failure suspend time.

To enable or disable alarms while failure suspend:

OSA 5401 R12.1.1 User Manual - Issue: A 77


Oscilloquartz: An ADVA Company Managing the OSA 5401

configure clock gnss alarms-while-failure-suspend [enabled | disabled]

Forcing the GNSS Antenna State to Connected


If the software detects the alarm condition, Antenna error, the OSA 5401 is unable to lock to
the GNSS. You can force the antenna state to stay connected after you verify that the
operational state is normal, because the OSA 5401 might not correctly detect some GNSS
antenna models.

For more information about built-in alarms and the alarm condition type
Antenna error, see Built-In Alarms.

To force the GNSS antenna state to connected:

l Enter this command:

configure clock gnss forced-antenna-connected

Configuring a Backup Clock for the GNSS


If a GNSS fails, you can use a PTP slave clock or Synchronous Ethernet as a backup clock.
Table 13 explains the possible backup configurations. This table also includes the steps you
can use to correctly set up an alternative backup clock based on the default configuration.

Table 13: Backup Clock for GNSS Configuration Options


Backup Clock for GNSS
Configuration Steps Required
Options
GNSS and PTP as a backup l Enable GNSS (default configuration).
(APTS) l Configure and enable a Layer 2 or Layer 3 PTP slave clock
including the IP addresses of acceptable masters and
packet rates (see Configuring PTP Slave Clocks).
l Set PTP slave algorithm mode to ptp-aware.
GNSS and SyncE as a l Enable GNSS (default configuration).
backup l Enable SyncE as a slave (default configuration) with a
proper SyncE source in the network that needs the slave.
l Disable the PTP slave clock (default configuration);
otherwise, it is selected, if available.

OSA 5401 R12.1.1 User Manual - Issue: A 78


Oscilloquartz: An ADVA Company Managing the OSA 5401

Table 13: Backup Clock for GNSS Configuration Options


Backup Clock for GNSS
Configuration Steps Required
Options
GNSS and PTP + SyncE as a l Enable GNSS (default configuration).
backup l Configure and enable a Layer 2 or Layer 3 PTP slave clock
including IP addresses of acceptable masters and packet
rates (see Configuring PTP Slave Clocks).
l Enable SyncE as a slave (default configuration) with a
proper SyncE source in the network that needs the slave.

Configuring PTP Profiles


You can configure the OSA 5401 PTP port to use different profiles and set parameters for
each profile. The OSA 5401 supports both Layer 2 PTP for PTP-over-Ethernet and Layer 3
PTP for PTP-over-IP/UDP profiles.

For a complete list of the profiles and the supported parameters, see Supported PTP Profiles
and Parameters.

Layer 2 PTP Profiles


l G.8275.1 (default)
l IEEE1588-2008 Annex F
l IEC-61850-9-3
l C37.238-2011
l C37.238-2017
l 802.1AS-2011

Layer 3 PTP Profiles


l G.8265.1 (default)
l Telecom-2008
l G.8275.2
l AES67 Media
l SMPTE ST-2059-2

The PTP domain number range for all profiles is 0 to 255. If you change a PTP profile, the
software applies the default settings for the packet rates. The system supports 64 slaves at
all packet rates. However, each L2 and L3 multicast grandmaster clock reserves one entry, so
that the maximum number of L3 PTP unicast slaves is 62.

l Packet rates for Sync and DelayRequest or DelayResponse messages are


{1, 2, 4, 8, 16, 32, 64, 128} pps

OSA 5401 R12.1.1 User Manual - Issue: A 79


Oscilloquartz: An ADVA Company Managing the OSA 5401

l Packet rates for Announce messages are {1/16, 1/8, 1/4, 1/2, 1, 2, 4, 8} pps

The PTP domain number remains the same if you change a PTP profile.

To change a Layer 2 PTP profile, enter this command, where the default is g8275.1:

configure clock l2-profiles [master | slave] profile [ g8275.1 | 1588_2008_annex_f | iec-


61850-9-3 | c37.238-2011 | c37.238-2017 | 802.1as-2011] ;default=g8275.1

To change a Layer 3 PTP profile, enter this command, where the default is g8265.1

configure clock l3-profiles [master | slave] profile [ g8265.1 | telecom2008 | g8275.2 |


aes67-media | smpte-st-2059-2 ] ;default=g8265.1

Configuring Master Clocks


The OSA 5401 PTP master clock supports both Layer 2 PTP for PTP-over-Ethernet and Layer
3 PTP for PTP-over-IP/UDP distribution in unicast and multicast modes simultaneously.

Configuring Priority1 Values 80

Configuring Priority2 Values 81

Configuring Delay Asymmetry Compensations 81

Configuring Best Master Clock Algorithm for Master Clocks 82

Configuring Layer 2 PTP Master Clocks 82

Configuring Layer 3 PTP Master Clocks 83

Configuring Priority1 Values


If a network has two almost identical master clocks, you might want to force a PTP slave
clock to prioritize a certain master clock over another one. You would do this for any
number of reasons, including for the type of device, for more capacity, or for better
connectivity.

To configure the Priority1 value for a Layer 2 PTP master clock:

Enter this command, where the value is from 0 to 255:

configure clock l2-profiles master priority1 <0-255>

To configure the Priority1 value for a Layer 3 PTP master clock:

Enter this command, where the value is from 0 to 255:

OSA 5401 R12.1.1 User Manual - Issue: A 80


Oscilloquartz: An ADVA Company Managing the OSA 5401

configure clock l3-profiles master priority1 <0-255>

Configuring Priority2 Values


If the Priority1 value is the same for different master clocks in a network, the software uses a
Priority2 value to differentiate and prioritize the master clocks to avoid confusion. For
example, if a network has two almost identical master clocks, you might want to force a PTP
slave clock to prioritize a certain master clock over another one. You would do this for any
number of reasons, including for the type of device, for more capacity, or for better
connectivity.

To configure the Priority2 value for a Layer 2 PTP master clock:

Enter this command, where the value is from 0 to 255:

configure clock l2-profiles master priority2 <0-255>

To configure the Priority2 value for a Layer 3 PTP master clock:

Enter this command, where the value is from 0 to 255:

configure clock l3-profiles master priority2 <0-255>

Configuring Delay Asymmetry Compensations


Asymmetry introduces time error, and network delay is often asymmetrical. Any delay
asymmetry contributes to the error in the time-offset calculation (time error):

Offset+(Delay_MS-Delay_SM)/2=(T2-T1)-(T4-T3))/2

You might already know the value of the delay asymmetry that you must consider. You can
configure this value for any number from –100,000,000 to 100,000,000 nsec.

To configure the Delay Asymmetry Compensation value for a Layer 2 PTP master
clock:

l Enter this command, where the value is from –100,000,000 to 100,000,000 nsec:

configure clock l2-profiles port-delay-asymmetry <range>

To configure the Delay Asymmetry Compensation value for a Layer 3 PTP master
clock:

l Enter this command, where the value is from –100,000,000 to 100,000,000 nsec:

configure clock l3-profiles port-delay-asymmetry <range>

OSA 5401 R12.1.1 User Manual - Issue: A 81


Oscilloquartz: An ADVA Company Managing the OSA 5401

Configuring Best Master Clock Algorithm for Master Clocks


OSA 5401 supports default and alternate BMC (Best Master Clcok) algorithms according to
the PTP profiles. BMCA is enabled by default.

Limitation:

BMCA for the master clock must be disabled if OSA 5401 is used as a L2 PTP or L3 PTP
multicast boundary clock (BC).

To disable BMCA:

configure clock [l2-profiles | l3-profiles] master bmca disable

Configuring Layer 2 PTP Master Clocks


When you use phase synchronization, you configure a Layer 2 PTP master clock and enable
the phase synchronization setting. The default is disabled. After the software sends enabled
sync and announce messages, you can verify the status of the master clock and any
associated slave clock statuses to make sure that the master clock is enabled. In addition,
you can use other commands to manage a Layer 2 PTP master clock (see Additional Layer 2
PTP Configuration Commands).

To configure a Layer 2 PTP master clock:

1. Enter this command to enable the Layer 2 PTP master clock setting:
configure clock l2-profiles master no shutdown

2. Enter this command to configure the interface for Layer 2 PTP traffic:
configure clock l2-profiles master interface [ replace ]

3. Enter this command to configure the one-step/two-step mode for L2 PTP master:
configure clock l2-profile master type [one-step | two-step],
default: one-step

4. Enter this command to verify that the master clock, including any of its associated slave
clocks, is enabled, and provide additional details related to the clocks:
configure clock l2-profiles show status

Sample Output:

Master:
multicast: enabled
rate announce: 8 pps
rate sync-dresp: 16 pps
Tx clockClass: 6
Dynamic slaves: 1

Active GM Clock ID: 00:80:EA:FF:FE:0F:12:93


Time Source: GPS
Frequency Traceable: TRUE

OSA 5401 R12.1.1 User Manual - Issue: A 82


Oscilloquartz: An ADVA Company Managing the OSA 5401

Time Traceable: TRUE


UTC Offset: 37
Slave: disabled

Counters: Received Sent


Sync: 0 4630
DelayReq: 4630 0
DelayResp: 0 4630
Announce: 0 2318

Additional Layer 2 PTP Configuration Commands


These additional Layer 2 PTP commands can be helpful when you configure a Layer 2 PTP
master clock:

Table 14: Additional L2 PTP Configuration Commands


Command Description
configure clock l2-profiles master Sets the forwardable or non-
mac <options> forwardable MAC address.
configure clock l2-profiles master Sets the multicast announce packet
rate announce <range> rate {1/16, 1/8, 1/4, 1/2, 1, 2, 4, 8} pps.
configure clock l2-profiles master Sets the multicast Sync and
rate sync-dresp <range> DelayRequest or DelayResponse
packet rate {1, 2, 4, 8, 16, 32, 64, 128}
pps.
configure clock l2-profiles slave Sets the slave domain number (0 to
domain-number [ <number> ] 255, default = 24).
configure clock l2-profiles master Sets the master domain number (0 to
domain-number [ <number>] 255, default = 24)
configure clock l2-profiles tlv Sets the grandmaster ID, grandmaster,
[time-inaccuracy | net-time- total, and network time inaccuracy for
inaccuracy | gm-identity]
PTP power profiles.

Configuring Layer 3 PTP Master Clocks


Before you configure a Layer 3 PTP master clock, be sure to complete the prerequisite step
related to your network configuration.

Prerequisite Step:
In general, you configure different IP addresses to handle management and Layer 3 PTP
(Clock) traffic. Before you configure a Layer 3 PTP master clock, make sure that you correctly
configure the network connectivity options (see Configuring IP Addresses and VLANs).

OSA 5401 R12.1.1 User Manual - Issue: A 83


Oscilloquartz: An ADVA Company Managing the OSA 5401

Enabling Multicast Mode 84

Viewing Dynamic Remote Slaves 84

Additional Layer 3 PTP Configuration Commands 84

Enabling Multicast Mode


A Layer 3 PTP master clock supports both unicast and multicast modes at the same time.
You can enable the multicast mode according to your network or system configuration.

To enable the multicast mode, enter this command:

configure clock l3-profiles master multicast no shutdown

To configure the interfaces for multicast traffic, enter this command:

configure clock l3-profiles master multicast interface [ replace | add | remove ]

To configure one-step/two-step mode for L3 PTP master:

configure clock l3-profile master type [one-step | two-step],


default: one-step

Viewing Dynamic Remote Slaves


To view the list of dynamic remote slaves associated with the Layer 3 PTP master clock,
enter this command, where you provide additional details:

configure clock l3-profiles show remote-slave-list

Sample Output:

ClockId:PortId IP Address Ann Sync DelayRsp LeaseDur LeaseDurRem


0080EAFFFE86AB32:1 192.168.0.2 1 128 128 300 100
0080EAFFFE86AB33:1 192.168.0.3 1/16 64 64 300 100

Additional Layer 3 PTP Configuration Commands


These additional Layer 3 PTP commands can be helpful when you configure a Layer 3 PTP
master clock:

Table 15: Additional L3 PTP Configuration Commands


Command Description
configure clock l3-profiles master Enables or disables a Layer 3 PTP
unicast [no] shutdown unicast master.

OSA 5401 R12.1.1 User Manual - Issue: A 84


Oscilloquartz: An ADVA Company Managing the OSA 5401

Table 15: Additional L3 PTP Configuration Commands


Command Description
configure clock l3-profiles master Sets the multicast announce packet
multicast rate announce <range> rate {1/16, 1/8, 1/4, 1/2, 1, 2, 4, 8} pps.
configure clock l3-profiles master Sets the multicast Sync and
multicast rate sync-dresp <range> DelayRequest or DelayResponse
packet rate {1, 2, 4, 8, 16, 32, 64, 128}
pps.
configure clock l3-profiles slave Sets the slave domain number (0 to
domain-number [ <number> ] 255, default = 4).
configure clock l3-profiles master Sets the master domain number (0 to
domain-number [ <number>] 255, default = 4)
configure clock 13-profiles tlv Sets video frame rate and time address
[smpte-system-frame-rate | smpte- for SMPTE ST 2059-2 profile.
time-address-flags]

OSA 5401 supports 64 slaves at 128 pps. However, each L2 and L3 multicast grandmaster
clock reserves one entry, so that the maximum number of L3 PTP unicast slaves is 62.

Configuring PTP Boundary Clocks


The OSA 5401 runs as a PTP boundary clock when you enable both PTP slave, Layer 2 or
Layer 3, and PTP master clocks, and you disable GNSS.

l Configuring Layer 2 PTP Master Clocks


l Configuring Layer 3 PTP Master Clocks
l Configuring PTP Slave Clocks
l Disabling a GNSS Clock Reference

Configuring a Static L3 PTP Slave Entry


The device supports PTP unicast message negotiation (UMN) that is the preferred method
to provide a PTP service for slaves. If a PTP slave does not support the UMN, the device
enables you to configure the IP address and packet rates statically for one slave.

To configure the IP address of the static L3 PTP slave entry:

configure clock l3-profiles master unicast static-slave 1 ip-address <ipv4/ipv6-address>

To configure the packet rates of the static L3 PTP slave entry:

OSA 5401 R12.1.1 User Manual - Issue: A 85


Oscilloquartz: An ADVA Company Managing the OSA 5401

configure clock l3-profiles master unicast static-slave 1 rate announce [ 1/16 | 1/8 |
1/4 | 1/2 | 1 | 2 | 4 | 8 ]
configure clock l3-profiles master unicast static-slave 1 rate sync [ 1 | 2 | 4 | 8 | 16
| 32 | 64 | 128 ]

To configure the PTP interface for the static L3 PTP slave entry:

configure clock l3-profiles master unicast static-slave 1 interface [ptp1 | ptp2 | ptp3]

To enable or disable the static L3 PTP slave entry:

configure clock l3-profiles master unicast static-slave 1 [enable | disable]

Configuring PTP Slave Clocks


The device supports one PTP slave clock instance, which can be either a Layer 2 or Layer 3
slave clock.

Configuring Best Master Clock Algorithm for Slave Clocks 86

Configuring Layer2 PTP Slave Clocks 86

Configuring Layer 3 PTP Slave Clocks 89

Configuring Best Master Clock Algorithm for Slave Clocks


OSA 5401 supports default and alternate BMC algorithms according to the PTP profiles.
BMCA listens to up to two PTP master clocks and is enabled by default.

To disable BMCA:

configure clock [l2-profiles | l3-profiles] slave bmca disable

Configuring Layer2 PTP Slave Clocks


To configure a Layer 2 PTP slave clock, enable the related setting, and then verify the status
of the Layer 2 PTP slave clock and its associated master clock. For the PTP port with a Layer
2 PTP profile that uses Ethernet multicast addressing, you can configure whether the
software will use forwardable or non-forwardable addresses. You can also configure delay
asymmetry compensation for a Layer 2 PTP slave clock.

Enabling Layer 2 PTP Slave Clocks 87

Viewing the Layer 2 PTP Slave Clock Status 87

Configuring a Forwardable or Non-Forwardable Destination MAC Address 88

OSA 5401 R12.1.1 User Manual - Issue: A 86


Oscilloquartz: An ADVA Company Managing the OSA 5401

Configuring Layer 2 End-to-End Delay Asymmetry Compensation 88

Configuring Clock Mode 89

Configuring SyncE Assist Mode 89

Enabling Layer 2 PTP Slave Clocks


To configure a Layer 2 PTP slave clock, you enable the related setting. The default is
disabled. You can also verify the status of the PTP slave clock and any associated PTP master
clock statuses to ensure that the Layer 2 PTP slave clock is enabled.

To configure a L2 PTP slave clock:

1. Enter this command to enable the Layer 2 PTP slave clock setting:

configure clock l2-profiles slave no shutdown

2. Verify that the master clock, including any of it associated slave clocks, is enabled (see
Viewing the Layer 2 PTP Slave Clock Status).

Viewing the Layer 2 PTP Slave Clock Status


To view the status of the Layer 2 PTP slave clock and other details for its related Layer 2 PTP
master clock, enter this command:

configure clock l2-profiles show status

Example Output:

Slave: enabled
Status (freq/phase): syntonized/synchronized
rate announce: 1 pps
rate sync-dresp: 1 pps
Mean Path Delay: 2763 ns
Offset From Master: 181 ns
Delay Asymmetry: Manual, 0 ns
Clock/Message Mode: two-way, one-step
Delay Mechanism: p2p
Clock ID: 00:80:EA:FF:FE:86:AB:01
Time Source: GPS
Clock Class: 6
Freq/Time Traceable: TRUE/TRUE
UTC Offset: 37
Current packet rates: 1 pps 1 pps
Counters: Received Sent
Sync: 5535 0
FollowUp: 0 0
DelayReq: 0 0

OSA 5401 R12.1.1 User Manual - Issue: A 87


Oscilloquartz: An ADVA Company Managing the OSA 5401

DelayResp: 0 0
PDelayReq: 0 5587
PDelayRsp: 5587 0
PDRespFup: 0 0
Announce: 5625 0

Configuring a Forwardable or Non-Forwardable Destination MAC


Address
A PTP port for a Layer 2 PTP profile uses Ethernet multicast addressing to transmit all PTP
messages. You select this setting as forwardable or non-forwardable. You will provision
generated PTP-frame destination MAC addresses in this procedure. Two multicast
addresses are supported:

l Non-forwardable (default): 01-80-C2-00-00-0E


l Forwardable: 01-1B-19-00-00-00

To configure MAC addresses for a Layer 2 PTP slave clock port:

l Enter this command, where the default uses the non-forwardable address:
01-80-C2-00-00-0E):

configure clock l2-profiles slave mac <options>

Configuring Layer 2
End-to-End Delay Asymmetry Compensation
Asymmetry introduces time error, and network delay is often asymmetrical. Any delay
asymmetry contributes to the error in the time-offset calculation (time error):

Offset+(Delay_MS-Delay_SM)/2=(T2-T1)-(T4-T3))/2

The OSA 5401 automatically learns the delay asymmetry.

To enable automatic delay asymmetry compensation:

configure clock l2-profiles slave delay-asymmetry-mode auto

You might already know the value of the delay asymmetry that you need to consider. You
can configure this value for any number from –100,000,000 to 100,000,000 nsec.

To enable manual delay asymmetry compensation:

configure clock l2-profiles slave delay-asymmetry-mode manual

To configure the Delay Asymmetry Compensation value for a Layer 2 PTP slave clock:

l Enter this command, where the value is from –100,000,000 to 100,000,000 nsec:

configure clock l2-profiles slave delay-asymmetry <range>

OSA 5401 R12.1.1 User Manual - Issue: A 88


Oscilloquartz: An ADVA Company Managing the OSA 5401

Configuring Clock Mode


PTP slave supports one-way and two-way (default) clock modes.

To change the clock mode:

configure clock l2-profiles slave clock-mode [ two-way | one-way ]

Configuring SyncE Assist Mode


To enable SyncE Assist Mode:

configure clock [l3|l2]-profiles slave synce-assist synce-nossm

Configuring Layer 3 PTP Slave Clocks


A Layer 3 PTP slave clock supports three different modes: unicast, multimode, and hybrid.
You can configure the requested packet rates depending on your network system
requirements. You can also configure up to two acceptable Layer 3 PTP master clocks for a
Layer 3 PTP slave clock and configure the end-to-end delay compensation.

Defining Layer 3 PTP Modes 89

Configuring Delay Mechanism 90

Configuring Clock Mode 90

Configuring Requested Packet Rates 90

Configuring Acceptable Master Clocks and Delay Asymmetry 91

Configuring Algorithm Mode 91

Configuring Local Priority 91

Configuring SyncE Assist Mode 92

Defining Layer 3 PTP Modes


A Layer 3 PTP slave clock supports these modes:

l Unicast (default mode): The software uses PTP unicast negotiation with signaling.
Before the system establishes a PTP session, it negotiates the announce,
synchronization, and delay response packet rates between the master and the
slave.
l Multicast: No signaling messages are sent. All PTP messages are sent with IPv4 PTP
multicast address 224.0.1.129. IPv6 PTP multicast is not currently supported.

OSA 5401 R12.1.1 User Manual - Issue: A 89


Oscilloquartz: An ADVA Company Managing the OSA 5401

l Hybrid: This mode is also called an Enterprise profile. A slave receives announce
and sync messages with the IP PTP multicast address 224.0.1.129. The software
sends DelayRequests and receives DelayResponses as unicast.

To define a Layer 3 PTP mode:

l Enter this command, where the default mode is unicast:

configure clock l3-profiles slave mode [unicast | multicast | hybrid]

Configuring Delay Mechanism


PTP slave supports end-to-end (default) and peer-to-peer delay mechanisms.

To change the delay mechanism:

configure clock l2-profiles slave delay-mechanism [ e2e | p2p ]

Configuring Clock Mode


PTP slave supports one-way and two-way (default) clock modes.

To change the clock mode:

configure clock l3-profiles slave clock-mode [ two-way | one-way

Configuring Requested Packet Rates


You configure Layer 3 PTP profiles with default requested packet rates for a specified range
(see Configuring PTP Profiles), where all packet rates support 32 slaves.

l Packet rates for Sync and DelayRequest or DelayResponse messages are {1, 2, 4, 8,
16, 32, 64, 128} pps
l Packet rates for Announce messages are {1/16, 1/8, 1/4, 1/2, 1, 2, 4, 8} pps

You can change these rates for the PTP slave clock depending on your system network
requirements.

To define Sync and DelayRequest or DelayResponse messages rate for the Layer 3
PTP slave clock:

l Enter this command, where the available packets rates for the <range> are
{1, 2, 4, 8, 16, 32, 64, 128} pps:

configure clock l3-profiles slave rate sync-dresp <range>

To define the Announce message rate for the Layer 3 PTP slave clock:

OSA 5401 R12.1.1 User Manual - Issue: A 90


Oscilloquartz: An ADVA Company Managing the OSA 5401

l Enter this command, where the available packets rates for the <range> are {1/16,
1/8, ¼, ½, 1, 2, 4, 8} pps:

configure clock l3-profiles slave rate announce <range>

Configuring Acceptable Master Clocks and Delay Asymmetry


You can configure up to two Layer 3 PTP master clocks for a Layer 3 PTP slave clock and
configure the end-to-end delay compensation. The slave computes the delay asymmetry
compensation for both acceptable master 1 and 2.

Asymmetry introduces time error, and network delay is often asymmetrical. Any delay
asymmetry contributes to the error in the time-offset calculation (time error):

Offset+(Delay_MS-Delay_SM)/2=(T2-T1)-(T4-T3))/2

The OSA 5401 automatically learns the delay asymmetry.

To enable automatic delay asymmetry compensation:

configure clock l3-profiles slave delay-asymmetry-mode auto

You might already know the value of the delay asymmetry that you must consider. You can
configure this value for any number from –100,000,000 to 100,000,000 nsec.

To enable manual delay asymmetry compensation:

configure clock l3-profiles slave delay-asymmetry-mode manual

To configure an acceptable Layer 3 PTP master clock for a Layer 3 PTP slave clock
where the end-to-end delay compensation <range> is -100,000,000 to 100,000,000 nsec:

configure clock l3-profiles slave acceptable-master [primary | backup] ip-address <ip_


address> <delay-asymmetry_range>

To configure interface for the acceptable master:

configure clock l3-profiles slave acceptable-master [primary | backup] interface [ptp1 |


ptp2 | ptp3]

Configuring Algorithm Mode


L3 PTP slave supports two algorithm modes for PTP aware and PTP unaware (default)
networks.

To change the algorithm mode:

configure clock l3-profiles slave algorithm-mode [ ptp-unaware | ptp-aware ]

Configuring Local Priority


To set the PTP LocalPriority (default 128):
OSA 5401 R12.1.1 User Manual - Issue: A 91
Oscilloquartz: An ADVA Company Managing the OSA 5401

configure clock l3-profiles slave acceptable-master [1 | 2] local-priority <1-255>

Configuring SyncE Assist Mode


To enable SyncE Assist Mode:

configure clock [l3|l2]-profiles slave synce-assist synce-nossm

Configuring SyncE Mode


You can configure the SyncE automatic negotiation mode based on your system network
configuration. These modes are supported:

l slave: use this mode when you want to use SyncE as a clock reference.
l master, default: use this mode when you want to use the OSA 5401 as a SyncE
master clock.

To configure the SyncE mode:

configure port [eth1 | eth2] synce [master | slave]

Configuring NTP, TIME, and DAYTIME Servers


The OSA 5401 supports NTP Server (NTPv1/v2/v3/v4) over IPv4 and IPv6 unicast. The
NTP server supports up to 500,000 transactions per second. The device supports both TIME
and DAYTIME protocols. DAYTIME format is: dd-mmm-yy hh:mm:ss UTC. For example, 04
OCT 19 07:59:01 UTC.

When you enable an NTP server, the server is available for all configured interfaces
including PTP1, PTP2, and PTP3.

To configure NTP, TIME, and DAYTIME Servers:

configure clock ntp server no shutdown

To view the NTP packet statistics:

configure clock ntp show status

Configuring Syncjack™
Syncjack™ is a clock monitoring system that can measure, record, and analyze timing data
across a network. Clock probes, which are embedded in all Oscilloquartz: An
ADVA Company equipment, collect raw timing data. The probes continuously compare

OSA 5401 R12.1.1 User Manual - Issue: A 92


Oscilloquartz: An ADVA Company Managing the OSA 5401

between two clock signals and record the difference. The first clock is identified by the
name of the probe and the second clock is the reference.

The clock probes continuously compare the difference between the phase of the clock
being probed and the selected reference clock. This enables accurate measurements of
both frequency and phase accuracy relative to the measurement reference timing signal.
The reference signal can be internal, external, or recovered, or can be based on a GNSS
signal. Syncjack™ continuously performs clock analysis, including frequency and phase
accuracy of packet domain, even if the sync reference is unavailable.

OSA 5401 supports two simultaneous physical clock probes and two PTP clock probe
instances. Measurement results from each of the probes is output as separate files using
FTP. The raw data files are available for any application, but we recommend to maintain
these probe instances through the ENC Network Manager. The Sync Analyzer, which is part
of the ENC Network Manager, provides a toolkit to monitor and analyze the probe capture
files. In addition, you can export the results as time-interval error (TIE) or time-error (TE) raw
data files to third-party analysis tools.

l All clock and PTP clock probes that run at the same time use the
same reference clock. The reference clock is also a source for the
OSA 5401 real-time clock if at least one probe is enabled.
l The system sets a PTP slave clock to one-way mode if GNSS is
enabled and the system uses it as a backup.
l When you start a PTP clock probe measurement and use PTP as a
reference or source, the PTP slave clock automatically changes to
two-way mode, and the PTP slave algorithm restarts.

Syncjack Functions 93

Configuring Raw Data Collection 97

Configuring Clock Probes for Clock Accuracy 98

Configuring PTP Clock Probes for Clock Analysis 100

Viewing Clock Probe Statuses 102

Syncjack Functions
The OSA 5401 uses these Syncjack tools: clock probe and PTP clock probe. The clock probe
measures clock frequency and phase accuracy based on physical signals. The PTP clock
probe performs PTP clock analysis based on packet timing signals.

The OSA 5401 has these capabilities:

OSA 5401 R12.1.1 User Manual - Issue: A 93


Oscilloquartz: An ADVA Company Managing the OSA 5401

l Actively probes and monitors multiple, telecom physical signals and multiple
packet-timing signals.
l Simultaneously probes physical signals and packet-timing signals.
l Bi-directionally probes the network packet delay variation (PDV).
l Measures network asymmetry.
l Tests multiple channels: two clock probes and two PTP clock probes.
l Tests SyncE wandering.

The OSA 5401uses these Syncjack™ functions and tools:

Parallel Probing Setup 94

Probing a Third-Party Master Port 96

Active Probing of the Network 96

Parallel Probing Setup


The OSA 5401 functions as an IEEE 1588v2 slave clock and can measure the quality of the
internal clock recovery function. If the system knows the clock recovery performance of the
OSA 5401 compared to the external slave clock, it can use the results of the OSA 5401 clock
accuracy / clock analysis function as a benchmark to assess the quality of the external slave
clock. The OSA 5401 connects to the Network Interface Device (NID) through one of the
Ethernet traffic ports to establish parallel probing. For an overview of the parallel probing
setup, see Figure 11.

In this use case, the system collects data from the measurement (TE/TIE data) between the
signal under test and the reference signal, and then sends it to the server. The server
collects the data. The system sends the data from the same port that you used to connect
PTP or SyncE.

OSA 5401 R12.1.1 User Manual - Issue: A 94


Oscilloquartz: An ADVA Company Managing the OSA 5401

Figure 11: Parallel Probing Setup

In addition, in this mode of operation, the OSA 5401 can run the clock accuracy function
and measure the quality of the internal slave clock relative to a measurement-reference
timing signal (clock Reference such as GNSS). The sync probe can also measure the quality
of the recovered SyncE clock (EEC) compared to the clock reference.

In a parallel probing setup, the OSA 5401 can also work as an IEEE 1588v2 mediation device
for an external clock (cell site/slave). When the OSA 5401 functions as an IEEE 1588v2 slave
clock, it recovers the clock using PTP. The OSA 5401 then hands off the clock to the external
clock through dedicated synchronization interfaces (for example, BITS-OUT). This ability is
especially useful for frequency distribution across legacy packet networks where neither the
network nodes nor the cell-site equipment support PTP.

The OSA 5401 in this mode runs the slave clock (OC-S).

Clock Accuracy
l Measures the accuracy of the phase and frequency that the internal slave clock
recovers with respect to a reference timing signal such as a GNSS input.
l Measures the accuracy of the incoming SyncE clock with respect to a reference
timing signal such as a GNSS input.

OSA 5401 R12.1.1 User Manual - Issue: A 95


Oscilloquartz: An ADVA Company Managing the OSA 5401

Probing a Third-Party Master Port


You can use the PTP clock analysis tool to monitor a third-party PTP master port and
associate this port to a Boundary Clock or Master Clock device under test (DUT). In this
configuration, the OSA 5401 acts as a slave clock or an active probe. The device exchanges
PTP packets with the clock under test such as a Boundary Clock. The OSA 5401
simultaneously performs measurements, using an active PTP probe, such as measuring the
quality of T1 and T4. The system sends the collected timestamped, packet TE/TIE, data from
the OSA 5401 to the server.

Figure 12: Example of Probing a Third-Party Master Port

Active Probing of the Network


When you implement active probing of the network, you direct the OSA 5401 to probe the
network under test. To do this, the OSA 5401 uses its internal telecom slave to exchange
packets across the network. The OSA 5401 usually uses a GNSS reference to get an accurate
measurement.

This setup characterizes metrics such as packet-delay variation or delay-asymmetry


compensation by using a one-way measurement in both directions. Typically, you configure
both Grandmaster and slave , which is used as a probe, to use a G.8275.2/G.8265.1 PTP
profile. Because both Grandmaster and slave probe use GNSS as a reference, the system
assumes that the time error between them is close to zero. This assumption results in an
accurate measurement of the delay in each direction.

OSA 5401 R12.1.1 User Manual - Issue: A 96


Oscilloquartz: An ADVA Company Managing the OSA 5401

For example, you can calculate the delay from the master to slave based on T1 and T2
associated with transmission and receipt of PTP sync messages, where the system measures
both using the GNSS reference. T2 – T1 = Delay from master to slave, because the Master
and Slave Clock are both locked to the same time-clock reference. The system uses the
same approach in the reverse direction by using the PTP delay request and response
messages
(T4-T3=Delay from slave to master). The system sends the collected data (packet TE/TIE
data) from the OSA 5401 to the server.

Figure 13: Example of Active Probing of the Network

Configuring Raw Data Collection


The clock probe and PTP clock probe support the extraction of raw data to an external
server. The system transfers the collected raw data every few minutes to the server using the
FTP protocol. You need to configure the FTP server address because it is not defined by
default.

After you configure the FTP server address, you or a Network Management System (NMS)
can collect the raw data from the server and concatenate the segments to create the full raw
TE/TIE data of the measurement. The system can separately configure the raw data
collection for each clock probe and PTP clock probe. The software saves the data in a dual-
column format that you can maintain through ENC Network Manager.

The file transfer interval is based on the sampling rate as defined in Table 16.

OSA 5401 R12.1.1 User Manual - Issue: A 97


Oscilloquartz: An ADVA Company Managing the OSA 5401

Table 16: File Transfer Interval based on the Sampling Rate


Probe Type Maximum Entries Interval (seconds)
Clock Probe 300 300
300 at 1 pps 300
600 at 2 pps 300

PTP Clock Probe 1200 at 4 pps 300


1920 at 8 pps 240
1920 at 16 pps 120
1920 at 32 pps 60
1920 at 64 pps 30
1920 at 128 pps 15

For clock probes, the system uses one sample per second regardless of the
physical clock frequency.

For PTP clock probes, an additional configuration is supported to collect


one sample per second regardless of the packet rate (see Configuring PTP
Clock Probes for Clock Analysis).

To configure a clock Syncjack raw data FTP server address:

configure clock sj rawdata_server protocol ftp <ip-address> <username> <password>

Configuring Clock Probes for Clock Accuracy


Clock accuracy is the Syncjack™ function that measures the frequency or phase accuracy of
a source timing signal relative to a measurement-reference timing signal. The clock
accuracy function uses clock probes to achieve the accuracy measurement.

The OSA 5401 simultaneously supports two clock probe instances. The clock probe
performs time interval error/time error (TIE/TE) and maximum time interval error (MTIE)
measurements between a source timing signal and a measurement-reference timing signal.
The clock probe processes the TIE/TE measurement results and sends them to the sync
analyzer server.

Clock Probe Source and Reference Timing Signals


The clock probe supports two types of source signals: frequency and phase signals. You
must configure frequency for the frequency accuracy measurements, and set the phase for
time/phase accuracy measurements. When you configure a clock probe, to define the
source timing signal and measurement-reference time signal, configure any of these
options:

OSA 5401 R12.1.1 User Manual - Issue: A 98


Oscilloquartz: An ADVA Company Managing the OSA 5401

l GNSS
l PTP
l SyncE
l SCI

When you configure a clock probe, you must define the clock accuracy parameters and then
activate the clock probe by using the Syncjack™ schedule.

To configure a clock probe:

1. Define the clock accuracy parameters for the clock probe in this command, where you
must define these parameters:
o <instance>: Number of clock probe instances [ 1 | 2 ].

o <type>: Type of source signals [ frequency | phase ].


o <source>: Source timing signal [ gnss | ptp | synce ].
o <reference>: Measurement-reference time signal [ gnss | ptp | synce ].
configure clock sj clock-accuracy <instance> <type> <source> <reference>

2. Activate the clock probe by using the Syncjack schedule in this command, where you
must define these parameters:
o <timing>: Time to schedule [ now | stop ].

o <length>: Length of time to schedule [ forever].


o <instance>: Clock probe instance to schedule [ 1 | 2 | both ].
configure clock sj clock-accuracy schedule <timing> <length> <instances>
After you complete the configuration, you can view the statuses of the clock probe
instances (see Viewing Clock Probe Statuses).

You can change a clock accuracy parameter for a clock probe only when
the Syncjack™ schedule is stopped.

To configure maximum time error alarms:


configure clock syncjack clock-accuracy config [1 | 2] max-te-threshold <value>,
range: 0 – 100 000 000 ns, default: 0 ns

configure clock syncjack clock-accuracy config [1 | 2] max-te-clear-threshold


<value>, range: 0 – 100 000 000 ns, default: 0 ns
To configure constant time error alarms:
configure clock syncjack clock-accuracy config [1 | 2] const-te-threshold <value>,
range: 0 – 100 000 000 ns, default: 0 ns

configure clock syncjack clock-accuracy config [1 | 2] const-te-clear-threshold


<value>, range: 0 – 100 000 000 ns, default: 0 ns

OSA 5401 R12.1.1 User Manual - Issue: A 99


Oscilloquartz: An ADVA Company Managing the OSA 5401

configure clock syncjack clock-accuracy config [1 | 2] const-te-window <value>,


range: 500 – 20 000 s, default: 1 000 s

Configuring PTP Clock Probes for Clock Analysis


In clock analysis, the Syncjack™ performs a quality measurement or estimate of the
frequency and phase that an internal IEEE 1588v2 slave clock (clock under test) recovers,
relative to a measurement reference timing signal.

The PTP clock probe measures the time interval error (TIE) between the clock under test and
the reference timing signal. The PTP clock probe uses the timestamp that PTP messages
carry and that originated from the 1588v2 clock under test.

The OSA 5401 simultaneously supports two PTP clock probe instances, where all probes
share the same reference timing signal. Depending on your system network configuration,
the system performs different PTP clock probes (see Understanding Different PTP Clock
Probes).

Clock Probe Source and Reference Timing Signals


The source signal of the PTP clock probe is an external IEEE 1588v2 clock, which is the clock
under test. This entity can be a master clock, slave clock, or Boundary clock.

When you configure a PTP clock probe, the measurement-reference time signal can be one
of these options:

l GNSS
l SyncE
l SCI

To measure the phase error (time error), the reference signal must be GNSS.

When you configure a clock PTP probe, you need to define the clock analysis parameters
and then activate the PTP clock probe by using the Syncjack™ schedule.

To configure a PTP clock probe:

1. Define the clock analysis parameters for the clock probe in this command, where you
must define these parameters:
o <instance>: Number of clock probe instances [ 1 | 2 ].

o <rate>: Measurement applied to each packet [ all-packets | 1 Hz ], where all-


packets records the measurements for all packets and 1 Hz takes the minimum
delay packet in a one-second time period.
o <direction>: PTP clock probe measurement direction [ master-to-slave | master-to-

OSA 5401 R12.1.1 User Manual - Issue: A 100


Oscilloquartz: An ADVA Company Managing the OSA 5401

slave-t4 ].
o <reference>: Measurement-reference time signal [ gnss | ptp | synce ].
configure clock sj clock-analysis <instance> <rate> <direction> <reference>

2. Activate the clock probe by using the Syncjack schedule in this command, where you
must define these parameters:
o <timing>: Time to schedule [ now | stop ].

o <length>: Length of time to schedule [ forever].


o <instance>: Clock probe instance to schedule [ 1 | 2 | both ].
configure clock sj clock-analysis schedule <timing> <length> <instances>
After you complete the configuration, you can view the statuses of the PTP clock probe
instances (see Viewing Clock Probe Statuses).

You can change a clock analysis parameter for a PTP clock probe only
when the Syncjack™ schedule is stopped.

To configure maximum time error alarms:


configure clock syncjack clock-analysis config [1 | 2] max-te-threshold <value>,
range: 0 – 100 000 000 ns, default: 0 ns

configure clock syncjack clock-analysis config [1 | 2] max-te-clear-threshold


<value>, range: 0 – 100 000 000 ns, default: 0 ns
To configure constant time error alarms:
configure clock syncjack clock-analysis config [1 | 2] const-te-threshold <value>,
range: 0 – 100 000 000 ns, default: 0 ns

configure clock syncjack clock-analysis config [1 | 2] const-te-clear-threshold


<value>, range: 0 – 100 000 000 ns, default: 0 ns

configure clock syncjack clock-analysis config [1 | 2] const-te-window <value>,


range: 500 – 20 000 s, default: 1 000 s
To configure instant time error alarms:
configure clock syncjack clock-analysis config [1 | 2] inst-te-threshold <value>,
range: 0 – 100 000 000 ns, default: 0 ns

configure clock syncjack clock-analysis config [1 | 2] inst-te-clear-threshold


<value>, range: 0 – 100 000 000 ns, default: 0 ns

Understanding Different PTP Clock Probes


The system network configuration determines the type of PTP clock probe to be performed.
The different options are explained in this section.

PTP Clock Probe - Master to Slave (T1)


Probing the master side of a Boundary clock - Active (or Passive) Probing:

OSA 5401 R12.1.1 User Manual - Issue: A 101


Oscilloquartz: An ADVA Company Managing the OSA 5401

l Probing T1 embedded in the PTP sync message.


l The main purpose of the test is to measure clock, not the network.
l For the master measurement: time error = T1 – T2REF.
l T2REF – T1 = OFM + Delay_M_S.
l You must calibrate the delay from the master port to the probe (Delay_M_S).

PTP Clock Probe - Master to Slave (T4)


Probing the Master side of a Boundary clock – Active (or Passive) Probing:

l Master To slave - Probing T4 embedded in a PTP delay response message.


l The main purpose of the test is to measure clock, not the network.
l For Master measurement: Time Error = T4 – T3REF.
l T4 – T3REF = OFM + Delay_S_M.
l You must calibrate the delay from the probe to the master port (Delay_S_M).

Viewing Clock Probe Statuses


You can view the statuses of these clock probes:

l Clock probes for clock accuracy


l PTP clock probes for clock analysis

Two instances are supported for each type of clock probe. Other configuration details
related to the clock probes are displayed. Enter this command at the Syncjack menu level:

show status

Example with Sample Output:

ADVA:configure:clock:sj:--> show status


syncjack
rawdata_server
protocol : ftp
username : root
ip-address : 0.0.0.0
clock-accuracy 1
state : not running
source failure : yes
refer. failure : no
measurem. type : frequency
rate : 1-Hz
source : synce
reference : gnss
clock-accuracy 2
state : not running

OSA 5401 R12.1.1 User Manual - Issue: A 102


Oscilloquartz: An ADVA Company Managing the OSA 5401

source failure : yes


refer. failure : no
measurem. type : frequency
rate : 1-Hz
source : synce
reference : gnss
clock-analysis 1
state : not running
source failure : yes
refer. failure : no
measurem. type : phase
rate : 1-Hz
source : ptp
reference : gnss
direction : master-to-slave
clock-analysis 2
state : not running
source failure : yes
refer. failure : no
measurem. type : phase
rate : 1-Hz
source : ptp
reference : gnss
direction : master-to-slave

Backing Up and Restoring the


Configuration File
To back up and restore a binary configuration file, you can copy the configuration file to the
appropriate location. The SNMP also supports backup and restore of binary configuration
files.

To back up and restore the OSA 5401 as an SCP server:

1. In an OpenSCP or SolarWinds SCP console window, to copy the configuration file with
the SCP from OSA 5401 to a server, enter this command:
scp root@<ip_address>:config.cfg osa540x_config.cfg

2. In a Linux, OpenSSH, or SCP console window, to copy the configuration file from the
server to OSA 5401 using OpenSCP or SolarWinds SCP, enter this command:
scp osa540x_config.cfg root@<ip_address>:config.cfg

3. After the successful file transfer, log in to OSA 5401 with Telnet or an SSH client. For
example, if you log in to the SSH client, enter this command:
ssh root@<ip_address>

4. To store the new configuration file, enter this command:

OSA 5401 R12.1.1 User Manual - Issue: A 103


Oscilloquartz: An ADVA Company Managing the OSA 5401

admin store

5. To activate the configuration file by rebooting the system, enter this command:
admin reboot

To back up and restore the OSA 5401 as an SCP client:

1. Back up the configuration file. The file extension must be bkp or cfg:
admin copy config-backup scp <ipv4/ipv6 address> <filename> <username> <password>

2. To restore the configuration file, copy the configuration file from the server to
OSA 5401:
admin copy config-restore scp <ipv4/ipv6 address> <filename> <username> <password>

3. Verify the file transfer status with the info command.


4. After a successful transfer, to store the new configuration file, enter this command:
admin load-config-file

5. To activate the configuration file by rebooting the system, enter this command:
admin reboot

Using CLI Configuration Files


CLI configuration files are text files that contains CLI commands. The files contain all
configurations except SSH host key, users, and public keys.

You can create CLI configuration files and run them manually to reconfigure the system. You
can create and save up to two files on the system. You cannot edit the files on the system,
but you can export the files, edit them outside the system, and then reimport back to the
system. You can also display existing files. SNMP does not support backup and restore of
CLI configuration files.

When you create a config file, the system automatically creates a binary, non-editable
config.cfg file. This file will not show in the admin config-file list command, but is available
in the admin copy put and config-backup commands.

To back up the configuration:

1. Create a configuration file from the running config, the file extension must be txt:
admin config-file create-from-running-config <config-file-filename>

2. Transfer a configuration file from OSA 540X to a SCP server:


admin copy put scp <ipv4/ipv6-addr> <filename> <username> <password> <path>

To restore the configuration:

1. Transfer a configuration file from a SCP server to OSA540X:


admin copy get scp <ipv4/ipv6-addr> <filename> <username> <password> [yes | no]

2. Load a configuration file:


admin config-file load <config-file-filename>

OSA 5401 R12.1.1 User Manual - Issue: A 104


Oscilloquartz: An ADVA Company Managing the OSA 5401

-or-
Restart with a configuration file:
admin config-file restart-with-configfile <config-file-filename>

To show and remove configuration files:

l Show the list of stored configuration files:


admin config-file list
Size (bytes) Filename
------------ ----------------------------
11081 config1.txt
11081 config2.txt

l Remove a configuration file:


admin config-file remove <config-file-filename>

Link Layer Discovery Protocol


Link Layer Discovery Protocol (LLDP) is a vendor-neutral link layer protocol that network
devices use to advertise their identity, capabilities, and neighbors on a local area network.

OSA 5401 supports an LLDP agent in transmit-only mode and it is enabled by default. When
LLDP is enabled and reported data values of the configuration change, an indication is sent
to the remote end to flush the stored LLDP data. The system sends an LLDPDU with a time-
to-live (TTL) TLV containing “0” in the information field.

You can configure the transmission interval from 5 to 3600 seconds. Default is 10 seconds.
Time-To-Live (TTL) is transmission interval multiplied by 4.

OSA 5401 supports transmission of the LLDP Basic Management TLV set.

Table 17: TLV Type Values


TLV Type TLV Name Usage in LLDPDU
0 End of LLDPDU Mandatory
1 Chassis ID Mandatory
2 Port ID Mandatory
3 Time to live Mandatory
4 Port description Optional
5 System name Optional
6 System description Optional
7 System capabilities Optional
8 Management address Optional

OSA 5401 R12.1.1 User Manual - Issue: A 105


Oscilloquartz: An ADVA Company Managing the OSA 5401

Table 17: TLV Type Values


TLV Type TLV Name Usage in LLDPDU
9 – 126 Reserved —
127 Custom TLVs Optional

Table 18: TLV Structure


Type Length Value
7 bits 9 bits 0-511 octets

OSA 5401 R12.1.1 User Manual - Issue: A 106


Oscilloquartz: An ADVA Company Managing the OSA 5401

To enable or disable LLDP:

configure system lldp [enable | disable]

To set the messaging interval for LLDP:

configure system lldp tx-interval 10

Example:

1. Chassis ID: IPv4 address of the management interface


2. Port ID: MAC address
3. Time To Live: 120 seconds
4. Port description: “ETHERNET TRAFFIC PORT”
5. System name: provides the system's assigned name in an alpha-numeric format.
6. System description: provides a description of the network entity in an alpha-numeric
format. This includes system's name and versions of hardware, operating system and
networking software supported in the device.
OSA5401, HW 2.02, SW 11.7.1-xxx

7. Management address: Indicates the IPv6 addresses of the local LLDP agent. Other
remote managers can use this address to obtain information related to the local device.
8. VLAN ID: Indicates the VLAN ID of the management interface.

OSA 5401 R12.1.1 User Manual - Issue: A 107


Oscilloquartz: An ADVA Company Managing the OSA 5401

ENC Network Manager Support


ENC Network Manager (NM) supports the OSA 5401 including integration using an XML
customization file with descriptions of the SNMP interface and the supported features that
follow.

For more information about the ENC Network Manager, see the ENC Net-
work Manager Administrator Manual.

l Discovery of the device.


l Retrieve inventory and inventory reports.
l Display with Name/IP/Description and icon on network map. You can set the
Name/Description for OSA 5401 using the CLI.
l Log alarms and events. The Network Manager can fully manage the unit alarms and
events reported as SNMP traps with the ability to recover lost traps, and support
events presentation.
l Indicate of the highest alarm severity.
l Monitor and represent the management connection to the NE.
l Launch a CLI client session for the selected NE (Telnet or SSH) – for nodal/element
management level operations.
l Monitor performance.
l Collect raw data files from an FTP Server for analysis in the ENC database.
l List remote slaves (Layer 3).

Initializing Service Time Counters


Service time counters are available separately and concurrently for System, GNSS, PTP, and
Sync-E services. Available time is incremented when the service is locked or when the unit is
in temporary phase holdover or when the unit is declaring holdover within limits.

The system implements service availability using two counters:

l Available Time Counter (ATC) – for every second the service is available the ATC is
incremented.
l Unavailable Time Counter (UTC) – for every second the service is not 100%
available the UTC counter is incremented.

In addition, the percentage value of 100* (Available / Available + Unavailable).

OSA 5401 R12.1.1 User Manual - Issue: A 108


Oscilloquartz: An ADVA Company Managing the OSA 5401

Initializing service time counters:

The service time counters initializes when the service is re-started. For example, if the GNSS
service is re-enabled (no shutdown), the counters are reset to zero.

Holdover (within-limits) is counted as available time for PTP.

Show command:

info service
Available Unavailable
GNSS 75:00:00 (75.00%) 25:00:00
PTP Master Clock 50:00:00 (50.00%) 50:00:00
Sync-E Master Clock 90:00:00 (90.00%) 10:00:00
System Up Time 100:00:00

Reset command:

info service reset [all | gnss | ptp | synce]

Viewing Ethernet Port Counters


configure port [ eth1 | eth2 ] show status
Mac-address 1:00-80-ea-9e-33-0f
Used interfaces : eth1
Speed: auto
Synce
Mode: master
rx-quality-level: ssm-based
Received SyncE Quality level : DNU
Transmitted SyncE Quality level : PRC
Counters:
RX:
Total Frames: 5524812
Unicast Frames: 3699
Broadcast Frames: 4381185
Control Frames: 4307814
Discarded Frames: 2275375
CRC errored Frames: 45
TX:
Total Frames: 1241076
Unicast Frames: 1153932
Broadcast Frames: 87144

OSA 5401 R12.1.1 User Manual - Issue: A 109


Oscilloquartz: An ADVA Company Managing the OSA 5401

Configuring Expected Clock Class


A clock class is the minimum clock class (0-255) that is accepted for locking the PTP slave.
Default value 255 means that the feature is disabled and the PTP slave locks to the following
clock classes: 6, 7, 80, 84, 90, 96, 135, 150, 160, and 187.

When you configure a 0 to 254 value, the slave locks to an acceptable master with clock
class equal or less than the configured value.

To configure expected clock class:

configure clock l2-profile slave expected-clock-class <0-255>, default=255


configure clock l3-profile slave expected-clock-class <0-255>, default=255

Configuring Holdover Time


You can specify the time for maintaining the clock class holdover within limits based on the
known performance of the local oscillator. To achieve good holdover performance, the unit
must be locked to a stable clock reference for at least 70 minutes.

Holdover time – the time (0–3000000 seconds) that the oscillator is expected to maintain
the required accuracy and maintain holdover-within-limits. The default value is 0 for
backward compatibility.

To configure holdover time:

configure clock holdover-time <0-3000000>, default=0

Show command:

configure clock show status

Clock References:
1 GNSS Selected
2 L2 PTP Slave Disabled
2 L3 PTP Slave Disabled
3 SyncE Failed
4 SCI Disabled
5 Local OCXO OK

Holdover:
Time in Holdover: 123 s
Timeout: 900 s

OSA 5401 R12.1.1 User Manual - Issue: A 110


Oscilloquartz: An ADVA Company Managing the OSA 5401

Configuring CLK Port


SCI supports DCLS output and PPS, 2M, 10M input or output.

To configure the signal type for SCI:

configure port sci signal [irig-dcls | pps | 2M | 10M], default: pps

To configure SCI as input or output:

configure port ch1 direction [ output | input ] ; default=output

To configure the RX quality level for SCI:

configure port ch1 rx-quality-level [ prc | dnu ] ; default=prc

To configure the IRIG polarity for the IRIG interfaces:

configure port sci irig-inverted-polarity [ on | off ] ; default=off

Control, SB, and Year Fields


To configure the control field for the IRIG interfaces:

configure port sci irig-ctrlfield [ ieee1344 | c37.118.1 | disable ] ; default=ieee1344

To configure the SBS field for the IRIG interfaces:

configure port sci irig-sbsfield [ enable | disable ] ; default=enable

To configure the year field for the IRIG interfaces:

configure port sci irig-yearfield [ enable | disable ] ; default=enable

OSA 5401 R12.1.1 User Manual - Issue: A 111


Chapter 6

Troubleshooting
Managing Faults using PTP Announce
Messages
For example, when there are GNSS outages, the slave nodes are notified through the
announce messages when the clock class of the master degrades.

During power or equipment failures, announce messages stop arriving altogether, where
each slave notice such faults.

When there is a network failure, only the slaves affected by the fault stop receiving
announce messages.

Figure 14: OSA 5401 Syncplug™ Fault Management through PTP Announce
Messages

OSA 5401 R12.1.1 -User Manual - Issue: A 112


Chapter 7

CLI Command Definitions


Command Tree 113

Global commands 120

Clock Type Configuration 123

L2 Master Configuration 124

L3 Master Configuration 126

GNSS Configuration 128

Primary IP Host Configuration 130

Port Configuration 131

System Configuration 132

SSH 133

SNMP 135

SYSLOG 137

Radius 138

Alarms 139

Command Tree
This section lists the complete command tree for the entire CLI according to topics.

OSA 5401 R12.1.1 -User Manual - Issue: A 113


Oscilloquartz: An ADVA Company CLI Command Definitions

ADMIN
|+---admin factory-default
|+---admin factory-default-wo-mgmt
|+---admin reboot
|+---admin restore
|||||||+---admin copy sw-upgrade scp <ip-address> <filename> <username> <password>
|||||||+---admin copy config-backup scp <ip-address> <filename> <username> <password>
|||||||+---admin copy config-restore scp <ip-address> <filename> <username> <password>
|||||||+---admin copy sw-downgrade scp <ip-address> <filename> <username> <password>
||||||||+---admin copy get scp <ip-address> <filename> <username> <password> [
yes | no ]
||||||||+---admin copy put scp <ip-address> <filename> <username> <password>
<path>
|||||+---admin copy sw-upgrade tftp <ip-address> <filename>
|||||+---admin copy sw-downgrade tftp <ip-address> <filename>
||+---admin software install
||+---admin software switch
|||+---admin daytime <date_and_time> <timezone>
|||+---admin daylight-saving-time control <options>
|||+---admin daylight-saving-time utc-offset <offset>
|||+---admin daylight-saving-time start-month <month>
||||+---admin daylight-saving-time start-day day-number <day-nbr>
||||+---admin daylight-saving-time start-day lastweekday <weekday>
||||||+---admin daylight-saving-time start-day weekday <weekday> <= <day-nbr>
||||||+---admin daylight-saving-time start-day weekday <weekday> >= <day-nbr>
|||+---admin daylight-saving-time start-time <time>
|||+---admin daylight-saving-time end-month <month>
||||+---admin daylight-saving-time end-day day-number <day-nbr>
||||+---admin daylight-saving-time end-day lastweekday <weekday>
||||||+---admin daylight-saving-time end-day weekday <weekday> <= <day-nbr>
||||||+---admin daylight-saving-time end-day weekday <weekday> >= <day-nbr>
|||+---admin daylight-saving-time end-time <time>
|+---admin store-config-file
||+---admin config-file list
|||+---admin config-file load <filename>
|||+---admin config-file remove <filename>
|||+---admin config-file restart-with-configfile <filename> [ yes | no ]
||||+---admin config-file create-from-running-config <filename> [ yes | no ]

GLOBAL COMMANDS
+---save
+---save-and-reconfig
+---help
+---quit
+---info
|+---info alarms
|+---info log
||+---info log clear

OSA 5401 R12.1.1 User Manual - Issue: A 114


Oscilloquartz: An ADVA Company CLI Command Definitions

|+---info reference-clocks
|+---info security-banner
|+---info service
|+---info service clear <options>
|+---info ptp-datasets
|+---info ptp-datasets-l2m
|+---ping <ip-address>
+---show
|+---show [ running-config | snmp ]
+---tree

INTERFACE CONFIGURATION
|||||+---conf interface <scope> ip-address ipv4 <ipv4_address/netmask>
|||||+---conf interface <scope> default-gw ipv4 <ipv4_address>
|||||+---conf interface <scope> ip-address ipv6 <ipv6_address/netmask>
|||||+---conf interface <scope> default-gw ipv6 <ipv6_address>
||||+---conf interface <scope> vlan-id <vlan_id>
||||+---conf interface <scope> vlan-pcp <vlan_pcp>
|||||+---conf interface <scope> ip-priority <mode> <value>
|||||+---configure interface mgmt port [ eth1 | eth2 ]
|||||+---configure interface mgmt dhcp [ ipv4 | ipv6 ] [ enable | disable ]

L2 PTP MASTER CLOCK


||||+---conf clock l2-profiles port-delay-asymmetry <range>
||||+---conf clock l2-profiles show status
||||+---conf clock l2-profiles master [no] shutdown
|||||+---conf clock l2-profiles master domain-number <range>
|||||+---conf clock l2-profiles master profile <options>
|||||+---conf clock l2-profiles master mac <options>
|||||+---conf clock l2-profiles master priority1 <range>
|||||+---conf clock l2-profiles master priority2 <range>
||||||+---conf clock l2-profiles master rate [ announce | sync | dresp | sync-dresp ]
<range>
|||||+---conf clock l2-profiles master type <options>
||||||+---conf clock l2-profiles master interface replace <instance>

L2 PTP SLAVE CLOCK


||||+---conf clock l2-profiles slave [no] shutdown
|||||+---conf clock l2-profiles slave domain-number <range>
|||||+---conf clock l3-profiles slave profile <options>
|||||+---conf clock l2-profiles slave mac <options>
|||||+---conf clock l2-profiles slave delay-asymmetry-mode <options>
|||||+---conf clock l2-profiles slave delay-asymmetry <range>
||||||+---conf clock l2-profiles slave interface replace <instance>
|||||+---conf clock l2-profiles slave expected-clock-class <options>
|||||+---conf clock l2-profiles slave delay-mechanism <options>
|||||+---conf clock l2-profiles slave clock-mode <options>
|||||+---conf clock l2-profiles tlv time-inaccuracy <range>

OSA 5401 R12.1.1 User Manual - Issue: A 115


Oscilloquartz: An ADVA Company CLI Command Definitions

|||||+---conf clock l2-profiles tlv net-time-inaccuracy <range>


|||||+---conf clock l2-profiles tlv gm-identity <range>

L3 PTP MASTER CLOCK


||||+---conf clock l3-profiles port-delay-asymmetry <range>
||||+---conf clock l3-profiles show status
||||+---conf clock l3-profiles show remote-slave-list
|||||+---conf clock l3-profiles master domain-number <range>
|||||+---conf clock l3-profiles master profile <options>
|||||+---conf clock l3-profiles master priority1 <range>
|||||+---conf clock l3-profiles master priority2 <range>
|||||+---conf clock l3-profiles master type <options>
|||||+---conf clock l3-profiles master unicast [no] shutdown
|||||+---conf clock l3-profiles master multicast [no] shutdown
|||||||+---conf clock l3-profiles master multicast interface [ replace | add | remove ]
<instance>
|||||||+---conf clock l3-profiles master multicast rate [ announce | sync | dresp | sync-
dresp ] <range>

L3 PTP SLAVE CLOCK


||||+---conf clock l3-profiles slave [no] shutdown
|||||+---conf clock l3-profiles slave domain-number <range>
|||||+---conf clock l3-profiles slave profile <options>
|||||+---conf clock l3-profiles slave mode <options>
|||||+---conf clock l3-profiles slave delay-asymmetry-mode <options>
||||||+---conf clock l3-profiles slave rate [ announce | sync-dresp ] <range>
||||||||+---conf clock l3-profiles slave acceptable-master [ 1 | 2 ] ip-address <ipv4_
address> <delay-asymmetry-range>
|||||||+---conf clock l3-profiles slave acceptable-master [ 1 | 2 ] interface <instance>
|||||||+---conf clock l3-profiles slave acceptable-master [ 1 | 2 ] local-priority
<range>
|||||+---conf clock l3-profiles slave expected-clock-class <options>
|||||+---conf clock l3-profiles slave algorithm-mode <options>
|||||+---conf clock l3-profiles slave delay-mechanism <options>
|||||+---conf clock l3-profiles slave clock-mode <options>
||||||+---conf clock l3-profiles tlv smpte-system-frame-rate <numerator-range>
<denominator-range>
|||||+---conf clock l3-profiles tlv smpte-time-address-flags <range>

GNSS
||||+---conf clock gnss [no] shutdown
||||+---conf clock gnss mode <options>
||||+---conf clock gnss augmentation <options>
||||+---conf clock gnss antenna-delay <range>
|||||+---conf clock gnss location mode <options>
|||||+---conf clock gnss location latitude <range>
|||||+---conf clock gnss location longitude <range>

OSA 5401 R12.1.1 User Manual - Issue: A 116


Oscilloquartz: An ADVA Company CLI Command Definitions

|||||+---conf clock gnss location height <range>


|||||+---conf clock gnss location survey-in-minimum-duration <range>
|||||+---conf clock gnss location survey-in-position-accuracy-limit <range>
||||+---conf clock gnss elevation <range>
||||+---conf clock gnss snr <range>
|||||+---conf clock gnss time-advance fixed <range>
||||||+---conf clock gnss satellites threshold min-1 <range>
||||||+---conf clock gnss satellites threshold min-2 <range>
||||+---conf clock gnss dyn-model <options>
||||+---conf clock gnss show status

NTP
||||+---conf clock ntp server [no] shutdown
||||+---conf clock ntp show status

CLOCK TYPE
|||+---conf clock type <options>

CLOCK PREFERENCES
||||+---conf clock references <options> ...
|||+---conf clock holdover-timeout <options>
|||+---conf clock show status

ETHERNET PORT
|||+---conf port [ eth1 | eth2 ] show status
|||+---conf port [ eth1 | eth2 ] [no] tx-ssm
||||+---conf port [ eth1 | eth2 ] rx-quality-level <level>
||||+---conf port [ eth1 | eth2 ] synce <options>

SCI
||||+---conf port sci signal <options>
||||+---conf port sci direction <options>
||||+---conf port sci rx-quality-level <level>

ACCESS CONTROL LIST


|||+---conf system acl <en/disable/clear-entries>
||||||+---conf system acl-entry <instance> permit <ipv4/ipv6> <network_address>/<prefix>

SYNCJACK
|||||||+--- conf clock syncjack rawdata-server protocol ftp <options>
||||+--- conf clock syncjack clock-accuracy <options>
|||||+--- conf clock syncjack clock-accuracy schedule <options>
||||+--- conf clock syncjack clock-analysis <options>
|||||+--- conf clock syncjack clock-analysis schedule <options>

OSA 5401 R12.1.1 User Manual - Issue: A 117


Oscilloquartz: An ADVA Company CLI Command Definitions

SYSTEM
|||+---conf system acl <en/disable/clear-entries>
||||||+---conf system acl-entry <instance> permit <ipv4/ipv6> <network_address>/<prefix>
|||+---conf system telnet <en/disable>
|||+---conf system tftp <en/disable>
|||+---conf system ssh <en/disable>
|||+---conf system scp <en/disable>
|||+---conf system snmp <en/disable>
|||+---conf system leds <en/disable>
|||+---conf system i2c <en/disable>
|||+---conf system lldp <en/disable>
||||+---conf system lldp tx-interval <range>
|||+---conf system engine-id <id>
|||+---conf system ne-name <string>
|||+---conf system ne-contact <string>
|||+---conf system ne-location <string>
|||+---conf system ne-physical-alias <string>
|||+---conf system ne-physical-asset-id <string>
|||+---conf system security-banner <string>

SYSLOG
|||+---conf system syslog <en/disable>
||||||+---conf system syslog server [ 1 | 2 ] ip-address <ipv4_address:port>

RADIUS
|||+---conf system radius <en/disable>
|||+---conf system radius auth-type <options>
|||+---conf system radius access-order <options>
||||||+---conf system radius server [ primary | backup ] ip-address <ipv4_address:port>
||||||+---conf system radius server [ primary | backup ] secret-key <key>
||||||+---conf system radius server [ primary | backup ] timeout <range>
||||||+---conf system radius server [ primary | backup ] retries <range>

ALARM SEVERITIES
|||||+---conf management alarm <alarm-type> severity <severity-level>

SNMP
|||||+---conf management snmp community <index> <options>
|||||+---conf management snmp t-params <index> <options>
|||||+---conf management snmp t-address <index> <options>
|||||+---conf management snmp u-user <index> <options>

SSH
|||+---conf management ssh list
|||||+---conf management ssh add <privilege> <username> <password>
||||+---conf management ssh delete <username>
||||+---conf management ssh keys <del1/2>

OSA 5401 R12.1.1 User Manual - Issue: A 118


Oscilloquartz: An ADVA Company CLI Command Definitions

||||||+---conf management ssh change-pw <username> <password> <repeat-password>


||||+---conf management ssh kex-algorithm <options>

OSA 5401 R12.1.1 User Manual - Issue: A 119


Oscilloquartz: An ADVA Company CLI Command Definitions

Global commands
help
back [all]
tree
quit
info
INFO: OSA 5401
SW version: 11.7.1-xxx
HW version: 1.01
Factory FPGA: 0x61622DFB unknown
Applic1 FPGA: 0x61622DFB OSA-5401.11.7.1-xxx.bin
Applic2 FPGA: 0x61622DFB OSA-5401.11.7.1-xxx.bin Current image
Clock state: GNSS - Locked
RTC time: 2022-08-10 08:52:05
Date and time:2022-08-10 08:51:28 UTC+0
Mac-address 00-80-ea-d0-28-1c
Serial number:FA71191950083
Mgmt:
ipv4-dhcp : disabled
ipv6-dhcp : enabled
ipv6-dhcp-type : stateful
ipv4-address : 10.33.188.149/25
ipv4-default-gw : 10.33.188.129
ipv6-address : 2001:1200:1100:1000:0:0:0:0200/64 ( 2001:1200:1100:1000:0:0:0:0200/64 )
ipv6-linklocal : FE80:0:0:0:0280:EAFF:FE9E:330F/64
ipv6-default-gw : 0:0:0:0:0:0:0:0
vlan-id : 4095
vlan-pcp : 7
ip-priority : none
System
acl : disabled
telnet: enabled
tftp : enabled
ssh : enabled
scp : enabled
snmp : enabled
leds : enabled
i2c : enabled
lldp : enabled
syslog: enabled
radius: disabled

OSA 5401 R12.1.1 User Manual - Issue: A 120


Oscilloquartz: An ADVA Company CLI Command Definitions

ne-name : OSA_5401-149

info alarms
Active Alarms:
NC Description Date/Time
-- -------------------------------------- -------------------
MN PTP - Sync Timeout 1970-01-01 00:00:38
MN PTP - Announce Timeout 1970-01-01 00:00:40
NR PTP - Loss of Announce 1970-01-01 00:00:40
NR PTP - Loss of Synchronization 1970-01-01 00:00:38
Alarm Attributes: 1/3
NC Description Loc Dir SA
-- --------------------------------- ---- ------- ---
NR Clock in Time Freerun Near RCVONLY NSA
NR Clock in Time Holdover Near RCVONLY NSA
MJ Clock Time Not Traceable Near RCVONLY NSA
NR Clock in Frequency Freerun Near RCVONLY NSA
NR Clock in Frequency Holdover Near RCVONLY NSA
MJ Clock Frequency Not Traceable Near RCVONLY NSA
MJ Antenna error (open or short) Near RCVONLY NSA
MN PTP - Sync Timeout Near RCVONLY NSA
MN PTP - Announce Timeout Near RCVONLY NSA
MN PTP - Delay Response Timeout Near RCVONLY NSA
NR PTP - Loss of Announce Near RCVONLY NSA
NR PTP - Loss of Synchronization Near RCVONLY NSA
NR PTP - Clock Class Mismatch Near RCVONLY NSA
NR PTP - Wrong Domain Near RCVONLY NSA
NR PTP - Peer Delay Response Timeout Near RCVONLY NSA
MJ SJ not locked to reference (time) Near RCVONLY NSA
MJ SJ not locked to reference (freq) Near RCVONLY NSA
NR SJ Test Reference Fail Near RCVONLY NSA
NR SJ Test Source Fail Near RCVONLY NSA
NR SJ Test No Message Near RCVONLY NSA
NR SJ Max TE Threshold Exceeded Near RCVONLY NSA
NR SJ Constant TE Threshold Exceeded Near RCVONLY NSA
NR SJ Instant TE Threshold Exceeded Near RCVONLY NSA
CR Equipment fault Near RCVONLY NSA
CR Equipment mismatch Near RCVONLY NSA
CR SFP module mismatch Near RCVONLY NSA
CR SFP removed Near RCVONLY NSA
CR SFP transmit fault Near RCVONLY NSA
NR SFP not qualified Near RCVONLY NSA
MJ Jamming/Interference detected Near RCVONLY NSA
MJ Spoofing detected Near RCVONLY NSA
NR MinSat1 Threshold Crossed Near RCVONLY NSA
NR MinSat2 Threshold Crossed Near RCVONLY NSA
NR Spoofing detected - Pps Near RCVONLY NSA
NR Spoofing detected - Loc Near RCVONLY NSA

OSA 5401 R12.1.1 User Manual - Issue: A 121


Oscilloquartz: An ADVA Company CLI Command Definitions

NR L1 Signals Available Only Near RCVONLY NSA


NR Advanced Jamming Detection Near RCVONLY NSA
NR Advanced Spoofing Detection Near RCVONLY NSA
NR Failure Suspended Near RCVONLY NSA

info log [clear] // shows the local log and [clears]


# Date/Time Uptime Description
--- ------------------- -------- ------------------------------
1 2016-01-07 10:40:08 123 Clock in Time Freerun

info counters [clear] // shows int counters and [clears]


save // copy running-config

show running-config
show running-config (1/11)

OSA 5401 R12.1.1 User Manual - Issue: A 122


Oscilloquartz: An ADVA Company CLI Command Definitions

Clock Type Configuration


configure clock
type { etsi | ansi } // default etsi

OSA 5401 R12.1.1 User Manual - Issue: A 123


Oscilloquartz: An ADVA Company CLI Command Definitions

L2 Master Configuration
L3 slave is disabled when L2 slave is enabled. You can enable only one slave
at a time.

configure clock l2-profiles


port-delay-asymmetry [-100 000 000 … 100 000 000] // default=0 [ns]
profile [g8275.1 | 1588_2008_annex_f | iec-61850-9-3 | c37.238-2011 | c37.238-2017 ] //
default g8275.1

configure clock l2-profiles tlv


tlv [time-inaccuracy | net-time-inaccuracy | gm-identity]

master
domain-number <number> // 0-127 , default 24
mac { 01-1b-19-00-00-00 | 01-80-c2-00-00-0e }..// default 01-80-c2-00-00-0e
[no] shutdown..// NOTE: default no shutdown

slave
domain-number <number> // 0-127 , default 24
mac { 01-1b-19-00-00-00 | 01-80-c2-00-00-0e }..// default 01-80-c2-00-00-0e
[no] shutdown..// NOTE: default shutdown

show status
Master:
multicast: enabled
rate announce: 1 pps
rate sync: 1 pps
rate dresp: 1 pps
type: one-step
Tx clockClass: 6
Dynamic slaves: 1
Active GM Clock ID: 00:80:EA:FF:FE:86:AB:01
Time Source: GPS
Freq/Time Traceable: TRUE/TRUE
UTC Offset: 37
Slave: enabled
Status (freq/phase): freerun/freerun
rate announce: 8 pps
rate sync-dresp: 16 pps
Mean Path Delay: -900 ns
Offset From Master: 0 ns
Delay Asymmetry: Auto, 0 ns

OSA 5401 R12.1.1 User Manual - Issue: A 124


Oscilloquartz: An ADVA Company CLI Command Definitions

Clock/Message Mode: two-way, one-step


Delay Mechanism: e2e
Clock ID: 00:00:00:00:00:00:00:00
Time Source: Other
Clock Class: 248
Freq/Time Traceable: FALSE/FALSE
UTC Offset: 0
Current packet rates: 0 pps 0 pps
Counters: Received Sent
Sync: 0 6530
FollowUp: 0 0
DelayReq: 0 0
DelayResp: 0 0
PDelayReq: 6380 6482
PDelayRsp: 0 6380
PDRespFup: 0 0
Announce 0 6530

OSA 5401 R12.1.1 User Manual - Issue: A 125


Oscilloquartz: An ADVA Company CLI Command Definitions

L3 Master Configuration
L3 slave is disabled when L2 slave is enabled (only one slave can be enabled
at a time). Master multicast no shutdown enables master unicast as well.

configure clock l3-profiles


port-delay-asymmetry [-100 000 000 … 100 000 000] // default=0 [ns]
profile [ g8265.1 | telecom2008 | g8275.2 | aes67-media | smpte-st-2059-2 ] // default
g8265.1
show remote-slave-list

configure clock l3-profiles tlv


tlv [ smpte-system-frame-rate | smpte-time-address-flags ] //for smpte-st-2059-2 profile

master
unicast
[no] shutdown // default shutdown

multicast
[no shutdown] // default shutdown
rate {1pps, 2pps, 4pps, 8pps, 16pps, 32pps, 64pps, 128pps} // for Sync, default 32 pps
// Announce, fixed ½ pps

slave
[no] shutdown // default shutdown
acceptable-master [primary | backup]
ip-address <A.B.C.D>
rate {16pps, 32pps, 64pps, 128pps} // for Sync and DelayRequests, default 128 pps

show status
configure clock l3-profiles show status
Master:
unicast: enabled
multicast: disabled
rate announce: 8 pps
rate sync: 16 pps
rate dresp: 16 pps
type: two-step
Tx clockClass: 6
Dynamic slaves: 7
Active GM Clock ID: 00:80:EA:FF:FE:86:AB:01
Time Source: GPS

OSA 5401 R12.1.1 User Manual - Issue: A 126


Oscilloquartz: An ADVA Company CLI Command Definitions

Freq/Time Traceable: TRUE/TRUE


UTC Offset: 37
Slave: unicast
Status (freq/phase): syntonized/acquisition
rate announce: 1 pps
rate sync-dresp: 128 pps
Acceptable Master 1: 10.33.188.230
Status: Active
LocalPriority: 128
Mean Path Delay: 9316 ns
Offset From Master: 65 ns
Delay Asymmetry: Auto, -142 ns
Acceptable Master 2: 10.33.188.222
Status: Passive
LocalPriority: 128
Mean Path Delay: N/A
Offset From Master: N/A
Delay Asymmetry: Auto, -133 ns
Clock/Message Mode: two-way, one-step
Delay Mechanism: e2e
Clock ID: 00:80:EA:FF:FE:86:AE:E9
Time Source: GPS
Clock Class: 6
Freq/Time Traceable: TRUE/TRUE
UTC Offset: 37
Requested packet rate:128 pps
Current packet rates: 128 pps 128 pps
Counters: Received Sent
Sync: 21098 5237667
FollowUp: 0 5237667
DelayReq: 5212157 21098
DelayResp: 21086 5212157
PDelayReq: 0 0
PDelayRsp: 0 0
PDRespFup: 0 0
Announce: 165 374701
Signaling: 4662 4652
Mgmt: 0 0

OSA 5401 R12.1.1 User Manual - Issue: A 127


Oscilloquartz: An ADVA Company CLI Command Definitions

GNSS Configuration
configure clock gnss
location
mode { navigation | survey-in | fixed } // default survey-in
latitude <deg> // default 0, -90 … 90 deg
// For example, N64.0000000
longitude <deg> // default 0, -180 … 180 deg
// For example, E124.0000000
altitude <cm> // default 0, -900000 - 900000
survey-in-minimum-duration <seconds> // default 7200 seconds
survey-in-position-accuracy-limit <mm> // default 100 meters
elevation <deg> // default 5, 1-90
snr <dBHz> // default 9, 1-99
antenna-delay <ns> // default 0, 0-9999 ns
configure clock gnss mode [ gps,glonass,beidou,galileo ] comma-delimited list ;
default=gps
[no] forced-antenna-connected // default no forced-antenna-c…
[no] shutdown // default no shutdown
show status // G=GPS, R=GLONASS,B=BeiDou
// when shutdown, very short response gnss: disabled

Administrative Status : Up
Operational Status : Up
Mode : gps-l1ca,gps-l5q
Antenna-delay : 0
Tracking : GNSS - Locked
Location Mode : fixed ( running-config: survey-in )
Minimum SNR : 9 dBHz
Minimum Elevation : 5 deg
Latitude : N60.1850938
Longitude : E024.8126701
Altitude : 47.191 m
Horizontal Accuracy : 5.525 m
Vertical Accuracy : 3.906 m
Time DOP : 0.320
Horizontal DOP : 0.000
Vertical DOP : 0.000

Satellite Status:
-----------------------------------------
Num Sig SNR Hlth Used Azim Elev Corr
-----------------------------------------
G 1 L1C/A 39 Y Y 185 67 MB PD Correction:

OSA 5401 R12.1.1 User Manual - Issue: A 128


Oscilloquartz: An ADVA Company CLI Command Definitions

G 1 L5Q 41 Y Y 185 67 MB None, MB, SBAS and QZSS


G 3 L1C/A 38 Y Y 254 64 MB PD
G 3 L5Q 36 Y Y 254 64 MB SBAS correction models:
G 4 L1C/A 38 Y Y 206 15 MB PD P = Pseudorange
G 4 L5Q 40 Y Y 206 15 MB C = Carrier range
G 12 L1C/A 24 Y Y 18 8 None D = Range rate (Doppler)
G 12 L5Q 0 N N 18 8 None
G 17 L1C/A 39 Y Y 288 38 SBAS PD
G 17 L5Q 0 N N 288 38 None
G 19 L1C/A 35 Y Y 321 24 SBAS PD
G 19 L5Q 0 N N 321 24 None
G 21 L1C/A 38 Y Y 164 46 SBAS PD
G 21 L5Q 0 N N 164 46 None
G 22 L1C/A 23 Y Y 78 53 SBAS PD
G 22 L5Q 0 N N 78 53 None
G 25 L1C/A 20 N N 48 0 MB
G 25 L5Q 16 N N 48 0 MB
G 31 L1C/A 36 Y Y 110 25 SBAS PD
G 31 L5Q 0 N N 110 25 None
G 32 L1C/A 35 Y Y 56 29 MB
G 32 L5Q 36 Y Y 56 29 MB
S 36 L1 37 Y Y 172 22 None
S 40 L1 0 N N 146 17 None
S 41 L1 0 N N 118 7 None
S 49 L1 38 Y Y 203 20 None
---------------------------------------------

OSA 5401 R12.1.1 User Manual - Issue: A 129


Oscilloquartz: An ADVA Company CLI Command Definitions

Primary IP Host Configuration


l Management host configuration is used for management (CLI)
communication, and same configuration maybe used for clock
master (PTP) communication, if configured in the similar manner
under configure clock master.
l Management host configuration has different IP-address than
clock master (PTP) IP-address, then at least other interface shall
contain VLAN in use, otherwise configuration save is disabled.
l DHCP not in use.

configure interface management


ip-address [ipv4 | ipv6] <ip address / subnet mask> // default ipv4 192.168.0.2/24
default-gw [ipv4 | ipv6] <ip address> // default 0.0.0.0
vlan-id <number> // 1,…,4095 // default 4095:not in use
vlan-pcp <number> // 0,…,7 ; default 0
ip-priority [dscp | tos | none ] ; default=none

OSA 5401 R12.1.1 User Manual - Issue: A 130


Oscilloquartz: An ADVA Company CLI Command Definitions

Port Configuration
configure port ethernet
configure port [ eth1 | eth2 ] [ [no] shutdown-if | speed | synce | show status ] ;
default=no shutdown-if
configure port [ eth1 | eth2 ] synce [ [no] tx-ssm | rx-quality-level | master | slave ]
; default=master ; default=tx-ssm

OSA 5401 R12.1.1 User Manual - Issue: A 131


Oscilloquartz: An ADVA Company CLI Command Definitions

System Configuration
ssh disabled command disables scp as well.

configure system
telnet { enabled | disabled } // default enabled
ssh { enabled | disabled } // default enabled
tftp { enabled | disabled } // default enabled
scp { enabled | disabled } // default enabled
snmp { enabled | disabled } // default enabled

engine-id <engine-id> // default 0x800015AF03AABBCC112233


where 0xAABBCC112233 is the MAC address of the device,max length 31 bytes

ne-name <name>
<name>: A character string (0 to 50 characters) representing the Name of the Network
Element. Valid entry: Character string - 0 to 50 characters; an empty string or string
containing spaces must be enclosed in quotation marks.
Default is OSA 5401.

ne-location <ne-location>
<ne-location>: A character string (0 to 50 characters) representing the location for the
Network Element. Valid entry: Character string - 0 to 50 characters; an empty string or
string containing spaces must be enclosed in quotation marks.
Default is null.

ne-contact <ne-contact>
<ne-contact>: A character string (0 to 50 characters) representing the contact for the
Network Element. Valid entry: Character string - 0 to 50 characters, an empty string or
string containing spaces must be enclosed in quotation marks.
Default is null.

ne-physical-alias <ne-physical-alias>
<ne-physical-alias>: Entity Physical Alias. Valid entry: Character string - 0 to 32
characters. Default is null.

ne-physical-asset-id <ne-physical-asset-id>
<ne-physical-asset-id>: Entity Physical Asset ID. Valid entry: Character string - 0 to 32
characters. Default is null.
security-banner add-line [ <ascii string> ] ; enclose all text within '' ; max 100
characters per line ; max 10 lines

OSA 5401 R12.1.1 User Manual - Issue: A 132


Oscilloquartz: An ADVA Company CLI Command Definitions

SSH
configure management ssh-user
Add new SSH User with user privileges:

add [superuser | retrieve] <username> <password>

[superuser | retrieve]: Defines the user privilege level as either a superuser (which
enables executing all CLI commands) or retrieve level (which enables viewing all CLI
commands, but can only execute show commands).

<username>: A character string representing the username. 2 users supported.

Valid entry: Character string 5 up to 32 characters (without spaces)

Default: root

<password> A character string representing the password.

Valid entry: Character string 5 up to 32 characters (without spaces)

Default: ChgMeNOW

Change Password:

<change-pw username> <password> <repeat password>

Valid entry: Same as above.

Delete Username:

<delete username> A character string representing the username.

Valid entry: As above.

Show the list of the users:

list

Copy a public key file:

scp id_rsa.pub <username>@<ip_address>:.

and save

Show the list of the authentication keys:

keys

Delete selected authentication key:

OSA 5401 R12.1.1 User Manual - Issue: A 133


Oscilloquartz: An ADVA Company CLI Command Definitions

keys [ del1 | del2 ]

OSA 5401 R12.1.1 User Manual - Issue: A 134


Oscilloquartz: An ADVA Company CLI Command Definitions

SNMP
configure management snmp community <index> <options>
<index> [ 1 | 2 ] ; community index
<options>
<enable>
<disable>
<name> A character string representing the SNMP Community
Name. Valid entry: Character string -up to 50 characters
(without spaces).
<access> The SNMP Access type support for this community.
Valid entry: access-none, readonly, readwrite.

configure management snmp target-params <index> <options>

<index> [ 1 | 2 ] ; target-params index


<options>
<enable>
<disable>
<community-index> [ 1 | 2 ] ; parent community index
<name> A character string representing the SNMP Target
Parameters Name. Valid entry: Character string - 0 to 50
characters (without spaces).
<mp-model> The Message Processing Model to be used when
generating SNMP messages using this entry. Valid entry:
snmpv2c, snmpv3
<security-model> The Security Model to be used when generating
SNMP messages using this entry. Valid entry: snmpv2c, usm
<security-level> The Security Level to be used when generating
SNMP messages using this entry. Valid entry: auth-no-priv,
auth-priv, no-auth

configure management snmp target-address <index> <options>

<index> [ 1 | 2 ] ; target-address index


<options>
<enable>
<disable>
<target-params-index> [ 1 | 2 ] ; parent target-params index
<name> A character string representing the SNMP Target
Address Name. Valid entry: Character string - 0 to 50
characters (without spaces).
<ip-address-port> The IP Address of the Traphost to be
associate with this Target Address Entry. Default port is 162.
Valid entry: Valid IP Address and Port, default
192.168.0.153:162.
<taglist> Must match a Notify Tag in the Notify Entry

OSA 5401 R12.1.1 User Manual - Issue: A 135


Oscilloquartz: An ADVA Company CLI Command Definitions

Table. Valid entry: trap

configure management snmp usm-user <index> <options>

<index> [ 1 | 2 ] ; usm-user index


<options>
<enable>
<disable>
<community-index> [ 1 | 2 ] ; parent community index
<user-name> A human readable string representing the name of
the USM user. Valid entry: Character string - 0 to 50
characters (without spaces)
<access> The SNMP Access type support for this USM user.
Valid entry: access-none, readonly, readwrite
<authentication-level> Authentication level for this user. Valid
entry: no-auth, auth-no-priv, auth-priv
<security-level> The Security Level associated with this usm
user. Valid entry: no-auth, auth-no-priv, auth-priv
<authentication-protocol> The Authentication Protocol support for
this USM user. An indication of whether messages sent on behalf
of this user to/from the SNMP engine identified by USM User
Engine ID, can be authenticated, and if so, the type of
Authentication Protocol which is used. Option present if <security-level>
is set to auth-priv or auth-no-priv. Valid entry: md5,
sha1
<authentication-key> The Authentication Key for this USM user.
Option present if sec-level is set to auth-priv or auth-nopriv.
Valid entry: Character string - 8 to 32 alpha-numeric.
<private-protocol> The Privacy Protocol support for this USM
user. An indication of whether messages sent on behalf of this
user to/from the SNMP engine identified by USM User Engine ID,
can be protected from disclosure, and if so, the type of
Privacy Protocol which is used. Option present if sec-level is
set to auth-priv. Valid entry: des (aes not supported in this
release).
<private-key> The Privacy Key for this USM user. Option
present if sec-level is set to auth-priv. Valid entry:
Character string - 0 to 128 characters;

OSA 5401 R12.1.1 User Manual - Issue: A 136


Oscilloquartz: An ADVA Company CLI Command Definitions

SYSLOG
The system does not prevent the same ip-address configuration for both primary and
secondary syslog servers.

configure system syslog [enable | disable] // default disabled

configure system syslog server [1 | 2] ip-address <A.B.C.D:P> // default 0.0.0.0:514.


Same non-zero IP addresses not allowed for server 1 and 2.

OSA 5401 R12.1.1 User Manual - Issue: A 137


Oscilloquartz: An ADVA Company CLI Command Definitions

Radius
configure system radius
[enable | disable] // disabled
auth-type [pap] // pap
access-order [local | remote] // local
configure system radius server[primary | backup
ip-address <A.B.C.D:P> // 0.0.0.0:1812
secret <1-128 chars>
timeout <num> // 2
retries <num> // 3 Same non-zero IP addresses not allowed for primary and backup server.

OSA 5401 R12.1.1 User Manual - Issue: A 138


Oscilloquartz: An ADVA Company CLI Command Definitions

Alarms
configure management alarm <alarm-type> severity <severity-level>
<alarm-type> Alarm type. Valid entry: time-freerun, time-holdover, error-gnss, error-
antenna
<severity-level> Severity. Valid entry: critical, major, minor, not-alarmed, not-reported
Default values:
time-freerun : not-reported
time-holdover : not-reported
time-traceable: major
freq-freerun : not-reported
freq-holdover : not-reported
freq-traceable : major
sync-timeout : minor
ann-timeout : minor
dresp-timeout : minor
loss-of-announce : not-reported
loss-of-sync : not-reported
error-antenna : major

OSA 5401 R12.1.1 User Manual - Issue: A 139


Appendix A

Technical Specifications
This section details the product technical specifications by category.

PTP Features 141

PTP Master Modes of Operation 141

PTP Slave Modes of Operation 142

Ethernet Interface 142

Synchronous Ethernet (SyncE) 142

NTP Server 143

GNSS Receiver 143

OSA 5405-I External Antenna 144

Programmable Inputs and Outputs 144

Internal Oscillator 144

LED Indications 145

Management and Security 145

Regulatory and Standards Compliance 146

Power Consumption 146

Mean Time Between Failures 146

Environmental 147

OSA 5401 R12.1.1 -User Manual - Issue: A 140


Oscilloquartz: An ADVA Company Technical Specifications

Optional Accessories 147

PTP Features
l Full-featured IEEE 1588-2008 PTP grandmaster, boundary, and slave clock
l Assisted partial timing support (APTS) – PTP input to backup GNSS outage over
network with partial/no timing support
l One-step and two-step clock
l Dedicated or common IP PTP interface
l VLAN (IEEE 802.1Q) or untagged
l SyncE input to PTP output (frequency) conversion
l Conversion between PTP profiles
l Maintains PTP slaves list
l Fixed and dynamic asymmetry compensation
l Hardware-based DoS protection

PTP Master Modes of Operation


PTP telecom profiles:

l ITU-T G.8265.1 & Telecom2008 frequency delivery profiles


l ITU-T G.8275.2 time/phase delivery profile (APTS & partial timing support)
l ITU-T G.8275.1 time/phase delivery profile (full timing support)

PTP enterprise profile (mixed IP multicast and unicast)

PTP power and utilities profiles:

l IEC/IEEE 61850-9-3
l IEEE C37.238-2011
l IEEE C37.238-2017

PTP Broadcast profiles:

l SMPTE ST 2059-2
l AES67 media profile

PTP AVB/TSN profile: IEEE 802.1AS

IEEE1588v2 default PTP profiles over L3 (Annex D and E) and L2 (Annex F)

OSA 5401 R12.1.1 User Manual - Issue: A 141


Oscilloquartz: An ADVA Company Technical Specifications

The system supports 64 slaves at all packet rates. However, each L2 and L3 multicast
grandmaster clock reserves one entry, so that the maximum number of L3 PTP unicast
slaves is 62.

Grandmaster simultaneous support for multiple profiles

No support for simultaneous L2-p and L3-p slave configuration. Only one
slave clock can be created.

PTP Slave Modes of Operation


PTP power and utilities profiles:

l IEC/IEEE 61850-9-3
l IEEE C37.238-2011
l IEEE C37.238-2017

PTP telecom profiles:

l ITU-T G.8265.1 and Telecom 2008 frequency delivery profiles


l ITU-T G.8275.2 time/phase delivery profile (APTS and partial timing support with
BMCA and automatic asymmetry compensation to two remote masters)
l ITU-T G.8275.1 time/phase delivery profile (full timing support)

IEEE1588v2 default PTP profiles over L3 (Annex D) and L2 (Annex F)

PTP enterprise profile (mixed IP multicast and unicast)

Ethernet Interface
l Hardware-based timestamping
l SFP or combo SFP/SFP+ 1000Base-X (MSA compliant)

Synchronous Ethernet (SyncE)


l Compliant to the relevant sections of ITU-T G.8261/G.8262/G.8264
l Supported on ingress and egress
l G.811 compliant Sync-E primary reference clock (PRC) when locked to GNSS

OSA 5401 R12.1.1 User Manual - Issue: A 142


Oscilloquartz: An ADVA Company Technical Specifications

l Ethernet Synchronization Message Channel (ESMC)


l SyncE input for time holdover during GNSS outage

NTP Server
l Smallest NTP server formfactor
l Security-hardened NTP server with Hardware-based responder
l Stratum 1 NTP server when locked to GNSS
l NTP v1, v2, v3, v4 and SNTP over IPv4 /IPv6
l Time & daytime protocols
l Hardware-based timestamping
l Within +/–100nsec from UTC
l Hardware base DoS protection using NTP responder
l Up to 500,000 transactions per second
l Support PTP and NTP on same port
l PTP to NTP translation
l PTP backup in case of GNSS outage
l Stationary or moving platforms

GNSS Receiver
l Provide high accuracy for PRTC-A applications, accuracy within +/-100nsec from
UTC
l Independent 72-channel multi-GNSS engine
l Supports single satellite timing modes:
l Survey fixed location
l Configurable fixed location
l Navigation mode
l Configurable satellites SNR and elevation masks
l Advanced spoofing and jamming detection on device level
l AI based spoofing and jamming detection based on Ensemble Controller featuring
NMS GNSS assurance
l GPS/QZSS L1 C/A and GLONASS L10F, BeiDou B1 , Galileo E1, SBAS (QZSS ,WAAS,
EGNOS, MSAS)
l Up to three concurrent GNSS constellations
l User configurable antenna cable delay compensation

OSA 5401 R12.1.1 User Manual - Issue: A 143


Oscilloquartz: An ADVA Company Technical Specifications

l Voltage to antenna +3.3VDC


l Antenna connector SMA-F (50 Ohms)

OSA 5405-I External Antenna


l User-configurable antenna cable delay compensation
l Voltage to antenna + VDC

Programmable Inputs and Outputs


l User-configurable output: 1PPS/10MHz/2.048MHz
When using PPS output, a good trigger level is about 1.5 V.
l RP-MMCX connector, 50 ohms

The PPS output connector type is RP-MMCX, which requires a cable


with a RP-MMCX male plug (also known as Reverse Polarity MMCX).
A suitable RP-MMCX to BNC cable is available as an optional
accessory.

The use of a regular MMCX connector may damage the device.

Table 19: 1PPS Out


Accuracy: +/- 50 ns (typical with good GNSS Signal)
Level: 2.3 V (50 Ohm load)
Rising Time: 4 ns (50 Ohm load)
Pulse Width: 20 µs

Internal Oscillator
l OCXO Stratum 3E
l Frequency stability over temperature: +/-10ppb
l Frequency slope ΔF/ΔT: +/-0.5 ppb/°C
l Long term stability (aging):

OSA 5401 R12.1.1 User Manual - Issue: A 144


Oscilloquartz: An ADVA Company Technical Specifications

o − +/-1ppb/day
o − +/-2.5ppm/20 years

LED Indications
The LED indicator is:

l GNSS operation and general fault indication status LED

For more information about the product LEDs, see LED Indicator.

Management and Security


l In-band management via Ethernet port (over PTP/SyncE port)
l Remote CLI-Telnet and SSH (Secure Shell)
l Separate management IP and PTP addresses
l VLAN and untagged
l System software download via TFTP and SCP (secure copy)
l Ability to disable each of the protocols through CLI
l Alarm log and security log
l Syslog
l Remote authentication through RADIUS
l Remote, secure backup and restore
l Remote, secure software upgrade
l Low touch provisioning with configuration file
l Multilevel user access
l Access control list (ACL)
l Full management using SNMP v2/v3 including authentication and encryption
l LLDAP
l Alarms, inventory and traps reporting to NMS
l Managed by ADVA Ensemble Controller and Ensemble Sync Director, including
GNSS assurance toolkit

OSA 5401 R12.1.1 User Manual - Issue: A 145


Oscilloquartz: An ADVA Company Technical Specifications

Regulatory and Standards Compliance


l ITU-T G.8261, G.8262, G.8264
l ITU-T G.8272, G.811
l ITU-T G.8265.1, G.8275.1. G.8275.2
l IEEE 1588v2 (PTP)
l IEEE 1613:2009, IEC 61850-3:2013
l RFC 1059 (NTPv1), RFC 1119 (NTPv2), RFC 1305 (NTPv3), RFC 5905 (NTPv4), RFC
4330 (SNTPv4)
l RFC868 (Time), RFC867(Daytime)
l ETSI EN 300 386 V2.1.1
l EN 55032, EN 55035
l AS/NZS CISPR 22
l FCC CFR 47 Part 15 Subpart B
l ANSI C63.4 Class-B
l IEC/EN 61000-3-2
l IEC/EN 61000-3-3
l IEC/EN 61000-4-2 (ESD): ±15 kV / ±8 kV (air/contact)
l IEC/EN 61000-4-3 (RI)
l IEC/EN 61000-4-4 (EFT): 1 kV / 50 A (5/50 ns)
l IEC/EN 61000-4-5 (Surge): 4KV (10/700 μs)
l IEC/EN 61000-4-6 (CI)
l EN 62368-1:2020+A11:2020, IEC 62368-1:2018 (Ed.3)
l RoHS compliance

Power Consumption
l Max power consumption <1.5W (T >20°C)
l Max power consumption <1.7W (T <20°C)

Mean Time Between Failures


This table lists Mean Time Between Failure (MTBF) values for OSA 5401.

OSA 5401 R12.1.1 User Manual - Issue: A 146


Oscilloquartz: An ADVA Company Technical Specifications

Table 20: MTBF Values


Product MTBF at 30° C Ambient Temperature
OSA 5401 1,945,279 hours

Environmental
l Operating temperature: -40 to +80°C (-104 to 176°F)
l Storage temperature : -40°C to +85°C (-104 to 185°F)
l Humidity: 5 to 95% (non-condensing)

Optional Accessories
l GNSS (GPS/GLONASS/BEIDOU) antenna kits 10/20/60/120/150m (32.8ft/65.6ft/
196.85 ft/393.7ft/492.1ft), including indoor and outdoor cables, roof antenna,
lightning protector, and mounting kit.
l Patch window antenna
l 1:2/1:4/1:8 GNSS (GPS/GLONASS) splitters
l RP-MMCX to BNC adapter cable

OSA 5401 R12.1.1 User Manual - Issue: A 147


Appendix B

Supported CLI and File


Transfer Applications
Table 21: CLI and File Transfer Applications Tested
Application Application Name Revision
SSH/Telnet TeraTerm 4.89, 4.106
SSH/Telnet PuTTY 0.66, 0.74, 0.76
SSH/Telnet SecureCRT 8.0.3, 7.3, 8.0.3, 9.0.2
TFTP Open TFTP Server (Windows) 1.64
TFTP TFTPD64 4.52
TFTP OpenTFTP (Linux) 0.17.18
SSH/SCP OpenSSH (SSH and SCP) 6.1, 6.6, 7.4, 7.6, 8.5
Not supported: 6.0 and
earlier
SCP SolarWinds SCP (Windows) 1.0.4.9

These SSH algorithms are supported with OSA 5401:

l Diffie-Hellman-Group1-SHA1, Diffie-Hellman-Group14-SHA1 (key exchange)


l 3DES-CBC (encryption)
l HMAC-SHA2-256 (message authentication code)

OSA 5401 supports four SSH sessions at a time.

OSA 5401 R12.1.1 -User Manual - Issue: A 148


Appendix C

Supported PTP Profiles and


Parameters
The supported L2 and L3 profiles and parameters are listed in the tables.

For more information on changing the default PTP profile, see


Configuring PTP Profiles.

L2 PTP Telecom Profiles 150

L2 PTP Power Profiles 151

L2 PTP Audio/Video Broadcasting and Automotive Systems Profile 152

L3 PTP Telecom Profiles 153

L3 PTP Broadcast Profiles 155

OSA 5401 R12.1.1 -User Manual - Issue: A 149


L2 PTP Telecom Profiles
The supported L2 PTP profiles are G.8275.1 (default) and IEEE1588-2008 Annex F. This table
lists the parameters for each L2 PTP profile.

OSA 5401 operates as a boundary clock when you configure L2 or L3 PTP


slave on the clock reference list with priority 1. Otherwise, it operates as a
grandmaster clock.

G.8275.1 IEEE1588-2008 Annex F


Boundary Boundary
L2 Parameters Grandmaster Grandmaster
Clock Clock
Default Domain Number 24 24 4 4
Unicast negotiation No No No No
mcast/ucast mcast mcast mcast mcast
Non-fwd address 01-80-C2-00-00- 01-80-C2- 01-80-C2-00- 01-80-C2-
0E 00-00-0E 00-0E 00-00-0E
Fwd dst address 01-1B-19-00-00- 01-1B-19- 01-1B-19-00- 01-1B-19-
00 00-00-00 00-00 00-00-00
Clock Class - Locked (ETSI | 6 | 6 N/A 6|6 N/A
ANSI)
HO-in-spec 7|7 135 | 135 7|7 187 | 187
HO-out-of-spec 140 | 140 165 | 165 52 | 52 187 | 187
Freerun 248 | 248 248 | 248 248 | 248 248 | 248
Clock Accuracy {0x21, 0xFE} {0xFE} {0x21, 0xFE} {0xFE}
OffsetScaledLogVariance {0x4E5D, 0xFFFF} {0xFFFF} {0x4E5D, {0xFFFF}
0xFFFF}
Default Sync Rate 16 pps 16 pps 128 pps 128 pps
Default DelayReq Rate 16 pps 16 pps 128 pps 128 pps
Default Announce Rate 8 pps 8 pps 1/2 pps 1/2 pps

OSA 5401 R12.1.1 -User Manual - Issue: A 150


L2 PTP Power Profiles
The supported L2 PTP power profiles are IEC-61850-9-3 utility profile, C37.238 2011 and
C37.238 2017 power profiles. The parameters for each profile are listed in this table.

L2 Parameters IEC-61850-9-3 C37.238 2011 C37.238 2017


Default Domain Number 0 0 254
Unicast negotiation No No No
mcast/ucast mcast mcast mcast
mcast address 01-80-C2-00-00-0E 01-80-C2-00-00-0E 01-80-C2-00-00-0E
Clock Class - Locked 6 6 6
HO-in-spec 7 7 7
HO-out-of-spec 187 187 187
Freerun 248 248 248
Clock Accuracy 0x21, 0x22, 0x23, 0x21, 0x22, 0x23, 0x21, 0x22, 0x23,
0xFE 0xFE 0xFE
OffsetScaledLogVariance {0x4E5D, 0xFFFF} {0x4E5D, 0xFFFF} {0x4E5D, 0xFFFF}
Default Sync Rate 1 1 1
Default PeerDelayReq 1 1 1
Rate
Default Announce Rate 1 1 1

OSA 5401 R12.1.1 -User Manual - Issue: A 151


L2 PTP Audio/Video Broadcasting and
Automotive Systems Profile
L2 Parameters 802.1AS-2011
Default Domain Number 0
Unicast Negotiation No
mcast/ucast mcast
mcast address 01-80-C2-00-00-0E
Clock Class - Locked 6
HO-in-spec 7
HO-out-of-spec 187
Freerun 248
Clock Accuracy 0x21, 0x22, 0x23, 0xFE
OffsetScaledLogVariance 0x4100
Default Sync Rate 8
Default PeerDelayReq Rate 1
Default Announce Rate 1

OSA 5401 R12.1.1 -User Manual - Issue: A 152


L3 PTP Telecom Profiles
The supported L3 PTP profiles are G.8265.1 (default), Telecom-2008, and G.8275.2. This
table lists parameters for each L3 PTP profile.

OSA 5401 operates as a boundary clock when you configure L2 or L3 PTP


slave on the clock reference list with priority 1. Otherwise, it operates as a
grandmaster clock.

G.8265.1 Telecom-2008 G.8275.2


L3 Grand- Boundary Grand- Boundary Grand- Boundary
Parameters master Clock master Clock master Clock
Default 4 4 4 4 44 44
Domain
Number
Unicast Yes Yes Yes Yes Yes Yes
negotiation
mcast/ucast ucast ucast ucast ucast ucast ucast
mcast N/A N/A N/A N/A N/A N/A
address
Clock Class - 84 | 80 N/A 6|6 N/A 6|6 N/A
Locked (ETSI |
ANSI)
HO-in-spec 90 | 96 187 | 187 7|7 187 | 187 7|7 135 | 135
HO-out-of- 96 | 100 187 | 187 52 | 52 187 | 187 140 | 140 165 | 165
spec
Freerun 104 | 102 248 | 248 248 | 248 248 | 248 248 | 248 248 | 248
Clock {0x21, {0xFE} {0x21, {0xFE} {0x21, {0xFE}
Accuracy 0xFE} 0xFE} 0xFE}
OffsetScaled {0x4E5D, {0xFFFF} {0x4E5D, {0xFFFF} {0x4E5D, {0xFFFF}
LogVariance 0xFFFF} 0xFFFF} 0xFFFF}
Default Sync 128 pps 128 pps 128 pps 128 pps 16 pps 16 pps
Rate

OSA 5401 R12.1.1 -User Manual - Issue: A 153


Oscilloquartz: An ADVA Company Supported PTP Profiles and Parameters

G.8265.1 Telecom-2008 G.8275.2


L3 Grand- Boundary Grand- Boundary Grand- Boundary
Parameters master Clock master Clock master Clock
Default 128 pps 128 pps 128 pps 128 pps 16 pps 16 pps
DelayReq
Rate
Default 1/2 pps 1/2 pps 1/2 pps 1/2 pps 8 pps 8 pps
Announce
Rate

OSA 5401 R12.1.1 User Manual - Issue: A 154


Oscilloquartz: An ADVA Company Supported PTP Profiles and Parameters

L3 PTP Broadcast Profiles


The supported L3 PTP broadcast profiles are AES67 Media and SMPTE ST 2059-2. The
parameters for each profile are listed in this table.

L3 Parameters AES67 Media SMPTE ST 2059-2


Default Domain Number 0 127
Unicast negotiation Yes Yes
mcast/ucast ucast/mcast ucast/mcast
mcast address N/A N/A
Clock Class - Locked (PTP | ARB) 6 | 13 6 | 13
HO-in-spec (PTP | ARB) 7 | 14 7 | 14
HO-out-of-spec (PTP | ARB) 187 | 193 187 | 193
Freerun 248 248
Clock Accuracy {0x21, 0xFE} {0x21, 0xFE}
OffsetScaledLogVariance {0x4E5D, 0xFFFF} {0x4E5D, 0xFFFF}
Default Sync Rate 8 8
Default DelayReq Rate 8 8
Default PeerDelayReq Rate 1 1
Default Announce Rate 1/2 4

OSA 5401 R12.1.1 User Manual - Issue: A 155


Appendix D

LAN Connector Pin


Assignments
The RJ45 1000 Base-T LAN port connector pin assignments are listed in the table.

Table 22: 1000 Base-T LAN Port (RJ45 Connector), where Bi D = Bi-directional Data
MDI MDI-X 1000 Base-T Signal Name
1 3 BI D1+
2 6 BI D1-
3 1 BI D2+
4 7 BI D3+
5 8 BI D3-
6 2 BI D2-
7 4 BI D4+
8 5 BI D4-

OSA 5401 R12.1.1 -User Manual - Issue: A 156


Appendix E

Mapping between Clock


Classes and ESMC
These tables indicate the PTP clock classes and ESMC QL used in different operating states.

Table 23: PTP Clock Classes ETSI


ETSI G.8265.1 telecom2008 G.8275.1 ESMC
Warm up 110 248 248 SEC/EEC-1
Locked 84 6 6 PRC
SyncE HO When incoming QL PRC 90 7 7 DNU
SyncE HO When incoming QL SSU-A 90 52 150 DNU
SyncE HO When incoming QL SSU-B 96 52 160 DNU
OCXO HO 96 187 160 SEC/EEC-1

Table 24: PTP Clock Classes ANSI


ANSI G.8265.1 telecom2008 G.8275.1 ESMC
Warm up 110 110 248 ST3/EEC-2
Locked 80 6 6 PRS
SyncE HO When incoming QL PRS 96 7 7 DUS
SyncE HO When incoming QL ST2 86 7 150 DUS
SyncE HO When incoming QL ST3E 100 52 160 DUS
OCXO HO 100 187 160 ST3/EEC-2

OSA 5401 R12.1.1 -User Manual - Issue: A 157

You might also like