12 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
How to Use This Guide
This section describes the format, layout, and purpose of 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
What’s New in This Document
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 13
How to Use This Guide
Purpose of This Guide
The SSU-2000 Technical Reference describes the programming languages that you
can use with the Symmetricom SSU-2000 Synchronization Supply Unit, and
contains the alarms and events you can use to troubleshoot the SSU-2000.
Who Should Read This Guide
This Technical Reference guide contains detailed information and instructions which
are intended to be performed by qualified personnel only.
Structure of This Guide
This guide contains the following chapters and appendixes:
Chapter, TitleDescription
Chapter 1, OverviewProvides an overview of the SSU-2000 Technical Reference.
Chapter 2, TL1 ReferenceDescribes the TL1 command set available for use in the
SSU-2000.
Chapter 3, ICS Command
Reference
Chapter 4, NTP and SNMPProvides an overview of the NTP and SNMP functions
Chapter 6, Alarms and EventsLists the alarms and events that appear on the console and
Chapter 7, Connector PinoutsLists the pinout of the connectors in the rear panel of the
Chapter 8, Default SettingsIncludes a list of the factory default values for hardware and
Chapter 9, SpecificationsLists the specifications for the SSU-2000.
Chapter 10, Reference MaterialsContains a listing of standards related to synchronizing
Index
Describes the ICS command set available for use in the
SSU-2000.
available in the SSU-2000.
provides basic indications of the source of the alarm.
SSU-2000.
software parameters.
telecommunications networks.
Provides references to individual topics within this guide.
14 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
How to Use This Guide
Conventions Used in This Guide
This guide uses the following conventions:
Acronyms and Abbreviations – Terms are spelled out the first time they appear
in text. Thereafter, only the acronym or abbreviation is used.
Revision Control – The title page lists the printing date and versions of the
product this guide describes.
Typographical Conventions – This guide uses the typographical conventions
described in the table below.
When text appears
this way...
SSU-2000 User’s GuideThe title of a document.
SSU
CRITICAL
Select File, Open...Click the Open option on the File menu.
Enter
Press
Press ;
SSU
Username:
PING
STATUS
A re-timing applicationA word or term being emphasized.
Symmetricom does not
recommend...
An operating mode, alarm state, status, or chassis label.
A named keyboard key.
The key name is shown as it appears on the keyboard.
An explanation of the key’s acronym or function
immediately follows the first reference to the key, if
required.
Text in a source file or a system prompt or other text that
appears on a screen.
A command you enter at a system prompt or text you
enter in response to a program prompt. You must enter
commands for case-sensitiv e operating systems exactly
as shown.
A word or term given special emphasis.
... it means:
Warnings, Cautions, Recommendations, and Notes
Warnings, Cautions, Recommendations, and Notes attract attention to essential or
critical information in this guide. The types of information included in each are
explained in the following examples.
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 15
How to Use This Guide
Warning: To avoid serious personal injury or death, do not
disregard warnings. All warnings use this symbol. Warnings are
installation, operation, or maintenance procedures, practices, or
statements, that if not strictly observed, may result in serious
personal injury or even death.
Caution: To avoid personal injury, do not disregard cautions. All
cautions use this symbol. Cautions are installation, operation, or
maintenance procedures, practices, conditions, or statements, that
if not strictly observed, may result in damage to, or destruction of,
the equipment. Cautions are also used to indi cat e a lon g- te rm
health hazard.
ESD Caution: To avoid personal injury and electrostatic discharge
(ESD) damage to equipment, do not disregard ESD cautions. All
ESD cautions use this symbol. ESD cautions are installation,
operation, or maintenance procedures, practices, conditions, or
statements that if not strictly observed, may result in possible
personal injury , electrostatic discharge damage to, or destruction of,
static sensitive components of the equipment.
Electrical Shock Caution: To avoid electrical shock and possible
personal injury, do not disregard electrical shock cautions. All
electrical shock cautions use this symbol. Electrical shock cautions
are practices, procedures, or statements, that if not strictly
observed, may result in possible personal injury, electr ical shock
damage to, or destruction of components of the equipment.
Recommendation: All recommendations use this symbol.
Recommendations indicate manufacturer-tested methods or known
functionality. Recommendations contain installation, operation, or
maintenance procedures, practices, conditions, or statements, that
provide important information for optimum performance results.
Note: All notes use this symbol. Notes contain installation,
operation, or maintenance procedures, practices, conditions, or
statements, that alert you to importa nt information, which may
make your task easier or increase your understanding.
16 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
How to Use This Guide
Related Documents and Information
Other helpful documents and software tools are listed below. See your
Symmetricom representative or sales office for a complete list of available
documentation.
SSU-2000e User’s Guide
SynCraft management software
TimePictra management software
Note: Symmetricom offers a number of applicable training courses
designed to enhance product usability. Contact your local
representative or sales office for a complete list of courses and
outlines.
Where to Find Answers to Product and Document
Questions
For additional information about the products described in this guide, please cont act
your Symmetricom representative or your local sales office. You can also contact us
on the web at www.symmetricom.com.
What’s New in This Document
Revision E.01 contains the following changes and new information:
Corrected the time format described on pages 27–31.
Added a description of the ACO feature in Retrieve Alarm Cutof f, on page 36 and
ALARM, on page 169.
Added new parameters to the response for the TL1 command Retrieve Clock
Parameters, on page 46.
Added new parameters to the response for the TL1 command Retrieve GPS
Data, on page 61.
Added new parameters to the response for the TL1 command Retrieve GPS
Input Parameters, on page 63.
Added the new TL1 command Retrieve Setup Parameters, on page 100.
The limit range for the MTIE parameter in the TL1 command Set MTIE
Parameters, on page 139, is changed to 0 to 60000.
The limit range for the MTIE parameter in the ICS command INPUT, on page
192, is changed to 0 to 60000.
The ICS command RESTART, on page 218, now requires a valid module
address.
The ICS command SETUP, on page 220, contains the new REPORT parameter.
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 17
How to Use This Guide
Corrected the vendor name in Table 5-10.
Added three GPS Input module alarms to Table 6-13.
Corrected the default values in Table 8-2, Table 8-3, Table 8-6, Table 8-8, Table
8-9, Table 8-10, Table 8-11, and Table 8-12.
Corrected the Min and Max Tau Limit and Min and Max Lock Tau values in Table
8-14.
Added metric equivalent to Altitude specification in Table 9-1.
18 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
Chapter 1 Overview
This chapter provides an overview of this guide.
In This Chapter
SSU-2000e Control Languages
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 19
Chapter 1 Overview
SSU-2000e Control Languages
SSU-2000e Control Languages
Software embedded in the SSU-2000e hardware allows operators to query and
manage an SSU-2000e from a local or remote management terminal using one of
three control interfaces. These management agents allow operators to change
factory default settings, set or restore stored configuration settings, configure and
provision the SSU-2000e to meet the requirements of a unique environment, and
perform maintenance and troubleshooting.
The SSU-2000e supports three control interfaces. Each grant s access to command
functions according to the security levels assigned to users. The control interfaces
are:
TL1 – The Transaction Language One (TL1) control language, perhaps the
dominant telecommunications industry ASCII command line interface, provides a
standard man-machine language. The TL1 language is defined in Bellcore
document TR-NWT-000831, Issue 3, Revision 1, December 1993.
ICS – The Interactive Command Set (ICS) control language also called the ASCII
command set, can be used to control the SSU-2000e from a terminal connected
to one of the SSU-2000e EIA-232 serial ports.
SNMP – The Simple Network Management Protocol (SNMP) protocol is based
on a client server query-response mode and is supported by Ethernet only.
There are six main executables (software versions) availab le for the SSU-2 000e as
shown in Table 1-2. This section provides information about the TL1 and ICS control
languages for all versions of software.
Chapter 2, TL1 Reference, contains the TL1 commands and responses
Chapter 3, ICS Command Reference, contains the ICS commands and
responses
Chapter 4, NTP and SNMP, describes NTP support functionality and identifies
SNMP command functions, as well as features supported in this software
version.
Recommendation: To ensure optimal system performance using the
Communications module main executable software shown in Table 1-2,
Symmetricom recommends that the module hardware and software
used be at the minimum revision levels as shown in Table 1-1.
20 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
Basic System LoadXX
Basic w/NTP SupportXXX
Basic w/SNMP v2 SupportXXX
Basic w/SNMP v2 and NTP SupportXXXX
Basic w/SNMP v3 SupportXXXX
Basic w/SNMP v3 and NTP SupportXXXXX
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 21
Chapter 1 Overview
SSU-2000e Control Languages
22 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
Chapter 2 TL1 Reference
This chapter provides detailed information about the Transaction Language One
(TL1) that is used to communicate with the SSU-2000e.
In This Chapter
TL1 Command Interface
TL1 Retrieve Commands and Responses
TL1 Set Commands
Other TL1 Commands
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 23
Chapter 2 TL1 Reference
TL1 Command Interface
Telcordia Technologies (formerly Bellcore) specifies the TL1 command interface for
use as a standard man-machine language for controlling telecommunications
network elements. TL1 provides command sets to support all operation,
administration, maintenance, and provisioning tasks required to maintain and
control an SSU-2000e. These tasks include configuring and provisioning security,
monitoring system performance, configuring hardware, locating and handling faults,
and performing equipment diagnosis and testing.
Note:
To communicate with the SSU-2000e, you must first connect a
terminal to one of the three EIA-232-C serial communication ports and
then provision the Ethernet port. Then you can communicate with the
SSU-2000e using an Ethernet telnet session.
To set up an SSU-2000e port for TL1 communications:
1. Log on to one of the SSU-2000e EIA-232 serial ports usin g a Supervisor-level (or
higher) user name and password.
2. Set port A, B, or L to TL1 mode. For example, to set the local port (COML) to TL1
mode, at the system prompt, type:
COMM L MODE TL1 then press Enter
The communications mode settings for the COMM A and COMM B port s (located
on the connection panel) are stored in non-volatile RAM, and remain in effect
even after restarting the SSU-2000e.
The communications mode settings for the COMM L (local) port (located on the
Communications module) always default to ASCII (ICS) mode on startup.
3. To close the serial port for TL1 communications, type
EXIT::::0; or send three
ESCape characters from the management terminal. This logs you out and
returns the port to the default communications mode.
When you connect to the SSU-2000e via Ethernet port 2000 (decimal) using a
Telnet-type application, the session opens in TL1 mode. Up to four sessions (users)
can be connected to port 2000 at one time. Once you are connected, you must log
in using the ACT-USER command with a user name and password (if security is
active on the unit).
To log off the user and exit from an Ethernet session, type
CANC-USER:::0;.
Another user can then open a new session by using the ACT-USER command.
To log off the user, exit from an Ethernet session, and close the Ethernet connection
to port 2000, type
EXIT:::0;. The next user must first connect to port 2000 and
then log in using the ACT-USER command.
24 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
TL1 Command and Response Conventions
Chapter 2 TL1 Reference
Note: The automatic time-out is disabled for the port when you
are communicating in TL1 mode using one of the serial
communications ports or the Ethernet port.
TL1 Command and Response Conventions
This section describes general and specific conventions for expressing TL1
command and response parameters for the four types of operations application
messages:
Input Command Message – This message determines the action that the
SSU-2000e will take. For a detailed descriptio n of input command messages and
conventions, see Input Command Message Conventions, on page 26.
In-Process Acknowledgment – The in-process acknowledgment (IP) response
message is sent in response to a command that the SSU-2000e is unable to
respond to within two seconds. For a detailed description of in-process
acknowledgment response messages and conventions, see In-Process
Acknowledgment Response Message Conventions, on page 27.
the command was complied with (COMPLD) or denied (DENY). For a detailed
description of output response messages and conventions, see Output
Response Message Conventions, on page 28.
Autonomous response or report message – The autonomous response or
report message is an output generated by the SSU-200 due to an event, such as
an alarm, or a change in status in the system. For a detailed description of
autonomous response or report messages and conventions, see Autonomous
Report Conventions, on page 30.
TL1 General Conventions
TL1 uses English-like acronyms and shorthand or abbreviations in a format that can
be read and composed by humans.
Follow these general conventions for entering all TL1 parameters:
Enter all command characters in upper-case. In the command syntax, lower-case
characters indicate parameters that you must supply.
All commands must contain the cmd, tid, and ctag fields.
You may omit trailing commas in the parameters field.
Terminate command lines with a terminating semicolon (;) and an end-of-line
designator (
<cr><lf> or <cr lf>). The SSU-2000e executes the command
when it receives the terminating semicolon in the command entry.
^ is a blank that must appear in a command or response
: is a block separator character
:: indicates a null field for a block
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 25
Chapter 2 TL1 Reference
TL1 Command and Response Conventions
; indicates the end of the message
<cr> and <lf> or <cr lf> indicate the ASCII carriage return (CR) and line feed
(LF) codes used as a line terminator and may be used separately or combined
The ASCII cancel code character (hex 18) can be used to cancel a partially sent
command and clear the input buffer.
Input Command Message Conventions
Command messages entered and sent by the user determine the action that the
SSU-2000e will take. Command messages are input messages, and are always
followed by an acknowledgment or output response message.
The format for the input command message is:
cmd:tid:[aid]:ctag[:[gb]:<other>;<cr lf>
where:
cmd (Command) is a descriptive string of letters that represents the input
command. The command string consists of a standard TL1 command verb,
followed by one or two command modifiers. The modifiers identify the subject of
the command verb and each may be as many as five characters. If two modifiers
are used, they must be separated by dashes:
verb- mod1- mod2.
tid
(Target Identifier) represents the name assigned to the SSU-2000e. The
assigned name must be either null or match the name assigned to the
SSU-2000e. If the tid is not null, it may must begin with a letter and may contain
up to 20 alphanumeric characters see
Note: The SSU-2000e does not generate a resp on se for entr ies
without a valid tid.
aid (Access Identifier) is an optional field that represents the shelf, module, and
Set Name, on page 140.
port within the SSU-2000e to which the command is addressed or to which the
response applies. The aid must be null (::, indicating ALL or not used), ALL
(indicating all modules and ports related to the command type), or the aid
assigned to an entity in the SSU-2000e.
Follow these conventions for entering the aid field:
SxAy-z
orALL
where:
Splaceholder to indicate Shelf number
x SSU-2000e main (1) or expansion shelf (2-5) number
A placeholder to separate the shelf number form the slot position
y slot position (1-16)
z port number (1-20)
ALL all modules or ports to which the command applies
26 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
TL1 Command and Response Conventions
Chapter 2 TL1 Reference
Specify multiple aids using the ampersand (&)
Use a single ampersand (&) to indicate aid1 and aid2
Use a double ampersand (&&) to indicate a range from aid1 to aid2
The y or z part of the aid also uses the ampersand (&)
ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code
that is received with the command and returned in the response, for correlation of
message and response within the operating system. The ctag can be any
combination of six alpha-numeric characters randomly generated by the user.
gb (General Block) is an field that is not used by the SSU-2000e but that you
must indicate by a double colon, that is, by preceding any parameters following
the ctag field with double colons (::).
other is a field that is used for commands that require other information. The
format for this field is specified in the individual command descriptions.
Each command received by the SSU-2000e with a valid tid generates a response
when the terminating semicolon is received, followed by an output response
message or the output response.
The SSU-2000e sends the in-process acknowledgment (IP) only if it is unable to
respond to the command within two seconds. The requested response is then sent
in full when the SSU-2000e data is available.
The in-process acknowledgment response always begins with a carriage return and
two line feed characters, and ends with the header line containing the source
identifier (sid), defined below, and the date^time stamp.
sid (Source Identifier) is the returned ID, and is the same as the tid in the input
command message to which the IP acknowledgment is responding.
date is the current year, month, and day in the SSU-2000e in the format:
YY-MM-DD.
time is the current hours, minutes, and seconds timestamp information in the
SSU-2000e in the 24-hour format: HH:MM:SS.
IP is the in-process response message that the SSU-2000e sends in response to
a command only if the SSU is unable to respond to the command within two
seconds. The SSU sends the requested response in full when the data is
available.
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 27
Chapter 2 TL1 Reference
TL1 Command and Response Conventions
ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code
that is received with the command and returned in the response, for correlation of
message and response within the operating system.
The IP acknowledgment response always terminates with the less-than
character (<). The semicolon appears after the requested output response
message is sent.
Output Response Message Conventions
The output response indicates whether the SSU-2000e complied with (COMPLD) or
denied (DENY) the input command.
COMPLD Output Response Message Conventions – If the message is received
correctly and can be processed by the SSU-2000e within two seconds, the
complied message is sent with data that was requested in the input command
message. The requested data is included in the response message lines and is
always enclosed in quotation marks.
The format for a complied (COMPLD) output response message is:
sid (Source Identifier) is the returned ID, and is the same as the tid in the input
command message to which the IP acknowledgment is responding
date is the current year, month, and day in the SSU-2000e in the format:
YY-MM-DD
time is the current hours, minutes, and seconds timestamp information in the
SSU-2000e in the 24-hour format: HH:MM:SS
ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code
that is received with the command and returned in the response, for correlation of
message and response within the operating system
COMPLD is the complied message
"response message"is the response message. The response message line for
complied messages always begins with 3 spaces (^^^) followed by the response
message enclosed in quotation marks, and terminated by <cr lf>. Multiple lines of
response messages are allowed. Each command response is terminated by a
semicolon following the last <cr lf>.
DENY Output Response Message Conventions – The DENY response contains
a four-character error code (ercd) that describes the reason for the denied
response. For example, the error code ICNV indicates Input Command Not Valid.
The error codes are listed in Table 2-1.
28 SSU-2000e Technical Reference12713140-003-2 Revision E.01 – January 2007
TL1 Command and Response Conventions
Chapter 2 TL1 Reference
The SSU-2000e sends the DENY response when:
the cmd is not valid
the aid is not valid
the ctag is not valid, indicated by a response containing the ctag set to a single
zero character (0)
the unit is unable to comply with the request for the reason indicated by the ercd
The format for a denied (DENY) output response message is:
sid (Source Identifier) is the returned ID, and is the same as the tid in the input
command message
date is the current year, month, and day in the SSU-2000e in the format:
YY-MM-DD.
time is the current hours, minutes, and seconds timestamp information in the
SSU-2000e in the 24-hour format: HH:MM:SS
ctag (Correlation Tag) field is a six-digit alpha-numeric message identifier code
that is received with the command and returned in the response, for correlation of
message and response within the operating system
DENY is the deny message
ercd (Error Code) is a four-character error code that explains the reason for the
deny, and is one of the following defined codes (other error codes may be
defined and used, if required).
Table 2-1. Denied Response Error Codes
Error CodeDefinition
ICNVCommand Not Valid
IIACInvalid aid Code
IICTInvalid ctag
IITAInvalid Target Identifier
IPEXExtra Parameter
IPMSParame ter Missing
IPNVParameter Not Valid
SDNRData Not Ready
12713140-003-2 Revision E.01 – January 2007SSU-2000e Technical Reference 29
Chapter 2 TL1 Reference
TL1 Command and Response Conventions
Autonomous Report Conventions
The SSU-2000e sends autonomous reports in response to a detected alarm
condition or status change. You can select one of two formats for autonomous
messages: GR-831 or GR-833. Use the RTRV-PRMTR-TL1FORMAT command to
select which format is generated. These reports are similar to the RTRV-ALARM
command responses, but contain an alarm code rather than the complied line.
The GR-831 format for an autonomous alarm report is:
sid is the source ID, and is the assigned name of the unit sending the message
date is the current date in the format: YY-MM-DD
time is the current timestamp information in the 24-hour format HH:MM:SS
alrmcde (Alarm Code) indicates the severity level of the reported alarm or event.
The alarm code is one of these four two-character codes:
*C= critical alarm
** = major alarm
*^ = minor alarm
A^= non-alarm event
atag (Alarm Correlation Tag) is a six-digit correlation tag that is incremented
each time a message is sent
REPT (Report) indicates an autonomous report
AIDTYPE indicates the cause for the report, such as input signal fault (INP or T1)
or module hardware faults (EQPT)
"response message" is the response message. The format for the response