How to Use This Guide This section describes the format, layout, and purpose of this guide. In This Preface Purpose of This Guide Who Should Read This Guide Structure of This Guide Conventions Used in This Guide Warnings, Cautions, Recommendations, and Notes Related Documents and Information Where to Find Answers to Product and Document Questions What’s New In This Guide...
How to Use This Guide Purpose of This Guide Purpose of This Guide The TimeProvider 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.
STATUS commands for case-sensitive operating systems exactly as shown. A re-timing application A word or term being emphasized. Symmetricom does not A word or term given special emphasis. recommend... Structure of This Guide, on The blue text, when viewed in a pdf file, indicates a page 8 hyperlink to the indicated text.
How to Use This Guide Warnings, Cautions, Recommendations, and Notes Warnings, Cautions, Recommendations, and Notes Warnings, Cautions, Recommendations, and Notes attract attention to essential or critical information in this guide. The types of information included in each are explained in the following examples. Warning: To avoid serious personal injury or death, do not disregard warnings.
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 Revision E of this guide contains new information for the following commands.
Page 12
How to Use This Guide What’s New In This Guide TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006...
Chapter 1 TL1 Overview This chapter provides a basic overview of the Transaction Language 1 (TL1) used by the TimeProvider. In This Chapter Overview TL1 Command Structure Responses Autonomous Messages Command Security 097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide...
Chapter 1 TL1 Overview Overview Overview Transaction Language 1 (TL1) is the most widely used management language in the telecommunications industry. TL1 provides a standardized set of vendor-independent, ASCII-based instructions that can be used to manage network elements (NEs) and their resources. The TimeProvider uses TL1 as its human-to-machine command line interface (CLI).
Chapter 1 TL1 Overview TL1 Command Structure Command Code Block The Command Code Block uniquely identifies the command and identifies the action to be taken. It consists of a verb and one or more modifiers, separated by the dash character ( - ). ED-DAT, for instance, is the command code block used in the TimeProvider’s “Edit Date”...
Chapter 1 TL1 Overview Responses Position-Defined – In a position-defined payload block, the parameters that make up the block are implied by their position within the block. The individual parameters are separated by the comma character ( , ). If the value of a given parameter is null, its position within the block still must be maintained by using adjacent commas ( ,, ).
Chapter 1 TL1 Overview Responses Table 1-1. Normal Response Fields Field Description The unit’s Source Identifier (SID), which identifies the specific TimeProvider unit within the synchronization network. The unit’s SID is set using the SET-SID TL1 command. date The date of the response, in the format YY-MM-DD, where YY is the 2-digit year, MM is the 2-digit representation of the month, and DD is the day of the month.
Chapter 1 TL1 Overview Responses Table 1-2. Error Response Fields (Continued) Field Description ctag The correlation tag that was sent as part of the TL1 command string. If the value for the ctag is null in the command string, the unit returns a zero ( 0 ) as the ctag in the response.
Chapter 1 TL1 Overview Autonomous Messages In-Process Response If the TimeProvider cannot send a Normal response or an Error response within two seconds of receipt of a command, it sends an In-Process response. The format of an In-Process response is as follows. Note that IP identifies the response as an In-Process response: <cr><lf><lf>...
Chapter 1 TL1 Overview Autonomous Messages Autonomous Messages can be generated by the unit at any time, whether to report that a user-initiated change has occurred to some setting within the unit, to report that an active alarm condition has cleared, etc. The format of an Autonomous Message is as follows.
Chapter 1 TL1 Overview Command Security Table 1-5. Autonomous Message Fields (Continued) Field Description aidtype The aid type. It can be EQPT (the aid is associated with the internal operation of the system) or T1 (the aid is external to the system or facility; for example, an input or output). Note: The aidtype that follows the reptype in the Autonomous Message is included only if the reptype is ALM.
Security is activated as soon as an initial user is entered into the system with a user access level of SECURITY. Symmetricom strongly recommends that an initial Security-level user be defined in the system as soon as the system is installed.
Page 23
Chapter 1 TL1 Overview Command Security Table 1-6. TimeProvider TL1 Command Types and Access Levels (Continued) Factory-Set Command Name Command Type Access Level CPY-MEM System ADMIN DLT-PM-DATA Administrative USER DLT-SECU Administrative SECURITY DLT-USER-SECU Administrative SECURITY ED-CKTID System USER ED-CMD-SECU Administrative ADMIN ED-DAT System...
Page 24
Chapter 1 TL1 Overview Command Security Table 1-6. TimeProvider TL1 Command Types and Access Levels (Continued) Factory-Set Command Name Command Type Access Level RTRV-LED System USER RTRV-LOG Administrative USER RTRV-NETYPE System NONE RTRV-NTP-PEER System USER RTRV-PM System USER RTRV-SYNC System USER RTRV-SYS-MODE System...
Chapter 2 TL1 Command Syntax and Description This chapter describes each of the TimeProvider’s TL1 commands in detail. In This Chapter TL1 Syntax Conventions Command Descriptions 097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide...
Chapter 2 TL1 Command Syntax and Description TL1 Syntax Conventions Table 2-1 describes the syntax used for commands and responses in this manual. Table 2-1. TL1 Syntax Conventions Symbol Description <cr> Carriage return character (ASCII 0x0D). <lf> Line-feed character (ASCII 0x0A). [ ...
The key to enable the feature. This can be up to 20 case-sensitive characters, and must be enclosed in quotes. Contact your Symmetricom representative to obtain the key. Example To activate the NTP feature using the Symmetricom-supplied <key> parameter: Input ACT-FEATURE::NTP:TP1000::"Symmetricom-Key"; Normal Response...
Chapter 2 TL1 Command Syntax and Description Activate Software Download Mode (ACT-SWDL) Activate Software Download Mode (ACT-SWDL) This command places the information management card (IMC) in the firmware download mode prior to a firmware download. IOC or IMC firmware can be transferred from a users system to the TimeProvider using the Ymodem protocol, and the command also allows firmware transfers directly from a specified IOC module to a redundant IOC module.
Furthermore, if security is not enabled, for example no users are assigned, any command is executable. Notes: Firmware upgrade files are periodically available from Symmetricom. Contact Symmetricom customer support for information on firmware upgrades that are available for the TimeProvider.
Page 30
Chapter 2 TL1 Command Syntax and Description The Firmware Download Process After the file transfer completes, the IMC module validates the file (the system remains locked against logins at this point). If the file is not validated, the unit returns an error response and the IMC module returns to normal operation. If the file is validated, the next step depends on which module is receiving the upgrade.
Page 31
Chapter 2 TL1 Command Syntax and Description The Firmware Download Process Firmware Transfer between two IOC modules When the TimeProvider receives the ACT-SWDL command, it automatically logs all users off of the system and locks the system against new logins. If the firmware upgrade is an IOC to IOC transfer, and if the target IOC is not active, firmware is transferred to the target IOC.
Page 32
Chapter 2 TL1 Command Syntax and Description The Firmware Download Process Response Example TP-SSU 05-03-09 14:11:20 400 REPT EVT "IMC,EQPT:FWLOAD,TC,05-03-09,14-11-20,,,,:\"BEGINNING FIRMWARE UPGRADE\"" ;CCCCCCCCCCCCCIP TP1000 < TP-SSU 05-03-09 14:19:59 TP1000 COMPLD TP-SSU 05-03-09 14:19:57 401 REPT EVT "IMC,EQPT:FWOK,TC,05-03-09,14-19-57,,,,:\"FIRMWARE UPGRADE SUCCESSFUL\"" Example 3 In this example, the system has redundant IOCs (IOC1 and IOC2) and the ACT-SWDL command is issued to download firmware to the modules (AID is IOC2).
Page 33
Chapter 2 TL1 Command Syntax and Description The Firmware Download Process TP-SSU 05-03-09 21:02:49 462 REPT EVT "IOC2,EQPT:IOCMODE,TC,05-03-09,21-02-49,,,,:\"IOC MODE IS, ACTIVE\"" TP-SSU 05-03-09 21:02:49 463 REPT EVT "IOC1,EQPT:IOCMODE,TC,05-03-09,21-02-49,,,,:\"IOC MODE IS, STANDBY\"" TP-SSU 05-03-09 21:06:06 464 REPT EVT "IOC,EQPT:FWOK,TC,05-03-09,21-06-06,,,,:\"FIRMWARE UPGRADE SUCCESSFUL\"" TP-SSU 05-03-09 21:06:08 0 COMPLD TP-SSU 05-03-09 21:06:11...
Chapter 2 TL1 Command Syntax and Description Activate User (ACT-USER) Activate User (ACT-USER) This command logs the specified existing user onto the system, and begins a user session. Each session is independent, allowing a user to have multiple sessions with no interaction among sessions (requested data is delivered to the proper session).
Chapter 2 TL1 Command Syntax and Description Cancel User (CANC-USER) Cancel User (CANC-USER) This command terminates the specified user’s session, and logs the user out of the system. This command has a default access level of USER. This command’s access level cannot be changed.
Chapter 2 TL1 Command Syntax and Description Copy Memory (CPY-MEM) Copy Memory (CPY-MEM) This command saves a module’s Istate (instrument state) in another module’s memory. IOC Istate is saved in IMC FLASH and IMC Istate is saved in IOC RAM. This command has a default access level of ADMIN.
Page 37
Chapter 2 TL1 Command Syntax and Description Copy Memory (CPY-MEM) Caution: If an IMC Istate is copied from an IOC module to the IMC module and that IState contains a different user list, ensure that the <uids> and <pids> are known to avoid being locked out of the system.
Chapter 2 TL1 Command Syntax and Description Delete Performance Monitoring Data (DLT-PM-DATA) Delete Performance Monitoring Data (DLT-PM-DATA) This command deletes the current set of performance monitoring data for one input channel. All Performance Data associated with the specified input is erased. This command has a default access level of USER.
Chapter 2 TL1 Command Syntax and Description Delete Security (DLT-SECU) Delete Security (DLT-SECU) This command deletes all of the information from the user database. This command has a default access level of SECURITY. Syntax DLT-SECU:[<tid>]::[<ctag>]; Note: The DLT-SECU command is typically used only after the initial installation of the TimeProvider.
Chapter 2 TL1 Command Syntax and Description Delete User Security (DLT-USER-SECU) Delete User Security (DLT-USER-SECU) This command allows a security-level user to delete any user in the user list. Note: The system does not allow the last security-level user to be deleted if other users are defined in the system.
Chapter 2 TL1 Command Syntax and Description Edit Circuit Identifier (ED-CKTID) Edit Circuit Identifier (ED-CKTID) This command edits the name of the equipment connected to the input or the output of the TimeProvider. This command has a default access level of ADMIN. This command’s access level cannot be changed.
Chapter 2 TL1 Command Syntax and Description Edit Command Security (ED-CMD-SECU) Edit Command Security (ED-CMD-SECU) This command changes the access level of the specified command. Note: The access level for the following commands is fixed and cannot be changed: ACT-USER, CANC-USER, ED-CMD-SECU, ED-USER-SECU, and ENT-USER-SECU.
Page 43
Chapter 2 TL1 Command Syntax and Description Edit Command Security (ED-CMD-SECU) Example To change the access level of the Retrieve Log (RTRV-LOG) command to ADMIN: Input ED-CMD-SECU::RTRV-LOG:TP1000::ACCLVL=ADMIN; Normal Response TP-SSU 05-02-10 3:35:56 TP1000 COMPLD Autonomous Message TP-SSU 05-02-10 13:35:56 A 2534 REPT EVT "IMC,EQPT:ACCLVL,TC,05-02-10,13-35-56,,,,:\"USER ACCESS LEVEL HAS CHANGED, RTRV-LOG\""...
Chapter 2 TL1 Command Syntax and Description Edit Date (ED-DAT) Edit Date (ED-DAT) This command changes the system date and time. If the date and time is set by GPS, the date and time cannot be changed. The local time offset can always be changed even after the time is changed by GPS.
Chapter 2 TL1 Command Syntax and Description Edit Equipment (ED-EQPT) Edit Equipment (ED-EQPT) This command is used to provision equipment parameters. To provision NTP parameters, see ED-EQPT for NTP Parameters, on page 51. This command has a default access level of ADMIN. Syntax ED-EQPT:[<tid>]:<aid>:[<ctag>]::<keyword>[=<value>];...
Chapter 2 TL1 Command Syntax and Description Edit Equipment (ED-EQPT) Description Parameter Value Table 2-5 for <keyword> and <value> descriptions. <aid> E422g The command’s effect is on the EIA-422 output group cont’d specified by g: g = “A” for the group marked “A” on the main shelf g = “B”...
Page 47
Chapter 2 TL1 Command Syntax and Description Edit Equipment (ED-EQPT) Table 2-5. ED-EQPT – Keywords and Values (Continued) <keyword> <value> Description Default <aid> = COML | COMR only BAUD 2400 The specified serial port’s baud rate is set to 2400 baud. 9600 9600 The specified serial port’s baud rate is set to 9600 baud.
Page 48
Chapter 2 TL1 Command Syntax and Description Edit Equipment (ED-EQPT) Table 2-5. ED-EQPT – Keywords and Values (Continued) <keyword> <value> Description Default ST2 / The assumed SSM quality level for the Rubidium IOC TYPEI / CLKTYPE TYPEII card’s clock is set to either ANSI stratum 2 traceable TYPEII Rubidium (ST2) or ETSI Type 2 (TYPEII) traceable.
Page 49
Chapter 2 TL1 Command Syntax and Description Edit Equipment (ED-EQPT) Table 2-5. ED-EQPT – Keywords and Values (Continued) <keyword> <value> Description Default <aid> = PRS INSTATE ENABLE The specified input is enabled. DISABLE DISABLE The specified input is disabled. MONITOR The specified input is in monitor-only mode. Note: In monitor-only mode, the input is monitored for signal faults and the performance of the input is monitored, but the input cannot be selected as a system...
Page 50
Chapter 2 TL1 Command Syntax and Description Edit Equipment (ED-EQPT) Example To enable Output Group B: Input ED-EQPT::OUTB:TP1000::OUTSTATE=ENABLE; Normal Response TP-SSU 05-02-10 13:35:56 TP1000 COMPLD Autonomous Message TP-SSU 05-02-10 13:35:56 A 2537 REPT EVT "OUTB,EQPT:OUTSTATE,TC,05-02-10,13-35-56,,,,:\"OUTPUT GROUP STATE HAS CHANGED, ENABLED\"" TimeProvider TL1 Reference Guide 097-58001-01 Revision E –...
Chapter 2 TL1 Command Syntax and Description ED-EQPT for NTP Parameters ED-EQPT for NTP Parameters There are two sets of ED-EQPT commands to set up the NTP option on the TimeProvider: Peer Server Authentication These commands have a default access level of ADMIN. Configuring the Peer Server When you set the <func>...
Page 52
Chapter 2 TL1 Command Syntax and Description ED-EQPT for NTP Parameters Normal Response TP-SSU 3-05-15 10-04-32 A 1166 REPT EVT “NTP,EQPT:SERVER,TC, 3-05-15 10-04-32,,,,:\NTP SERVER CONFIGURATION HAS CHANGED,192.168.10.1,0,16,1024,NO” Enabling NTP Authentication This command enables or disables the use of the KeyID/Key pairs. Syntax ED-EQPT:[<tid>]:NTP:[<ctag>]::AUTHEN=<value>;...
Page 53
Chapter 2 TL1 Command Syntax and Description ED-EQPT for NTP Parameters Syntax ED-EQPT:[<tid>]:NTP:[<ctag>]::KEYGEN,<func>,<keyid>[,<key>]; <keyword> <value> Description Default FUNC ADD | DELETE Key to be added, deleted, or modified | MODIFY 32-character Authentication key Null ASCII value KEYID 1 to 65534 The Authentication identification value Example To add an NTP authentication key:...
Chapter 2 TL1 Command Syntax and Description Edit Password (ED-PID) Edit Password (ED-PID) This command allows users to edit their own password in the user database. This command has a default access level of USER. Syntax ED-PID:[<tid>]:<uid>:[<ctag>]::<oldpid>,<newpid>; Parameter Value Description <uid>...
Chapter 2 TL1 Command Syntax and Description Edit Sync (ED-SYNC) Edit Sync (ED-SYNC) This command changes factory settings and input and output port parameter settings that can influence how the system’s signal synchronization operates. This command has a default access level of ADMIN. Syntax ED-SYNC:[<tid>]:<aid>:[<ctag>]::<keyword>=<value>;...
Chapter 2 TL1 Command Syntax and Description Edit Sync (ED-SYNC) Table 2-6. ED-SYNC – Keywords and Values <keyword> <value> Description Default <aid> = SYS CLRDELAY 0 – 1000 The time, in seconds, that elapses after a signal fault clears and before the associated alarm condition clears.
Page 57
Chapter 2 TL1 Command Syntax and Description Edit Sync (ED-SYNC) Table 2-6. ED-SYNC – Keywords and Values (Continued) <keyword> <value> Description Default <aid> = GPS QLEVEL The user-assigned quality level of the GPS input is specified as PRC/PRS (primary reference Note: QLEVEL is clock/source).
Page 58
Chapter 2 TL1 Command Syntax and Description Edit Sync (ED-SYNC) Table 2-6. ED-SYNC – Keywords and Values (Continued) <keyword> <value> Description Default FRMTYPE 1.544M The PRS input frequency is provisioned as 1.544 MHz. The PRS input frequency is provisioned as 2 MHz (2048 kHz).
Page 59
Chapter 2 TL1 Command Syntax and Description Edit Sync (ED-SYNC) Table 2-6. ED-SYNC – Keywords and Values (Continued) <keyword> <value> Description Default SSMENA ENABLE The input is provisioned to read the received SSM. DISABLE DISABLE The input is provisioned to not read (ignore) the received SSM.
Page 60
Chapter 2 TL1 Command Syntax and Description Edit Sync (ED-SYNC) Table 2-6. ED-SYNC – Keywords and Values (Continued) <keyword> <value> Description Default FRMTYPE ISOLATED_ The framing type generated by the specified output (cont’d) group is provisioned as an ‘isolated one’ test pattern. FREEFLT Outputs are generated based on system SSM when SQUELCH...
Page 61
Chapter 2 TL1 Command Syntax and Description Edit Sync (ED-SYNC) Table 2-6. ED-SYNC – Keywords and Values (Continued) <keyword> <value> Description Default HOLDFLT CUTTHRU Cut-thru mode is engaged when the Local Oscillator RETIME enters Holdover mode. RETIME Cut-thru mode is not engaged when the Local Oscillator enters Holdover mode.
Chapter 2 TL1 Command Syntax and Description Edit User Security (ED-USER-SECU) Edit User Security (ED-USER-SECU) This command changes the specified user’s access level. This command has a default access level of SECURITY. This command’s access level cannot be changed. Syntax ED-USER-SECU:[<tid>]:<uid>:[<ctag>]::<keyword>=<value>;...
Chapter 2 TL1 Command Syntax and Description Enter Password (ENT-PID) Enter Password (ENT-PID) This command allows a security-level user to edit any user’s password in the user database. This command has a default access level of SECURITY. Syntax ENT-PID:[<tid>]:<uid>:[<ctag>]::<newpid>; Parameter Value Description <uid>...
Chapter 2 TL1 Command Syntax and Description Enter User Security (ENT-USER-SECU) Enter User Security (ENT-USER-SECU) This command enters a new user in the user database. Notes: Up to 20 users can be stored in the user database. With no users defined, anyone connecting to the system has access to all commands.
Page 65
Chapter 2 TL1 Command Syntax and Description Enter User Security (ENT-USER-SECU) Example To add a user "FRANKJ" to the system, with a case-sensitive password of "GyRo%23" and an access level of USER: Input ENT-USER-SECU::FRANKJ:TP1000::”GyRo%23”,USER; Normal Response TP-SSU 05-02-10 13:35:56 TP1000 COMPLD Autonomous Message TP-SSU 05-02-10 13:35:56 A 2560 REPT EVT...
Chapter 2 TL1 Command Syntax and Description Initialize Event Log (INIT-LOG) Initialize Event Log (INIT-LOG) This command clears the event log on the IMC module. This command has a default access level of ADMIN. Syntax INIT-LOG:[<tid>]:<aid>:[<ctag>]; Parameter Value Description <aid> The command’s effect is on the Information Management Card module.
Chapter 2 TL1 Command Syntax and Description Initialize System (INIT-SYS) Initialize System (INIT-SYS) This command initializes the specified module, or the system. Caution: This command causes the local oscillator in the specified IOC to enter the Warm-up mode; the outputs are squelched until the system enters FAST-LOCK.
Page 68
Chapter 2 TL1 Command Syntax and Description Initialize System (INIT-SYS) Example To perform a reset on the IOC2 module: Input INIT-SYS::IOC2:TP1000::RESET; Normal Response TP-SSU 05-02-10 13:35:56 TP1000 COMPLD Autonomous Message TP-SSU 05-02-10 13:35:56 258 REPT EVT "IOC2,EQPT:RESET,TC,05-02-10,13-35-56,,,,:\"MODULE HAS BEEN RESET\"" TimeProvider TL1 Reference Guide 097-58001-01 Revision E –...
Chapter 2 TL1 Command Syntax and Description Operate Alarm Cutoff (OPR-ACO-ALL) Operate Alarm Cutoff (OPR-ACO-ALL) This command deactivates (opens) the minor, major, and critical audible alarm relays. Note: When you deactivate the audible alarm relays using this command, they reactivate when subsequent alarms occur. This command has a default access level of USER.
Chapter 2 TL1 Command Syntax and Description Ping (PING) Ping (PING) This command allows the TimeProvider to test (ping) for network connectivity. This command has a default access level of USER. Syntax PING:[<tid>]::[<ctag>]::<ipaddr>; Parameter Value Description <ipaddr> IP dot notation The IP address of the host system to be pinged from the TimeProvider.
Chapter 2 TL1 Command Syntax and Description Remove Equipment (RMV-EQPT) Remove Equipment (RMV-EQPT) This command allows the user to confirm that a redundant IOC, Output module, Retimer module, Expansion Panel, or TPIU that was connected to the system when it started up has been removed from the system and to clear the associated alarm. If you issue the RMV-EQPT command before your physically remove the equipment, then the alarm associated with the removal is silenced.
Page 72
Chapter 2 TL1 Command Syntax and Description Remove Equipment (RMV-EQPT) <aid> <keyword> Description RTMg Clears currently active RTMgEQPT alarms from the Retimer (cont’d) module specified by g, if the module is not to be replaced: g = “A” for the group marked “A” on the main shelf g = “B”...
Chapter 2 TL1 Command Syntax and Description Retrieve Alarm Condition (RTRV-ALM) Retrieve Alarm Condition (RTRV-ALM) This command retrieves information on currently active alarms. This command has a default access level of USER. Syntax RTRV-ALM:[<tid>]:[<aid>]:[<ctag>]; Parameter Value Description <aid> Retrieves information for all alarms that are currently active (or null) in the entire system.
Chapter 2 TL1 Command Syntax and Description Retrieve Alarm Condition (RTRV-ALM) Parameter Value Description <aid> E422g Retrieves information for all currently active alarms from the (cont’d) specified EIA-422 output module. g = “A” for the group marked “A” on the main shelf g = “B”...
Page 75
Chapter 2 TL1 Command Syntax and Description Retrieve Alarm Condition (RTRV-ALM) Example To display all currently active alarms from the system: Input RTRV-ALM::ALL:TP1000; Response Example TP-SSU 05-02-10 13:37:39 TP1000 COMPLD "SYS,EQPT:MJ,EXPFAIL,SA,05-02-10,13-37-39,,:\"EXPANSION CONNECTIVITY FAILED\"" "IOC1,EQPT:MJ,CLKHOLD,SA,05-02-10,13-37-39,,:\"CLOCK ENTERED HOLDOVER MODE\"" "IOC2,EQPT:MJ,CLKHOLD,SA,05-02-10,13-37-39,,:\"CLOCK ENTERED HOLDOVER MODE\"" Autonomous Message None 097-58001-01 Revision E –...
Chapter 2 TL1 Command Syntax and Description Retrieve Attribute (RTRV-ATTR) Retrieve Attribute (RTRV-ATTR) This command retrieves the alarm level set for a specified alarm. This command has a default access level of USER. Syntax RTRV-ATTR:[<tid>]:[<aid>]:[<ctag>][::<keyword>]; Description Parameter Value Table 2-10 for <keyword>...
Chapter 2 TL1 Command Syntax and Description Retrieve Attribute (RTRV-ATTR) Description Parameter Value Table 2-10 for <keyword> descriptions. <aid> OUTg Retrieves the alarm level(s) set for all alarms related to the cont’d specified Output module. g = “A” for the group marked “A” on the main shelf g = “B”...
Chapter 2 TL1 Command Syntax and Description Retrieve Attribute (RTRV-ATTR) Table 2-11. RTRV-ATTR Output Fields Field Description alarm id The identifier of the alarm for which the level is displayed. Note: See Table B-1 for the possible alarm identifiers. alarm level The level for the specified alarm.
Chapter 2 TL1 Command Syntax and Description Retrieve BesTime Status (RTRV-BESTIME-STAT) Retrieve BesTime Status (RTRV-BESTIME-STAT) This command displays the BesTime status, the data indicates predicted BesTime ensemble information. This command has a default access level of USER. Syntax RTRV-BESTIME-STAT:[tid]:<aid>:[<ctag>]; Parameter Value Description <aid>...
Page 80
Chapter 2 TL1 Command Syntax and Description Retrieve BesTime Status (RTRV-BESTIME-STAT) Example To display the BesTime status of IOC1: Input RTRV-BESTIME-STAT::IOC1:TP1000; Response Example TP-SSU 05-02-04 21 TP1000 COMPLD "IOC1-SYS:250ns" "IOC1-PRS:0.85" "IOC1-INP1:0.00" "IOC1-INP2:0.00" "IOC1-LO:0.15" Autonomous Message None TimeProvider TL1 Reference Guide 097-58001-01 Revision E –...
Chapter 2 TL1 Command Syntax and Description Retrieve Built-In Self Test (RTRV-BIST) Retrieve Built-In Self Test (RTRV-BIST) This command displays all currently active faulted built-in self test information for either the IMC or IOC or both. This command has a default access level of USER. Syntax RTRV-BIST:[tid]:<aid>:[<ctag>];...
Chapter 2 TL1 Command Syntax and Description Retrieve Built-In Self Test (RTRV-BIST) Table 2-13. Retrieve Built-In Self Test Output Fields Value Description RAM FAULT IMC condscr NVRAM FAULT GPS 1PPS FAULT (may occur during IOC startup) NETWORK FAULT SOFTWARE FAULT UNKOWN FAULT [fault number] NO FAULTS OUTPUT GROUP A CALIBRATION FAULT...
Page 83
Chapter 2 TL1 Command Syntax and Description Retrieve Built-In Self Test (RTRV-BIST) Example To display the currently active faulted built-in self test information for IOC1: Input RTRV-BIST::IOC1:TP1000; Response Example TP-SSU 05-02-10 13:35:56 TP1000 COMPLD IOC1 BIST OUTPUT GROUP A FAULT E1 PLL UNLOCKED IMC POWER SUPPLY FAULT Autonomous Message...
Chapter 2 TL1 Command Syntax and Description Retrieve Circuit Identification (RTRV-CKTID) Retrieve Circuit Identification (RTRV-CKTID) This command retrieves the circuit identification assigned to the designated aid. This command has a default access level of USER. Syntax RTRV-CKTID:[<tid>]:<aid>:[<ctag>]; Parameter Value Description <aid>...
Chapter 2 TL1 Command Syntax and Description Retrieve Command Security (RTRV-CMD-SECU) Retrieve Command Security (RTRV-CMD-SECU) This command retrieves the access level set for a specified command, or all commands. This command has a default access level of ADMIN. Syntax RTRV-CMD-SECU:[<tid>]:<cid>:[<ctag>]; Parameter Value Description...
Page 86
Chapter 2 TL1 Command Syntax and Description Retrieve Command Security (RTRV-CMD-SECU) Example To display the current access level set for all TL1 commands: Input RTRV-CMD-SECU::ALL:TP1000; Response Example TP-SSU 05-02-10 13:37:39 TP1000 COMPLD "ACT-SWDL,ADMIN" "ACT-USER,NONE" "CANC-USER,NONE" "CPY-MEM,ADMIN" "DLT-SECU,SECURITY" "DLT-USER-SECU,SECURITY" "ED-CMD-SECU,ADMIN" "ED-DAT,ADMIN" "ED-EQPT,ADMIN"...
Chapter 2 TL1 Command Syntax and Description Retrieve Condition (RTRV-COND) Retrieve Condition (RTRV-COND) This command retrieves information about the current state and status of system components. This command has a default access level of USER. Syntax RTRV-COND:[<tid>]:[<aid>]:[<ctag>]; Parameter Value Description <aid>...
Page 88
Chapter 2 TL1 Command Syntax and Description Retrieve Condition (RTRV-COND) Parameter Value Description <aid> RTMg Retrieves status of the Retimer group specified by g. (cont’d) g = “A” for the group marked “A” on the main shelf g = “B” for the group marked “B” on the main shelf g = “C”...
Chapter 2 TL1 Command Syntax and Description Retrieve Condition (RTRV-COND) Table 2-15. RTRV-COND Output Fields Field Description <aid> = SYS pwra Indicates if the IMC has detected a loss of power at the Power A(B) connection. The pwrb possible returned values can be either PWRA(B)-OK (no PWRA(B) alarm is currently active), or PWRA(B)-ALM (a PWRA(B) alarm is currently active).
Page 90
Chapter 2 TL1 Command Syntax and Description Retrieve Condition (RTRV-COND) Table 2-15. RTRV-COND Output Fields (Continued) Field Description <aid> = GPS gpsstatus The current status of the GPS input. The status can be OK (no alarms are currently active for the specified component), ALM (one or more alarms are currently active for the specified component), or UNEQUIPPED (TPIUEQPT connectivity alarm).
Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data (RTRV-CRAFT) Retrieve Craft Data (RTRV-CRAFT) This command retrieves information about the system state, clock mode of operation, input provisioning, and output provisioning. This command has a default access level of USER. Syntax RTRV-CRAFT:[<tid>]::[<ctag>];...
Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data (RTRV-CRAFT) "RTMB-2:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf> "RTMC-1:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf> "RTMC-2:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf> "RTMD-1:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf> "RTMD-2:<rtmstatus>,<rtmstate>,<rtmlbo>,<freeflt>,<holdflt>,<rtmslip>”<cr><lf> "E422A:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf> "E422B:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf> "E422C:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf> "E422D:<outstatus>,<outstate>,<frmtype>,<freeflt>,<holdflt>”<cr><lf> "NTP:AUTHENTICATION,<authen>"<cr><lf> "NTP:SERVER,<serveripl>,<keyid>,<minpoll>,<maxpoll>,>preferred>"<cr><lf> "NTP:SERVER,<serveripl>,<keyid>,<minpoll>,<maxpoll>,>preferred>"<cr><lf> Table 2-16. RTRV-CRAFT Output Fields Field Description <aid> = SYS pwra Indicates if the IMC has detected a loss of power at the Power A(B) connection. pwrb PWRA(B)-OK –...
Page 94
Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data (RTRV-CRAFT) Table 2-16. RTRV-CRAFT Output Fields (Continued) Field Description clrdelay The time that elapses after a signal fault clears and before the associated alarm condition clears. This delay helps prevent an alarm from clearing before the signal is stable. 0 | 1 | ...
Page 95
Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data (RTRV-CRAFT) Table 2-16. RTRV-CRAFT Output Fields (Continued) Field Description imccomm Indicates if a communication alarm from the IMC to the IOC2(1) module is active IMC1(2)COMM-OK – no IMC1(2)COMM alarm is currently active IMC1(2)COMM-ALM –...
Page 96
Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data (RTRV-CRAFT) Table 2-16. RTRV-CRAFT Output Fields (Continued) Field Description priority The provisioned priority level for the PRS input. 1 | 2 | 3 | 4 frmtype The PRS input frequency setting. 2M | 5M | 10M <aid>...
Page 97
Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data (RTRV-CRAFT) Table 2-16. RTRV-CRAFT Output Fields (Continued) Field Description <aid> = RTMg-p rtmstatus The current status of the specified Retimer group and port. OK | ALM | UNEQUIPPED rtmstate The state of the specified Retimer group and port. ENABLE | DISABLE rtmlbo The line buildout for the specified Retimer group and port.
Page 98
Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data (RTRV-CRAFT) Table 2-16. RTRV-CRAFT Output Fields (Continued) Field Description maxpoll The maximum time (in seconds) between Server time requests. 16 | 32 | 64 | 128 | 256 | 512 | 1024 preferred The Preferred Server setting.
Chapter 2 TL1 Command Syntax and Description Retrieve Date (RTRV-DAT) Retrieve Date (RTRV-DAT) This command retrieves the system date, time, and local offset. This command has a default access level of USER. Syntax RTRV-DAT:[<tid>]:<aid>:[<ctag>]; Parameter Value Description <aid> The command’s effect is at the system level. Command Output The following shows the output format of the command, and Table 2-17...
Page 100
Chapter 2 TL1 Command Syntax and Description Retrieve Date (RTRV-DAT) Example To display the currently set system date, time, and local offset: Input RTRV-DAT::SYS:TP1000; Normal Response TP-SSU 05-02-10 13:37:39 TP1000 COMPLD "SYS:05-02-10 13:37:39,00-00" Autonomous Message None 100 TimeProvider TL1 Reference Guide 097-58001-01 Revision E –...
Chapter 2 TL1 Command Syntax and Description Retrieve Equipment (RTRV-EQPT) Retrieve Equipment (RTRV-EQPT) This command retrieves currently provisioned equipment parameters. This command has a default access level of USER. Note: See Edit Equipment (ED-EQPT), on page 45 for <keywords> and descriptions of their possible <values>. Syntax RTRV-EQPT:[<tid>]:<aid>:[<ctag>]::<keyword>;...
Chapter 2 TL1 Command Syntax and Description Retrieve Equipment (RTRV-EQPT) Parameter Value Description <aid> Equipment settings for the NTP: cont’d Peer Server Authentication Note: See ED-EQPT for NTP Parameters, on page 51 for <keywords> and descriptions of their possible <values>. Normal Retrieve Response <cr><lf><lf>...
Chapter 2 TL1 Command Syntax and Description Retrieve GPS Status (RTRV-GPS-STAT) Retrieve GPS Status (RTRV-GPS-STAT) This command displays the position of the GPS receiver, UTC time and status information for each of the GPS satellites in view. This command has a default access level of USER. Syntax RTRV-GPS-STAT:[<tid>]::[<ctag>];...
Chapter 2 TL1 Command Syntax and Description Retrieve Header (RTRV-HDR) Retrieve Header (RTRV-HDR) This command displays the response header information, which includes the system identifier (<sid>), and the system date and time. It can be used to verify operation of the communication link between the TimeProvider and the computer. This command has a default access level of NONE.
Chapter 2 TL1 Command Syntax and Description Retrieve Inventory (RTRV-INV) Retrieve Inventory (RTRV-INV) This command retrieves the system inventory. This command has a default access level of USER. Syntax RTRV-INV:[<tid>]::[<ctag>]; Table 2-20. RTRV-INV Output Fields Field Description The module’s part number. The module’s serial number.
Page 106
Chapter 2 TL1 Command Syntax and Description Retrieve Inventory (RTRV-INV) Example To display the current system inventory: Input RTRV-INV:::TP1000; Response Example TP-SSU 05-02-10 13:37:39 TP1000 COMPLD "IMC:,12345,,,1.02.01.build.16,00-60-08-00-A0-6E" "IOC1:090-58021-02,C12345,CLEI012345,B,1.02.07" "IOC2:090-58022-02,C12345,CLEI012345,B,1.02.07" "RTMA:090-5802x-02,C12345,CLEI012345 "RTMB:,,," "RTMC:,,," "RTMD:,,," "E422A:090-58071-02,C12345,CLEI012345,A" "E422B:,,," "E422C:,,," "E422D:,,," Autonomous Message None 106 TimeProvider TL1 Reference Guide 097-58001-01 Revision E –...
Chapter 2 TL1 Command Syntax and Description Retrieve LED Status (RTRV-LED) Retrieve LED Status (RTRV-LED) This command retrieves the current state (color) of the various LED indicators that are on the panels of the IMC and IOC modules. This command has a default access level of USER. Syntax RTRV-LED:[<tid>]:[<aid>]:[<ctag>];...
Page 108
Chapter 2 TL1 Command Syntax and Description Retrieve LED Status (RTRV-LED) Note: Refer to the TimeProvider User Guide (097-58001-02) for a description of the various LED indicator states and for troubleshooting procedures using the LEDs. Example To display the current state of all IMC and IOC module LED indicators: Input RTRV-LED:::TP1000;...
Chapter 2 TL1 Command Syntax and Description Retrieve Log (RTRV-LOG) Retrieve Log (RTRV-LOG) This command displays all events in the event log in chronological order (first in, first out). The event log contains the last 500 alarmed and non-alarmed events. Note: Alarms with an alarm level set to NONE are not stored in the event log.
Chapter 2 TL1 Command Syntax and Description Retrieve Log (RTRV-LOG) Table 2-22. RTRV-LOG – Keywords for all <aids> <keyword> Description Value ALL (or null) Retrieves both alarmed and non-alarmed events for the specified aid. Retrieves non-alarmed events for the specified aid. Retrieves alarmed events for the specified aid.
Chapter 2 TL1 Command Syntax and Description Retrieve Log (RTRV-LOG) Table 2-23. RTRV-LOG Event Output Fields (Continued) Field Description ocrtim The time that the event occurred, in the format HH:MM:SS. condscr The description of the alarm or event. It is a quoted text string, preceded with the “\” escape character.
Page 112
Chapter 2 TL1 Command Syntax and Description Retrieve Log (RTRV-LOG) Table 2-24. RTRV-LOG Alarm Output Fields (Continued) Field Description condscr The description of the alarm or event. It is a quoted text string, preceded with the “\” escape character. Note: Table C-2 shows all of the possible TimeProvider event descriptions (event condition strings), and...
Chapter 2 TL1 Command Syntax and Description Retrieve Network Equipment Type (RTRV-NETYPE) Retrieve Network Equipment Type (RTRV-NETYPE) This command retrieves the network equipment (NE) type from the unit, in this case, “TimeProvider.” This command has a default access level of NONE. Syntax RTRV-NETYPE:::[<ctag>];...
Chapter 2 TL1 Command Syntax and Description Retrieve NTP Information (RTRV-NTP-PEER) Retrieve NTP Information (RTRV-NTP-PEER) This command retrieves the NTP Peer information for up to 8 peers. The data includes the information server IP address, the stratum level of the server, the server LI (in decimal format), the root dispersion value, and the root delay value.
Page 115
Chapter 2 TL1 Command Syntax and Description Retrieve NTP Information (RTRV-NTP-PEER) Normal Response TP-1100 06-02-14 11:01:01 0 COMPLD "172.16.21.35,1,reject,-23,3.951,4000.230,0.015,2618.640" "172.16.21.54,16,reject,-16,0.000,0.000,0.000,4000.000" "172.16.21.198,16,reject,-16,0.000,0.000,0.000,4000.000" Autonomous Message None 097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 115...
Chapter 2 TL1 Command Syntax and Description Retrieve PM (RTRV-PM) Retrieve PM (RTRV-PM) This command displays the current set of performance monitoring data for one input channel. This command has a default access level of USER. Syntax RTRV-PM:[<tid>]:<aid>:[<ctag>]::<keyword>[,[<startdat>][,<starttim>], [<stopdat>],[<stoptim]]; Parameter Value Description <aid>...
Chapter 2 TL1 Command Syntax and Description Retrieve PM (RTRV-PM) Table 2-28. RTRV-PM Output Fields Field Value Description <aid> Specified AID used in the command. <monval> The requested performance data (an absolute value). <vldty> Indicates if the data sample is considered a valid measurement by the system.
Page 118
Chapter 2 TL1 Command Syntax and Description Retrieve PM (RTRV-PM) Response Example TIMEPROVIDER 05-02-10 13:37:39 M TP1000 COMPLD "IOC1-GPS:FFOFF-60,-59,COMPL,05-02-03,19-00-32" "10,-26,83,-101,-7,25,-31,-47,-32,183" "-129,-64,-51,-27,52,-41,70,-14,-7,63" "18,-89,-12,58,40,-101,-27,103,-4,10" "-1,-21,-12,-4,-4,-7,15,-19,113,-66" "42,10,-52,70,-94,22,87,-16,-74,113" "-16,75,-51,-11,-112,220,-212,-84,107," Example To retrieve MTIE data: Input RTRV-PM::IOC1-INP-2:TP1000::MTIE; Response Format <sid> <date> <time><cr><lf> <ctag> COMPLD<cr><lf> "IOCm-INPp:MTIE-a,<monval>,<vldty>,<sampledat>,<sampletim>"<cr><lf> "IOCm-INPp:MTIE-a,<monval>,<vldty>,<sampledat>,<sampletim>"<cr><lf>...
Page 119
Chapter 2 TL1 Command Syntax and Description Retrieve PM (RTRV-PM) Input RTRV-PM::IOC1-GPS:TP1000::PHASE; Response Format <cr><lf><lf> sid date time<cr><lf> ctag COMPLD<cr><lf> "IOCm-INPp:PHASE,<monval>,<vldty>,<sampledat>,<sampletim>"<cr><lf> "<.>,<.>,<.>,<.>,<.>,<.>,<.>,<.>,<.>,<.>"<cr><lf> "<.>,<.>,<.>,<.>,<.>,<.>,<.>,<.>,<.>,<.>"<cr><lf> Response Example TIMEPROVIDER 05-02-10 13:37:39 M TP1000 COMPLD "IOC1-GPS:PHASE,93.7,COMPL,05-02-03,20-15-32" "1.8,0.8,-1.4,-1.9,-0.1,-1.8,-2.1,0.8,1.5,0.9" "0.4,1.4,1.1,-2.1,-1.9,0.1,-1.9,-2.0,0.6,0.6" "-0.2,0.2,1.5,1.1,0.9,1.8,1.0,0.3,0.2,0.0" "-0.6,0.1,0.0,0.5,1.4,0.2,-0.2,0.0,-0.9,-1.1" "-0.6,-0.3,-0.6,-0.9,-0.9,-0.9,-0.8,-1.2,-0.6,4.1" "2.9,-0.2,1.7,1.8,-0.8,-1.7,-1.3,-1.5,-1.5,0.2" Example To retrieve PHASE1S data: Notes: To select a specific set of accumulated phase data from the previous 24 hours, enter the start date (startdat), start time (starttim),...
Page 121
Chapter 2 TL1 Command Syntax and Description Retrieve PM (RTRV-PM) Example To retrieve PHASE1M data: Notes: To select a specific set of accumulated phase data from the previous 7 days, enter the start date (startdat), start time (starttim), stop date (stopdat), and stop time (stoptim). If any startdat or starttim combination is null or outside of the previous 24 hour window, the current 24-Hour 1-Minute Phase data (1 nS resolution) is displayed.
Page 122
Chapter 2 TL1 Command Syntax and Description Retrieve PM (RTRV-PM) Response Example TIMEPROVIDER 05-02-03 12:00:23 M CTAG COMPLD “IOC2-PRS:TDEV-1,0.9,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-5,0.4,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-10,0.3,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-50,0.8,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-100,1.1,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-500,1.3,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-1000,2.0,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-5000,2.2,COMPL,05-02-03,12-00-00” “IOC2-PRS:TDEV-7200,1.8,COMPL,05-02-03,12-00-00” Autonomous Message None 122 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006...
Chapter 2 TL1 Command Syntax and Description Retrieve Sync (RTRV-SYNC) Retrieve Sync (RTRV-SYNC) This command retrieves equipment parameters associated with provisioning of the synchronization interfaces for the system inputs and outputs. This command has a default access level of USER. Syntax RTRV-SYNC:[<tid>]:<aid>:[<ctag>]::<keyword>;...
Chapter 2 TL1 Command Syntax and Description Retrieve Sync (RTRV-SYNC) Normal Retrieve Response <cr><lf><lf> sid date time<cr><lf> ctag COMPLD<cr><lf> "<aid>:<keyword>,<value>"<cr><lf> Table 2-29. RTRV-SYNC Output Field Field Description <aid> The access identifier for the equipment component (Refer to Edit Sync (ED-SYNC), on page 55 for valid <aid>) <keyword>...
Chapter 2 TL1 Command Syntax and Description Retrieve System Mode (RTRV-SYS-MODE) Retrieve System Mode (RTRV-SYS-MODE) This command retrieves the TimeProvider’s currently provisioned system operating mode. The response is one of the following values: SSU – The TimeProvider is provisioned in the Synchronization Supply Unit operating mode.
Chapter 2 TL1 Command Syntax and Description Retrieve Threshold (RTRV-TH) Retrieve Threshold (RTRV-TH) This command displays the alarm level set for a particular alarm. The IOC threshold attribute information is retrieved from the Active IOC. This command has a default access level of USER. Syntax RTRV-TH:[<tid>]:<aid>:[<ctag>][::<keyword>];...
Chapter 2 TL1 Command Syntax and Description Retrieve Threshold (RTRV-TH) Table 2-30. RTRV-TH – Output Fields Field Value Description <aid> The aid associated with the PM ID <alarm threshold> MTIE-### = 1 – 100000 Performance threshold that generates an alarm, FFOFF-60 = 1 –...
Chapter 2 TL1 Command Syntax and Description Retrieve User (RTRV-USER) Retrieve User (RTRV-USER) This command lists all users that are currently logged onto the TimeProvider. Note: The TimeProvider supports up to ten simultaneous TCP connections, as well as one local and one remote serial connection. This command has a default access level of USER.
Chapter 2 TL1 Command Syntax and Description Retrieve User Security (RTRV-USER-SECU) Retrieve User Security (RTRV-USER-SECU) This command displays the access level of the specified user, or the access level of all users. This command has a default access level of SECURITY. Syntax RTRV-USER-SECU:[<tid>]:[<uid>]:[<ctag>];...
Page 130
Chapter 2 TL1 Command Syntax and Description Retrieve User Security (RTRV-USER-SECU) Example To display the current access level settings for all users that have been defined in the system: Input RTRV-USER-SECU:::TP1000; Response Example TP-SSU 05-02-10 13:37:39 TP1000 COMPLD "LEE,SECURITY" "FRANKJ,USER" "BILLG,SECURITY"...
Chapter 2 TL1 Command Syntax and Description Set Attribute (SET-ATTR) Set Attribute (SET-ATTR) This command sets the alarm level that an event generates. Use this command also to reset all alarm levels to factory settings, and to specify whether or not the system escalates alarms.
Chapter 2 TL1 Command Syntax and Description Set Attribute (SET-ATTR) Table 2-32. SET-ATTR – Keywords and Values for all <aids> <keyword> <value> Description Default BRDGTIM 300 to In PRR mode, this sets the length of time, in seconds, the (SYS aid 500000 system remains in bridging mode.
Chapter 2 TL1 Command Syntax and Description Set Source Identifier (SET-SID) Set Source Identifier (SET-SID) This command provisions the TimeProvider system’s source identifier (SID). The SID identifies the TimeProvider in the normal and error response messages it sends. This command has a default access level of ADMIN. Syntax SET-SID:[<tid>]::[<ctag>]::<keyword>=<value>;...
Chapter 2 TL1 Command Syntax and Description Set System Mode (SET-SYS-MODE) Set System Mode (SET-SYS-MODE) This command provisions the TimeProvider system’s operating mode. The following operating modes are available: SSU – The TimeProvider is provisioned in the Synchronization Supply Unit operating mode.
Page 135
Chapter 2 TL1 Command Syntax and Description Set System Mode (SET-SYS-MODE) Autonomous Message TP-SSU 05-02-10 13:35:56 396 REPT EVT "SYS,EQPT:SYSMODE,TC,05-02-10,13-35-56,,,,:\"SYSTEM MODE OF OPERATION HAS CHANGED,SUB\"" 097-58001-01 Revision E – September 2006 TimeProvider TL1 Reference Guide 135...
Chapter 2 TL1 Command Syntax and Description Set Threshold (SET-TH) Set Threshold (SET-TH) This command sets the alarm threshold for performance monitored data, for example MTIE and Fractional Frequency Offset. This command has a default access level of ADMIN. Syntax SET-TH:[<tid>]:<aid>:[<ctag>]::<keyword>[=<value>];...
Chapter 2 TL1 Command Syntax and Description Set Threshold (SET-TH) Table 2-35. SET-TH – Keywords and Values for all <aids> (Continued) <keyword> <value> Description Default FFOFF-60 100 to 10000000 Fractional Frequency Offset threshold for 60 second 10 000 000 (ps/s) calculation period, defined in ps per s SLIPCHG 0 to 255...
Page 138
Chapter 2 TL1 Command Syntax and Description Set Threshold (SET-TH) 138 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006...
Appendix A TL1 Command by Function This appendix lists the TL1 commands by function: Table A-1 contains security and administrative commands, Table A-2 contains system commands, and Table A-3 contains performance monitoring commands. Refer to Chapter 2, TL1 Command Syntax and Description for detailed information.
Appendix A Table A-2. System Commands Command Description Copy Memory (CPY-MEM), on Saves a module’s Istate in another module’s flash memory page 36 Retrieve Date (RTRV-DAT), on Retrieves the system date, time, and local offset page 99 Edit Date (ED-DAT), on page 44 Changes the system date and time Retrieve Equipment Retrieves currently provisioned equipment parameters...
Appendix A Table A-2. System Commands (Continued) Command Description Retrieve BesTime Status Displays the BesTime status, the data indicates predicted (RTRV-BESTIME-STAT), on BesTime ensemble information page 79 Retrieve Built-In Self Test Displays all currently active faulted built-in self test information (RTRV-BIST), on page 81 for either the IMC or IOC or both Retrieve Condition...
Page 142
Appendix A 142 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006...
Page 143
Appendix B Alarms Table B-1 provides a list of all alarm identifiers and a description of the alarm. The AID type indicates if the event occurred in the unit (EQPT) or externally from an input or output (T1). The table also shows if the alarm is service affecting (SA), or non-service affecting (NSA) Table B-2 is a list of alarm identifiers and conditional descriptions.
Page 144
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB IOC2EQPT IOC2EQPT indicates that EQPT NSA IMMED the IOC was physically inserted or removed from the system.
Page 145
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB CLKHOLD The local oscillator on EQPT SA IMMED the specified IOC is in Holdover Mode.
Page 146
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB CLKWARM The local oscillator on EQPT SA IMMED the specified IOC is in Warm-up mode.
Page 147
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB INPLOS The 1PPS from GPS is IMMED LOS. The LOS must be continuously present for the Fault Delay Time (FLTDELAY) before...
Page 148
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB <aid> = PRS INPDISQ The specified input was Disqualified or Qualified DELAY as a possible system reference.
Page 149
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB INPFRQ The specified input IMMED port’s calculated received frequency is exceeding the pull-in range of the local oscillator.
Page 150
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB <aid> = INP1 | INP2 INPDISQ The specified input was Disqualified or Qualified as a possible system reference.
Page 151
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB INPLOS The specified input port IMMED has Loss Of Signal. When LOS is detected, the input is removed from the possible reference list.
Page 152
Appendix B Alarms Table B-1. Alarms (Continued) Alarm Default Alarm ID Error Error Alarm Condition Service Level Delay Delay Description Type Affecting CONDTYPE Default Editable SSU PRS SUB INPFRQ The specified input port’s IMMED calculated received frequency is exceeding the pull-in range of the local oscillator.
Page 153
Appendix B Alarms Table B-2. Alarm Code Condition Descriptions Alarm ID Set Alarm Condition Description Clear Alarm Condition Description SYS Alarm Conditions COMPAT System components are incompatible System components are compatible EXPFAIL See EXPNEQPT alarm PWRA Power A Failed POWER A Restored PWRB Power B Failed POWER B Restored...
Page 154
Appendix B Alarms Table B-2. Alarm Code Condition Descriptions (Continued) Alarm ID Set Alarm Condition Description Clear Alarm Condition Description IOC1 Alarm Conditions IOCSTATE IOC State has Changed, Unequipped IOC State has Changed, Equipped SYNTHEOR Output Generator Exceeded Pull-in Range Output Generator Within Pull-in Range IOC2 Alarm Conditions IOCSTATE...
Page 155
Appendix B Alarms Table B-2. Alarm Code Condition Descriptions (Continued) Alarm ID Set Alarm Condition Description Clear Alarm Condition Description INP[p] Alarm Conditions INPDISQ Input Disqualified as Possible Reference Input Qualified as Possible Reference INPAIS AIS Fault AIS Fault Cleared INPLOS LOS Fault LOS Fault Cleared...
Page 156
Appendix B Alarms 156 TimeProvider TL1 Reference Guide 097-58001-01 Revision E – September 2006...
Page 157
Appendix C Events This appendix lists all events and describes the possible cause. Table C-1 is a list of events and descriptions and Table C-2 is a list of event code conditional descriptions. Table C-1. Event Identifiers Event ID Event Description Default Value Value Description TYPE...
Page 158
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE FLOW The IMC serial port flow EQPT NONE NONE – No flow control control has changed SW – Software flow control XON/XOFF HW –...
Page 159
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE LOGECHO Allows the system to be EQPT ENABLE ENABLE – Echo the configured to echo the login/logout events login or logout events. DISABLE –...
Page 160
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE XFEROK The transfer of IMC Istate EQPT NA to the IOC was successful. The transfer of IOC Istate to the IMC was successful. The transfer of IOC Istate to the redundant IOC was successful.
Page 161
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE INPREF The specified input was EQPT PRS GPS | PRS | INP1 | INP2 selected as system reference. The possible references includes PRS, INP1, or INP2.
Page 162
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE IOC Clock Event Codes CLKFSTLK The local oscillator on the EQPT NA specified IOC is in Fast-Lock mode CLKLOCK The local oscillator on the EQPT NA specified IOC is in Lock mode...
Page 163
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE INSTATE The state of the input ENABLE DISABLE – Disabled inputs, ports used by the system associated active alarms are cleared. ENABLE – Enabled inputs, are available as system reference.
Page 164
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE SSMENA Allows the user to DISABLE ENABLE – Enable the reading provision the ESF or E1 of SSM (CAS/CCS) input to read DISABLE –...
Page 165
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE SSMBIT Allows the user to 4 | 5 | 6 | 7 | 8 | ALL provision E1 bit position and generate SSMs on the specified bit position.
Page 166
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE KEYGEN Indicated that the EQPT NA Authentication Key table is being generated SERVER Indicates that a user has EQPT NA changed the NTP Peer Server parameters.
Page 167
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE INPREF Indicates when the PRS – Select PRS input system automatically INP1 – Select Input 1 selects a new reference INP2 – Select Input 2 input.
Page 168
Appendix C Events Table C-1. Event Identifiers (Continued) Event ID Event Description Default Value Value Description TYPE CONDTYPE HOLDFLT Defines if the Retimer CUTTHRU RETIMER – In fault mode the mode operates or not output signals are retimed when the LO enters CUTTHRU –...
Page 169
Appendix C Events Table C-2. Event Code Condition Descriptions (Continued) Event ID Event Condition Description FLOW SERIAL FLOW CONTROL HAS CHANGED, <state> FWFAIL FIRMWARE UPGRADE UNSUCCESSFUL FWOK FIRMWARE UPGRADE SUCCESSFUL FWLOAD BEGINNING FIRMWARE UPGRADE IMCBIST BUILT-IN SELF TEST, <value> INITLOG EVENT LOG HAS BEEN CLEARED IPADDR IP ADDRESS HAS CHANGED, <value>...
Page 170
Appendix C Events Table C-2. Event Code Condition Descriptions (Continued) Event ID Event Condition Description FWOK FIRMWARE UPGRADE SUCCESSFUL FWLOAD BEGINNING FIRMWARE UPGRADE IOCMODE IOC MODE IS. <mode> IOCSTATE IOC STATE HAS CHANGED, <state> RESET MODULE HAS BEEN RESET IOC Clock Event Conditions CLKFSTLK CLOCK ENTERED FAST-LOCK MODE CLKLOCK...
Page 171
Appendix C Events Table C-2. Event Code Condition Descriptions (Continued) Event ID Event Condition Description SSMENA OUTPUT GENERATION OF SSM HAS CHANGED, <value> EIA-422 Output Event Conditions CKTIDCHG OUTPUT CIRCUIT ID HAS CHANGED, <cktid> FREEFLT FREE-RUN OUTPUT FAULT STRATEGY HAS CHANGED, <state> FRMTYPE OUTPUT FRAMING TYPE HAS CHANGED, <value>...
Page 172
Appendix C Events Table C-2. Event Code Condition Descriptions (Continued) Event ID Event Condition Description HOLDFLT HOLDOVER OUTPUT FAULT STRATEGY HAS CHANGED, <state> RTMLBO PORT LBO HAS CHANGED, <value> RTMSTATE PORT STATE HAS CHANGED, <value> SLIPCHG SLIP THRESHOLD HAS CHANGED, <value> SLIPCLR SLIP COUNTER HAS BEEN CLEARED 172 TimeProvider TL1 Reference Guide...
Page 173
Index Symbols—C Index Symbols <sid> BAUD keyword retrieving baud rate setting retrieving setting BIST, retrieving results BRDGTIM keyword access levels, default command – access levels, user ACCLVL keyword ACT-FEATURE command CANC-USER command activating NTP cautions defined active mode, IOC, setting circuit identifier ACT-SWDL command editing...
Need help?
Do you have a question about the TimeProvider 1100 and is the answer not in the manual?
Questions and answers