Symmetricom TimeHub 5500 Reference Manual
  1. Manuals
  2. Brands
  3. Symmetricom Manuals
  4. Data Loggers
  5. TimeHub 5500
  6. Reference manual
Symmetricom TimeHub 5500 Reference Manual

Symmetricom TimeHub 5500 Reference Manual

Building integrated timing system; tl1 reference
Hide thumbs Also See for TimeHub 5500:
Table of Contents

Advertisement

Quick Links

Download this manual See also: System Manual, User Manual
TimeHub 5500
TL1 Reference Manual
097-55501-02
Issue 5
June 2003

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the TimeHub 5500 and is the answer not in the manual?

Questions and answers

Related Manuals for Symmetricom TimeHub 5500

Summary of Contents for Symmetricom TimeHub 5500

  • Page 1 TimeHub 5500 TL1 Reference Manual 097-55501-02 Issue 5 June 2003...
  • Page 2 Copyright © 2003 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. TimeHub 5500 TL1 Reference Manual Contents 097-55501-02 Issue 5: June 2003...
  • Page 3 Added keyword descriptions for BRIDGED, SELMDE, USESUBRCK, and YEAR4 • Revised Table D, Keywords and Descriptions, Values, Commands, and Targets Chapter 5, Troubleshooting • Revised Table L, TimeHub 5500 Events • Revised Table M, Message Troubleshooting 097-55501-02 Issue 5 – June 2003...
  • Page 4 This page intentionally left blank. 097-55501-02 Issue 5 – June 2003...

  • Page 5: Table Of Contents

    Delete User Security ..... . . 37 Edit Command Security ..... 38 TimeHub 5500 TL1 Reference Manual Contents...
  • Page 6 Set Threshold ......98 Switch Duplex Equipment ....99 TimeHub 5500 TL1 Reference Manual Contents...
  • Page 7 IPEM2 (IP Address of Alternate Element Manager– Working Memory) ......140 TimeHub 5500 TL1 Reference Manual Contents...
  • Page 8 Memory) ....... 165 PORTCMDS (Command/Response Reporting Port Number–Working Memory) ....166 TimeHub 5500 TL1 Reference Manual Contents 097-55501-02 Issue 5: June 2003...
  • Page 9 Measurement Properties ..... . . 215 Displaying ......216 TimeHub 5500 TL1 Reference Manual Contents...
  • Page 10 Troubleshooting with Error Messages ....234 Error Responses ......246 TimeHub 5500 TL1 Reference Manual Contents...
  • Page 11 Chapter Chapter 1 Introduction This chapter provides general information about the TL1 language.

  • Page 12: Conventions

    When the context requires different values for a parameter, the value is listed with the parameter in the applicable commands, responses, and messages. TimeHub 5500 TL1 Reference Manual Introduction 097-55501-02 Issue 5: June 2003...
  • Page 13 Code that shows the event or alarm severity, which is one of the following: = critical alarm = major alarm = minor alarm = cleared = non-alarmed = not reported TimeHub 5500 TL1 Reference Manual Introduction 097-55501-02 Issue 5: June 2003...

  • Page 14: Security

    = retrieves all messages <tid> Target identifier Identifies the equipment (TimeHub 5500) to which the command is directed. Must be a valid TL1 identifier of a maximum of 20 characters (limited to letters, digits, and hyphens). The <tid> value may be null.

  • Page 15: Enabling

    Action If the management card switch S1-1 is set to Off (factory setting), skip to Step 4. If the management card switch S1-1 is set to On, remove the card (refer to the TimeHub 5500 System Manual for details). Set switch S1-1 to Off.

  • Page 16: Command Types

    Events are configured by using the provisioning commands to set thresholds, values, and conditions. Events and alarms are described in the Troubleshooting chapter. TimeHub 5500 TL1 Reference Manual Introduction 097-55501-02 Issue 5: June 2003...

  • Page 17: Chapter 2 Commands

    Chapter Commands This chapter describes the TL1 commands.

  • Page 18: Command Format

    Null parameter separated by a comma Fields semicolon block command-code:[<tid>]:[<aid>]:<ctag>::[<date>,<time>]:[<keyword>]; Command Target Access Correlation Spec Keyword code Identifier Identifier Block Block (Optional (Optional (Optional (Optional parameter) parameter) parameter) parameter) TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 19: Responses

    • Error response A normal or error response is returned when the TimeHub 5500 receives a command. These types of 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 20: Normal Response

    M^^<ctag>^DENY ^^^<errcde> ^^^/* <error message> */ DENY indicates that the command was denied due to an error. The <errcde> parameter indicates the error type or cause of the error. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 21: Command Factory-Set Security Access Levels

    Retrieve Status of Multiple Remote Sessions RTRV-STATUS-SECU Security Retrieve User RTRV-USER User Security Retrieve User Security RTRV-USER-SECU Provisioning Commands Edit Equipment ED-EQPT[-TSG] Admin Edit Sync ED-SYNC[-TSG] Admin Retrieve Equipment RTRV-EQPT[-TSG] User TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 22 Retrieve Log RTRV-LOG User Set System Identifier SET-SID Admin Switch Duplex Equipment SW-DX-EQPT Admin Network WKG (Working)/AUX (Auxiliary) Commands Copy Network Memory CPY-MEM Admin Copy Network Memory Security CPY-MEM-SECU Security TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 23 Security Memory Erase Firmware from Main Memory DLT-SFWR Security Remove Equipment RMV-EQPT Security Verify Firmware Integrity VRF-SFWR Security All other commands do not have a factory set access level. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 24: Command Description

    The definition is followed by the actual command, followed by the variables that can be used with the command. Command and response examples are shown where applicable. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 25: Activate Bulk Text Transfer Mode

    The command format is: ACT-BTT:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Management card CLK1 Clock card 1 CLK2 Clock card 2 Command Example: ACT-BTT:SYMMBITS:CLK1:SC003; Response Example: SYMMBITS 00-06-15 05:01:26 SC003 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 26: Activate Software Download Mode

    The command format is: ACT-SWDL:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Management card CLK1 Clock card 1 CLK2 Clock card 2 Command Example: ACT-SWDL:SYMMBITS:CLK1:SC002; Response Example: SYMMBITS 00-06-15 05:01:20 SC002 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 27: Activate User

    The response in this example indicates that the previous logon for FRED was at 1:30:04 a.m. on December 22, 2000, and since then there have been two unsuccessful attempts at logging on. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 28: Cancel Bulk Transfer Mode

    The command format is: CANC-BTT:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Management card CLK1 Clock card 1 CLK2 Clock card 2 Command Example: CANC-BTT:SYMMBITS:CLK1:SC005; Response Example: SYMMBITS 00-06-15 05:01:32 SC005 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 29: Cancel Port

    Cancel Port This command terminates a current session on the TimeHub 5500. It can be used to remotely cancel a session on the local port. If the port of the user is specified, the user will be logged off. The command format is: CANC-CID-SECU:[<tid>]:<aid>:<ctag>;...

  • Page 30: Cancel User

    • If LOCAL is specified, the user on the local port will be logged off. Since it is a physical connection the connection cannot actually be closed. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 31: Cancel User Security

    The command format is: CANC-USER-SECU:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Up to ten case-insensitive Assigned user alphanumeric characters name Command Example: CANC-USER-SECU::MARTHA:SC001; The command in this example terminates MARTHA’s session. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 32: Change To Normal Mode

    The command format is: CANC-SWDL:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Management card CLK1 Clock card 1 CLK2 Clock card 2 Command Example: CANC-SWDL:SYMMBITS:IMC:SC001; Response Example: SYMMBITS 00-06-15 15:30:45 SC001 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 33: Copy Network Memory

    Copy Network Memory This command copies data from the working (WKG) memory to the auxiliary (AUX) memory. The command format is: CPY-MEM::NET:<ctag>::WKG,AUX; TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 34: Copy Network Memory Security

    AUX memory to WKG memory. Copying will be denied if the values are the same (PORTAOX and PORTCMD are not allowed to have the same value). The command format is: CPY-MEM-SECU::NET:<ctag>::WKG,AUX; TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 35: Copy Software From Main To Backup Memory

    Copies current firmware from backup to main memory in clock card 2 Command Example: COPY-SFWR:SYMMBITS:CLK1-MAIN:SC006;IP SC006 <IP SC006 <IP SC006 <IP SC006 <IP SC006 <IP SC006 <; Response Example: SYMMBITS 00-06-15 05:03:13 SC006 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 36: 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 37: Delete User Security

    DLT-USER-SECU:[<tid>]:<aid>:<ctag>; Parameter Value Description <aid> Up to ten case-insensitive Assigned user name alphanumeric characters Command Example: DLT-USER-SECU::FRED:SC001; The command in this example deletes FRED from the Security Database. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 38: Edit Command Security

    <uap> SECURITY Access level ADMIN USER NONE Command Example: ED-CMD-SECU::ED-DAT:SC001::SECURITY; The command in this example changes the access level of the ED-DAT command from ADMIN (factory setting) to SECURITY. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 39: Edit Date

    Time in hour-minute-second Command Example: ED-DAT:::SC001::00-8-27,10-3-29; The command in this example sets the date to August 27, 2000 and the time to 10:03:29 a.m. Response Example: SYMMBITS 00-08-27 10:03:29 SC001 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 40: Edit Equipment

    A – D. For expansion shelf, range is A – H. c = 1, 2 Port group. PG1 identifies ports 1 – 20. PG2 identifies ports 21 – 40. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • 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 TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • 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 Manual Commands 097-55501-02 Issue 5: June 2003...
  • 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 TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 44 SNPWRA SNPWRB RACKALM1 RACKALM2 RACKALM3 RACKALM4 RACKALM5 RACKALM6 RACKALM7 RACKOOR UNKALM SECACTV Minor alarm INDISQ XFER RACKALM8 SNSCSUS UNKALM CLKACTV Event CLKNCOM CLKDISA SNDRIFT SNHAVL IMCRST INPSSM MEASRNG MEASRP TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 45 Maximum Relative Time Interval Error SPRD Frequency Spread TDEV Time Deviation Time Interval Error <value> See the Keywords chapter Note: For detailed descriptions of keywords, see the Keywords chapter. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 46 Edit Equipment (cont’d) Command Example: ED-EQPT::CLK:SC001:::SYNCMDE=MANUAL,MANCHAN=2; The command in this example sets the input selection mode to manual and sets the input channel to 2. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 47: Edit Password

    Command Example: ED-PID::FRED:SC001::TANK.1,CAR.2; The command in this example allows FRED to change his password from TANK.1 to CAR.2. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 48: Edit Port Security

    Set switch S2 on the management card back to its normal position. Parameter Value Parameter Description <aid> REMOTE Communication port LOCAL <chap> ENABLED Channel access privileges DISABLED Command Example: ED-CID-SECU::REMOTE:SC001::DISABLED; The command in this example disables the remote port. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 49: Edit Sync

    Read SSM Bits SSMPRI SSM Priority Grouping TCONST Time Constant TCONSTSEC Time Constant for Secondary Oscillator <value> See the Keywords chapter Note: For detailed descriptions of keywords, see the Keywords chapter. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 50 The command in this example sets the priority of input channel 5 and enables the input channel. ED-SYNC::CLK-0&&4:SC001:::ENABLE=Y; The command in this example enables input channels 0 through 4, inclusive. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 51 3 as an input reference (CRI-Y). In addition it tells the system to display an Automatic Message (RPT-Y) if the threshold is exceeded and display the measurement every 15 minutes (PM-Y). TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 52: Edit User Security

    The command in this example changes the password and user name of FRED to FREDJR with a new password of TANK.1. Note: If the new user name, password, or access level is omitted, it will be left unchanged. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 53: Enter User Security

    USER Access level ADMIN SECURITY Command Example: ENT-USER-SECU::MARTHA:SC001::CHESS.1,,ADMIN; The command in this example sets up a new user (MARTHA) with a password (CHESS.1) and an access level of ADMIN. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 54: Erase Firmware From Main Memory

    CLK2-BACKUP Erases backup memory on clock card 2. Command Example: DLT-SFWR:SYMMBITS:IMC-MAIN:SC001; Response Example: SYMMBITS 00-06-15 15:30:45 SC001 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 55: Inhibit User Security

    Command Example: INH-USER-SECU:::SC001::FRED; The command in this example will temporarily inhibit FRED from logging on. Note: This command correlates to the ALW-USER-SECU command, which reinstates a user. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 56: Initialize Event Log

    INIT-LOG::CLK:SC001::EVT; The command in this example clears the event log on both clock cards. INIT-LOG::CLK1:SC001::EVT; The command in this example clears the event log on clock card 1 only. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 57: Initialize Register

    Restarts measurements on a channel and disqualifies the channel until a good measurement is completed Command Example: INIT-REG::CLK-1:SC001; The command in this example clears and restarts all performance monitoring measurements on input channel 1. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 58: Operate Alarm Cutoff

    Operate Alarm Cutoff This command deactivates (silences) the audible office alarm. The command format OPR-ACO-ALL:[<tid>]::<ctag>; Command Example: OPR-ACO-ALL:::SC001; TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 59: Reinstate User

    <uid> Up to ten case-insensitive Assigned user name alphanumeric characters Command Example: ALW-USER-SECU:::SC001::FRED; The command in this example reinstates the user (FRED) after he was inhibited from logging on. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 60: Retrieve Alarm Condition

    The command in this example displays all active alarms from the system. Response Example: SYMMBITS 98-01-02 16:30:45 RTRV "S0-CLK-1:MN,INDISQ,NSA,,:\"Input disqualified\"" "S0-CLK-2:MN,INDISQ,NSA,,:\"Input disqualified\"" "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\"" TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 61: Retrieve All Network Equipment Types

    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" "S1-IMC:,090-55542-01-A,,R0039A,E26658,D0TPN00AAA, 267825" "S1-CLK1:,090-55512-01-A,,R0039A,E26658,D0TPVP0AAA, 267862" "S1-CLK2:,090-55512-01-A,,R0039A,E26658,D0TPVP0AAA, 267862" "S1-OUT5C:,090-55581-01-B,R0042A,E25345,D0TPJN0AAA, 267799,DS1,CC" "S1-OUT6C:,090-55581-01-B,R0042A,E25345,D0TPJN0AAA, 267799,DS1,CC"...

  • Page 62: Retrieve Attribute

    CLKGONE — Fail alarm CLKFAIL CLKWARM EXCD24HR ECCRDMM EPROTMM NVERROR OPCDFL OPCDNA OPCDNP SNFAIL CLKOFFL Major alarm SNFREE SNHOLD SNPWRA SNPWRB RACKALM1 RACKALM2 RACKALM3 RACKALM4 RACKALM5 RACKALM6 RACKALM7 RACKOOR TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 63 MEASRP NETCLOS CLKCDIN OPCDIN SNSAVL SNSSM SNOPER SNTRCK TRAOOR Command Example: RTRV-ATTR:::SC1::INDISQ; The command in this example displays the alarm level that will be generated by the INDISQ event. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 64: Retrieve Automatic Messages

    The command in either of these examples displays all messages in the log. RTRV-AO:::SC1:::ATAGSEQ=4&17&25&&30; The command in this example displays messages 14, 17, and 25 through 30 from the log. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 65 Retrieve Automatic Messages (cont’d) RTRV-AO:::SC001:::MSGTYPE=ALM; The command in this example displays all alarmed messages in the log. RTRV-AO:::SC001:::ATAGSEQ=4&&10,MSGTYPE=EVT; The command in this example displays all non-alarmed messages between 4 and TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 66: Retrieve Command Security

    The parameters which will be displayed in the response are listed below. Parameter Value Description <aid> Command <uap> SECURITY Access level ADMIN USER NONE Response Example: SYMMBITS 00-06-15 12:30:00 SC001 COMPLD "SET-SID:ADMIN" TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 67: Retrieve Condition

    Configuration Change) condition regardless of the port receiving this command. Command Examples: RTRV-COND:::SC9::CFGCHD; The command in this example displays the Configuration Changed condition. RTRV-COND:::SC11::LSTCFGC; The command in this example displays the Latest Configuration Change condition. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 68 Configuration changed condition information SYMMBITS 00-06-19 05:57:33 SC11 COMPLD "TSG:NR,LSTCFGC,NSA,06-19,05-57-25,2055,,\ "Latest Configuration Change\"" The information displayed in the response message includes: • Which shelf (S11) • Latest configuration change condition information TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 69: Retrieve Equipment

    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 TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 70 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 Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 71 TIDQUIET TID Quiet TRAFFIC Traffic Data Pattern WTRSS Wait Time to Restore Synchronization Source <value> See the Keywords chapter Note: For detailed descriptions of keywords, see the Keywords chapter. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 72 <event> CLKGONE — Fail alarm CLKFAIL CLKWARM EXCD24HR ECCRDMM EPROTMM NVERROR OPCDFL OPCDNA OPCDNP SNFAIL CLKOFFL Major alarm SNFREE SNHOLD SNPWRA SNPWRB RACKALM1 RACKALM2 RACKALM3 TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 73 RACKALM6 RACKALM7 RACKOOR UNKALM SECACTV Minor alarm INDISQ XFER RACKALM8 SNSCSUS UNKALM CLKACTV Event CLKNCOM CLKDISA SNDRIFT SNHAVL IMCRST INPSSM MEASRNG MEASRP NETCLOS CLKCDIN OPCDIN SNSAVL SNSSM SNOPER SNTRCK TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 74 Time Interval Error <value> See the Keywords chapter Note: For detailed descriptions of keywords, see the Keywords chapter. Command Examples: RTRV-EQPT::CLK:SC1:::PARAMETER=SYNCMDE; The command in this example displays the selection algorithm setting. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 75 SYMMBITS 01-05-24 11:25:52 COMPLD "CLK::SPRD-12S = THR-0.000 & CRI-N & RPT-N & PM-M" The command in this example displays the threshold value along with the CRI, RPT, and PM settings. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 76: Retrieve Equipment Type

    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 77: Retrieve Header

    This command displays the response header information which includes the system identification (<sid>), date, and time for the unit. It can be used to verify operation of the communication link between the TimeHub 5500 and the computer communication port. The command format is: RTRV-HDR:::<ctag>;...

  • Page 78: Retrieve Log

    EVTTOP and EVTCONT are recommended for retrieving the event log. Command Example: RTRV-LOG::CLK:SC1::EVTTOP; The command in this example displays the ten most recent events in the event log. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 79 Retrieve Log (cont’d) Response Example: SYMMBITS 00-09-28 10:58:58: COMPLD "EVTTOP" "OUT3:NA,OPCDNA,SA,,:\"Output Card Not Accessible\"" "OUT3:NA,OPCDIN,NSA,,:\"Output Card Inserted\"" TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 80: Retrieve Performance Monitoring Information

    30M, 1H, 2H, 8H, observation time interval in seconds (S), minutes (M), or hours (H) Command Example: RTRV-PM::CLK-4:SC1::MRTIE; The command in this example displays MRTIE information about input channel 4. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 81 Once the measurement time reaches 24 hours, data prior to 24 hours will be lost as new data is collected. A specific measurement may be specified if only that one value is desired (for example, RTRV-PM::CLK-4:SC1::MRTIE-1S;). TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 82: Retrieve Port Security

    DISABLED Communication port is disabled HWENABLE Switch S2 on the management card is set to force enabling of the local communication port. Applies only to the local communication port. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 83 Retrieve Port Security (cont’d) Response Example: SYMMBITS 00-11-05 12:30:00 COMPLD "LOCAL:ENABLED" TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 84: Retrieve Status

    The above response indicates that users FRED and MARTHA are logged on at the LOCAL and REMOTE ports, respectively, and that users RS, GH, and KL have been inhibited from logging on. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 85: Retrieve Status Of Multiple Remote Sessions

    "REMOTExx:<user name>,<ip> Where xx = 01, 02, ..., 10 and each line will have a unique xx. Command Example: RTRV-STATUS-SECU:::SV506; Response Example: SYMMBITS 02-07-10 13:36:30 SV506 COMPLD "LOCAL:," "REMOTE02:TEST,192.168.3.75" "REMOTE01:,192.168.5.108" TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 86 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. Note: This command is available in firmware versions 4142B or later. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 87: Retrieve Sync

    Squelch Output SSMENB Read SSM Bits SSMPRI SSM Priority Grouping TCONST Time Constant TCONSTSEC Time Constant for Secondary Oscillator Note: For detailed descriptions of keywords, see the Keywords chapter. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 88 The command in this example displays the priority of input channel 3. RTRV-SYNC::CLK-3:SC1:::PARAMETER=PRIORITY&ENABLE; The command in this example displays the priority of input channel 3 and whether it is enabled. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 89 Retrieve Sync (cont’d) RTRV-SYNC::CLK-3:SC1:::PARAMETER=TDEV-1S; The command in this example displays the properties for a 1 second TDEV measurement on input channel 3. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 90: Retrieve Threshold Information

    (S), minutes (M), or hours Command Example: RTRV-TH::CLK-2:SC1::LMRTIE-15M; The command in this example displays the threshold value set for the LMRTIE-15M measurement on input channel 2. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 91: Retrieve User

    SYMMBITS 00-11-02 16:30:45 RTRV "FRED:LOCAL,SECURITY" The above response indicates that the currently logged in user name is FRED, logged on at the LOCAL port with the highest (SECURITY) access level. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 92: Retrieve User Security

    The command in this example displays another user’s access level. Response Example: SYMMBITS 00-11-02 16:30:45 RTRV "FRED:,SECURITY" The above response indicates that FRED has the highest access level (SECURITY). TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 93: Set Attribute

    SNFAIL An alarm signal is present within the shelf that has not been identified by the card generating the alarm signal CLKOFFL The indicated clock card is offline TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 94 The frequency of an input signal, as compared to the clock oscillator, has drifted beyond the acceptable limits SNHAVL The clock card has collected enough tracking data to enter holdover mode if all inputs become disqualified TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 95 The value of the Traffic Data Pattern (TRAFFIC) keyword is invalid for the output driver card type Command Example: RSET-ATTR:::SC1::MAJOR,INDISQ; The command in this example sets a major alarm if an INDISQ (Input Channel Disqualified) event occurs. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 96: Set Synchronization

    <aid> CLK1 Clock card 1 CLK2 Clock card 2 Command Example: SET-SYNCN::CLK1:SC1::NORM; The command in this example forces clock card 1 to assume its oven is fully warmed up. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 97: Set System Identifier

    If a target identifier (<tid>) is included in a command, it will be compared against the system identifier (SID) of the TimeHub 5500, and the command will only be executed if these match. If they do not match, the command will be rejected.

  • Page 98: Set Threshold

    Threshold value for FFOFF in parts per 0 to 7,300,000 million. Factory setting is 0. Command Example: SET-TH::CLK-2:SC1::LMRTIE-15M,100; This example sets a threshold of 100 ns on the LMRTIE-15M measurement for clock input channel 2. TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 99: Switch Duplex Equipment

    The command in this example causes the active clock card to switch to the secondary clock card. Response Example: <IP SC1 < SYMMBITS 00-07-22 15:52:31 SC1 COMPLD SYMMBITS 00-07-22 15:52:31 0095 REPT EVT TSG "CLK1:CLKACTV,SC,02-22,15-52-31:\"CLK Active\"" TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...

  • Page 100: Verify Firmware Integrity

    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 00-06-15 09:19:11 SC001 COMPLD TimeHub 5500 TL1 Reference Manual Commands 097-55501-02 Issue 5: June 2003...
  • Page 101 Keywords This chapter describes the keywords that can Chapter be used with provisioning commands.

  • Page 102: Overview

    ED-SYNC::OUTC-20&&40:SC8:::CCDENB=Y; (CC Delay) CLRPTALL Y / N ED-EQPT::S0-OUTB:SC10:::CLRPTALL=Y; CURRSSM RTRV-SYNC::CLK- (Current 2:SC9:::PARAMETER=CURRSSM; Synchronization Status Message (SSM) Value) DSCTIME 1 - 15 ED-EQPT::CLK:SC10:::DSCTIME=10; (Discontinuity Time) ECLKEXP Y / N ED-EQPT::S2-CLK2:SV01:::ECLKEXP=N; TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 103 Y / N ED-EQPT::OUTA:SC21:::INSRVC=Y; (In Service) IPEM1 0.0.0.1 RTRV-EQPT::IMC:SC22:::PARAMETER=IPEM1; (IP Address of Primary Element Manager–Working Memory) IPEM1X 0.0.0.1 0.0.0.0 - (IP Address of 223.255.255. EQPT::IMC:SC23:::IPEM1X=123.123.12.123; Primary Element Manager–Auxiliary Memory) TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 104 (IP Address of Alternate Local Manager–Working Memory) IPLM2X 0.0.0.1 0.0.0.0 - ED-EQPT::IMC:SC31:::IPLM2X=123.123.12.12; (IP Address of 223.255.255. Alternate Local Manager–Auxiliary Memory) IPNE 0.0.0.0 RTRV-EQPT::IMC:SC32:::PARAMETER=IPNE; (IP Address of Network Element– Working Memory) TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 105 (Output Quality Level) OUTESF Clock firmware Y / N ED-EQPT::S1-OUTA-PG1:SC45:::OUTESF=Y; (Output ESF) prior to version 4236B: N Clock firmware version 4236B or later: Y PIRANGE 10 - 10000 RTRV-EQPT::CLK:SC46:::PARAMETER=PIRANGE; (Pull-In Range) TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 106 1 (PRS), 2 (other inputs) Remote shelf: 2 (both CC inputs) QCUTOFF 1 - 9 ED-SYNC::CLK-3:SC56:::QCUTOFF=5; (Quality Cutoff) QLEVEL 1 (PRS) 1 - 9 ED-SYNC::CLK-0:SC57:::QLEVEL=1; (Quality Level) 2 (Inputs 1-4) TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 107 ED-EQPT::CLK:SC66:::SYNCMDE=MANUAL; (Sync Mode) 4236B: AUTO/ MANUAL/ FORCED/ FW 4236B or later: AUTO/ TCONST 96 - 49152 ED-SYNC::CLK-1:SC69:::TCONST=768; (Time Constant) TCONSTSEC 96 - 49152 ED-SYNC::CLK-2:SC70:::TCONSTSEC=384; (Time Constant for Secondary Oscillator) TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 108 TRAFFIC 0 - 255 ED-EQPT::OUTA:SC73:::TRAFFIC=17; (Traffic Data Pattern) USESUBRCK Y / N ED-EQPT::IMC:SC77:::USESUBRCK=Y; WTRSS 0 - 1000 ED-EQPT::CLK:SC78:::WTRSS=60; (Wait Time to Restore Synchronization Source) YEAR4 Y / N ED-EQPT::IMC:SC79:::YEAR4=Y; TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 109: Keyword Description

    Keywords are listed on the following pages. After the keyword name, a definition of the keyword is given. The definition is followed by the format of the keyword, followed by the value(s) that can be used with the keywords. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 110: Actssm (Active Ssm)

    SSM" and "Output Quality Level" keyword topics), ACTSSM will not report the manually set SSM value. Instead, ACTSSM will report the SSM value that would be applied if the manual capability was disabled. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 111: Ais (Output Ais)

    This keyword forces an output driver card to generate AIS instead of the usual formatted signal. The keyword format is: AIS=<value> Parameter Value Description <value> Output driver card generates AIS Output driver card generates framed data TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 112: Aomerge (Automatic Output Merge)

    Following a firmware download to the management card, AOMERGE may 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 Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 113: Autopm (Auto-Upload Pm)

    1 second data is not explicitly enabled for automatic reporting. If the reporting of the 1 second data is enabled, it will be displayed every second (except for MRTIE which is only calculated at 15 minute intervals). TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 114: B8Zs (B8Zs)

    This keyword does not affect the PRC (Primary Reference Clock) input. The keyword format is: B8ZS=<value> Parameter Value Description <value> B8ZS coding is enabled B8ZS coding is disabled TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 115: Bridged (Bridged Input)

    Command Examples: Enable BRIDGED mode for input 3: ED-SYNC::CLK-3:SV13:::BRIDGED=Y; This is the response: SYMMBITS 03-03-24 09:10:50 M SV13 COMPLD To retrieve the BRIDGED setting for input 4, send: RTRV-SYNC::CLK-4:SC14:::PARAMETER=BRIDGED; TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 116 BRIDGED (Bridged Input) (cont’d) This is the response: SYMMBITS 03-03-24 09:12:12 M SC14 COMPLD "S1-OUTC-PG1::CBCOMP=100" indicating that input 4 is currently NOT set for BRIDGED mode. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 117: Cbcomp (Cable Compensation)

    Set the CC compensation for expansion shelf 1 (S1-) output card group C, ports 1-20 (PG1) to 100. ED-EQPT::S1-OUTC-PG1:SV322:::CBCOMP=100; This is the response: SYMMBITS 02-07-09 11:29:09 M SV322 COMPLD TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 118 CBCOMP (Cable Compensation) (cont’d) Retrieve the CBCOMP setting: RTRV-EQPT::S1-OUTC-PG1:SV323:::parameter=CBCOMP; This is the response: SYMMBITS 02-07-09 11:29:09 M SV323 COMPLD "S1-OUTC-PG1::CBCOMP=100" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 119: Ccalign (Composite Clock Alignment)

    CCALIGN is activated. The result will be that the CC output will be offset from the input CC by the user-selected delay amount. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 120: Ccdel (Cc Delay Value)

    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; Response Example: SYMMBITS 00-06-18 11:40:54 M SC050 COMPLD "OUTA-PG1::CCDEL = 80" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 121: Ccdenb (Cc Delay)

    CCDENB=<value> Parameter Value Description <value> Delay is enabled Delay is disabled Note: If this keyword is enabled, the amount of delay is controlled by the CC Delay Value (CCDEL). TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 122: Clrptall (Clear Port Alarm)

    Y. Do not attempt port alarm clear. When the CLRPTALL value is queried, it will nearly always be set to N since the TimeHub 5500 automatically sets the value to N after a port alarm clear attempt.
  • Page 123 CLRPTALL (Clear Alarm Port) (cont’d) Retrieve the current value of CLRPTALL: RTRV-EQPT::S1-OUTC:SV821:::PARAMETER=CLRPTALL; This is the response: SYMMBITS 02-07-09 16:53:30 M SV821 COMPLD "S1-OUTC::CLRPTALL=N" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 124: Currssm (Current Ssm Value)

    SSMENB=Y and ESF=Y. If SSM has been disabled (SSMENB=N), the assumed SSM (QLEVEL) will be retrieved instead. The keyword format is: PARAMETER=CURRSSM Command Example: RTRV-SYNC::CLK-2:SC321:::PARAMETER=CURRSSM; Response Example: SYMMBITS 00-06-18 11:43:10 M SC321 COMPLD "CLK-2::CURRSSM = 0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 125: Dsctime (Discontinuity Time)

    The keyword format is: DSCTIME=<value> Parameter Value Description <value> 1 to 15 Number of seconds Command Example: RTRV-EQPT::CLK:SC334:::PARAMETER=DSCTIME; Response Example: SYMMBITS 00-06-18 11:43:16 M SC334 COMPLD "CLK::DSCTIME = 15" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 126: Eclkexp (Expected Expansion Controller Card)

    For each expansion shelf, the left side EC card (labeled EC1 on the shelf) is identified by CLK1. The right side EC card (labeled EC2 on the shelf) is identified by CLK2. RTRV-EQPT::S2-CLK2:SV01:::PARAMETER=ECLKEXP; TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 127 Which results in this response: SYMMBITS 02-07-10 13:09:51 M SV01 COMPLD And an automatic message showing that the condition has ended: SYMMBITS 02-07-10 13:09:51 0296 REPT ALM TSG "S2-CLK2:CL,EXCLKGONE,NSA,07-10,13-09-51:\"ENDED Expansion CLK card missing\"" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 128: 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 00-06-18 11:54:40 M SC341 COMPLD "OUTA-PG1::ECONCRD = DONT-CARE" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 129: Enable (Input Enable)

    The following are used for SSM enabling: 1 = DS1 1 (SSM read only, not a timing input) 2 = DS1 2 (SSM read only, not a timing input) TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 130: Eprot (Protection)

    DONT-CARE No requirement REQUIRED Two output driver cards must be in the specified slot pair Command Example: RTRV-EQPT::OUTA:SC505:::PARAMETER=EPROT; Response Example: SYMMBITS 00-06-18 11:55:55 M SC505 COMPLD "OUTA::EPROT = DONT-CARE" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 131: Esf (Esf)

    ESF (ESF) This keyword sets the framing for a specific input channel. The keyword format is: ESF=<value> Parameter Value Description <value> ESF framing D4 framing TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 132: Freeact (Freerun Action)

    For output to be possible when in freerun mode, not only must FREEACT=CONTINUE but the selected output port must be enabled and in service (see "In Service" and "Squelch Output" keyword topics). TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 133: Hfqlevl (Holdover And Freerun Quality Level)

    Stratum 3E Traceable (ST3E) Stratum 3 Traceable (ST3) SONET Minimum Clock (SMC) Do not use for synchronization (DUS) Command Example: RTRV-EQPT::CLK:SC566:::PARAMETER=HFQLEVL; Response Example: SYMMBITS 00-06-18 11:45:28 M SC566 COMPLD "CLK::HFQLEVL = 4" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 134: Hfqlevlsec (Holdover And Freerun Quality Level For Second Oscillator)

    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; Response Example: SYMMBITS 00-06-18 11:45:35 M SC581 COMPLD "CLK::HFQLEVLSEC = 4" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 135: Hldact (Holdover Action)

    Output driver card will output an AIS signal SQUELCH Output driver card will be squelched Command Example: RTRV-EQPT::OUTA:SC594:::PARAMETER=HLDACT; Response Example: SYMMBITS 00-06-18 11:45:41 M SC594 COMPLD "OUTA::HLDACT = CONTINUE" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 136: Inacttime (Inactivity Time-Out)

    The inactivity timer has a setting range of 0 to 10000, where each 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 will be closed. The connection will be re-established when another automatic message occurs.

  • Page 137: Insrvc (In Service)

    INSRVC (In Service) This keyword disables an output driver card (in case maintenance is required). The keyword format is: INSRVC=<value> Parameter Value Description <value> Disabled output Enabled output TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 138: Ipem1 (Ip Address Of Primary Element Manager-Working Memory)

    0 to 255 0 to 255 Note: Network parameters in working memory cannot be directly modified. Command Example: RTRV-EQPT-TSG::IMC:SC678:::PARAMETER=IPEM1; Response Example: SYMMBITS 00-06-18 11:46:21 M SC678 COMPLD "IMC::IPEM1 = 0.0.0.0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 139: 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 00-06-18 11:46:22 M SC681 COMPLD "IMC::IPEM1X = 123.123.12.123" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 140: Ipem2 (Ip Address Of Alternate Element Manager-Working Memory)

    0 to 255 0 to 255 Note: Network parameters in working memory cannot be directly modified. Command Example: RTRV-EQPT::IMC:SC692:::PARAMETER=IPEM2; Response Example: SYMMBITS 00-06-18 11:46:43 M SC692 COMPLD "IMC::IPEM2 = 0.0.0.0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 141: Ipem2X (Ip Address Of Alternate Element Manager-Auxiliary Memory)

    Auxiliary memory alternate element manager IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT::IMC:SC693:::PARAMETER=IPEM2X; Response Example: SYMMBITS 00-06-18 11:46:44 M SC693 COMPLD "IMC::IPEM2X = 0.0.0.0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 142: Ipgate (Ip Address Of Default Gateway-Working Memory)

    0 to 255 0 to 255 Note: Network parameters in working memory cannot be directly modified. Command Example: RTRV-EQPT::IMC:SC708:::PARAMETER=IPGATE; Response Example: SYMMBITS 00-06-18 11:47:06 M SC708 COMPLD "IMC::IPGATE = 192.207.10.15" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 143: Ipgatex (Ip Address Of Default Gateway-Auxiliary Memory)

    Auxiliary memory default gateway IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT:::SC723:::PARAMETER=IPGATEX; Response Example: SYMMBITS 00-06-18 11:47:18 M SC723 COMPLD "IMC::IPGATEX = 145.34.45.99" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 144: Iplm1 (Ip Address Of Primary Local Manager-Working Memory)

    Working memory primary local manager IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT::IMC:SC728:::PARAMETER=IPLM1; Response Example: SYMMBITS 00-06-18 11:47:31 M SC728 COMPLD "IMC::IPLM1 = 0.0.0.0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 145: Iplm1X (Ip Address Of Primary Local Manager-Auxiliary Memory)

    Auxiliary memory primary local manager IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT-TSG:::SC739:::PARAMETER=IPLM1X; Response Example: SYMMBITS 00-06-18 11:47:35 M SC739 COMPLD "IMC::IPLM1X = 145.34.45.99" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 146: Iplm2 (Ip Address Of Alternate Local Manager-Working Memory)

    Working memory alternate local manager IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT::IMC:SC750:::PARAMETER=IPLM2; Response Example: SYMMBITS 00-06-18 11:47:57 M SC750 COMPLD "IMC::IPLM2 = 0.0.0.0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 147: Iplm2X (Ip Address Of Alternate Local Manager-Auxiliary Memory)

    Auxiliary memory alternate local manager IP address 0 to 255 0 to 255 0 to 255 Command Example: RTRV-EQPT:::SC753:::PARAMETER=IPLM2X; Response Example: SYMMBITS 00-06-18 11:47:58 M SC753 COMPLD "IMC::IPLM2X = 123.123.12.123" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 148: Ipne (Ip Address Of Network Element -Working Memory)

    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> Parameter Value Description 0 to 255...

  • Page 149: Ipnex (Ip Address Of Network Element -Auxiliary Memory)

    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 150: Ipsubnet (Subnetwork Mask-Working Memory)

    0 to 255 0 or 128 Note: Network parameters in working memory cannot be directly modified. Command Example: RTRV-EQPT::IMC:SC782:::PARAMETER=IPSUBNET; Response Example: SYMMBITS 00-06-18 11:58:41 M SC782 COMPLD "IMC::IPSUBNET = 255.255.248.0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 151: Ipsubnetx (Subnetwork Mask-Auxiliary Memory)

    0 to 255 Auxiliary memory subnetwork mask 0 to 255 0 to 255 0 or 128 Command Example: RTRV-EQPT::IMC:SC779:::PARAMETER=IPSUBNETX; Response Example: SYMMBITS 00-06-18 11:58:40 M SC779 COMPLD "IMC::IPSUBNETX = 0.0.0.0" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 152: Lclao (Local Automatic Output)

    Only report automatic messages when logged into the local port NEVER Never report automatic messages Command Example: RTRV-EQPT:::SC801:::PARAMETER=LCLAO; Response Example: SYMMBITS 00-06-18 11:58:49 M SC801 COMPLD "IMC::LCLAO = LOGIN" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 153: Lclbaud (Local Baud Rate)

    The keyword format is: LCLBAUD=<value> Parameter Value Description <value> 1200 Baud rate 2400 9600 19200 Command Example: RTRV-EQPT::IMC:SC806:::PARAMETER=LCLBAUD; Response Example: SYMMBITS 00-06-18 11:58:57 M SC806 COMPLD "IMC::LCLBAUD = 9600" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 154: Lclecho (Local Echo)

    This keyword tells the system to echo commands to the local terminal. The keyword format is: LCLECHO=<value> Parameter Value Description <value> System echoes commands to the local terminal System does not echo commands to the local terminal TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 155: Mainclk (Main Clock)

    Description <value> The shelf is configured as a Master shelf. The shelf is configured as a Remote shelf. Note: This feature is available in firmware versions 4142B and later. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 156: Manchan (Manual Channel)

    Value Description <value> 0 to 11 Input channel (0 indicates the 5/10 MHz PRC input) Command Example: RTRV-EQPT::CLK:SC818:::PARAMETER=MANCHAN; Response Example: SYMMBITS 00-06-18 11:59:02 M SC818 COMPLD "CLK::MANCHAN = 2" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 157: Measdly (Measurement Delay)

    The keyword format is: MEASDLY=<value> Parameter Value Description <value> 0 to Number of minutes following measurement 1800 restarts Command Example: RTRV-SYNC::CLK-1:SC839:::PARAMETER=MEASDLY; Response Example: SYMMBITS 00-06-18 11:59:10 M SC839 COMPLD "CLK-1::MEASDLY = 1" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 158: Monitor (Input Event Monitoring)

    (ENABLE) for the input to be monitored to N, set this keyword (MONITOR) to Y, and connect the signal. The keyword format is: MONITOR=<value> Parameter Value Description <value> Disabled inputs events are not suppressed Disabled inputs events are suppressed TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 159: Omanssm (Output Manual Ssm)

    Y (OUTESF=Y). The keyword format is: OMANSSM=<value> Parameter Value Description <value> Allow user to specify SSM quality level Do not allow user to specify SSM quality level TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 160: Oqlevel (Output Quality Level)

    Stratum 3E Traceable (ST3E) Stratum 3 Traceable (ST3) SONET Minimum Clock (SMC) Do not use for synchronization (DUS) Command Example: RTRV-EQPT::OUTD:SC1010:::PARAMETER=OQLEVEL; Response Example: SYMMBITS 00-06-18 12:00:30 M SC1010 COMPLD "OUTD::OQLEVEL = 4" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 161: Outesf (Output Esf)

    This keyword sets the framing for a specific output connector card port group. The keyword format is: OUTESF=<value> Parameter Value Description <value> ESF framing D4 framing Note: This keyword applies only if the output connector card is a DS1 type. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 162: Pirange (Pull-In Range)

    Description <value> 10 to 10000 Range in ppb (parts per billion = parts in 10 Command Example: RTRV-EQPT::CLK:SC1056:::PARAMETER=PIRANGE; Response Example: SYMMBITS 00-06-18 12:00:57 M SC1056 COMPLD "CLK::PIRANGE = 4731" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 163: Pirangesec (Pull-In Range For Secondary Oscillator)

    This keyword sets the pull-in range for the secondary oscillator; it applies only to the clock card with the inferior oscillator when mixed clock oscillator types are used in the TimeHub 5500 system. This keyword can set how far off in fractional frequency the incoming signal can be from the secondary oscillator and still have this clock card successfully track it.

  • Page 164: Portao (Event Reporting Port Number-Working Memory)

    Working memory port number for automatic event reporting Note: Network parameters in working memory cannot be directly modified. Command Example: RTRV-EQPT:::SC1087:::PARAMETER=PORTAO; Response Example: SYMMBITS 00-06-18 12:01:11 M SC1087 COMPLD "IMC::PORTA0 = 7589" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 165: Portaox (Event Reporting Port Number-Auxiliary Memory)

    Parameter Value Description <value> 5001 to 20000 Auxiliary memory port number for automatic event reporting Command Example: RTRV-EQPT:::SC1088:::PARAMETER=PORTAOX; Response Example: SYMMBITS 00-06-18 12:01:11 M SC1088 COMPLD "IMC::PORTA0X = 7589" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 166: Portcmds (Command/Response Reporting Port Number-Working Memory)

    Network parameters in working memory cannot be directly modified. Command Example: ED-EQPT:::SC4:::PORTCMDS=7588; Response Example: SYMMBITS 01-05-29 10:41:16 M SC4 DENY "IDNV" /* Input Data Not Valid */ /* Cannot directly set this parameter */ TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 167: Portcmdsx (Command/Response Reporting Port Number-Auxiliary Memory)

    Value Description <value> 5001 to 20000 Auxiliary memory port number for command and response reporting Command Example: RTRV-EQPT::IMC:SC1131:::PARAMETER=PORTCMDSX; Response Example: SYMMBITS 00-06-18 12:01:28 M SC1131 COMPLD "IMC::PORTCMDSX = 5001" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 168: Prc5Mhz (Prc 5Mhz Signal)

    <value> 5 MHz signal on the PRC input channel 10 MHz signal on the PRC input channel Note: This keyword should only be used with an <aid> of CLK-0. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 169: Priority (Input Priority)

    SSM. The keyword format is: PRIORITY=<value> Parameter Value Description <value> 1 to 9 Input channel priority Command Example: RTRV-SYNC::CLK-0:SC1162:::PARAMETER=PRIORITY; Response Example: SYMMBITS 00-06-18 12:01:42 M SC1162 COMPLD "CLK-0::PRIORITY = 9" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 170: Qcutoff (Quality Cutoff)

    The keyword format is: QCUTOFF=<value> Parameter Value Description <value> 0 to 8 SSM quality level Command Example: RTRV-SYNC::CLK-0:SC1206:::PARAMETER=QCUTOFF; Response Example: SYMMBITS 00-06-18 12:02:00 M SC1206 COMPLD "CLK-0::QCUTOFF = 6" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 171: Qlevel (Quality Level)

    Stratum 3 Traceable (ST3) SONET Minimum Clock (SMC) Stratum 4 Traceable (ST4) Do not use for synchronization (DUS) Command Example: RTRV-SYNC::CLK-0:SC1293:::PARAMETER=QLEVEL; Response Example: SYMMBITS 00-06-18 12:02:38 M SC1293 COMPLD "CLK-0::QLEVEL = 6" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 172: 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 TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 173: Rptall (Report All)

    “active” clock will be retrieved. By contrast, however, the automatic output (AO) log only contains entries for those events that were reported by automatic output messages. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 174: Scramble (Scramble Communication)

    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> Parameter...

  • Page 175: Selmde (Selection Mode)

    SELMDE (Selection Mode) This keyword controls whether the selection of the active timing reference will be performed automatically by the TimeHub 5500 or directly selected by the user. Note: This keyowrd is only available in clock card firmware versions 4236B or later.
  • Page 176 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 M SV49 COMPLD "CLK::SELMDE=FORCED" In this case the setting was FORCED. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 177: Sngclk (Single Clock)

    N, the SGLSWMM event will be cleared. 2. Regardless of SNGCLK setting, if there is no clock card in the shelf, a CLKGONE event will be generated. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 178 5. If using Symmetricom’s TimePictra version 1.0 management software, the SNGCLK setting can be configured by using the TimePictra Passthru feature. 6. If using Symmetricom’s TimeScan THC version 1.0 management software, the SNGCLK setting can be configured by using the Communication form and enter- ing the command manually.

  • Page 179: Sprdchn (Spread Channels)

    SPRD is recalculated if a measurement is restarted (for example, using the Initialize Register [INIT-REG] command) on a channel that is included in the SPRD calculation. Command Example: ED-EQPT::CLK:SC1419:::SPRDCHN=1&&4; Response Example: SYMMBITS 00-06-18 12:03:35 M SC1419 COMPLD TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 180: Squelch (Squelch Output)

    SQUELCH (Squelch Output) This keyword specifies which output channels are to be squelched. The keyword format is: SQUELCH=<value> Parameter Value Description <value> Output channel is squelched Output channel is not squelched TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 181: Ssmenb (Read Ssm Bits)

    Y (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 TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 182: 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 00-06-18 12:05:43 M SC1643 COMPLD "CLK-0::SSMPRI = 8" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 183: 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 00-06-18 12:06:01 M SC1687 COMPLD "CLK::SYNCMDE = MANUAL" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 184 Command Example (set SYNCMDE to AUTO): ED-EQPT::CLK:SV54:::SYNCMDE=AUTO; Retrieve the current SYNCMDE setting with: RTRV-EQPT::CLK:SV55:::PARAMETER=SYNCMDE; Which produces a response similar to: SYMMBITS 02-12-13 11:26:15 M SV55 COMPLD "CLK::SYNCMDE = AUTO" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 185: Tconst (Time Constant)

    192 would be implemented. The keyword format is: TCONST=<value> Parameter Value Description <value> Time constant 3072 12288 49152 Command Example: RTRV-SYNC::CLK-4:SC1729:::PARAMETER=TCONST; Response Example: SYMMBITS 00-06-18 12:06:31 M SC1729 COMPLD "CLK-4::TCONST = 49152" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 186: Tconstsec (Time Constant For Secondary Oscillator)

    This keyword sets the time constant for the secondary oscillator; it applies only to the clock card with the inferior oscillator when mixed clock oscillator types are used in the TimeHub 5500 system. This keyword can be used to set the loop tracking time constant for each input.

  • Page 187: Tidquiet (Tid Quiet)

    DENY response is not displayed when the <tid> specified is not the same as the current <sid> DENY response is displayed when the <tid> specified is not the same as the current <sid> TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 188: Traffic (Traffic Data Pattern)

    <value> Traffic pattern value that produces one zero Traffic pattern value that produces all ones Command Example: RTRV-EQPT::OUTA:SC1769:::PARAMETER=TRAFFIC; Response Example: SYMMBITS 00-06-18 12:06:52 M SC1769 COMPLD "OUTA::TRAFFIC = 255" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 189: Usesubrck

    Setting USESUBRCK=N in a system that contains expansion shelves does not cause the S0- prefix to be omitted. Command Examples: ED-EQPT::IMC:SV13:::USESUBRCK=Y; This is the response: SYMMBITS 03-03-24 10:23:14 M SV13 COMPLD To retrieve the USESUBRCK setting, send: RTRV-EQPT::IMC:SC14:::PARAMETER=USESUBRCK; TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 190 RTRV-NETYPE-ALL:::SV48; produces the following response (note that there are no S0- on response lines): SYMMBITS 03-03-24 15:21:23 M SV48 COMPLD "EQPT:Symmetricom,5500,EQPT" "IMC:,090-55542-01-A,,R4236B,DOTPNONAAA,106063" "CLK1:,090-55514-01-A,,R4236B,0000001,DOTPKPKAAA, 299461" "CLK2:,090-55514-02,,R4236B,J44993,DOTPKRKAAA,299462" "OUT6C:,090-55581-01-A,,R4209A,00J21559,DOTPJNOAAA, 267799,DS1,DS1" "OUT8D:,090-55581-01-B,,R4209A,00J43250,DOTPJNOAAA, 267799,CC" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 191 RTRV-NETYPE-ALL:::SV48; produces the following response (note S0- now present on response lines): SYMMBITS 03-03-24 15:25:30 M SV49 COMPLD "EQPT:Symmetricom,5500,EQPT" "S0-IMC:,090-55542-01-A,,R4236B,J44568,DOTPNONAAA, 106063" "S0-CLK1:,090-55514-01-A,,R4236B,0000001,DOTPKPKAAA, 299461" "S0-CLK2:,090-55514-02,,R4236B,J44993,DOTPKRKAAA, 299462" "S0-OUT6C:,090-55581-01-A,,R4209A,00J21559,DOTPJNOAAA, 267799,DS1,DS1" "S0-OUT8D:,090-55581-01-B,,R4209A,00J43250,DOTPJNOAAA, 267799,CC" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 192: 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; Response Example: SYMMBITS 00-06-18 12:07:05 M SC1801 COMPLD "CLK::WTRSS = 731" TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...

  • Page 193: 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 M SV13 COMPLD Retrieve the current setting of YEAR4 with: RTRV-EQPT::IMC:SC14:::PARAMETER=YEAR4; TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 194 YEAR4 (cont’d) This is the response: SYMMBITS 03-03-24 17:13:34 M SC14 COMPLD "IMC::YEAR4 = N" indicating that, in this case, YEAR4 is disabled. TimeHub 5500 TL1 Reference Manual Keywords 097-55501-02 Issue 5: June 2003...
  • Page 195 Performance Monitoring This chapter describes input signal performance monitoring measurements. Chapter 4...

  • Page 196: 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 on a single input port or across all enabled input ports.

  • Page 197: Fractional Frequency Offset

    <monval> Calculated values for averaging times in ppm <status> COMPL Averaging time calculation was completed NA,NA Averaging time calculation is not yet available TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 198 3 seconds, 12 seconds, 48 seconds, and 192 seconds for input port 4 of clock card 1. The values for averaging times of 768 seconds and 3072 seconds are not yet available, but will become available as the system collects data. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 199: Frequency Spread

    <monval> Calculated values for averaging times in ppm <status> COMPL Averaging time calculation was completed NA,NA Averaging time calculation is not yet available TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 200 (in some cases the updates may occur more often). Command Example: RTRV-PM::CLK:SC1::SPRD; The command in this example displays SPRD information about the input ports on the active clock card. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 201 3 seconds, 12 seconds, 48 seconds, and 192 seconds. The values for averaging times of 768 seconds and 3072 seconds are not yet available, but will become available as the system collects data. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 202: Latest Maximum Relative Time Interval Error

    Variable a can also be appended to LMRTIE in RTRV-PM to obtain a response for only that measurement time <monval> Calculated values for maximum phase variation of the input signal in ns TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 203 Parameter Value Description <status> COMPL Observation time calculation was completed NA,NA Observation time calculation is not yet available TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 204 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. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 205 1 hour. The values for observation times 2, 8, and 24 hours are not yet available because the system has not been running long enough to collect that data. They will become available as the system continues to collect data. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 206: Maximum Relative Time Interval Error

    <monval> Calculated values for maximum phase variation of the input signal in ns <status> COMPL Averaging time calculation was completed NA,NA Averaging time calculation is not yet available TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 207 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. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 208 30 minutes, and 1 hour for input port 4 of clock card 1. The values for time intervals of 2 hours, 8 hours, and 24 hours are not yet available, but will become available as the system collects data. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 209: Time Deviation

    Variable a can also be appended to TDEV in RTRV-PM to obtain a response for only that measurement time <monval> Calculated values for averaging times in ns TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 210 1536 s 25088 s TDEV-1024S 100352 s 3072 s 100532 s Command Example: RTRV-PM::CLK-4:SC1::TDEV; The response to the command in this example displays TDEV information about input port 4. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 211 1 seconds, 4 seconds, 16 seconds, and 64 seconds for input port 4 of clock card 1. The values for averaging times of 256 seconds and 1024 seconds are not yet available, but will become available as the system collects data. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 212: Time Interval Error

    = 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) Response Format: <sid> <date> <time> <ctag> COMPLD "CLK a-b:TIE-a,<monval>,<status>"... TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 213 15 min 15 min 15 min TIE-30M 30 min 15 min 30 min TIE-1H 15 min TIE-2H 15 min TIE-8H 15 min TIE-24H 24 h 15 min 24 h TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 214 1. The values for time intervals of 2 hours, 8 hours, and 24 hours are not yet available, but will become available as the system collects data. TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 215: Measurement Properties

    GOOD 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 TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 216: Displaying

    TIE monitored type, where a is the 1H, 2H, 8H, 24H observation time interval in seconds (S), minutes (M), or hours (H) Response Format: <sid> <date> <time> <ctag> COMPLD "<aid>::<montype>=THR-a&CRI-a&RPT-a&PM-a&GOOD-a:" TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 217 = 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 TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 218: Changing

    = 4 if clock card is 555xx-01 (5 input) a = 8 if clock card is 555xx-02 (9 input) Command Example: ED-SYNC::CLK-0&&8:SC3:::TDEV-1s=THR-10; Response Example: SYMMBITS 01-06-01 10:25:04 SC3 COMPLD TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 219: Individual Input Ports

    INMEAS event to be cleared Individual Input Ports To specify measurement properties for a single input port of a clock card, the command format is: ED-SYNC[-TSG]:[<tid>]:CLK-a:<ctag>::: <montype>=THR-a&CRI-a&RPT-a&PM-a&GOOD-a; TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...
  • Page 220 = 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 TimeHub 5500 TL1 Reference Manual Performance Monitoring 097-55501-02 Issue 5: June 2003...

  • Page 221: Chapter 5 Troubleshooting

    Troubleshooting This chapter provides troubleshooting information using messages, events, and alarms. Chapter 5...

  • Page 222: 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 determines how it is reported, if at all. For certain events, this property is user configurable to control which automatic messages are generated by the system.

  • Page 223: Alarm Event

    Alarm Event This message reports an alarmed event. In general, an alarmed event causes a standing condition and has immediate or potential impact on the operation or performance of the TimeHub 5500. The message format is: <sid> <date> <time> <severity>...

  • Page 224: Non-Alarmed Event

    (Refer to the Performance Monitoring chapter for details.) The message format is: <sid> <date> <time> 0009 REPT PM TSG "<aid>:<montype>,<mondat>,<status>,,,[<meas time>]"... Parameter Value Description <montype> Refer to the Performance Monitoring chapter <mondat> <status> <meas time> TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...

  • Page 225: Events

    Events Events are conditions that occur or 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 226 Table L. TimeHub 5500 Events (cont’d) Event Default Configurable Configurable Code Default Alarm Severity Alarm Severity Log Settings EXCLKGONE MAJOR EXCLKIN NONALM EXCLKRM NONALM EXNC1L1 MAJOR EXNC1L2 MAJOR EXNC2L1 MAJOR EXNC2L2 MAJOR EXOTHCLK MINOR EXPWRA MAJOR EXPWRB MAJOR IMCCRST NONALM...
  • Page 227 Table L. TimeHub 5500 Events (cont’d) Event Default Configurable Configurable Code Default Alarm Severity Alarm Severity Log Settings MODMONL NONE MODMRDY NONE NETCLOS NONALM NORESP NONE OCCRDIN NONALM OCCRDNP MAJOR OCCRDRM NONALM OPCDFL MAJOR OPCDIN NONALM OPCDMS MAJOR OPCDNA MAJOR...
  • Page 228 Table L. TimeHub 5500 Events (cont’d) Event Default Configurable Configurable Code Default Alarm Severity Alarm Severity Log Settings RCKALM5 MAJOR RCKALM6 MAJOR RCKALM7 MINOR RCKALM8 MINOR RCKALM9 MINOR RCKALM10 MINOR SECACTV MINOR SGLSWMM NONALM SNAUTO NONALM SNDRIFT NONALM SNFAIL FAIL...
  • Page 229 Table L. TimeHub 5500 Events (cont’d) Event Default Configurable Configurable Code Default Alarm Severity Alarm Severity Log Settings TRCSLIP NONALM YES (NONE or NONALM only) UNKALM FAIL UNKSTAT MAJOR XFER MINOR TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...

  • Page 230: Log Types

    Log Types The TimeHub 5500 maintains two separate logs: • Event • Automatic Output (AO) Event logging in either log is controlled by the following properties: • ALM: specifies the severity of the event, and controls whether an event generates an automatic message and is recorded in the AO Log •...

  • Page 231: Event Types

    Events related to input signals are normally only reported by the active clock card to avoid duplicate reports from the two clock cards (refer to the Report All keyword in the Keywords chapter). TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...

  • Page 232: Transient Events

    Commands chapter.) The Retrieve Alarm Condition command is similar to the Retrieve Condition command, except that it only reports events which are causing alarms (e.g., critical, major, and minor). TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...

  • Page 233: Displaying Event Properties

    Refer to the Event Code column in Table M. Event is recorded in the event log Event is not recorded in the event log NONE Alarm severity NONALM MINOR MAJOR FAIL TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...

  • Page 234: Troubleshooting With Error Messages

    2. If the clock card entered holdover because the performance measurements disqualified the inputs, use the Initialize Register (INIT-REG) command to clear the performance measurements for each disqualified input. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 235 Edit Equipment command (ED- EQPT::OUTa:<ctag>:::EPROT=b;, where a is the output card pair and b is the protection requirement). Refer to the Keywords chapter for details on the Protection (EPROT) keyword. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 236 1. Remove, then insert, the indicated the shelf that has not been identified failed card. by the card generating the alarm 2. If the condition does not clear, signal. replace the card. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 237 For further details, see "Output Port Alarms in TimeHub 5500" in the Functional Description section in Chapter 1 of the TimeHub 5500 System Guide. Alarms on same OPTALMEXT A port alarm has occurred on the 1.
  • Page 238 CLK2 card in master received from CLK2 via Link 1. shelf, link 1 cable, or expansion 3. Communication must be received controller card by individually from CLK2 via Link 1. replacing each. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 239 If the clock card has just been inserted, reference output, but there are no wait for an input to qualify. If not, qualified inputs, and holdover correctly configure the input signal mode is not available. format. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 240 Replace, but if fuse continues to go out, shelf may require service. Power supply B SNPWRB The –48V B input failed. Troubleshoot and repair the B 48 V – failed battery input. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 241 (SW-DX-EQPT) command, or press pressed or the superior clock card the Force Active pushbutton. failed. 2. If the condition does not clear, replace the clock card with the superior oscillator. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 242 Hence, an example where this alarm would occur is if an expansion controller card in EC1 is only getting clock information from CLK2 in the master shelf. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 243 Expansion CLK EXCLKIN An expansion controller card has None required. inserted been inserted into the indicated controller card location (EC1 or EC2) on the indicated expansion shelf. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 244 The clock card has been operating None required. available* continuously for at least 32 h. SSM algorithm SNSSM The clock card is using SSM to None required. executed* determine which input should be tracked. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...
  • Page 245 (TRAFFIC) keyword is invalid for the EQPT) to set the TRAFFIC keyword value output driver card type. to 255. * This alarm can be set to other severities using the Edit Equipment (ED-EQPT) command. TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...

  • Page 246: Error Responses

    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. 246 (End) TimeHub 5500 TL1 Reference Manual Troubleshooting 097-55501-02 Issue 5: June 2003...

Table of Contents