Page 1 TimeHub 5500 TL1 Reference Guide Issue 7 – January, 2005 Part Number 097-55501-02...
Page 2 2300 Orchard Parkway San Jose, CA 95131-1017 U.S.A. http://www.symmetricom.com Copyright © 1999–2005 Symmetricom, Inc. All rights reserved. Printed in U.S.A. All product names, service marks, trademarks, and registered trademarks used in this document are the property of their respective owners.
Page 3: Table Of Contents
Activate Software Download Mode ......32 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 4 Retrieve User Security ........78 TimeHub 5500 TL1 Reference Guide...
Page 5 IPGATEX (IP Address of Default Gateway–Auxiliary Memory)..114 IPLM1 (IP Address of Primary Local Manager–Working Memory) ..114 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 6 TRAFFIC (Traffic Data Pattern) .......143 TimeHub 5500 TL1 Reference Guide...
Page 7 Error Responses ..........207 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 8 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 9 TimeHub 5500 Events ........
Page 10 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 11: How To Use 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 Guide 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 12: Purpose Of This Guide
Purpose of This Guide Purpose of This Guide The TimeHub 5500 TL1 Reference Guide provides information on TL1 command conventions and parameters. It covers command types, formats, and responses. It provides an explanation of the command function and a description of each command parameter, value, and variable when applicable.
Page 13: Conventions Used In This Guide
You must enter commands for case-sensitive operating systems exactly as shown. lowest A word or term being emphasized. Symmetricom does not A word or term given special emphasis. recommend... 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 14: Warnings, Cautions, Recommendations, And Notes
Note: All notes use this symbol. Notes contain installation, operation, or maintenance procedures, practices, conditions, or statements, that alert you to important information, which may make your task easier or increase your understanding. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 15: Related Documents And Information
Where to Find Answers to Product and Document Questions For additional information about the products described in this guide, please contact 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 Guide This revision of this guide has a new format and typography to make the text easier to read.
Page 16 Added a note at each applicable command description for the following events indicating the default severity level is different for software version R4315C: INPAIS INPLOS INPOOF INPULL MEASRP INEXPH INMEAS INDISQ SNDRIFT MEASRNG TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 17: Chapter 1 Introduction
Chapter 1 Introduction This chapter provides general information about the Transaction Language 1 (TL1) control language used on the TimeHub 5500. It covers the various types of commands and includes the procedure for turning on the security function to limit system access.
Page 18: Command Types
TL1 provides a standard man-machine language as defined in Bellcore document TR-NWT-000831, Issue 3, Revision 1, December 1993. This section provides an overview of the TL1 commands used to control the TimeHub 5500. For detailed information on using TL1 commands, refer to...
Page 19: Provisioning
Table 1-3 System Administration Commands Factory Set Command Syntax Access Level Edit Date ED-DAT Admin Initialize Event Log INIT-LOG Admin Operate Alarm Cutoff OPR-ACO-ALL Admin Remove Equipment RMV-EQPT Security 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 20: Performance Monitoring
User Note: Firmware version 4328D also supports the syntax RTRV-ALM-ALL Retrieve Attribute RTRV-ATTR[-TSG] User Retrieve Condition RTRV-COND[-TSG] User Retrieve Performance RTRV-PM[-TSG] User Monitoring Information Retrieve Threshold RTRV-TH[-TSG] User Information TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 21: Network And Auxiliary Memory Commands
Mode Cancel Bulk Transfer Mode CANC-BTT Security Change to Normal Mode CANC-SWDL Security Copy Software from Main to COPY-SFWR Security Backup Memory Erase Firmware from Main DLT-SFWR Security Memory 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 22: Automatic Messages And Alarm Management
Automatic Messages and Alarm Management Automatic messages are classified as alarmed or non-alarmed events (conditions detected by the TimeHub 5500) and are automatically displayed and recorded in the system logs. Events are configured by using the provisioning commands to set thresholds, values, and conditions (see Provisioning, on page 19).
Page 23: User Security Levels
Users can only edit their password and retrieve information unless a command security level is set to allow access. Administration Users are allowed to change configuration. Security Users are allowed to modify the security database or download new firmware. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 24: Command Security Levels
None. User Commands that only allow retrieving information. Administration Commands that allow changing the configuration. Security Commands that modify the security database or download new firmware. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 25: Chapter 2 Commands
It also provides an example of each command and the response. For information on keywords, see Chapter 3, Keywords. In This Chapter Command Format Command Structure Parameters Responses Command Description 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 26: Command Format
Figure 2-1 Command Format and Description Command Structure The following examples provide an illustration of command structure and syntax. Format Example: RTRV-SYNC[-TSG]:[<tid>]:<aid>:<ctag>:::PARAMETER=<keyword>; Command Example: RTRV-SYNC::S2-OUTA-3:SC1:::PARAMETER=SQUELCH; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 27 < > encloses a TL1 named variable \" \" encloses a description of a condition indicates the line in a response can be repeated as required 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 28: Parameters
Chapter 3, Keywords. <montype> Monitor type Performance monitoring data type. Refer to Chapter 4, Performance Monitoring. <monval> Monitor value Performance monitoring data value. Refer to Chapter 4, Performance Monitoring. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 29 OPCDPMM event occurs and when it ends: SNDKCAQO05050501 03-03-13 11:41:01 ** 0242 REPT ALM EQPT "S1-OUT1A:MJ,OPCDPMM,SA,03-13,11-41-02:\"Output Card Protection Mismatch\"" SNDKCAQO05050501 03-03-13 11:41:18 0287 REPT ALM EQPT "S1-OUT1A:CL,OPCDPMM,SA,03-13,11-41-18:\"ENDED Output card Protection Mismatch\"" 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 30: Responses
Normal response Error response A normal or error response is returned when the TimeHub 5500 receives a command. These responses include the source identifier (<sid>), the date, the time, an M to indicate that it is a response to a command, and the correlation tag (<ctag>) that was entered with the command.
Page 31: Acknowledgement
^^^<sid>^<date>^<time> M^^<ctag>^DENY ^^^<errcde> ^^^/* <error message> */ DENY indicates a command was denied due to an error. The <errcde> parameter indicates the error type or cause of the error. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 32: Command Description
This command places a Management card or Clock card in the firmware download mode prior to a firmware download. The command format is: ACT-SWDL:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Management card CLK1 Clock card 1 CLK2 Clock card 2 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 33: Activate User
1:30:04 a.m. on December 22, 2004 and after that there were two unsuccessful log-on attempts. Cancel Bulk Transfer Mode This command cancels the bulk transfer mode. It signifies that all data segments were sent. The command format is: CANC-BTT:[<tid>]:<aid>:<ctag>; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 34: Cancel Port
SC005 COMPLD Cancel Port This command terminates a current session on the TimeHub 5500. You can use it to remotely cancel a session on the local port. If the port of the user is specified, the user is logged off. The command format is: CANC-CID-SECU:[<tid>]:<aid>:<ctag>;...
Page 35: Cancel User Security
The command format is: CANC-USER-SECU:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Up to ten case-insensitive Assigned user name alphanumeric characters Command Example: CANC-USER-SECU::MARTHA:SC001; The command in this example terminates MARTHA’s session. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 36: Change To Normal Mode
This command copies the current firmware from the main memory to the backup memory (or vice versa) in a or Clock card and requests the card to Management card validate the checksum of the memory transfer. The command format is: COPY-SFWR:[<tid>]:<aid>:<ctag>; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 37: Delete Security
Delete Security This command deletes all information in the security database. It is typically used after the initial installation of a TimeHub 5500. All existing user names and passwords are deleted. Note: This command can only be executed if the switch S1 on the Management card is in the OFF position (set to no password required).
Page 38: Delete User Security
NONE before logging out. In an emergency, a user can set switch S1 on the Management card to the OFF position, then change the ACT-USER command’s access level back to NONE. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 39: Edit Date
Time in hour-minute-second Command Example: ED-DAT:::SC001::04-8-27,10-3-29; The command in this example sets the date to August 27, 2004 and the time to 10:03:29 a.m. Response Example: SYMMBITS 04-08-27 10:03:29 SC001 COMPLD 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 40: Edit Equipment
A – D. For expansion shelf, range is A – H. c = 1, 2 Port group. PG1 indicates ports 1 – 20. PG2 indicates ports 21 – 40. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 41 IP Address of Primary Element Manager–Auxiliary Memory IPEM2 IP Address of Alternate Element Manager–Working Memory IPEM2X IP Address of Alternate Element Manager–Auxiliary Memory IPGATE IP Address of Default Gateway–Working Memory 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 42 Pull-In Range for Secondary Oscillator PORTAO Event Reporting Port Number–Working Memory PORTAOX Event Reporting Port Number–Auxiliary Memory PORTCDMS Command/Response Reporting Port Number–Working Memory PORTCDMSX Command/Response Reporting Port Number–Auxiliary Memory REVERT Revertive Mode TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 43 = 1 Shelf number b = A, B, C, or D Output Driver card letter <event> CLKGONE — Fail alarm CLKFAIL CLKWARM EXCD24HR ECCRDMM EPROTMM NVERROR OPCDFL OPCDNA OPCDNP SNFAIL 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 44 MEASRNG Minor alarm MEASRP SECACTV SNDRIFT SNSCSUS UNKALM XFER CLKACTV Event CLKCDIN CLKDISA CLKNCOM IMCRST INDISQ INPSSM NETCLOS OPCDIN SNHAVL SNOPER SNSAVL SNSSM SNTRCK <value> Chapter 3, Keywords. ED-EQPT[-TSG]:[<tid>]:<aid>:<ctag>:::<measurement>=<value>; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 45: Edit Password
Note: For Management cards that contain firmware version 4328D, no special characters are required in the password, but they can be used if desired. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 46: Edit Port Security
2. Log on (if necessary) to the local port. 3. Use the ED-CID-SECU command to enable the local port. 4. Set switch S2 on the Management card back to its normal position. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 47: Edit Sync
(9-input clocks only) a = 10 – 11 (remote shelf) Sa-OUTb-c a = 0 – 4 Shelf number (0 is main shelf). This prefix is optional for main shelf. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 48 (9-input clocks only) a = 10 – 11 (remote shelf) Sa-OUTb-c a = 0 – 4 Shelf number (0 is main shelf). This prefix is optional for main shelf. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 49: Edit User Security
Automatic Message (RPT-Y) and displays the measurement every 15 minutes (PM-Y). Edit User Security This command changes the user name, access level, or password. The command format is: ED-USER-SECU:[<tid>]:<aid>:<ctag>::<newuid>,<newpid>,,<uap>; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 50: Enter User Security
Note: If the new user name, password, or access level is omitted, it is left unchanged. Enter User Security This command sets up a new user. Up to ten users can be entered. The command format is: ENT-USER-SECU:[<tid>]:<aid>:<ctag>::<pid>,,<uap>; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 51: Erase Firmware From Main Memory
Erases backup memory on the Management card. IMC-MAIN Erases main memory on the Management card. This command is denied if a copy of a valid firmware is not in the backup memory. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 52: Inhibit User Security
Note: This command normally clears the event logs on both Clock cards. However, it is possible to specify a particular Clock card for diagnostic purposes in which case the other Clock card is not affected. INIT-LOG:[<tid>]:<aid>:<ctag>::EVT; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 53: Initialize Register
The command in this example clears and restarts all performance monitoring measurements on input channel 1. Operate Alarm Cutoff This command deactivates (silences) the audible office alarm. The command format OPR-ACO-ALL:[<tid>]::<ctag>; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 54: Reinstate User
Clock card 2 if it is the active card or inactive card. Alarms from other cards are not reported. Firmware version 4328D also supports the following command syntax: RTRV-ALM-ALL:::<ctag>::,,,,,; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 55: Retrieve All Network Equipment Types
"S0-CLK-3:MN,INDISQ,NSA,,:\"Input disqualified\"" "S0-CLK-4:MN,INDISQ,NSA,,:\"Input disqualified\"" > SYMMBITS 98-01-02 16:30:45 COMPLD "S0-CLK2:MN,SNFAIL,SA,,:\Sync failure\"" Retrieve All Network Equipment Types This command displays inventory information about the TimeHub 5500. The command format is: RTRV-NETYPE-ALL:::<ctag>; Response Example: >IP SC1 < SYMMBITS 00-00-00 00:00:00 SC1 RTRV "TSG:Symmetricom,5500,TSG"...
Page 56: Retrieve Attribute
"S1-OUT6C:,090-55581-01-B,R0042A,E25345,D0TPJN0AAA, 267799,DS1,CC" The information displayed in the response message in this example includes: Company (Symmetricom), model number (5500), equipment type (TSG) Shelf number (S1) Management card model number (090-55542-01), firmware revision (R0039A), serial number (E26658), CLEI code (DOTPN00AAA), and ECI code (267825)
Page 57 <event> MEASRNG — Minor alarm MEASRP RCKALM1 Major alarm RCKALM2 RCKALM3 Minor alarm RCKALM4 RCKALM5 Major alarm RCKALM6 RCKALM7 Minor alarm RCKALM8 RCKALM9 RCKALM10 SECACTV SNSCSUS SNDRIFT UNKALM XFER 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 58: Retrieve Automatic Messages
These messages can be selectively displayed by number or type, or by both number and type. The command format is: RTRV-AO:[<tid>]::<ctag>:::<keyword>; Note: For detailed descriptions of keywords, see Chapter 3, Keywords. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 59: Retrieve Command Security
The command in this example displays all non-alarmed messages between 4 and Retrieve Command Security This command displays the access level of a command. The command format is: RTRV-CMD-SECU::<aid>:<ctag>; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 60: Retrieve Condition
NONE Response Example: SYMMBITS 04-06-15 12:30:00 SC001 COMPLD "SET-SID:ADMIN" Retrieve Condition This command displays information about Clock cards, input signals, and Output cards. The command format is: RTRV-COND[-TSG]::[<aid>]:<ctag>[::<spec block>]; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 61 SC009 COMPLD "TSG:NR,CFGCHD,NSA,06-18,11-32-44,1,,\ "Configuration changed\"" Command Example: RTRV-COND:::SC0011::LSTCFGC; The command in this example displays the Latest Configuration Change condition. Response Example: SYMMBITS 04-06-19 05:57:33 SC11 COMPLD "TSG:NR,LSTCFGC,NSA,06-19,05-57-25,2055,,\ "Latest Configuration Change\"" 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 62: Retrieve Equipment
Management card. This parameter is optional. Sa-OUTb a = 1 Shelf number. This parameter is not optional. b = A, B, C, or D Output driver card letter. This parameter is not optional. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 63 Holdover and Freerun Quality Level for Secondary Oscillator HLDACT Holdover Action INACTTIME Inactivity Time-Out INSRVC In Service IPEM1 IP Address of Primary Element Manager–Working Memory IPEM1X IP Address of Alternate Element Manager–Working Memory 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 64 MAINCLK Retrieve MAINCLK setting (read only) MANCHAN Manual Channel OMANSSM Output Manual SSM OQLEVEL Output Quality Level OUTESF Output ESF PIRANGE Pull-In Range PIRANGESEC Pull-In Range for Secondary Oscillator TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 65 Management card. This parameter is optional. Sa-OUTb a = 1 Shelf number. This parameter is not optional. b = A, B, C, or D Output Driver card letter. This parameter is not optional. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 66 EPROTMM NVERROR OPCDFL OPCDNA OPCDNP SNFAIL <event> CLKOFFL Major alarm SNFREE SNHOLD SNPWRA (See Power Supply Events, on page 205) SNPWRB (See Power Supply Events, on page 205) UNKALM TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 67 Minor alarm RCKALM8 RCKALM9 RCKALM10 SECACTV SNDRIFT SNSCSUS UNKALM XFER <event> CLKACTV Event CLKCDIN CLKDISA CLKNCOM IMCRST INDISQ INPSSM NETCLOS OPCDIN SNHAVL SNOPER SNSAVL SNSSM SNTRCK <value> Chapter 3, Keywords 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 68 Command Examples: RTRV-EQPT::CLK:SC1:::PARAMETER=SYNCMDE; The command in this example displays the selection algorithm setting. RTRV-EQPT::CLK:SC1:::PARAMETER=SYNCMDE&MANCHAN; The command in this example displays the selection algorithm setting and the selected manual channel number. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 69: Retrieve Equipment Type
This command displays basic information about the TimeHub 5500. The command format is: RTRV-NETYPE:::<ctag>; Command Example: RTRV-NETYPE:::SC1; The command in this example displays basic information about the TimeHub 5500. Response Format: <sid> <date> <time> <ctag> COMPLD "<company>,<model number>,<equipment type>, <management card firmware revision>"...
Page 70: Retrieve Log
1000 events consisting of 100 response blocks of ten events each. Once started, the retrieval cannot be aborted. Use EVTTOP and EVTCONT to retrieve the event log. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 71: Retrieve Performance Monitoring Information
= 1S, 1M, 15M, 30M, TIE monitored type, where a is the 1H, 2H, 8H, 24H observation time interval in seconds (S), minutes (M), or hours (H) Command Example: RTRV-PM::CLK-4:SC1::MRTIE; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 72: Retrieve Port Security
This command displays the state of a communication port. The command format is: RTRV-CID-SECU:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> REMOTE Communication port LOCAL Command Example: RTRV-CID-SECU::LOCAL:SC1; The command in this example displays the state of the local port. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 73: Retrieve Status
This command displays the names of users logged on and users inhibited from logging on. The command format is: RTRV-STATUS:[<tid>]::<ctag>; Command Example: RTRV-STATUS:::SC1; Response Example: SYMMBITS 04-12-02 16:30:45 RTRV ":LOCAL&REMOTE,FRED&MARTHA,RS&GH&KL" 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 74: Retrieve Status Of Multiple Remote Sessions
This example shows that session REMOTE02 has a user logged on named TEST and the connection is from IP 192.168.3.75. An additional connection, REMOTE01 is established without a logon from IP 192.168.5.108. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 75: Retrieve Sync
PRC 5MHz Signal PRIORITY Input Priority QCUTOFF Quality Cutoff SQUELCH Squelch Output SSMENB Read SSM Bits SSMPRI SSM Priority Grouping TCONST Time Constant TCONSTSEC Time Constant for Secondary Oscillator 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 76: Retrieve Threshold Information
The command in this example displays the properties for a 1 second TDEV measurement on input channel 3. Retrieve Threshold Information This command displays the threshold of a measurement for a particular input channel. The command format is: RTRV-TH[-TSG]::<aid>:<ctag>::<montype>; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 77: Retrieve User
This command displays the currently logged in user’s access level. The command format is: RTRV-USER:::<ctag>; Command Example: RTRV-USER:::SC1; The command in this example displays the currently logged in user’s access level. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 78: Retrieve User Security
"FRED:,SECURITY" The above response indicates that FRED has the highest access level (SECURITY). Set Attribute This command sets the alarm level that an event generates. The command format SET-ATTR[-TSG]:::<ctag>::<value>,<event>; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 79 A Connector card exists that is different from the one specified through the TL1 command. Specified outputs have been disabled EPROTMM There are less than two Output Driver cards in the indicated output pair 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 80 SNFREE The Clock card is generating a reference output, but there are no qualified inputs and holdover mode is not available TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 81: Set Synchronization
Note: The oven should actually be warmed up before using this command. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 82: Set System Identifier
The command in this example sets the system identification code to SYMMBITS2. Note: If a target identifier (<tid>) is included in a command, it is compared against the system identifier (SID) of the TimeHub 5500 and the command is only executed if these match. If they do not match, the command is rejected.
Page 83: Set Threshold
This command forces the system to switch the inactive Clock card to the active state. The effect is the same as pressing the Force Active pushbutton on the inactive Clock card. The command format is: SW-DX-EQPT:[<tid>]:CLK:<ctag>; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 84: Verify Firmware Integrity
"CLK1:CLKACTV,SC,02-22,15-52-31:\"CLK Active\"" Verify Firmware Integrity This command requests a Management card or Clock card to validate the checksum of the firmware in the main memory. The command format is: VRF-SFWR:[<tid>]:<aid>:<ctag>; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 85 Validates the checksum of the firmware in the backup memory on Clock card 2. Command Example: VRF-SFWR:SYMMBITS:CLK1-MAIN:SC001;IP SC001 <IP SC001 <IP SC001 <IP SC001 <IP SC001 < Response Example: SYMMBITS 04-06-15 09:19:11 SC001 COMPLD 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 86 Commands Command Description TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 87: Chapter 3 Keywords
This chapter describes the keywords used with provisioning commands. It provides a list of keywords along with descriptions, default values, accepted values, and example commands. In This Chapter Overview Keyword Description 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 88: Overview
Message (SSM) Value) DSCTIME 1 - 15 ED-EQPT::CLK:SC10::: (Discontinuity Time) DSCTIME=10; ECLKEXP Y / N ED-EQPT::S2-CLK2:SV01::: ECLKEXP=N; ECONCRD DONT-CARE DONT-CARE / ED-EQPT::OUTD-PG1:SC11::: (Output Connector Card DSC1 / CC ECONCRD=DS1; Type) TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 89 (IP Address of Alternate PARAMETER=IPEM2; Element Manager–Working Memory) IPEM2X 0.0.0.1 0.0.0.0 - ED-EQPT::IMC:SC25::: (IP Address of Alternate 223.255.255. IPEM2X=123.123.12.122 Element Manager–Auxiliary Memory) IPGATE 0.0.0.1 RTRV-EQPT::IMC:SC26::: (IP Address of Default PARAMETER=IPGATE; Gateway–Working Memory) 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 90 9600 1200 / 2400 / ED-EQPT::IMC:SC37::: (Local Baud Rate) 9600 / 19200 LCLBAUD=19200; LCLECHO Y / N ED-EQPT::IMC:SC38::: (Local Echo) LCLECHO=N; MAINCLK Y / N RTRV-EQPT::CLK:SC38::: (Main Clock) MAINCLK=Y; TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 91 7588 RTRV-EQPT::IMC:SC52::: (Command/Response PARAMETER=PORTCMDS; Reporting Port Number–Working Memory) PORTCMDSX 7588 5001 - 20000 ED-EQPT::IMC:SC53::: (Command/Response PORTCMDSX=5002; Reporting Port Number–Auxiliary Memory) PRC5MHZ Y / N ED-SYNC::CLK-0:SC54::: (PRC 5MHz Signal) PRC5MHZ=Y; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 92 SQUELCH=N; SSMENB Y / N ED-SYNC::CLK-1:SC64::: (Read SSM Bits) SSMENB=Y; SSMPRI (Channel 0 - 9 ED-SYNC::CLK-3:SC65::: (SSM Priority Grouping Number) + 1 SSMPRI=4; removed as of clock firmware 4236B) TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 93: Keyword Description
SSM quality level (see the chart in QLEVEL (Quality Level), on page for mapping of SSM quality level to associated description). The keyword format is: CCALIGN=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 94: Ais (Output Ais)
Following a firmware download to the Management card, AOMERGE can be reset to N. If one port had been used to carry both automatic events and commands, the AOMERGE setting should be checked and changed to Y if necessary. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 95: Autopm (Auto-Upload Pm)
B8ZS (Bipolar 8-Zero Substitution) This keyword enables bipolar 8-zero substitution (B8ZS) coding on an input channel. This keyword does not affect the PRC (Primary Reference Clock) input. The keyword format is: B8ZS=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 96: Bridged (Bridged Input)
5 through 8, which are used only for DS1 performance monitoring, are not configurable but accept only bridged inputs. Command Examples: Enable BRIDGED mode for input 3: ED-SYNC::CLK-3:SV13:::BRIDGED=Y; The response is: SYMMBITS 03-03-24 09:10:50 SV13 COMPLD TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 97: Cbcomp (Cable Compensation)
0 to 6000 feet Cable compensation in amount of feet using conversion of 1 foot = 1.63 nanoseconds Note: This feature is available in firmware versions 4209C and later. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 98: Ccalign (Composite Clock Alignment)
CC IN 1. If the input is not valid, the shelf uses its normal reference inputs for timing. Master shelf operates normally, using 5/10 MHz and DS1 inputs as timing references. If a CC input is connected, it is ignored. TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 99: Ccdel (Cc Delay Value)
Delay in nanoseconds Note: This keyword applies only if the individual output port delay is enabled (CCDENB=Y) and if the Output Connector card is a CC type. Command Example: RTRV-EQPT::OUTA-PG1:SC050:::PARAMETER=CCDEL; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 100: Ccdenb (Cc Delay)
Y. Do not attempt port alarm clear. When the CLRPTALL value is queried, it is nearly always set to N since the TimeHub 5500 automatically sets the value to N after a port alarm clear attempt.
Page 101: Currssm (Current Ssm Value)
SSMENB=Y and ESF=Y. If SSM was disabled (SSMENB=N), the assumed SSM (QLEVEL) is retrieved instead. The keyword format is: PARAMETER=CURRSSM Command Example: RTRV-SYNC::CLK-2:SC321:::PARAMETER=CURRSSM; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 101...
Page 102: Dsctime (Discontinuity Time)
If communication with this card is not taking place, an EXCLKGONE event is generated (refer to the following command example). Does not allow communication with the identified Expansion Controller card. 102 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 103 If there is no communication, the following condition is present: "S2-CLK2:MJ,EXCLKGONE,NSA,07-10,13-05-52:\"Expansion CLK card missing\"" Setting ECLKEXP to N causes this condition to end: ED-EQPT::S2-CLK2:SV01:::ECLKEXP=N; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 103...
Page 104: Econcrd (Output Connector Card Type)
CC card type DS1 card type Note: Outputs are not disabled when the ECCRDMM event is generated. Command Example: RTRV-EQPT::OUTA-PG1:SC341:::PARAMETER=ECONCRD; Response Example: SYMMBITS 04-06-18 11:54:40 SC341 COMPLD "OUTA-PG1::ECONCRD = DONT-CARE" 104 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 105: Enable (Input Enable)
This keyword sets the requirement for Output card protection. If the requirement is not met, an event (EPROTMM) is generated stating an output protection mismatch, but the outputs are enabled if possible. The keyword format is: EPROT=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 105...
Page 106: Esf (Extended Super Framing)
Clock card remains in freerun indefinitely. During freerun, the Clock card uses its internal oscillator as the timing source for output generation. The keyword format is: FREEACT=<value> 106 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 107: Hfqlevl (Holdover And Freerun Quality Level)
Synchronized – Traceability Unknown (STU) Stratum 2 Traceable (ST2) Transit Node Clock Traceable (TNC) Stratum 3E Traceable (ST3E) Stratum 3 Traceable (ST3) SONET Minimum Clock (SMC) Do not use for synchronization (DUS) 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 107...
Page 108: Hfqlevlsec (Holdover And Freerun Quality Level For Secondary Oscillator)
Stratum 2 Traceable (ST2) Transit Node Clock Traceable (TNC) Stratum 3E Traceable (ST3E) Stratum 3 Traceable (ST3) SONET Minimum Clock (SMC) Do not use for synchronization (DUS) Command Example: RTRV-EQPT::CLK:SC581:::PARAMETER=HFQLEVLSEC; 108 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 109: Hldact (Holdover Action)
0 to 10000 and each setting has a time value of 0.1 seconds (100 ms). For example, a setting of 100 specifies that after 10 seconds without an automatic message the connection to the TimeHub 5500 PORTAO is closed. The connection is re-established when another automatic message occurs.
Page 110: Insrvc (In Service)
0 to 255 Working memory primary element manager IP address 0 to 255 0 to 255 0 to 255 Note: You cannot directly modify network parameters in working memory. 110 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 111: Ipem1X (Ip Address Of Primary Element Manager-Auxiliary Memory)
Auxiliary memory primary element manager IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT:::SC681:::PARAMETER=IPEM1X; Response Example: SYMMBITS 04-06-18 11:46:22 SC681 COMPLD "IMC::IPEM1X = 123.123.12.123" 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 111...
Page 112: Ipem2 (Ip Address Of Alternate Element Manager-Working Memory)
Auxiliary memory contains a backup copy of network parameters in working memory (working memory controls the actual operation of the network). The keyword format is: IPEM2X=<a.b.c.d> 112 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 113: Ipgate (Ip Address Of Default Gateway-Working Memory)
Working memory default gateway IP address 0 to 255 0 to 255 0 to 255 Note: You cannot directly modify network parameters in working memory. Command Example: RTRV-EQPT::IMC:SC708:::PARAMETER=IPGATE; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 113...
Page 114: Ipgatex (Ip Address Of Default Gateway-Auxiliary Memory)
IP address sets the address of a local PC connected to the LAN port of the shelf. Working memory controls the actual operation of the network. The keyword format is: IPLM1=<a.b.c.d> 114 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 115: Iplm1X (Ip Address Of Primary Local Manager-Auxiliary Memory)
The keyword format is: IPLM1X=<a.b.c.d> Parameter Value Description 0 to 255 Auxiliary memory primary local manager IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT-TSG:::SC739:::PARAMETER=IPLM1X; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 115...
Page 116: Iplm2 (Ip Address Of Alternate Local Manager-Working Memory)
PC connected to the LAN port of the shelf.) Auxiliary memory contains a backup copy of network parameters in working memory (working memory controls the actual operation of the network). The keyword format is: IPLM2X=<a.b.c.d> 116 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 117: Ipne (Ip Address Of Network Element -Working Memory)
SC753 COMPLD "IMC::IPLM2X = 123.123.12.123" IPNE (IP Address of Network Element –Working Memory) This keyword sets the network element (TimeHub 5500) IP address in working memory. Working memory controls the actual operation of the network. The keyword format is: IPNE=<a.b.c.d>...
Page 118: Ipnex (Ip Address Of Network Element -Auxiliary Memory)
"IMC::IPNE = 192.207.10.205" IPNEX (IP Address of Network Element –Auxiliary Memory) This keyword sets the network element (TimeHub 5500) IP address in auxiliary memory. Auxiliary memory contains a backup copy of network parameters in working memory (working memory controls the actual operation of the network).
Page 119: Ipsubnetx (Subnetwork Mask-Auxiliary Memory)
The keyword format is: IPSUBNETX=<a.b.c.d> Parameter Value Description 0 to 255 Auxiliary memory subnetwork mask 0 to 255 0 to 255 0 or 128 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 119...
Page 120: Lclao (Local Automatic Output)
"IMC::LCLAO = LOGIN" LCLBAUD (Local Baud Rate) This keyword sets the baud rate on the local port. Note: The baud rate of the port in use cannot be set. 120 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 121: Lclecho (Local Echo)
MAINCLK (Main Clock) This keyword allows you to configured the shelf for Master or Remote use. This is a read-only keyword. The keyword format is: MAINCLK=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 121...
Page 122: Manchan (Manual Channel)
The performance measurements are restarted by any of the following conditions: Initial startup of the Clock card Input signal frequency outside the measurement range 122 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 123: Monitor (Input Event Monitoring)
To monitor an input signal that is not being used as a system reference, on the input to be monitored set the input keyword ENABLE to N, set MONITOR to Y, and connect the signal. The keyword format is: MONITOR=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 123...
Page 124: Omanssm (Output Manual Ssm)
Synchronized – Traceability Unknown (STU) Stratum 2 Traceable (ST2) Transit Node Clock Traceable (TNC) Stratum 3E Traceable (ST3E) Stratum 3 Traceable (ST3) SONET Minimum Clock (SMC) Do not use for synchronization (DUS) 124 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 125: Outesf (Output Esf)
Note: Because this is over the lifetime of the oscillator, this is not a substitute for frequency deviation. The keyword format is: PIRANGE=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 125...
Page 126: Pirangesec (Pull-In Range For Secondary Oscillator)
Description <value> 10 to 10000 Range in ppb (parts per billion = parts in 10 Command Example: RTRV-EQPT::CLK:SC1071:::PARAMETER=PIRANGESEC; Response Example: SYMMBITS 04-06-18 12:01:04 SC1071 COMPLD "CLK::PIRANGESEC = 105" 126 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 127: Portao (Event Reporting Port Number-Working Memory)
This keyword sets the port number for automatic event reporting in auxiliary memory. Auxiliary memory contains a backup copy of network parameters in working memory (working memory controls the actual operation of the network). 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 127...
Page 128: Portcmds (Command/Response Reporting Port Number-Working Memory)
Working memory controls the actual operation of the network. Note: If the Automatic Output Merge function is enabled (AOMERGE=Y) events, commands, and responses are carried on this port. The keyword format is: PORTCMDS=<value> 128 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 129: Portcmdsx (Command/Response Reporting Port Number-Auxiliary Memory)
(AOMERGE=Y) events, commands, and responses are carried on this port. The keyword format is: PORTCMDSX=<value> Parameter Value Description <value> 5001 to 20000 Auxiliary memory port number for command and response reporting 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 129...
Page 130: Prc5Mhz (Prc 5 Mhz Signal)
PRIORITY is also used to set the DS1 SSM input to use (CLK-1 or CLK-2) if both SSM inputs are enabled and providing valid SSM. The keyword format is: PRIORITY=<value> Parameter Value Description <value> 1 to 9 Input channel priority 130 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 131: Qcutoff (Quality Cutoff)
This assumed SSM level is used when SSM was disabled (SSMENB=N). The assumed SSM level is always used for the PRC input. The keyword format is: QLEVEL=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 131...
Page 132: Revert (Revertive Mode)
The keyword format is: REVERT=<value> Parameter Value Description <value> Highest priority qualified input is always chosen as the active input Current input remains active until it is disqualified 132 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 133: Rptall (Report All)
SCRAMBLE (Scramble Communication) This keyword allows an encryption for communications to and from the TimeHub 5500. It requires use of the TimePictra software and a network connection to the LAN port of the TimeHub 5500. The keyword format is: SCRAMBLE=<value>...
Page 134: Selmde (Selection Mode)
SELMDE (Selection Mode) This keyword controls if the selection of the active timing reference is performed automatically by the TimeHub 5500 or directly selected by the user. Note: This keyword is only available in Clock card firmware versions 4236B or later. Firmware version can be observed in RTRV-NETYPE-ALL response.
Page 135 Retrieve the SELMDE setting with the following command: RTRV-EQPT::CLK:SV49:::PARAMETER=SELMDE; Which generates a response similar to: SYMMBITS 02-12-13 10:50:37 SV49 COMPLD "CLK::SELMDE=FORCED" In this case the setting was FORCED. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 135...
Page 136: Sngclk (Single Clock)
Command Example (for setting single clock operation as normal operating mode): ED-EQPT::IMC:SC01:::SNGCLK=Y; Response Example: SYMMBITS 01-06-19 08:09:52 SC01 COMPLD Command Example (for retrieving SNGCLK setting): RTRV-EQPT::IMC:SC02:::PARAMETER=SNGCLK; Response Example: SYMMBITS 01-06-19 08:11:09 SC02 COMPLD "IMC::SNGCLK=Y" 136 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 137: Sprdchn (Spread Channels)
If using Symmetricom’s TimePictra version 1.0 management software, the SNGCLK setting can be configured by using the TimePictra Passthru feature. If using Symmetricom’s TimeScan THC version 1.0 management software, the SNGCLK setting can be configured by using the Communication form and entering the command manually.
Page 138: Squelch (Squelch Output)
(ESF=Y). This keyword has no effect on the PRC (Primary Reference Clock) input. The keyword format is: SSMENB=<value> Parameter Value Description <value> SSM is enabled SSM is disabled 138 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 139: Ssmpri (Ssm Priority Grouping)
SSMPRI. The keyword format is: SSMPRI=<value> Parameter Value Description <value> 0 to 8 SSM priority Command Example: RTRV-SYNC::CLK-0:SC1643:::PARAMETER=SSMPRI; Response Example: SYMMBITS 04-06-18 12:05:43 SC1643 COMPLD "CLK-0::SSMPRI = 8" 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 139...
Page 140: Syncmde (Sync Mode)
The input channel is chosen based on manual selection unless the given input is disqualified, in which case it goes into holdover. Command Example: RTRV-EQPT::CLK:SC1687:::PARAMETER=SYNCMDE; Response Example: SYMMBITS 04-06-18 12:06:01 SC1687 COMPLD "CLK::SYNCMDE = MANUAL" 140 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 141: Tconst (Time Constant)
If a value other than those listed below is given, the nearest one from the list below is substituted. For example, if a value of 191 was assigned, a value of 192 would be implemented. The keyword format is: TCONST=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 141...
Page 142: Tconstsec (Time Constant For Secondary Oscillator)
The keyword format is: TCONSTSEC=<value> Parameter Value Description <value> Time constant 1824 24864 142 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 143: Tidquiet (Tid Quiet)
This keyword specifies a data pattern to be carried in the traffic time slots of the Output Driver card. Note: 255 (all ones) is the preferred value because this causes the greatest number of clock pulses to occur. The keyword format is: TRAFFIC=<value> 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 143...
Page 144: Usesubrck (Use Sub Rack)
This is for consistency with other shelves in the network that contain expansion shelves, where it might be preferred to have all shelves providing a shelf prefix. The keyword format is: USESUBRCK=<value> 144 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 145 RTRV-NETYPE-ALL response on a TimeHub configured with only a master shelf: USESUBRCK set to N: RTRV-NETYPE-ALL:::SV48; produces the following response (note that there are no S0 identifiers on response lines): 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 145...
Page 146: Wtrss (Wait Time To Restore Synchronization Source)
The keyword format is: WTRSS=<value> Parameter Value Description <value> 0 to 1000 Time in seconds Command Example: RTRV-EQPT:::SC1801:::PARAMETER=WTRSS; 146 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 147: Year4
Disable YEAR4: ED-EQPT::IMC:SV13:::YEAR4=N; This is the response (note that two-digit year is already in the response): SYMMBITS 03-03-24 17:11:49 SV13 COMPLD Retrieve the current setting of YEAR4 with: RTRV-EQPT::IMC:SC14:::PARAMETER=YEAR4; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 147...
Page 148: Timehub 5500 Tl1 Reference Guide 097-55501-02 Issue 7 – January
Keywords Keyword Description The response is: SYMMBITS 03-03-24 17:13:34 SC14 COMPLD "IMC::YEAR4 = N" indicating that, in this case, YEAR4 is disabled. 148 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 149: Chapter 4 Performance Monitoring
Chapter 4 Performance Monitoring This chapter describes input signal performance monitoring measurements and provides example commands. In This Chapter Overview Measurements Measurement Properties 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 150: Overview
Performance Monitoring Overview Overview The TimeHub 5500 continuously makes phase deviation measurements on each input reference. Network performance parameters based on these measurements are computed and updated periodically. Depending on the type of measurement, the time periods are either averaging time or observation time and are performed either on a single input port or across all enabled input ports.
Page 151: Ffoff Measurements And Time Periods For Single Input Port
256 s 768 s FFOFF-3072S 3072 s 1024 s 3072 s Command Example: RTRV-PM::CLK-4:SC1::FFOFF; The response to the command in this example displays FFOFF information about input port 4. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 151...
Page 152: Frequency Spread
SPRD is recalculated if a measurement is restarted on a port that is included in the SPRD calculation. The command format is: RTRV-PM[-TSG]:[<tid>]:CLK:<ctag>::SPRD; Response Format: <sid> <date> <time> <ctag> COMPLD "CLK a:SPRD-a,<monval>,<status>"... The parameters displayed in the response are listed below. 152 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 153: Sprd Measurements And Time Periods For All Input Ports
Note 2: For longer averaging times, SPRD is updated when new FFOFF values become available, provided at least 1 minute has elapsed since the last update (in some cases the updates may occur more often). Command Example: RTRV-PM::CLK:SC1::SPRD; 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 153...
Page 154: Latest Maximum Relative Time Interval Error
Input port number of active Clock card 555xx-02 (9 input) Response Format: <sid> <date> <time> <ctag> COMPLD "CLK a-b:LMRTIE-a,<monval>,<status>,,,<meas time>"... The parameters displayed in the response are listed below. 154 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 155: Lmrtie Measurements And Time Periods For Single Input Port
LMRTIE-8H 15 min LMRTIE-24H 24 h 15 min 24 h Command Example: RTRV-PM::CLK-4:SC1::LMRTIE; The response to the command in this example displays LMRTIE information about input port 4. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 155...
Page 156: Maximum Relative Time Interval Error
Input port number of Clock active card 555xx-02 (9 input) Response Format: <sid> <date> <time> <ctag> COMPLD "CLK a-b:MRTIE-a,<monval>,<status>,,,<meas time>"... The parameters displayed in the response are listed below. 156 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 157: Mrtie Measurements And Time Periods For Single Input Port
15 min 24 h MRTIE-24H 24 h 15 min 24 h Command Example: RTRV-PM::CLK-4:SC1::MRTIE; The response to the command in this example displays MRTIE information about input port 4. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 157...
Page 158: Time Deviation
= 0 to 4 Input port number of active Clock card 555xx-01 (5 input) a = 0 to 8 Input port number of active Clock card 555xx-02 (9 input) 158 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 159: Tdev Measurements And Time Periods For Single Input Port
TDEV-1S 98 s 96 s 98 s TDEV-4S 392 s 192 s 392 s TDEV-16S 1568 s 384 s 1568 s TDEV-64S 6272 s 768 s 6272 s 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 159...
Page 160: Time Interval Error
For example, a 1 minute TIE measurement is the difference in the phase deviation between two samples 1 minute apart. Similarly, a 1 second TIE measurement is the difference between phase deviation samples captured 1 second apart. 160 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 161: Tie Measurements And Time Periods For Single Input Port
Table 4-6 TIE Measurements and Time Periods for Single Input Port Measurement First Data Includes Data Updated Every Observation Time Available After from Last TIE-1S TIE-1M 1 min 1 min 1 min 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 161...
Page 162: Measurement Properties
1. The values for time intervals of 2 hours, 8 hours, and 24 hours are not yet available, but do become available as the system collects data. Measurement Properties Measurement property descriptions and factory settings are listed in Table 4-7. 162 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 163: Displaying
= 1 to 4 Input port number of Clock card. Applies to monitored types other than SPRD. — All input ports of Clock card. Applies to SPRD monitored type only. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 163...
Page 164 = 1 to 4 Input port number of Clock card. Applies to monitored types other than SPRD. — All ports of Clock card. Applies to SPRD monitored type only. 164 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 165: Changing
INMEAS event to be cleared Changing Measurement properties can be specified for all input ports of a Clock card or a single input port of a Clock card. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 165...
Page 166 Threshold value, in nanoseconds, for TDEV monitored type RPT-a a = Y or N Indicates if an event is generated (Y) or not generated (N) when a threshold is crossed 166 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 167 = 0 ppm to 7,300,000 ppm Threshold value, in ppm, for SPRD and FFOFF monitored types a = 0 ns to 800,000 ns Threshold value, in nanoseconds, for TDEV monitored type 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 167...
Page 168 = 1 to 15 Number of consecutive good measurements that must occur following a bad measurement before an input signal can be qualified and for the INMEAS event to be cleared 168 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 169: Chapter 5 Troubleshooting
Chapter 5 Troubleshooting This chapter provides troubleshooting information using messages, events, and alarms. In This Chapter Overview Automatic Messages Events Troubleshooting with Error Messages Error Responses 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide...
Page 170: Overview
Overview Automatic messages automatically report network and system alarmed and non-alarmed events. Events are conditions that are detected by the TimeHub 5500. The alarm property of each event specifies how it is reported, or if it is not reported. For certain events, this property is user configurable to control which automatic messages are generated by the system.
Page 171: User Logged On
If the system is configured to display the information automatically, measurement properties must be specified using the Edit Sync or Edit Equipment commands. (Refer to Chapter 4, Performance Monitoring for details.) 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 171...
Page 172: Events
<meas time> Events Events are conditions that occur and are detected in the TimeHub 5500. Alarms are a subset of these events which have been configured, either by factory setting or by the user, to indicate an alarm and generate an Alarm Event (RPT ALM TSG) message.
Page 173 Troubleshooting Events Table 5-1. TimeHub 5500 Events (Continued) Event Default Alarm Default Configurable Configurable Code Severity Alarm Severity Log Settings CLKGONE FAIL (both clocks gone) NO (see SNGCLK MAJOR (one clock (Single Clock), on gone) page 136) CLKNCOM MINOR CLKNVFL...
Page 174 Troubleshooting Events Table 5-1. TimeHub 5500 Events (Continued) Event Default Alarm Default Configurable Configurable Code Severity Alarm Severity Log Settings EXOTHCLK MINOR EXPWRA (see Power MAJOR Supply Events, on page 205) EXPWRB (See Power MAJOR Supply Events, on page 205)
Page 175 Troubleshooting Events Table 5-1. TimeHub 5500 Events (Continued) Event Default Alarm Default Configurable Configurable Code Severity Alarm Severity Log Settings NORESP EVENT OCCRDIN EVENT OCCRDNP MAJOR OCCRDRM EVENT OPCDFL MAJOR OPCDIN NONALM OPCDNA MAJOR OPCDNP MAJOR OPCDPMM MAJOR OPCDRM EVENT...
Page 176: Log Types
In firmware version R4315C, this event has a default severity of MINOR. In firmware version R4315C, this event has a default severity of EVENT. Log Types The TimeHub 5500 maintains two separate logs: Event Automatic Output (AO) Event logging in either log is controlled by the following properties: 176 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 –...
Page 177 (whichever is less) and is retrieved in chronological order. No battery backup is provided. Automatic messages can be retrieved from the AO log using the Retrieve Automatic Messages (RTRV-AO) command. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 177...
Page 178: Event Types
Transient Events Transient events do not have an ongoing state. Therefore, they cannot generate alarms. 178 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 179: Retrieving State Events
Use the Retrieve Equipment (RTRV-EQPT) command to display the properties of an event (see Retrieve Equipment, on page 62). The command format is: RTRV-EQPT[-TSG]:[<tid>]:<aid>:<ctag>:::PARAMETER=<event>; Parameter Value Description <event> Refer to the Event Code column in Table 5-2. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 179...
Page 180: Changing Event Properties
For details on removing or replacing cards, refer to the Maintenance chapter in the TimeHub 5500 User’s Guide, part number 097-55501-01. 180 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 181: Message Troubleshooting
3. If the condition does not clear, replace the indicated Clock card. CLKWARM The Clock card is warming up None required. CLK Warm-up and the card is not yet active. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 181...
Page 182 Output card pair, b is the port group, and c is the Connector card type). Refer to ECONCRD (Output , on Connector Card Type) page 104 for details. 182 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 183 Edit Equipment command (ED-EQPT::OUTa:<ctag>:: EPROT=b;, where a is the Output card pair and b is the protection requirement). Refer to , on EPROT (Protection) page 105 for details. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 183...
Page 184 Expansion link cables. disrupted. 2. Reinsert/Replace the Both Expansion link Expansion Controller cables to the shelf are cards. removed/failed. Both Expansion Controller cards in the shelf are removed/failed. 184 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 185 Output card is detecting a port Alarms" portion of this alarm on port 15, this alarm is table for message "Alarms reported. on same ports - check external conditions", event code OPTALMEXT. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 185...
Page 186 1. Remove then insert the the shelf, but has not been indicated failed card. identified by the card 2. If the condition does not generating the alarm signal. clear, replace the card. 186 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 187 Clock marginal At least one of the internal Replace Clock card. failure Clock card voltages exceeds the failure limit. Clock card internal power supply voltage exceeds fail limits. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 187...
Page 188 Controller card in this location and the alarm is being reported, the controller card may need to be replaced. Try removing and inserting the card to see if condition persists. 188 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 189 CLK2 via Link 1. CLK2 card in master shelf, 3. Communication must link 1 cable, or Expansion be received from CLK2 Controller card by via Link 1. individually replacing each. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 189...
Page 190 CLK2 via Link 2. CLK2 card in master shelf, 3. Communication must link 2 cable, or Expansion be received from CLK2 Controller card by via Link 2. individually replacing each. 190 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 191 If it is lit, the fuse has blown. The fuse is replaceable. Replace, but if fuse continues to go out, shelf may require service. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 191...
Page 192 Only one Output card 3. Replace the failed Output inserted in a slot pair. card. One of the Output cards in the slot pair has failed. 192 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 193 For further details, see "Output Port Alarms in TimeHub 5500" in the Functional Description section in Chapter 1 of the TimeHub 5500 User’s Guide, part number 097-55501-01.
Page 194 Output cards to see if it also detects a failure. For further details, see "Output Port Alarms in TimeHub 5500" in the Functional Description section in Chapter 1 of the TimeHub 5500 User’s Guide, part number 097-55501-01.
Page 195 205) SNPWRB Power supply B The –48V B input failed. Troubleshoot and repair the B failed 48 V battery input. (See Power – Supply Events, on page 205) 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 195...
Page 196 Expansion links that could further Controller card in EC1 is only diagnose the cause of the getting clock information from problem. CLK2 in the master shelf. 196 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 197 End holdover mode by frequency has drifted outside configuring the shelf to qualify an suspended the pull-in range and the input signal. oscillator is no longer using the SmartClock algorithm. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 197...
Page 198 2. Replace the Clock card. other Clock card was removed. A Clock card was removed from the shelf. A serious hardware failure has occurred on the Clock card like power supply failure. 198 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 199 ECLKEXP (Expected Expansion Events, on page indicated expansion shelf. Controller Card), on page 102). 207) This clears the EXCLKGONE alarm that occurs after the controller card is removed. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 199...
Page 200 Measurements have restarted. minutes specified by MEASDLY controls the delay MEASDLY to elapse. qualification of an input until 2. Set MEASDLY to zero. the desired measurement has completed. 200 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 201 SSM value from the changed incoming signal, disable SSM reading for the indicated input (ED-SYNC::CLK-a:<ctag>:::SSM ENB=N;, where a is the indicated input). 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 201...
Page 202 Note: In increase the measurement threshold firmware threshold setting. version 4328D 2. Investigate the upstream or later equipment quality. versions, this event has a default severity of MINOR. 202 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 203 5. If the condition does not clear, replace the card. SNFRCD Forced Mode Input selection for tracking is Normal event. Selection forced to particular input. Parameter SELMDE is set to FORCED. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 203...
Page 204 None required. operating continuously for at available least 32 h. SNSSM SSM algorithm The Clock card is using SSM None required. to detect which input to track. executed 204 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 205: Power Supply Events
"S0-PWRA:MJ,SNPWRA,NSA,03-13, 11:45:06:\"Power Supply A failed\"" The following is an example of power being re-supplied to power terminal A on the main shelf: SNDKCAQO05050501 03-03-13 11:45:14 0282 REPT ALM EQPT 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 205...
Page 206: Expansion Link Events
EXNC1L2 EXNC2L2 For example, an error in the expansion link 1 cable that is detected in Expansion Controller card 2 would be reported as follows: SNDKCAQO05050501 03-03-13 13:19:23 206 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 207: Expansion Controller Card Events
DENY indicates that the command was denied due to an error. The error code <errcde> parameter indicates the error type or cause of the error. Table 5-3 lists error codes, their description, and the action to take. 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Guide 207...
Page 208: Error Code Troubleshooting
Status, all resources busy Try again later. SROF Status, requested operation failed Check the command description. SSRE Status, system resources exceeded Try again later. IBEX Block, extra Check the command syntax. 208 TimeHub 5500 TL1 Reference Guide 097-55501-02 Issue 7 – January, 2005...
Page 209 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Manual 209...
Page 210 IP address of alternate element manager firmware auxiliary memory copy firmware download mode working memory force ITH card to assume oven is fully of alternate local manager 210 TimeHub 5500 TL1 Reference Manual 097-55501-02 Issue 7 – January, 2005...
Page 211 SSM priority grouping subnetwork mask provisioning command auxiliary memory pull-in range working memory purpose of this guide sync mode TID quiet time constant recommendations defined reference source 097-55501-02 Issue 7 – January, 2005 TimeHub 5500 TL1 Reference Manual 211...
Page 212 EEPROM card user value session verify operation of communication port terminates alarm level of an event warnings defined input channel priority threshold measurement web address severe errors 212 TimeHub 5500 TL1 Reference Manual 097-55501-02 Issue 7 – January, 2005...

Symmetricom TimeHub 5500 Reference Manual

How to Use this Guide

Chapter 1 Introduction

Chapter 2 Commands

Chapter 3 Keywords

Chapter 4 Performance Monitoring

Chapter 5 Troubleshooting

Quick Links

Troubleshooting

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Symmetricom TimeHub 5500

Summary of Contents for Symmetricom TimeHub 5500