Symmetricom 1000, 1100 TL1 Overview

Chapter 4 Provisioning the TimeProvider

TL1 Overview

86 TimeProvider User’s Guide 097-58001-02 Revision G – April 2008

TL1 Overview

The TimeProvider uses the TL1 syntax; this chapter and the TimeProvider TL1

Reference Guide describes command lines and responses. For a complete

description of the TL1 syntax, refer to Telcordia (Bellcore) Technical Reference

TR-NWT-00831 and TR-NWT-00833.

TL1 Command Structure

The TL1 commands you issue to the TimeProvider use the following structure:

verb-modifier:|tid|:|aid|:[<ctag>]::|<keyword>|=<value||;

where:

: (colon) is a block separator

, (comma) is a parameter field separator

; (semicolon) is the terminating character for commands and responses

[ ] (square brackets) indicate optional parameters

Adjacent colons indicate unused fields. If an unused field is the last parameter in the

list, for example the general block or the parameter block, you can omit the colon

and simply type the semicolon.

If you enter a space in the command string, the TimeProvider ignores it.

TL1 commands are not case-sensitive.

Table 4-1 describes the syntax used in this manual.

Table 4-1. TL1 Syntax Conventions

Symbol Description

^ Space character (ASCII 0x20)

<cr> Carriage return (ASCII 0x0D)

<lf> Line feed (ASCII 0x0A)

[ ... ] Optional command parameter or data

< ... > ASCII characters sent in commands or returned in response

( ... ) Numeric data that can be positive or negative

Contents

Main Page Contents How to Use This Guide Chapter 1 Overview of the TimeProvider Chapter 2 Engineering and Ordering Procedures Chapter 3 Installing the TimeProvider Chapter 4 Provisioning the TimeProvider Chapter 5 Testing the TimeProvider Chapter 6 Maintaining and Troubleshooting the TimeProvider Chapter 7 Specifications of the TimeProvider Index Figures Page Tab le s Page How to Use This Guide In This Preface Purpose of This Guide Who Should Read This Guide Structure of This Guide Conventions Used in This Guide Warnings, Cautions, Recommendations, and Notes Related Documents and Information Where to Find Answers to Product and Document Questions Whats New in This Guide Page Chapter 1 Overview of the TimeProvider Overview Shelves Expansion Panel Inputs Outputs Communication Clocks Operating Modes Performance Monitoring Phase Measurements MTIE Calculations TDEV Calculations FFOFF Calculations NTP Operation Page SNMP Simple Network Management Protocol Physical Description Page Functional Description Page Page System Power Communication Ports Ethernet Local Craft Serial Port Remote Serial Port Reference Input Signals Selecting the Input SSMs and Quality Level Page GPS Inputs Clock Performance Output Signals Retimer Modules Alarms Synchronization Status Messages (SSMs) Page SmartClock BesTime Normal Tracking GPS Holdover Chapter 2 Engineering and Ordering Procedures Shelf Model 1000 Front Access Model 1100 Rear Access Expansion Panel Front Access Input Modules Output Modules IMC and IOC Modules GPS Antenna The following table identifies the parts available for the GPS antenna. Page Ordering and Parts List Ordering the Cable Management Option Ordering an NTP or SNMP License Page Chapter 3 Installing the TimeProvider Getting Started Pre-Installation Check Performing a Site Survey Gathering the Tools Unpacking the Unit Rack Mounting Page Page Page Making Connections Making Ground Connections Making Power Connections Verifying Power and Grounding Connections Making Input Connections The pinout for the DB9 Input module is shown in Table 3-3. Page Making Output Connections Page Page Making Retimer Connections Making Alarm Connections Making GPS Connections Page Page Page Page Page Page Page Making Communications Connections Changing Communications Settings Installing Connections to the Ethernet Port Page Installation Check List Powering Up the Shelf Working With Cards Properly Handling Cards Inserting Cards Removing Cards Firmware Features 1.05.04 1.05.00 IMC Release IOC Release Features Added 1.01.04 1.01.02 1.02.01 1.02.12 1.03.03 1.03.04 Chapter 4 Provisioning the TimeProvider TL1 Overview TL1 Command Structure TL1 Response Format Autonomous Messages Starting the TimeProvider for the First Time Logging In for the First Time Page Setting Communications Parameters Setting RS-232 Parameters Page Setting Ethernet Parameters Checking Communication Links Defining the Security Parameters Defining a User at the Security Access Level Managing the User List Logging In Logging Out Adding a User Changing the Current Users Password Displaying a Users Access Level Editing a Users Access Level Deleting A User Retrieving Current Users Using SynCraft Starting SynCraft Creating a Connection Opening a Connection Closing a Connection Provisioning the IOC Setting the System Mode Page Setting the IOC Parameters This command has a default access level of ADMIN. Provisioning the Input Reference Setting the Input State Setting the GPS Parameters Setting the Input Frequency Setting the Input Frame Type Controlling Automatic Reference Switching Setting the Input Quality Level Setting the Input Priority Level Manually Selecting the Reference Provisioning the SSM Enabling CRC4 Using Performance Monitoring This command sets the GPS input performance monitoring threshold to a mask value of GPS-R. Provisioning the Outputs Enabling and Disabling the Outputs Provisioning the Output Framing Type Provisioning Retimer Parameters Enabling and Disabling the Retimers Provisioning the LBO This command has a default access level of ADMIN. Provisioning Cut-thru Mode Provisioning NTP Parameters Activating NTP Editing NTP Peer Server Parameters Enabling NTP Authentication Setting the NTP Authentication Key Provisioning Alarms Provisioning the Alarm Levels Page Page Page Provisioning System-Level Alarms Retrieving Current Alarm Settings This command always has an access level of USER. You can display the current settings for any alarm using the RTRV-ATTR command. Response Format Retrieving Current Alarms You can display the current active alarms using the RTRV-ALM command. This command has a default access level of USER. Normal Response Format where * indicates zero or more of the preceding element This command causes the TimeProvider to return all current alarms. Displaying Alarm Status This command always has an access level of USER. Normal Response Format Clearing Alarms Provisioning SNMP Parameters Activating SNMP Adding a User Changing A Users Security Parameters Displaying the Connected Users Deleting a User Setting Up SNMP Traps, Informs, and Notifications System Commands Displaying Events Displaying the Configuration of the TimeProvider Restarting the TimeProvider Saving Provisioning Data Page Page Page Chapter 5 Testing the TimeProvider Testing the TimeProvider Test Overview Test Equipment Verifying Normal Operation Page Testing Alarm Conditions Testing the IOC Operating Modes Testing the Reference Switching Testing the Non-Revertive Operating Mode Testing the Revertive Operating Mode Testing the Power Alarms Detecting Input Errors Testing the Communication Ports Testing the Local Craft Serial Port Testing the Remote Serial Port Testing the Ethernet Port Testing the Outputs Test Record Page Chapter 6 Maintaining and Troubleshooting the TimeProvider Preventive Maintenance Safety Considerations ESD Considerations Diagnosing the IOC Reading LED Conditions Table 6-2 shows the function of the LED indicators on the front panel of the IOC. Interpreting Error Messages Removing the IOC Page Replacing the IOC Page Diagnosing the IMC Reading LED Conditions Interpreting Error Messages Replacing the IMC or IMC/TPIU Diagnosing the External TPIU Diagnosing the Retimer Module Replacing Output Modules Replacing the Input Module Troubleshooting the TimeProvider Using Events to Troubleshoot Page Page Page Page Page Page Table 6-6 describes the alarm codes and their set and clear conditions. Page Using Alarm Codes to Troubleshoot Page Page Page Page Page Page Page Table 6-8 describes the conditions that generate the associated event. Page Page Repairing the TimeProvider Obtaining Technical Assistance Upgrading the Firmware Page Upgrading the IMC Upgrading the IOC Page Returning the TimeProvider Repacking the Unit Equipment Return Procedure Manual Updates Chapter 7 Specifications of the TimeProvider Communications Ports Serial Ports LAN Port Clocks Inputs Page Outputs Page Alarms Input Alarms Output Alarms Power Roof Antenna Mechanical TimeProvider 1000 Front-Access Shelf TimeProvider 1100 Rear-Access Shelf Environmental Appendix A Factory Default Values In This Appendix Default Command Access Levels Alarm Default Values Page Page Default Equipment Parameters Default Input Parameters Default Output Parameters Default Retimer Parameters Page Appendix B CRAFT Software Reference In This Appendix Overview System Requirements Installing SynCraft Page Index Symbols A B C D E F G H I L M N O P Q R S T U W Y