Home

TimeProvider 1000 and 1100 Edge Clock

1. tT TIMEPROVIDER 08 03 24 00 40 13 M 0 COMPLD SNMPSHANONEINF NONE SNMPSHA 11 22 33 44 10 SNMPMD 5DESSEC1234567 SECURITY SNMPMD5DES SNMPMD5SEC1234567890 SECURITY SNMPMD5 138 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve User Security RTRV USER SECU SNMP SHASEC1234567890 SECURITY SNMPSHA SNMP SHADESSEC1234567 SECURITY SNMPSHADES SNMPMD5DESADM1234567 ADMIN SNMPMD5DES SNMP SHADESUSER123456 USER SNMPSHADES SNMPMD5NO 23456789 NONE SNMPMD5 SNMPSHADESSECINF SECURITY SNMPSHADES AA BB CC DD EE 59 SNMPMD5DESNONEINF NONE SNMPMD5DES 11 22 33 44 55 66 42 SNMPV1LNONETRAP123456 NONE SNMPV1 SNMPV2CSECNOTIF12345 SECURITY SNMPV2C SNMPV2CADMINF1234567 ADMIN SNMPV2C Recommendation To keep user names and user types clearly defined Symmetricom recommends that you add the user type TL1 SNMP etc to the user name Examples of these user names are shown in the Response Example above 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 139 Chapter 2 TL1 Command Syntax and Description Set Attribute SET ATTR Set Attribu
2. Command Name Command Type Access Lovel ACT FEATURE Administrative ADMIN ACT SWDL Administrative ADMIN ACT USER Session NONE CANC USER Session USER 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 ADMIN ED EQPT System ADMIN ED PID Administrative USER ED SYNC System ADMIN ED USER SECU Administrative SECURITY ENT PID Administrative SECURITY ENT USER SECU Administrative SECURITY INIT LOG System ADMIN INIT SYS System ADMIN OPR ACO ALL System USER PING Session USER RMV EQPT System USER RTRV ALM System USER RTRV ATTR System USER RTRV BESTIME STAT Administrative USER RTRV BIST System USER RTRV CKTID System USER RTRV CMD SECU Administrative ADMIN 24 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table 1 6 TimeProvider TL1 Command Types and Access Levels Continued Factory Set Chapter 1 TL1 Overview Command Security Command Name Command Type N EERE RTRV COND System USER RTRV CRAFT System USER RTRV DAT System USER RTRV EQPT System USER RTRV GPS STAT System USER RTRV HDR System NONE RTRV INV System USER RTRV LED System USER RTRV LOG Administrative USER RTRV NETYPE System NONE RTRV NTP PEER System USER RTRV PM System USER RTRV SYNC Sy
3. iocstatus The current status of the specified IOC module OK ALM ioccomm Indicates if a communication alarm from the IOC1 2 to the IOC2 1 module is active m 10C01 2 TO2 1 COMM OK no 10C1 2 TO2 1 COMM alarm is currently active a 10C01 2 TO2 1 COMM ALM an l1OC1 2 TO2 1 COMM alarm is currently active imccomm Indicates if a communication alarm from the IMC to the IOC2 1 module is active a IMC1 2 COMM OK no IMC1 2 COMM alarm is currently active a IMC1 2 COMM ALM an IMC1 2 COMM alarm is currently active iocstate The service mode of the IOC module INSERV OOSRV iocmode Indicates if the IOC module is active ACTIVE STANDBY clkmode The current mode of the local oscillator on the IOC module WARMUP FREERUN FASTLOCK BRIDGING HOLDOVER LOCKED clktype The assumed SSM quality level for the IOC module s clock ST3E TYPE ST2 TYPEIII scavail SmartClock is available ON OFF lt aid gt GPS gpsstatus The current status of the GPS OK ALM instate The state of the GPS input ENABLE DISABLE MONITOR qlevel The provisioned quality level for the GPS input 1 2 9 priority The provisioned priority level for the GPS input 1 2 3 4 utc Universal Coordinated Time setting The format is HH MM SS where HH is the hour in 24 hour format MM is the minutes and SS is the seconds 102 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and D
4. lt keyword gt lt value gt Description Default ACCLVL NONE The specified user is assigned an access level of NONE N A Note With an access level of NONE users can receive autonomous messages but have very limited command access USER The specified user has USER access and can issue commands having an access level of NONE or USER ADMIN The specified user has ADMIN access and can issue commands having an access level of NONE USER or ADMIN SECURITY The specified user has SECURITY access and can issue all commands AUTHPROT MD5 SHA Specifies the authentication type for the specified SNMPvs3 principal AUTHPASS text string Changes the authentication password for the specified user Enclose the string in double quotes if the password is case sensitive Minimum length is 8 characters maximum is 64 characters Notes The following characters are not allowed space colon semicolon dash single quote and double quote a Leave this field blank for SNMP v1 and v2 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 65 Chapter 2 TL1 Command Syntax and Description Edit User Security ED USER SECU Table 2 7 ED USER SECU Keyword and Values for lt uid gt text string Continued lt keyword gt lt value gt Description Default PRIVPASS text string Changes the privacy password for SNMPV3 users with privacy Enclose the string in double quo
5. Field Description aidtype Specifies if the event is associated with the internal operation of the system EQPT or external to the system or facility T1 ntfencde The notification code for the alarm or event The notification code can be CR critical alarm MJ major alarm MN minor alarm CL clearing event or NA non alarmed event or report condtype The TL1 alarm or event code that is associated with the event or alarm Note Table C 2 shows all of the possible TimeProvider event codes event condition types and Table B 2 shows all of the possible TimeProvider alarm condition types condeff Defines the effect of the event on the system CL indicates clearing of a standing condition SC indicates a standing condition is raised and TC indicates a transition of a condition ocrdat The date the event occurred in the format YY MM DD 118 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 Note Table C 2 shows all of the possible TimeProvider event codes event condition strings and Table B 2 shows all of the possible TimeProvider alarm condition types Input RT
6. lt ctag gt lt keyword gt Parameter Value Description lt aid gt SYS Equipment settings for system level COMp Equipment settings for the communication port specified by p a p L for the local serial port p R for the remote serial port p forthe IP Ethernet port IOCm Equipment settings for the IOC module specified by m a m 1 for the slot marked IOC 1 on the main shelf m 2 for the slot marked IOC 2 on the main shelf GPS Equipment settings for the GPS system input PRS Equipment settings for the PRS system input INPp Equipment settings for the input port specified by p p 1 for the input marked INP 1 on the Input Connector module a p 2 for the input marked INP 2 on the Input Connector module OUTg Equipment settings for the output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf E4229 Equipment settings for the EIA 422 output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf 097 58001 01 Revision G April 2008 TimePro
7. w m IN U SECURITY ENT PID SECURITY ENT USER SECU SECURITY INIT LOG ADMIN INIT SYS ADMIN OPR ACO ALL USER PING USER RTRV ALM USER RTRV ATTR USER RTRV CMD SECU ADMIN RTRV COND USER RTRV CRAFT USER RTRV DAT USER RTRV EQPT USER RTRV HDR NONE RTRV INV USER RTRV LED USER RTRV LOG ADMIN RTRV MANF INFO SECURITY RTRV NETYPE NONE RTRV SYNC USER RTRV SYS MODE USER RTRV USER USER RTRV USER SECU SECURITY SET ATTR ADMIN SET SID ADMIN SET SYS MODE Al Autonomous Message None 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 93 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 lt tid gt lt aid gt lt ctag gt or RTRV COND ALL lt tid gt lt aid gt lt ctag gt Parameter Value Description lt aid gt null or Retrieves all state and status information for the entire ALL system SYS Retrieves expansion panel connectivity status and any alarm events associated with the expansion panel Note This informatio
8. IMC EVT EQPT PIDCHG TC 05 02 10 13 35 56 USER PASSWORD HAS CHANGED D TP SSU 05 02 10 13 35 56 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 57 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 lt tid gt lt aid gt lt ctag gt lt keyword gt lt value gt Parameter Value Dercnpiion See Table 2 6 for lt keyword gt and lt value gt descriptions lt aid gt SYS The command s effect is on system level input settings GPS The command s effect is on the GPS system input PRS The command s effect is on the PRS system input INPp The command s effect is on the input port specified by p a p 1 forthe input marked INP 1 on the Input Connector module p 2 for the input marked INP 2 on the Input Connector module OUTg The command s effect is on the output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf RTMog p The command s effect is on the Reti
9. SNMP MGR5 lt mgr5 gt lt sender5 gt lt iftout5 gt lt ifretry5 gt SNMP lt snmpport gt lt trapport gt Table 2 16 RTRV CRAFT Output Fields Field Description lt aid gt SYS pwra Indicates if the IMC has detected a loss of power at the Power A B connection pwrb a PWRA B OK no PWRA B alarm is currently active PWRA B ALM a PWRA B alarm is currently active expneqpt Indicates if the connection to the expansion output panel was lost a EXP OK no EXPFAIL alarm is currently active m EXP ALM an EXPFAIL alarm is currently active extalm1 Indicates if external equipment is currently generating alarm s extalm2 a EXT1 2 OK no EXTALM1 2 alarm is currently active a EXT1 2 ALM an EXTALM1 2 alarm is currently active ioc1eqpt Indicates if the system is equipped with an IOC module in the specified slot ioc2eqpt a 10C1 2 EQPT an lOC1 2 EQPT event was received 10C1 2 UNEQPT no lOC1 2 EQPT event was received sysqlevel Indicates the system output quality level 1 through 9 lastdat The date the system was last provisioned by a user The format is 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 lasttim The time the system was last provisioned by a user The format is HH MM SS where HH is the hour in 24 hour format MM is the minutes and SS is the seconds syncmode The TimeProvider system s currently p
10. 2 for Port 2 on the Retimer module E4229 Retrieves information for all currently active alarms from the specified EIA 422 output module g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf Command Output The following shows the output format of the command and Table 2 9 explains the various fields in the command output Legacy Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt lt aid gt aidtype ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt 1lf gt lt aid gt aidtype ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt l1f gt GR 833 Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt lt aid gt ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt lf gt lt aid gt ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt lf gt 80 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Alarm Condition RTRV ALM Table 2 9 RTRV ALM Output Fields Field Description aidtype Specifies if the event is associated with the interna
11. Alarm Default Level SSU PRS SUB INPLOS The 1PPS from GPS is LOS The LOS must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPLOS is set the alarm clears when the input signal is LOS free for the Clear Delay Time CLRDELAY T1 NSA IMMED NO MN MN MN INPPHASE The specified input port has a excessive phase measurement that disqualifies it from being used T1 NSA IMMED NO MN MN MN EXDSC Input has had excessive discontinuities indicated by more than 3 signal faults OOF BPV CRC or AIS within a 5 minute window The alarm clears when the 5 minute window contains less than 3 signal faults T1 NSA IMMED NO MN MN MN FFOFF Input has exceeded the Fractional Frequency Offset threshold T1 NSA IMMED NO MN MN MN MTIE Input has exceeded at least one of the MTIE alarm thresholds T1 NSA IMMED NO MN MN MN TPIUSIG TimeProvider Composite Timing Signal interface is not functioning T1 NSA IMMED NO MN MN MN 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 155 Appendix B Alarms Table B 1 Alarms Continued Alarm Default oor Ip Alarm Condition AID Service Balay Balay Level CONDTYPE pescnpion Type Affecting Def
12. April 2008 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 When you issue the RMV EQPT command before removing a module a 20 minute timer starts If you remove the equipment while the timer is running the alarm associated with the removal is silenced If you do not remove the equipment while the timer is running then the system reverts to normal alarming If you reinstall the equipment after issuing the RMV EQPT command the message lt module gt IS EQUIPPED is not reported This command has a default access level of USER Syntax RMV EQPT lt tid gt lt aid gt lt ctag gt lt keyword gt lt aid gt lt keyword gt Description SYS IlOCm m 1 2 Clears currently active IOCmEQPT alarms from the Input Output Card module specified by m if the module is not to be replaced E4229 g A B C D Clears alarms associated with E422gEQPT alarms if the module is not to be replaced OUTg g A B C D_ Clears alarms associated with OUTgEQPT alarms if the module is not to be replaced
13. ED CKTID INP1 TP1000 ABC123 SYS EQPT CKTIDCHG TC 05 02 10 13 35 56 INPUT CIRCUIT ID HAS CHANGED ABC123 13 35 56 44 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 cannot be changed ACT USER CANC USER ED CMD SECU E Note The access level for the following commands is fixed and ED USER SECU and ENT USER SECU This command also allows you to create SNMP community names for SNMP v1 and v2C and user names for SNMP v3 These users are separate from the TL1 users This command has a default access level of ADMIN This command s access level cannot be changed Syntax ED CMD SECU lt tid gt lt cid gt lt ctag gt lt keyword gt lt value gt Parameter Value Description lt cid gt text string The identifier of the command for which the access level is being changed The command identifier is the part of the command syntax that appears before the first colon It is not case sensitive Note See Table 2 3 for lt keyword gt and lt value gt descriptions FACTORY The access levels for all commands are set to their factory defined values Note If FACTORY is used no keyword is required and is ignored if used Table 2 3 ED CMD SECU Keyword and
14. Lely hy fi 2 07 l Iy lys r 3 0 aai 2 1 alleen 1 1 OO 1 r 0 2 3 0 0 0 0 0 0 0 TIMEPROVIDER 05 M TP1000 RTRV NO H150 270 7 15 40 147 07 3 wd 33 07270 0 1 0 2 0 0 2 4 1 N 3 0 37 21 Nop ly a1 9 0 2 2 0 niys miy 07 37 r 3 y 2 23 5 lyZy ly 0 1 0 2 2 1 3 0 2 1 la pH 25 0 15 1 742 3 0 r por 2 12 7 2 f wer il Peel 2 Ty 0 1 r 02 03 20 20 56 2 190 1 170 1 25 0 3 37 0 2 0 3 2 0 2 On 27 15 0 27 17 0 0 0 0 0 3 0 07 370 271 Oped pp Lies OF 723 HL 2 0G 2y d fel pO 2p eye r 3 1 2 0 0 0 3 0 2 0 4 1 3 0 1 0 2 0 2 2 1 1 1 1 2 3 0 2 0 1 l 1 2 0 1 eee 2 2 2 0 S10 2 rly OF Qu r pigs 1 1 2 TIO pir Ly 2y 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 TIMEPROVIDER 05 M TP1000 COMPLD 07 0505 0 0715 A ee 1 1 1 3 0 POTO 0 j pon i 0 0 0 0 0 0 0 0 r 02 03 20 20 58 0 0 0 0 128 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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
15. MN MN lt aid gt 1OC1 IMC1COMM A communication alarm with the IMC module and lOC1 module EQPT NSA IMMED NO MN MN MN 1IOC1TO2 COMM A communication alarm from IOC1 module to IOC2 module EQPT NSA IMMED NO MN MN MN IOCFAIL A summary alarm for failures of the IOC hardware that are not specified in other alarms EQPT SA IMMED NO MJ MJ MJ BTBCKUP All BesTime Backup sources inputs are unusable to the BesTime engine EQPT NSA IMMED NO NA NA NA CLKBRDG The local oscillator on the specified IOC is in Bridging Mode EQPT NSA IMMED NO NA NA NA CLKHOLD CLKFREE The local oscillator on the specified IOC is in Holdover Mode The local oscillator on the specified IOC is in Free run mode EQPT EQPT SA SA IMMED IMMED NO NO MJ MJ MJ MJ MJ MJ 152 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table B 1 Alarms Continued Alarm ID or CONDTYPE Alarm Condition Description AID Type Service Affecting Error Delay Default Error Delay Editable Appendix B Alarms Alarm Default Level SSU PRS SUB CLKWARM The local oscillator on the specified IOC is in Warm up mode EQPT SA IMMED NO MN MN MN SYNTHEOR The synthesizer
16. TOC2 TOC2 IOC2 TP SSU 05 02 10 13 37 39 0 COMPLD POWER GREEN FAIL OFF ALARM RED CRITICAL RED MAJOR OFF MINOR OFF ACO OFF ANTPOWER GREEN ANTSIG GREEN TOC1 TOC1 POWER GREEN FAIL OFF ALARM RED ACTIVE GREEN HOLDOVER OFF GPS RED PRS Q RED PRS A OFF INP1 Q OFF INP1 A OFF INP2 Q OFF INP2 A OFF POWER GREEN FAIL OFF ALARM RED ACTIVE OFF HOLDOVER OFF GPS RED PRS Q RED PRS A OFF INP1 Q OFF INP1 A OFF INP2 Q OFF INP2 A OFF Autonomous Message None 116 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 This command has a default access level of USER Syntax RTRV LOG lt tid gt lt aid gt lt ctag gt lt keyword gt index count start date stop date Description PEL ELEM ake See Table 2 22 for lt keyword gt descriptions lt aid gt ALL or null Retrieves events containing an
17. E TC 05 02 10 13 35 56 OUTPUT GROUP STATE ENABLED HAS 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 53 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 lt func gt value to ADD or MODIFY you must include the lt keyid gt lt minpoll gt lt maxpoll gt and lt preferred gt values Syntax ED EQPT lt tid gt NTP lt ctag gt SERVER lt func gt lt serverIP gt lt keyid gt lt minpoll gt lt maxpoll gt lt preferred gt lt keyword gt lt value gt Description Default FUNC ADD DELETE The SERVERIP address to be added deleted NA MODIFY or modified SERVERIP 1 0 0 1 The NTP Server IP address 0 0 0 0 254 255 255 254 Note If you change this parameter while NTP is functioning you must restart the IMC card using the INIT SYS command to use the new address KEYID 0 to 65535 The Authentication identification value 0 MINPOLL 16 32 64 128 The minimum amount of time in seconds 16 256 512 1024 between Server time requests MAXPOLL 16 32 64 128 The maximum amount of time in seconds 1024 256 5
18. lt cr gt lt lf gt INP2 lt inpstatus gt lt inpstate gt lt qlevel gt lt priority gt lt frmtype gt lt spantype gt lt rqlevel gt lt crcena gt lt ssmena gt lt ssmbit gt lt cr gt lt lf gt OUTA lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt l1f gt OUTB lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt 1lf gt OUTC lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt l1f gt OUTD lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt 1lf gt RTMA 1 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt lf gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 99 Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data RTRV CRAFT RTMA 2 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt lf gt RTMB 1 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt 1lf gt RTMB 2 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt lf gt RTMC 1 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt lf gt
19. 38400 The specified serial port s baud rate is set to 38400 baud 57600 The specified serial port s baud rate is set to 57600 baud FLOW NONE No flow control is set on the port NONE SW Software flow control XON XOFF is set on the specified port HW Hardware flow control CTS RTS is set on the specified port SWHW Both software and hardware flow control is set on the specified port lt aid gt COMI only Note For valid IP address ranges refer to RFC1466 and RFC3330 Note To avoid unexpected interruptions in NTP service you must restart the IMC card after you change either the Subnet Mask or the IP Address when NTP is active IPGATE IP dot The IP address of the default gateway 127 0 0 1 notation The range is 1 0 0 1 to 254 255 255 254 IPADDR IP dot The IP address of the Network Element 127 0 0 1 notation The range is 1 0 0 1 to 254 255 255 254 IPSUBNET IP dot The subnet mask 255 255 notation The range is 1 0 0 1 to 255 255 255 254 255 0 IPHOST 1 2 3 Reserved for future use 4 lt aid gt 1 OCm IOCMODE ACTIVE The specified IOC card is forced to the active state The ACTIVE other IOC card is set to the standby state STANDBY The specified IOC card is forced to the standby state The other IOC card is set to the active state Note If only one IOC card is installed the IOCMODE STANDBY setting is ignored 50 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April
20. A for the group marked A on the main shelf g B for the group marked B on the main shelf m g C for the group marked C on the main shelf g D for the group marked D on the main shelf Note This information is reported by the active IOC RTMg Retrieves status of the Retimer group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf m g C for the group marked C on the main shelf g D for the group marked D on the main shelf Note This information is reported by the active IOC E4229 Retrieves status of the EIA 422 output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf Note This information is reported by the active IOC SNMP Retrieves the status of the SNMP parameters Command Output The following shows the output format of the command when the ALL aid is used and Table 2 15 explains the various fields in the command output Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt l1f gt M ctag COMPLD lt cr gt lt l1f gt SYS lt pwra gt lt pwrb gt lt expneqpt gt lt extfault gt lt ioclegpt gt lt ioc2eqpt gt lt sysqlevel gt
21. Disabled inputs ports used by the system associated active alarms are cleared a ENABLE Enabled inputs are available as system reference a MONITOR Allows the input to be monitored for performance and signal faults but cannot be selected as reference input PMCLR Allows the user to Clear EQPT NA NA the gathered Performance Data that is stored in the IMC module PRIORITY Allows the user to T1 1 GPS 1 Highest provision the priority of 1 PRS 2 the input using 2 INP1 3 3 INP2 4 Lowest RQLEVEL The Received Quality T1 2 1 PRC PRS Level represents the 2 UNK STU received SSM on INP1 or 3 TYPE II ST2 INP2 this allows 4 TYPE notification of changing SSMs 5 TYPE V TNC 6 TYPE III ST3E 7 TYPE IV ST3 8 8110PT3 SMC 9 DUS 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 171 Appendix C Events Table C 1 Event Identifiers Continued Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE QLEVEL Allows the user to T1 2 1 PRC PRS provision the Quality 2 UNK STU Level of the input 3 TYPE II ST2 4 TYPE I 5 TYPE V TNC 6 TYPE III ST3E 7 TYPE IV ST3 8 8110PT3 SMC 9 DUS SSMBIT Allows the user to T1 8 4 5 6 7 8 provision E1 CAS CCS SSM bit position to allow the input to determine to proper bit to read the SSM on SSMENA Allows the user to T1 DISABLE ENABLE Enable the reading provisi
22. RTMA 1 lt cktid gt lt cr gt lt lf gt RTMA 2 lt cktid gt lt cr gt lt lf gt RTMD 1 lt cktid gt lt cr gt lt lf gt RTMD 2 lt cktid gt lt cr gt lt lf gt R422A 1 lt cktid gt lt cr gt lt lf gt R422A 2 lt cktid gt lt cr gt lt lf gt H422D 7 lt cktid gt lt cr gt lt lf gt E422D 8 lt cktid gt lt cr gt lt lf gt 90 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 RIRV CMD SECU lt tid gt lt cid gt lt ctag gt Parameter Value Description lt cid gt text string Retrieves the access level for the command with this identifier The command identifier is the part of the command syntax that appears before the first colon It is not case sensitive ALL Retrieves the access level for all commands Command Output The following shows the output format of the command and Table 2 14 explains the various fields in the command output Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt command access lt cr gt lt lf gt command access lt cr gt lt lf gt command access
23. TC 05 03 09 20 36 07 IOC MODE IS ACTIVE D TP SSU 05 03 09 20 39 26 450 REPT EVT IOC2 EQPT RESET TC 05 03 09 20 39 26 MODULE HAS BEEN RESET D TP SSU 05 03 09 21 02 45 461 REPT EVT IOC2 EQPT CLKLOCK TC 05 03 09 21 02 45 CLOCK ENTERED LOCK MODE D F 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 35 Chapter 2 TL1 Command Syntax and Description The Firmware Download Process TP SSU 05 03 09 21 02 49 A 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 A 463 REPT EVT IOC1 EQPT LOCMODE TC 05 03 09 21 02 49 IOC MODE IS STANDBY TP SSU 05 03 09 21 06 06 A 464 REPT EVT IOC EQPT FWOK TC 05 03 09 21 06 06 FIRMWARE UPGRADE SUCCESSFUL TP SSU 05 03 09 21 06 08 M 0 COMPLD TP SSU 05 03 09 21 06 11 A 465 REPT EVT IOC1 EQPT RESET TC 05 03 09 21 06 10 MODULE HAS BEEN RESET r Example 4 In this example the ACT SWDL command is issued to transfer a firmware file to the IOC1 module from the IOC2 module and the download and upgrade is successful Input ACT SWDL IOC1 TP1000 Response Example ACT SWDL IOC1 TP1000 TP SSU 05 03 09 14 36 09 A 15 REPT EVT IOC EQPT FWLOAD TC 05 03 09 14 36 09 BEGINNING FIRMWARE UPGRADE IP TP1000 lt TP SSU 05 03 09 14 39 35 A 16 REPT EVT IOC1 EQPT RESET TC 05
24. event log retrieving 117 status retrieving 94 sync parameters retrieving 131 sync parameters setting 58 61 INSTATE keyword 51 52 intended audience 8 inventory retrieving 113 IOC alarm condition descriptions 161 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 185 Index K M alarm list 152 154 alarms retrieving 79 clock type setting 51 craft data retrieving 102 equipment parameters retrieving 109 equipment parameters setting 48 50 event list 168 event log retrieving 117 LED status retrieving 115 resetting 73 setting mode 50 status retrieving 94 IOCMODE keyword 50 IOCSTATE keyword 51 IPADDR keyword 50 IPEX error code 19 IPGATE keyword 50 IPMS error code 19 IPNV error code 19 IPSUBNET keyword 50 ISCH error code 19 ISPC error code 19 IState 39 K key generation NTP 55 KEY keyword 56 KEYID keyword 54 56 keywords ACCLVL 45 65 ALARM ID 83 141 ALL 83 118 ALM 118 AOMERGE 49 AUTHEN 55 BAUD 50 BRDGTIM 141 CKTIDCHG 44 CLKTYPE 51 CLRDELAY 59 CRCENA 61 DATCHG 47 ECHO 49 ELEVMASK 51 ELEVTIME 141 EVT 118 FACTORY 73 141 FFOFF 146 FFOFF 60 124 FLOW 50 FLTDELAY 59 FREEFLT 63 64 FRMTYPE 61 62 64 FUNC 54 56 GPSCLRDEL 59 GPSFLTDEL 59 HOLDEFLT 63 64 INACTTIME 49 INPREF 59 INSTATE 51 52 IOCMODE 50 IOCSTATE 51 IPADDR 50 IPGATE 50 IPSUBNET 50 KEY 56 KEYID 54 56 LOCTIM 47 LOGECHO 49 MASK 145 MAXPOLL 54 MINPOLL 54 MODE GPS 51 MTIE 124 OUTSTATE 52
25. generating the modules stable output frequency has reached the defined End of Range for the type of oscillator used on the IOC EQPT SA IMMED NO MJ MJ MJ IMC2COMM A communication alarm with the IMC module and lOC2 module lt aid gt 1OC2 EQPT NSA IMMED NO MN MN lIOC2TO 1COMM A communication alarm from IOC2 module to IOC1 module EQPT NSA IMMED NO MN MN MN IOCFAIL A summary alarm for IOC BIST faults EQPT SA IMMED NO MJ MJ MJ BTBCKUP CLKBRDG All BesTime Backup sources inputs are unusable to the BesTime engine The local oscillator on the specified IOC is in Bridging Mode EQPT EQPT NSA NSA IMMED FLT DELAY NO NO NA NA NA NA NA NA CLKHOLD The local oscillator on the specified IOC is in Holdover Mode EQPT SA IMMED NO MJ MJ MJ CLKFREE The local oscillator on the specified IOC is in Free run mode EQPT SA IMMED NO MJ MJ MJ CLKWARM The local oscillator on the specified IOC is in Warm up mode EQPT SA IMMED NO MN MN MN 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 153 Appendix B Alarms Table B 1 Alarms Continued Alarm Default A E Alarm Condition AID Service Eifel Eror Level on Description Type Affecting D
26. on the main shelf p 1 for Port 1 on the Retimer module p 2 for Port 2 on the Retimer module Table 2 35 SET TH Keywords and Values for all lt aids gt lt keyword gt lt value gt Description Default MASK GPS R PRS Set MTIE x and FFOFF 60 thresholds to predefined See DS1 OCN PRC settings Table 2 36 TYPE TYPEII MTIE 1 1 to 5000000 1 Second MTIE observation threshold defined in ns 10 000 MTIE 5 1 to 5000000 5 Second MTIE observation threshold defined in ns 50 000 MTIE 10 1 to 5000000 10 Second MTIE observation threshold defined inns 100 000 MTIE 50 1 to 5000000 50 Second MTIE observation threshold defined inns 500 000 MTIE 100 1 to 5000000 100 Second MTIE observation threshold defined in ns 1 000 00 MTIE 500 1 to 5000000 500 Second MTIE observation threshold defined in ns 5 000 000 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 145 Chapter 2 TL1 Command Syntax and Description Set Threshold SET TH Table 2 35 SET TH Keywords and Values for all lt aids gt Continued lt keyword gt lt value gt 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 Maximum number of slips that can occur in a 4 24 hour pe
27. reference The possible references includes PRS INP1 or INP2 GPS is reference in PRR mode only EQPT PRS GPS PRS INP1 INP2 IOCMODE When an IOC becomes the Active it generates an event EQPT ACTIVE ACTIVE STANDBY IOCSTATE The specified IOC module was inserted into the system The module is automatically Placed In Service EQPT INSRV INSRV In Service The User has specified the IOC module be taken Out of Service OOSRV prevents the module from generating alarms or being provisioned or queried for provisioned settings etc EQPT INSRV OOSRV Out of Service RESET When the IOC is commanded to reset it generates an event indicating that it is being restarted Prior to restarting all alarms associated with the specified IOC is cleared Prior to restarting if the IOC is the Active IOC it is successfully placed in Standby mode EQPT NA NA 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 169 Appendix C Events Table C 1 Event Identifiers Continued Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE SYSMODE Configures the systems EQPT SSU SSU Sync Supply Unit mode mode of operation of operation SUB Subtending TSG mode of operation PRR Primary Reference Receiver mode of operation IOC Clock Event Codes CLKFSTLK The l
28. sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt 1lf gt SYS lt pwra gt lt pwrb gt lt expegpt gt lt extalm1 gt lt extalm2 gt lt ioclegpt gt lt ioc2eqpt gt lt sysqlevel gt lt lastdat gt lt lasttim gt lt syncmode gt lt refmode gt lt inpref gt lt clrdelay gt lt fltdelay gt lt inacttime gt lt logecho gt lt evtformat gt lt gpsclrdel gt lt gpsfltdel gt lt cr gt lt 1f gt IMC lt ioclcomm gt lt ioc2comm gt lt cr gt lt l1f gt COML lt baud gt lt flow gt lt echo gt lt cr gt lt lf gt COMR lt baud gt lt flow gt lt echo gt lt cr gt lt lf gt COMI lt ipaddr gt lt ipgate gt lt ipsubnet gt lt echo gt lt cr gt lt lf gt TOC1L lt iocstatus gt lt ioccomm gt lt imccomm gt lt iocstate gt lt iocmode gt lt clkmode gt lt clktype gt lt scavail gt lt cr gt lt lf gt TOC2 lt iocstatus gt lt ioccomm gt lt imccomm gt lt iocstate gt lt iocmode gt lt clkmode gt lt clktype gt lt scavail gt lt cr gt lt lf gt GPS lt gpsstatus gt lt instate gt lt qlevel gt lt priority gt lt utc gt lt mode gt lt pos gt lt elevmask gt lt cr gt lt 1f gt PRS lt prsstatus gt lt instate gt lt qlevel gt lt priority gt lt frmtype gt lt cr gt lt lf gt INP1 lt inpstatus gt lt instate gt lt qlevel gt lt priority gt lt frmtype gt lt spantype gt lt rqlevel gt lt crcena gt lt ssmena gt lt ssmbit gt
29. 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 The first line of the record has the first measurement requested the timestamp lt sampletim gt lt sampledat gt are associated with this measurement Input RTRV PM 10C1 GPS TP1000 PHASE1M Response Format lt cr gt lt lf gt lt l1lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt TOCm INPp PHASEIM lt monval gt lt vldty gt lt sampledat gt lt sampletim gt lt cr gt lt lf gt Wp KM Pp lt a Sp SS Sp lt lt Sy My Me Sj SS ERO lt 1ED We gt Sap Sy Se yp Sy Seo Sa i psa gt So ser lt 1 ts Response Example TIMEPROVIDER 05 02 03 20 34 20 M TP1000 COMPLD IOC1 GPS PHASEI1M 84 COMPL 05 02 03 19 33 32 Wel phy 0 34 07 17 0 17 074 0 1 lpl 3707 17270 0 2 1 0 1 5 5 2 0 1 M15 2 p0 270 12r 0 0 3 er Ay Op a dg Wy wy dy dy 2 47 37 27 0 Example To retrieve TDEV24 data Input RTRV PM IOC1 INP2 TP1000 TDEV24 Response Format lt cr gt lt 1lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt TOCm INPp TDEV a lt monval gt lt vldty gt lt sampledat gt lt sampletim gt TOCm INPp TDEV a lt monval gt lt vldty gt lt sampledat gt lt sampletim gt 097 58001 01 Revision G Ap
30. the alarm clears when the input frequency is within the defined pull in range limits T1 NSA IMMED NO MN MN NR INPPHASE The specified input port has a excessive phase measurement that is disqualifies it from being used NSA IMMED NO MN MN MN FFOFF Input has exceeded the Fractional Frequency Offset threshold T1 NSA IMMED NO MN MN MN MTIE Input has exceeded at least one of the MTIE alarm thresholds T1 NSA IMMED NO MN MN MN EXDSC Input has had excessive discontinuities This is indicated when there are more than 3 signal faults OOF BPV CRC or AIS within a 5 minute window The alarm clears when the 5 minute window contains less than 3 signal faults T1 NSA IMMED NO MN MN MN 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 157 Appendix B Alarms Table B 1 Alarms Continued Alarm Default oor E Alarm Condition AID Service Balay Balay Level CONDTYPE pescnpion Type Affecting Default Editable SSU PRS SUB lt aid gt INP1 INP2 INPDISQ The specified input was T1 NSA FLT YES MN IMN MN Disqualified or Qualified DLY as a possible system reference The fault condition must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPDISQ is set the
31. 2 Cleared IOC1EQPT IOC1 is Unequipped IOC1 is Equipped IOC2ZEQPT IOC2 is Unequipped IOC2 is Equipped EXPNEQPT Expansion Panel is Unequipped Expansion Panel is Equipped IMC Alarm Conditions IOC1COMM IMC to IOC 1 Communication Failed IMC to IOC 1 Communication Established IOC2COMM IMC to IOC 2 Communication Failed IMC to IOC 2 Communication Established IMCFAIL IMC BIST Fault IMC BIST Fault Cleared IMCTCPIP IMC TCP IP Activity is Excessive IMC TCP IP Activity is Normal IOC Alarm Conditions IMC1COMM IOC1 to IMC Communication Failed IOC1 TO IMC Communication Established IMC2COMM IOC2 to IMC Communication Failed IOC2TO IMC Communication Established IOC1TO2 IOC1 to IOC2 Communication Failed IOC1 TO IOC2 Communication COMM Established IOC2TO1 IOC2 to IOC1 Communication Failed IOC2 TO IOC1 Communication COMM Established IOCFAIL IOC BIST Fault IOC BIST Fault Cleared BTBCKUP BesTime Backup References Disqualified BesTime Backup References Qualified CLKWARM _ Clock Entered Warm up Mode Clock Exited Warm up Mode CLKFREE Clock Entered Free Run Mode Clock Exited Free Run Mode CLKBRDG Clock Entered Bridging Mode Clock Exited Bridging Mode CLKHOLD Clock Entered Holdover Mode Clock Exited Holdover Mode 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 161 Appendix B Alarms Table B 2 Alarm Code Condition Descriptions Continued A
32. 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 G April 2008 TimeProvider TL1 Reference Guide 123 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 lt tid gt lt aid gt lt ctag gt lt keyword gt lt startdat gt lt starttim gt lt stopdat gt lt stoptim Parameter Value Description lt aid gt IOC m GPS GPS input on either of the two IOC modules IOC m PRS PRS input on either of the two IOC modules IOC m INP p INP input on either of the two IOC modules Table 2 26 RTRV PM Keywords for all lt aids gt lt keyword gt Description FFOFF 60 1 Minute measurements of Fractional Frequency Offset stored for 24 hours MTIE MTIE measurements for the current 600 second observation window displayed in 1 ns resolution MTIE24 MTIE measurement over the previous 24 hour period of 1 ns resolution data PHASE 1 second phase data for the current 60 seconds of 100 ps resolution data PHASE1S 1 second phase data reported up to 24 hours of 1 ns resolution data PHASE1M 1 minute phase data reported up to 10800 minu
33. 35 56 A 2563 REPT EVT IMC EQPT INITLOG TC 05 02 10 13 35 56 EVENT LOG HAS BEEN CLEARED 72 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 A IOC to enter the Warm up mode the outputs are squelched until the system enters FAST LOCK After issuing the INIT SYS command with the SYS aid and FACTORY keyword all system parameters are reset including the entire user list You must therefore create a new security level user after the user list is reset to avoid a service call Refer to Defining the First User in the TimeProvider User Guide 097 58001 02 for more information This command has a default access level of ADMIN Syntax INIT SYS lt tid gt lt aid gt lt ctag gt lt keyword gt Parameter Value Description lt aid gt SYS The command s effect is at the system level Note See Table 2 8 for the lt keyword gt description IMC The command s effect is on the IMC module Note See Table 2 8 for the lt keyword gt description IOCm The command s effect is on the Input Output Card module specified by m m 1 for the slot marked IOC 1 on the main shelf m 2 for
34. 91 11 112 220 212 84 107 Example To retrieve MTIE data Inp RTRV PM IOC1 INP 2 TP1000 MTIE ut Response Format M lt sid gt lt date gt lt time gt lt cr gt lt lf gt lt ctag gt COMPLD lt cr gt lt l1f gt TOCm INPp MTI TOCm INPp MTI Response Example E a lt monval gt lt vldty gt lt sampledat gt E a lt monval gt lt vldty gt lt sampledat gt lt sampletim gt lt cr gt lt 1lf gt lt sampletim gt lt cr gt lt 1lf gt TIMEPROVIDER 05 02 10 13 37 39 M TP1000 COMPLD TOC1 INP2 MTIE 1 1 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 5 3 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 10 6 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 50 7 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 100 8 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 500 10 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 1000 15 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 5000 15 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 10000 15 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 50000 20 COMPL 05 02 10 12 00 00 TOC1 INP2 MTIE 86400 25 COMPL 05 02 10 12 00 00 Example To retrieve PHASE data Notes This data record provides the most recent 60 seconds of phase data The data resolution is 100pS resolution PHASE1S and PHASE1M data record resolution is 1 nS The first line of the record has the first meas
35. Appendix C Events Index 4 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table of Contents Tables 1 1 Normal Response Fields o 3c8 2 cette tieevndies Riad eto de bese been be 17 1 2 Error Response Fields ing 23 aera a ae eh eed eae Pa eee ae 18 1 3 Error Codes Returned in Error Responses 0200 0c eee eee eee 18 1 4 In Process Response Fields 2 000 e eee eee 20 1 5 Autonomous Message Fields 0000 eee eee 21 1 6 TimeProvider TL1 Command Types and Access Levels 005 24 2 1 TL1 Syntax Conventions dads dike Siw eRe tied Det doe Ee Eee ees 28 2 2 ED DAT Keywords and Values for lt aid gt SYS 0 0 0 0 cee 44 2 3 ED CMD SECU Keyword and Values for lt cid gt text string 45 2 4 ED DAT Keywords and Values for lt aid gt SYS 0 2 0000 c eee 47 2 5 ED EQPT Keywords and ValueS 0000 e eee eee eee 49 2 6 ED SYNC Keywords and Values n n naana cece eee 59 2 7 ED USER SECU Keyword and Values for lt uid gt text string 65 2 8 INIT SYS Keywords annann aides tate rah Bate Maeeig A Bat Pa we eles We wee 73 2 9 RTRV AUM Output Fieldsi osc acute Pa ae eee ee eee ed BE Raa s 81 2 10 RTRV ATTR Keywords and Values for all lt aidS gt 0 0000s eee 83 2 11 RTRV ATTR Output Fields ec0t 0s bowed oo ew dee ew abe edb es 84 2 12 RTRV BESTIME STAT Output
36. Appendix C Events Table C 2 Event Code Condition Descriptions Continued Event ID Event Condition Description SNMP SENDERS SNMP SENDER 1 HAS CHANGED lt ip gt SNMP SNMPCTAC SNMP MIB SYSTEM CONTACT HAS CHANGED SNMP SNMPDESC SNMP MIB DESCRIPTION HAS CHANGED SNMP SNMPLOC SNMP SYSTEM MIB LOCATION HAS CHANGED SNMP SNMPNAME SNMP SYSTEM MIB NAME HAS CHANGED SNMP SNMPPORT SNMP ACCESS PORT HAS CHANGED lt value gt SNMP TRAPPORT SNMP TRAP PORT HAS CHANGED lt port gt SNMP IFTOUT1 SNMP INFORM TIMEOUT 1 HAS CHANGED lt timeout gt SNMP IFTOUT2 SNMP INFORM TIMEOUT 2 HAS CHANGED lt timeout gt SNMP IFTOUT3 SNMP INFORM TIMEOUT 3 HAS CHANGED lt timeout gt SNMP IFTOUT4 SNMP INFORM TIMEOUT 4 HAS CHANGED lt timeout gt SNMP IFTOUT5 SNMP INFORM TIMEOUT 5 HAS CHANGED lt timeout gt SNMP IFRETRY1 SNMP INFORM RETRY COUNT 1 HAS CHANGED lt retry gt SNMP IFRETRY2 SNMP INFORM RETRY COUNT 2 HAS CHANGED lt retry gt SNMP IFRETRY3 SNMP INFORM RETRY COUNT 3 HAS CHANGED lt retry gt SNMP IFRETRY4 SNMP INFORM RETRY COUNT 4 HAS CHANGED lt retry gt SNMP IFRETRY5 SNMP INFORM RETRY COUNT 5 HAS CHANGED lt retry gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 181 Appendix C Events 182 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Inde
37. ENT USER SECU command Users log in using the ACT USER command specifying the user name and password that have been assigned by a Security level user E Note A Security level user initially sets up the user list by using the Example To log user FRED into the TimeProvider system with the password FRED 1 Input ACT USER FRED TP1000 FRED 1 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Error Response TP SSU 05 02 10 13 38 176 M TP1000 DENY y 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 37 Chapter 2 TL1 Command Syntax and Description Cancel User CANC USER Autonomous Message TP SSU 05 02 10 13 35 56 A 2528 REPT EVT IMC EQPT LOGIN TC 05 02 10 13 35 56 Cancel User CANC USER USER LOGG ED IN FRI ED yn 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 Syntax CANC USER lt tid gt lt uid gt lt ctag gt Parameter Value Description lt uid gt text string The user name assigned to the user whose session is being terminated Note Users at the Admin or Security level can terminate the active sessions of other users In such cases this parameter must be specified Including the lt uid gt in the command line is not necessary for
38. Fields 0 0000 e eee eee 85 2 13 Retrieve Built In Self Test Output Fields 0 000 e eee eee 88 2 14 RTRV CMD SECU Output Fidldss 2 scsi seg we hae we ewe Meek ee ees 92 2 15 RTRV GOND Output Fields i os dicen ee ceie bo alee Sages eo eee aw ewe es 96 2 16 RTRV CRAFT Output Fields 54 2 0 h2 244 Secs tbe tenet inet beabeeiaeies 100 2 17 RTRV DAT Output Fields 32 5 secsieh keane Me ek ked Oa Sha waleneaee A 107 2 18 RURV EOPT Outout Field isc id oe 24 eee ee Bahia s ees 110 2 19 RTRV GPS STAT Output Fields 0 0 00 c eee eee 111 2 20 RTRV INV Output Fields age ine eee waned Bota We eed 113 2 21 RTRV LED Output Fields ie cceye axe aiticauald Kran egy he Sued oy te Meee eee 115 2 22 RTRV LOG Keywords for all lt aids gt nnana anaa 118 2 23 RTRV LOG Event Output Fields nanna anaa 118 2 24 RTRV LOG Alarm Output Fields anna anaana 119 2 25 RTRV NTP PEER Output Fields 2c2 scecdesa aana 122 2 26 RTRV PM Keywords for all lt aidS gt 2 ee ee 124 2 27 RTRV PM Keyword Modifier Fields 0 naaa 124 2 28 RTRV PM Output Fields nananana anna 125 2 29 RTRV SYNC Output Field anana a naa 132 2 30 RTRV TH Output Fields rca nananana 135 2 31 RTRV USER SECU Output Fields nnana nana 137 2 32 SET ATTR Keywords and Values for all lt aids gt 00 000000s 141 2 33 SET SID Keyword and Value 0 0 cee eee 142 2 34 SET SYS M
39. 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 If the upgrade file applies to the IMC module If the upgrade file that was downloaded is valid and is for the IMC module the flash memory on the IMC module is reprogrammed and the IMC module is rebooted using the new firmware The system outputs are not interrupted when the IMC module is upgraded If the process fails at any time the upgrade process aborts and the IMC module returns to normal operation using the existing version of firmware If the upgrade file applies to the IOC modules If the upgrade file that was downloaded is valid and is for the IOC modules the system checks the following criteria to determine how to proceed with the upgrade process a It checks if the shelf contains two installed and communicating IOC modules a It checks if both IOC control loops are locked a It checks if both IOC modules are in service a It checks if both IOC modules are alarm free a t checks if one of the IOC modules is active If the system determines that any of the above criteria are false it reprograms the IOC1 module s flash memory and reboots the module then reprograms the IOC2
40. Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt IMC lt p n gt lt s n gt lt clei gt lt hw ver gt lt fw ver gt lt mac gt lt cr gt lt lf gt TOC1 lt p n gt lt s n gt lt clei gt lt hw ver gt lt fw ver gt lt cr gt lt lf gt TOC2 lt p n gt lt s n gt lt clei gt lt hw ver gt lt fw ver gt lt cr gt lt lf gt RTMA lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt RTMB lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt RTMC lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt RTMD lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt E422A lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt E422B lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt E422C lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt E422D lt p n gt lt s n gt lt clei gt lt hw ver gt lt cr gt lt lf gt Note If an element of a module s inventory is not available the corresponding field is left blank in the command output 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 113 Chapter 2 TL1 Command Syntax and Description Retrieve Inventory RTRV INV Example To display the current system inventory Input RTRV INV Ti TPIOO0 Response Example TP SSU M TP1000 IMC 1
41. GPSPOS default alarm level to MN in Table B 1 Added SNMP Event conditions to Table C 2 Added AUTHPASS AUTHPRIV and PRIVPASS events to IMC in Table C 2 Added GPSCLRDEL and GPSFLTDEL to Table C 2 12 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 1 TL1 Overview This chapter provides a basic overview of the Transaction Language 1 TL1 used by the TimeProvider In This Chapter a Overview a 1TL1 Command Structure a Responses Autonomous Messages a Command Security 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 13 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 ASCIl 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 Note For a complete description of the TL1 syntax refer to Telcordia Bellcore General Requirements GR 831 and GR 833 The remainder of this chapter explains the TL1 command language and how it applies to the TimeProvider TL1 Command Structure The TL1 commands used in the TimeProvider consist of the following three main parts or blocks The Command Code Block a The Staging Block a The Payload Block These three main blocks are separated by a col
42. PHASE 124 POS 51 PREFERRED 54 PRIORITY 60 61 QLEVEL 60 61 REFMODE 59 RESET 73 RTMLBO 63 SERVERIP 54 SIDCHG 142 SLIPCHG 146 SSMBIT 62 63 SSMENA 62 63 TDEV24 124 TIDQUIET 49 TIMCHG 47 L LED status retrieving 115 line build out setting 63 LOCTIM keyword 47 log retrieving 117 LOGECHO keyword 49 logging on 37 logging out 38 M MAC retrieving 113 MASK keyword 145 MAXPOLL keyword 54 memory copying 39 186 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 messages autonomous 20 MINPOLL keyword 54 mode retrieving 133 setting 143 MODE keyword GPS 51 MTIE keyword 124 MTIE output example 126 N network element type retrieving 121 normal TL1 command response 16 notes defined 10 notification code alarms 81 119 events 118 ntfencde 81 118 119 NTP activating 29 authentication configuring 55 craft data retrieving 105 ED EQPT command 54 equipment parameters retrieving 110 event list 174 key generation 55 parameters configuring 54 peer information retrieving 122 peer server configuring 54 server address setting 54 O occurrence date alarms 81 119 events 119 occurrence time alarms 81 119 events 119 ocrdat 81 119 ocrtim 81 119 offset changing 47 retrieving 107 OPR ACO ALL command 75 outputs alarm condition descriptions 163 circuit ID retrieving 90 circuit ID setting 44 craft data retrieving 104 equipment parameters retrieving 109 equipment para
43. RTMC 2 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt lf gt RTMD 1 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt lf gt RTMD 2 lt rtmstatus gt lt rtmstate gt lt rtmlbo gt lt freeflt gt lt holdflt gt lt rtmslip gt lt cr gt lt lf gt E422A lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt lf gt E422B lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt l1f gt E422C lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt l1f gt E422D lt outstatus gt lt outstate gt lt frmtype gt lt freeflt gt lt holdflt gt lt cr gt lt 1f gt NTP AUTHENTICATION lt authen gt lt cr gt lt 1f gt NTP SERVER lt serveripl gt lt keyid gt lt minpoll gt lt maxpoll gt gt preferred gt lt cr gt lt 1f gt NTP SERVER lt serveripl gt lt keyid gt lt minpoll gt lt maxpoll gt gt preferred gt lt cr gt lt 1f gt SNMP MGR1 lt mgr1 gt lt senderl gt lt iftoutl gt lt ifretryl gt SNMP MGR2 lt mgr2 gt lt sender2 gt lt iftout2 gt lt ifretry2 gt SNMP MGR3 lt mgr3 gt lt sender3 gt lt iftout3 gt lt ifretry3 gt SNMP MGR4 lt mgr4 gt lt sender4 gt lt iftout4 gt lt ifretry4 gt
44. and Priority to select the reference input or allow system reference the user to select the a FORCED The user selects reference the system reference if the selected reference fails the system reverts to AUTO mode for reference selection TIMCHG The system time was EQPT hh mm ss a hh Hours 24 hour clock changed mm Minutes ss Seconds 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 175 Appendix C Events Table C 1 Event Identifiers Continued Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE UTC Indicates UTC time was EQPT hh mm ss hh mm ss determined by GPS interface Retimer Event Codes CKTIDCHG A user has modified the T1 GPS The ID can be up to 40 characters Circuit ID for the output in length FREEFLT Defines if the Retimer T1 CUTTHRU RETIMER In fault mode the mode operates or not output signals are retimed when the LO enters a CUTTHRU In fault mode the Free run mode of cut thru mode is enabled and operation The output output signals are not retimed groups are provisioned for fault strategies HOLDFLT _ Defines if the Retimer T1 CUTTHRU RETIMER In fault mode the mode operates or not output signals are retimed when the LO enters a CUTTHRU In fault mode the Holdover mode of cut thru mode is enabled and operation The output output signals are not retimed groups are provisioned
45. does not use the Ymodem file receiver If a new IOC is installed into a system or if one IOC card has a previous version of firmware the active IOC can be used to transfer its version of firmware to the target IOC m 1 for the module marked IOC 1 on the main shelf m 2 for the module marked IOC 2 on the main shelf 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 31 Chapter 2 TL1 Command Syntax and Description The Firmware Download Process The Firmware Download Process Caution To avoid a possible service call do not issue any additional A TL1 commands to the TimeProvider do not remove power from the TimeProvider and do not remove an IOC or IMC from the shelf during the firmware upgrade process minimum 30 minutes Doing so could corrupt the flash memory in a card disabling the TimeProvider When the IMC module is in firmware download mode most commands are not executable because all users are logged off the system however commands with an access level of NONE are executable 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 Refer to the TimeProvider User s Guide 097 58001 02 for more complete firmware upgrade informatio
46. firmware file to the IMC module and the download and upgrade is successful Input ACT SWDL IMC TP1000 34 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description The Firmware Download Process Response Example TP SSU 05 03 09 14 11 20 A 400 REPT EVT IMC EQPT FWLOAD TC 05 03 09 14 11 20 BEGINNING FIRMWARE UPGRADE CCCCCCCCCCCCCIP TP1000 lt TP SSU 05 03 09 14 19 59 M TP1000 COMPLD r TP SSU 05 03 09 14 19 57 A 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 IOC2 is active and IOC1 is in standby mode After the file downloads IOC1 becomes active and locked and IOC2 goes into standby to receive the firmware file The download and upgrade is successful for both modules Note Some evenis in the following example were removed for space considerations Input ACT SWDL IOC TP1000 Response Example TP SSU 05 03 09 20 34 03 A 447 REPT EVT IOC EQPT FWLOAD TC 05 03 09 20 34 03 BEGINNING FIRMWARE UPGRADE CCCIP 0 E TP SSU 05 03 09 20 36 06 448 REPT EVT IOC2 EQPT IOCMODE TC 05 03 09 20 36 06 IOC MODE IS STANDBY D TP SSU 05 03 09 20 36 07 449 REPT EVT IOC1 EQPT LOCMODE
47. for fault strategies RTMLBO The Line Buildout on the T1 0 0 0to 133 ft specified Retimer port m 1 133 to 266 ft has changed m 2 266 to 399 ft m 3 399 to 533 ft m 4 533 to 650 ft RTMSTATE The state of the specified T1 ENABLE a ENABLE Enable the Retimer Retimer port has port changed DISABLE Disable the Retimer port and clear all alarms associated with the port SLIPCHG The Retimer slip T1 4 1 to 255 threshold has changed SLIPCLR The Retimer slip counter T1 NA NA has been cleared 176 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Appendix C Events Table C 2 Event Code Condition Descriptions Event ID Event Condition Description IMC Event Conditions ACCLVL USER ACCESS LEVEL HAS CHANGED ACO AUDIO ALARM IS DEACTIVATED ALMCHG ALARM PARAMETER HAS CHANGED lt keyword gt lt alarm gt AOMERGE AUTONOMOUS EVENT REPORTING HAS CHANGED lt state gt AUTHPASS SNMP USER AUTHENTICATION PASSWORD HAS CHANGED AUTHPROT SNMP USER AUTHENTICATION PROTOCOL HAS CHANGED BAUD SERIAL BAUDRATE HAS CHANGED lt value gt CMDCHG COMMAND ACCESS LEVEL HAS CHANGED lt command gt ECHO SERIAL PORT ECHO MODE HAS CHANGED lt state gt EVTFORMAT AUTONOMOUS MESSAGE FORMAT HAS CHANGED lt state gt FEATURE SYSTEM FEATURE HAS BEEN ACTIVATED lt feature gt FLOW SERIAL FLOW CONTROL HAS CHANGED lt state
48. g C for the group marked C on the main shelf g D for the group marked D on the main shelf E4229 Retrieves the alarm level s set for all alarms related to the specified EIA 422 output module Table 2 10 RTRV ATTR Keywords and Values for all lt aids gt g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf lt keyword gt Description Default Alarm ID The identifier of the alarm for which the level is to be retrieved N A Notes m See Table B 1 for the possible alarm identifiers a This keyword is not valid if the lt aid gt is ALL or null null or ALL Retrieves alarm attributes that are associated with all alarms N A that are related to the specified lt aid gt Command Output The following shows the output format of the command and Table 2 11 explains the various fields in the command output Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt lt aid gt alarm id alarm level lt cr gt lt lf gt lt aid gt alarm id alarm level lt cr gt lt lf gt lt aid gt alarm id alarm level lt cr gt lt lf gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 83 Chapter 2 TL1 Command Syntax
49. gt FWFAIL FIRMWARE UPGRADE UNSUCCESSFUL FWOK FIRMWARE UPGRADE SUCCESSFUL FWLOAD BEGINNING FIRMWARE UPGRADE IMCBIST BUILT IN SELF TEST lt value gt INITLOG EVENT LOG HAS BEEN CLEARED IPADDR IP ADDRESS HAS CHANGED lt value gt IPGATE GATEWAY IP ADDRESS HAS CHANGED lt value gt IPSUB SUBNET MASK IP ADDRESS HAS CHANGED lt value gt ISDIFF CONFIGURATION IMAGES ARE DIFFERENT ISEQ CONFIGURATION IMAGES ARE THE SAME LOGOUT USER LOGGED OUT lt username gt PRIVPASS SNMP USER PRIVACY PASSWORD HAS CHANGED PIDCHG USER PASSWORD HAS CHANGED RESET MODULE HAS BEEN RESET SIDCHG SYSTEM S SOURCE ID HAS CHANGED lt value gt USRADD USER HAS BEEN ADDED USRDEL NO USERS DEFINED 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 177 Appendix C Events Table C 2 Event Code Condition Descriptions Continued Event ID Event Condition Description USRDEL USER HAS BEEN DELETED XFERFAIL CONFIGURATION TRANSFER FAILED lt fromdev gt lt todev gt XFEROK CONFIGURATION TRANSFER SUCCESSFUL lt fromdev gt lt todev gt GPS Event Conditions CKTIDCHG GPS CIRCUIT ID HAS CHANGED lt cktid gt MODE GPS ANTENNA MODE lt mode gt POS GPS ANTENNA POSITION lt pos gt ELEVMASK GPS ELEVATION MASK lt value gt RESET GPS POWER HAS BEEN RESET IOC Event Conditions CCALIGN COMPOSITE CLOCK ALIGNMENT CLKTYPE CLOCK TYPE HAS CHANGED lt state gt FW
50. input is enabled DISABLE DISABLE The specified input is disabled Note While in PRR mode the command to disable the GPS input is not allowed MONITOR The specified input is in monitor only mode Note In monitor only mode the performance of the input is monitored and it is monitored for signal faults but cannot be selected as a system reference MODE AUTO The antenna position latitude longitude and height is AUTO automatically computed or re computed and then set MANUAL The user sets the antenna position latitude longitude and elevation using the POS keyword POS LAT dd mm ss ssN or dd mm ss ssS N A Moto POS ean LONG dd mm ss ssE or dd mm ss ssW only be set when MODE ELEV hhhh h elevation altitude in meters Manual ELEVMASK 5 to 45 The specified elevation mask 10 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 51 Chapter 2 TL1 Command Syntax and Description Edit Equipment ED EQPT Table 2 5 ED EQPT Keywords and Values Continued lt keyword gt lt value gt Description Default lt aid gt 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 i
51. is Equipped S1LOS Side 1 LOS Fault Side 1 LOS Fault Cleared S2LOS Side 2 LOS Fault Side 2 LOS Fault Cleared EXSLIP Slip Rate Threshold Exceeded Slip Rate Within Threshold RTMFAULT Retimer Module has a Fault Retimer Module Fault Cleared 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 163 Appendix B Alarms 164 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 or Event Description SE Default Value Value Description CONDTYPE IMC Event Codes ACCLVL The user s system EQPT SECURITY NONE user has no access access level has when no users USER user can access user changed in the database have been level commands assigned to the ADMIN user can access admin system level commands SECURITY user can access security level commands ACO Audio Alarm was EQPT NA NA deactivated ALMCHG The IMC alarm EQPT NA Alarm Keywords and Values are parameters have been shown in Appendix B Alarms changed When a Value is changed the ALMCHG event is generated and the keyword and value is displayed AOMERGE Enable Disable EQPT ENABLE ENABLE Enables the autonomous event autonomous messages to be generation f
52. is the seconds 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 textblk A double quoted message containing less than 4 kBytes of information that the unit returns in response to the command LG_textblk If the unit responds with a message containing more than 4 kBytes of information the message is divided into records of approximately 4 kBytes each ending with COMP LD lt cr gt lt 1f gt The last record ends with lt cr gt lt 1f gt Large Response If the contents of the response exceeds 4K bytes of information the TL1 large data block syntax is used The large data block format divides the response into approximately 4Kbyte sized records Each record contains the intermediate response identifier RTRV indicating more data is being retrieved by the system The final data block size is determined by the size of the remainder of the data the response identifier COIMPLD indicates completion of the request The data block terminates with lt cr gt lt 1f gt lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt IP ctag RTRV lt cr gt lt lf gt textblk lt cr gt lt lf gt gt lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt IP ctag RTRV lt cr gt lt lf gt textblk lt cr gt lt lf gt gt lt cr gt lt lf
53. on page 20 Changed the default value of INACTTIME to 1800 in Table 2 5 Added the GPSCLRDEL and GPSFLTDEL keywords to Table 2 6 Added new keywords to Edit User Security ED USER SECU on page 65 Added TPIU and group parameters to Remove Equipment RMV EQPT on page 77 Added the GPSCLRDEL and GPSFLTDEL parameters to the SYS response in Retrieve Craft Data RTRV CRAFT on page 99 Added the scavail parameter to the IOCx response in Retrieve Craft Data RTRV CRAFT on page 99 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 11 How to Use This Guide What s New In This Guide Added the EVTFORMAT keyword to Retrieve Craft Data RTRV CRAFT Edit Equipment ED EQPT Table 2 5 Table 2 16 Table C 1 Table C 2 Added the PLNA error code to Retrieve Header RTRV HDR on page 112 Changed the KEYID parameter values to 0 to 65535 in ED EQPT for NTP Parameters and in Table 2 16 Changed the Retrieve Alarm Condition RTRV ALM command description to include the ALL EQPT and T1 modifiers Changed the Retrieve Condition RTRV COND command description to include the ALL modifier Added the GR 833 response format to the Retrieve Alarm Condition RTRV ALM and Enter User Security ENT USER SECU commands Removed the TPIU keyword from Remove Equipment RMV EQPT on page 77 Changed the Error Delay Default to GPSFLTDEL for ANTCOM GPSPOS GPSPWR GPSSYS and GPSTRK in Table B 1 Changed the
54. pair that can be used to authenticate the NTP timestamp that the TimeProvider sends as the NTP server You can create up to nine KeyID Key pairs and then specify which pair to use when you configure the NTP Server Note To prevent confusion at a later date be sure to write down and store in a secure place the KeyID Key pairs you create There is no provision for displaying the stored KeyID Key pairs E Note The and characters may not be used in the KeyID Key pairs 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 55 Chapter 2 TL1 Command Syntax and Description ED EQPT for NTP Parameters Syntax ED EQPT lt tid gt NTP lt ctag gt KEYGEN lt func gt lt keyid gt lt key gt lt keyword gt lt value gt Description Default FUNC ADD DELETE Key to be added deleted or modified NA MODIFY KEY 32 character Authentication key Null ASCII value KEYID 0 to 65535 The Authentication identification value 0 Example To add an NTP authentication key Input ED EQPT NTP TP1000 KEYGEN ADD ABC XYZABCDEF 1024 Normal Response M TP SSU 05 02 10 13 35 56 TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 2537 REPT EVT NTP EQPT SERVER TC 05 02 10 13 35 56 NTP AUTHENTICATION HAS CHANGED 56 TimeProvider TL1 Referenc
55. 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 lt tid gt lt ctag gt Table 2 19 RTRV GPS STAT Output Fields Field Description mode The GPS Positioning Mode pos dd mm ss ss N or S dd mm ss ss E or W hhhh h sv Satellite Vehicle Number 0 through 32 hith Satellite Health OK UNH snr Signal to noise ratio rr svel Satellite Elevation dd degrees svaz Satellite Azimuth ddd degrees Command Output The following shows the output format of the command and Table 2 19 explains the various fields in the command output Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt GPS lt mode gt lt pos gt lt cr gt lt lf gt GPS lt sv gt lt hlth gt lt snr gt lt svel gt lt svaz gt lt cr gt lt lf gt Example To display the current GPS status Input RTRV GPS STAT TP1000 Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD GPS AUTO 0 0 0 0N 0 0 0 0E 0 0 Autonomous Message None 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 111 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 lt sid gt and th
56. the IOC module that is currently active GPS PRS Retrieves the alarm level s set for all GPS alarms or for the specified GPS alarm Retrieves the alarm level s set for all PRS alarms or for the specified PRS alarm INPp RTMg p Retrieves the alarm level s set for all alarms related to the specified input port or for the specified alarm related to the specified input port a p 1 forthe input marked INP 1 on the Input Connector module p 2 forthe input marked INP 2 on the Input Connector module Retrieves the alarm level s set for all alarms related to the specified Retimer module and port g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf p 1 for Port 1 on the Retimer module p 2 for Port 2 on the Retimer module 82 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Attribute RTRV ATTR Parameter Value Description See Table 2 10 for lt keyword gt descriptions lt aid gt 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 for the group marked B on the main shelf
57. users to log themselves out of their own user session null The owner s current user session is terminated Example To terminate Input the current session for user FRED CANC USER FRED TP1000 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD T Autonomous Message TP SSU 05 02 10 13 35 56 A 2529 REPT EVT IMC EQPT LOGOUT TC 05 02 10 13 35 56 TUS ER LOGG ED OUT FR ED 38 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 Syntax CPY MEM lt tid gt lt ctag gt lt fromdev gt lt todev gt lt istate gt Parameter Value Description lt fromdev gt IOC The specified Istate is copied from the IOC card IMC The specified Istate is copied from the IMC card lt todev gt IOC The specified Istate is copied to the IOC card IMC The specified Istate is copied to the IMC card lt istate gt IOC The IOC Istate is copied IMC The IMC Istate is copied Note In order to from a valid command line the lt f romdev gt and lt todev gt parameter values cannot be the same The IState
58. value gt Description Default MGRx IP dot The IP address of SNMP manager 1 5 0 0 0 0 x 1 5 notation SENDERx text string An existing SNMP principle community or user x 1 5 SNMPCTAC text string Changes the SNMP system contact in the MIB SNMPDESC text string Changes the SNMP description in the MIB SNMPLOC text string Changes the SNMP location in the MIB If set to lt null gt then it appears as lt 00 gt hex on the SNMP side SNMPNAME text string Changes the SNMP name in the MIB SNMPPORT 0 161 The port number used by SNMP If set to 0 SNMP is 161 1024 disabled You must reboot the IMC to make the change 65535 effective TRAPPORT 0 65535 SNMP trap port applies to all five managers If setto0 162 no notification is sent Note 1 You must set up MGRx SENDERx IFTOUTx and IFRETRYx before a notification INFORM is sent from the TimeProvider to the selected notification INFORM receiver The format sent V1 V2 etc depends on the principle community or user selected using the ENT USER SECU command Note See Edit Sync ED SYNC on page 58 for more provisioning parameters Example To enable Output Group B Input ED EFOPT OUTB TP1000 OUTSTATE ENABLE Normal Response L TP SSU 05 02 10 13 35 56 TP1000 COMPLD Autonomous Message TP SS A 2537 REPT OUTB 1 EVT U 05 02 10 13 35 56 EQPT OUTSTAT CHANGED
59. 000 Response Example TP SSU 05 02 04 21 15 00 M TP1000 COMPLD TOC1 SYS 250ns IOC1 PRS 0 85 TOC1 INP1 0 00 TOC1 INP2 0 00 TOC1 LO 0 15 Autonomous Message None 86 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt aid gt lt ctag gt Parameter Value Description lt aid gt IMC Displays the currently active faulted built in self test information for the Information Management Card IMC Note See Table 2 13 for lt condscr gt descriptions IOCm Displays the currently active faulted built in self test information Normal Response IMC lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt IMC BIST lt cr gt lt lf gt for the Information Management Card IOC m 1 for the slot marked IOC 1 on the main shelf m 2 for the slot marked IOC 2 on the main shelf Note See Table 2 13 for lt condscr gt descriptions lt IMC condscr gt lt cr gt lt lf gt j IOC lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf
60. 01 the SNMP feature is identified by Symmetricom part number 920 58002 01 This command has a default access level of ADMIN Syntax ACT FEATURE lt tid gt lt fid gt lt ctag gt lt key gt Parameter Value Description lt fid gt NTP Activates the Network Timing Protocol feature SNMP Activates the Simple Network Management Protocol feature lt key gt ASCII The key to enable the feature Contact your Symmetricom dataor representative to obtain the key If lt null gt then the command lt null gt returns the current state of lt fid gt Example To activate the NTP or SNMP feature using the Symmetricom supplied lt key gt parameter Input ACT FEATURE NTP TP1000 Symmetricom Key Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD f Input ACT FEATURE SNMP TP1000 Normal Response TIMEPROVIDER 08 03 23 22 54 25 M TP1000 COMPLD IMC Serial S16026 SNMP activated Input ACT FEATURE NTP tp1000 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 29 Chapter 2 TL1 Command Syntax and Description Activate Feature ACT FEATURE Normal Response TIMEPROVIDER 08 03 23 22 56 38 M 0 COMPLD IMC Serial S16026 NTP activated Autonomous Message TP SSU 05 02 10 13 35 56 A 2528 REPT EVT IMC EQPT FEATURE TC 05 02 10 13 35 56 SYSTEM FEATURE HAS BEEN AC
61. 03 09 14 39 34 MODULE HAS BEEN RESET TP SSU 05 03 09 14 39 37 A 18 REPT EVT IOC EQPT FWOK TC 05 03 09 14 39 37 FIRMWARE UPGRADE SUCCESSFUL TP SSU 05 03 09 14 39 38 M TP1000 COMPLD 36 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 If a user has a current session active that user can log in using another user name which transfers the current session to the new user name The system records the log in event but does not record a log out event for the previous user If no users are defined in the system then the user has access at the Security level This command has a default access level of NONE This command s access level cannot be changed Syntax ACT USER lt tid gt lt uid gt lt ctag gt lt pid gt Parameter Value Description lt uid gt text string The user name assigned to the user logging on lt pid gt text string The password assigned to the user logging on Note Refer to lt newpid gt on page 67 for valid password specifications The maximum number of sessions is ten Enter User Security
62. 1 01 Revision G April 2008 TimeProvider TL1 Reference Guide 143 Chapter 2 TL1 Command Syntax and Description Set System Mode SET SYS MODE Autonomous Message TP SSU 05 02 10 13 35 56 A 396 REPT EVT SYS EQPT SYSMODE TC 05 02 10 13 35 56 SYSTEM MODE OF OPERATION HAS CHANGED SUB 144 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 S ET TH lt tid gt lt aid gt Parameter Value lt ctag gt lt keyword gt lt value gt Description See Table 2 35 for lt keyword gt and lt value gt descriptions lt aid gt GPS The command s effect is on the GPS system input PRS The command s effect is on the PRS system input INP 1 The command s effect is on the INP1 system input INP2 RTMg p The command s effect is on the INP2 system input The command s effect is on the specified Retimer module and Port g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D
63. 12 1024 between Server time requests PREFERRED YES NO Sets the server to be the Preferred server NO Example This command adds the server mask of 192 168 10 1 sets the Authentication ID to 1 the max poll to 64 the min poll to 1024 and the preferred to No Input ED EQPT NTP TP1000 SERVER ADD 192 168 10 1 1 64 1024 NO 54 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description ED EQPT for NTP Parameters Normal Response TP SSU 03 05 15 10 04 32 A 1166 REPT EVT NTP EOPT SERVER TC 03 05 15 10 04 32 NTP SERVER CONFIGURATION HAS CHANGED 192 168 10 1 0 16 1024 NO y Enabling NTP Authentication This command enables or disables the use of the KeyID Key pairs Syntax ED EQPT lt tid gt NTP lt ctag gt AUTHEN lt value gt lt keyword gt lt value gt Description Default AUTHEN ENABLE DISABLE Enable or disable NTP Authentication DISABLE Example To enable NTP authentication Input ED EQPT NTP TP1000 AUTHEN ENABLE Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 2537 REPT EVT NIP EQPT SERVER TC 05 02 10 13 35 56 NIP AUTHENTICATION ENABLE Configuring NTP Key Generation This command creates a KeyID and Key
64. 2008 Chapter 2 TL1 Command Syntax and Description Edit Equipment ED EQPT Table 2 5 ED EQPT Keywords and Values Continued lt keyword gt lt value gt Description Default CLKTYPE ST2 The assumed SSM quality level for the Rubidium IOC TYPE TYPEIl card s clock is set to either ANSI stratum 2 traceable TYPEIl Rubidium ST2 or ETSI Type 2 TYPEIl traceable This value is used for placing SSM bits in the output stream when in Holdover mode Any input to the unit that is of lesser quality than ST2 TYPEIl is not used as a reference Note ST2 and TYPEII can only be provisioned on the Rubidium IOC card they cannot be provisioned on the Quartz IOC card STSE The assumed SSM quality level for the Quartz IOC card s TYPEI clock is set to either ETSI Type 1 TYPEI or ANSI Quartz ST3E This value is used for placing SSM bits in the output stream when in Holdover mode Any input to the unit that is of lesser quality than TYPEI ST3E is not used as a reference Note ST3E and TYPEI can only be provisioned on the Quartz IOC card they cannot be provisioned on the Rubidium IOC card IOCSTATE INSRV The IOC card is placed into service INSRV OOSRV The IOC card is taken out of service Note A module that was taken out of service is not selectable by the system to generate outputs or monitor inputs and no alarms are generated by the module lt aid gt GPS INSTATE ENABLE The specified
65. 2345 1 02 01 build 16 00 60 08 00 A0 6E IOC1 TOC2 RIMA RIMB RIMC RIMD E422A E422B E422C E422D 05 02 10 13337339 COMP LD 090 58021 02 C12345 CLI 090 58022 02 C12345 CLI I012345 B 1 02 07 1012345 B 1 02 07 090 5802x 02 C12345 CLEI012345 error 090 58071 02 C12345 CLEI012345 A vie vine EER Autonomous Message None 114 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt tid gt lt aid gt lt ctag gt Parameter Value Description lt aid gt null Retrieves the status of all LED indicators IMC Retrieves the status of the LED indicators on the IMC module IOC1 Retrieves the status of the LED indicators on the IOC1 module IOC2 Retrieves the status of the LED indicators on the IOC2 module Command Output The following shows the output format of the command and Table 2 21 explains the various fields in the command output Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt lt aid gt indicator state l
66. 3 37 39 EXPANSION CONNECTIVITY FAILED TOC1 MJ CLKHOLD SA 05 02 10 13 37 39 CLOCK ENTERED HOLDOVER MODE TOC2 MJ CLKHOLD SA 05 02 10 13 37 39 CLOCK ENTERED HOLDOVER MODE Autonomous Message None 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 81 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 lt tid gt lt aid gt lt ctag gt lt keyword gt Parameter Value Description See Table 2 10 for lt keyword gt descriptions lt aid gt ALL or null Retrieves the alarm levels set for all alarms in the entire system SYS IMC Retrieves the alarm level s set for all system level alarms or for the specified system level alarm Retrieves the alarm level s set for all Information Management Card IMC alarms or for the specified IMC alarm IOCm Retrieves the alarm level s set for all alarms in the specified Input Output Card module or for the specified alarm from the specified Input Output Card module a m 1 for the slot marked IOC 1 on the main shelf a m 2 for the slot marked IOC 2 on the main shelf Note Alarm level information is retrieved from
67. Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE HOLDFLT _ Defines if the output fault T1 ON a ON In fault mode generate are set or not set when outputs based upon system the LO enters Holdover SSM mode of operation The AIS In fault mode generate output groups are AIS outputs provisioned for fault SQUELCH In fault mode strategies outputs are turned off OUTSTATE The specified output T1 DISABLE a ENABLE Enable the output state has changed to generate the defined signal type DISABLE Disable the output NTP Event Codes AUTHEN Allows the user to enable or disable NTP Authentication This parameter applies to both Server and Peer EQPT DISABLE ENABLE NTP Authentication is enabled DISABLE NTP Authentication is disabled KEYGEN Indicated that the Authentication Key table is being generated EQPT NA NA SERVER Indicates that a user has changed the NTP Peer Server parameters EQPT NA NA BRDGTIM Bridging Time in PRR mode the amount of time the system stays in Bridging Mode SYS Event Codes EQPT 900 seconds 300 to 500000 seconds DISABLE CLRDELAY The time in seconds before a faulted signal indicates it is valid to be used as a system reference EQPT 5 seconds 0 to 1000 seconds GPSCLRDEL The time in seconds after a cleared GPS fault can be used EQPT 5 0 to 1000 seconds ELEVTI
68. FAIL FIRMWARE UPGRADE UNSUCCESSFUL FWOK FIRMWARE UPGRADE SUCCESSFUL FWLOAD BEGINNING FIRMWARE UPGRADE IOCMODE IOC MODE IS lt mode gt IOCSTATE IOC STATE HAS CHANGED lt state gt RESET MODULE HAS BEEN RESET IOC Clock Event Conditions CLKFSTLK CLOCK ENTERED FAST LOCK MODE CLKLOCK CLOCK ENTERED LOCK MODE SCAVAIL SMARTCLOCK ALGORITHM lt value gt IOC Input Event Conditions CKTIDCHG INPUT CIRCUIT ID HAS CHANGED lt cktid gt CRCENA INPUT CRC HAS CHANGED lt value gt FRMTYPE INPUT FRAMING TYPE HAS CHANGED lt value gt INSTATE INPUT STATE HAS CHANGED lt value gt PRIORITY PRIORITY HAS CHANGED lt value gt RQLEVEL RECEIVED QUALITY LEVEL HAS CHANGED lt old quality value gt lt new quality value gt 178 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Appendix C Events Table C 2 Event Code Condition Descriptions Continued Event ID Event Condition Description QLEVEL USER ASSIGNED QUALITY LEVEL HAS CHANGED lt value gt SSMBIT E1 SSM BIT HAS CHANGED lt bit position gt SSMENA INPUT READING OF SSM HAS CHANGED lt value gt THRCHG PM THRESHOLD HAS CHANGED lt PM type gt lt value gt IOC Output Event Conditions CKTIDCHG OUTPUT CIRCUIT ID HAS CHANGED lt cktid gt CRCENA OUTPUT GENERATION OF CRC HAS CHANGED lt value gt FREEFLT FREE RUN OUTPUT FAULT STRATEGY HAS CHANGED lt state gt FRMTYPE OU
69. Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt lt ipl gt lt stratum gt lt status gt lt precision gt lt delay gt lt offset gt lt dispersion gt lt jitter gt lt cr gt lt lf gt lt ip2 gt lt stratum gt lt status gt lt precision gt lt delay gt lt offset gt lt dispersion gt lt jitter gt lt cr gt lt lf gt lt ip8 gt lt stratum gt lt status gt lt precision gt lt delay gt lt offset gt lt dispersion gt lt jitter gt lt cr gt lt lf gt T Table 2 25 RTRV NTP PEER Output Fields Field Description ip The IP address of the NTP server stratum The stratum level of the NTP server status The status of the NTP server as described in RFC 1305 Appendix B precision The precision value of the NTP server delay The client s calculated root delay value for the NTP server offset The client s calculated time offset value for the NTP server dispersion The client s calculated root dispersion value for the NTP server jitter The client s calculated network jitter Example To retrieve the NTP peer information from the TimeProvider Input RTRV NTP PEER TP 1100 122 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve NTP Information RTRV NTP PEER Normal Response TP 1100 06 02 14 11 01 01 M 0 COMPLD 172 16
70. GPS This command has a default access level of ADMIN Syntax ED DAT lt tid gt lt aid gt lt ctag gt lt keyword gt lt value gt Parameter Value Description lt aid gt SYS The command s effect is at the system level Note See Table 2 4 for lt keyword gt and lt value gt descriptions Table 2 4 ED DAT Keywords and Values for lt aid gt SYS lt keyword gt lt value gt Description Default DATCHG yy mm dd The year month and day set for the system N A yy the 2 digit year mm the 2 digit representation of the month dd the day of the month TIMCHG hh mm ss The hours minutes and seconds set for the system N A hh hour in 24 hour format mm minutes ss seconds LOCTIM hh mm The hours and minutes that local time is offset from UTC N A hh the local time s hour offset from UTC 12 hours mm the local time s minute offset from UTC Example To change the system time to 1 35 56 PM Input ED DAT SYS TP1000 TIMCHG 13 35 56 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 2535 REPT EVT SYS EQPT TIMCHG TC 05 02 10 13 35 56 SYSTEM TIME HAS CHANGED 13 35 56 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 47 Chapter 2 TL1 Command Syntax and Description Edit Equipment ED EQPT Edit Equipment ED EQPT This comm
71. In Process response TL1 Command IP ctag lt cr gt lt l1f gt lt lt cr gt lt lf gt lt 1lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt 1lf gt textblk lt cr gt lt lf gt where indicates zero or more of the preceding element 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 19 Chapter 1 TL1 Overview Autonomous Messages When the TimeProvider finishes processing the original command the In Process response is followed with either a Normal or Error response as is appropriate Table 1 4 provides a description of each field contained in the In Process response Table 1 4 In Process Response Fields Field Description sid 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 time The time of the response in the format HH MM SS where HH is the hour in 24 hour format MM is the minutes and SS is the seconds 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 Autonomous Messages In addition to the TL1 respo
72. LEVEL and PRIORITY settings FORCED Input reference selection is determined by the INPREF parameter setting AUTO GPSCLRDEL 0 1000 The time in seconds that elapses after a GPS fault clears and before the associated alarm condition clears This delay helps prevent an alarm from clearing before the GPS is stable GPSFLTDEL 0 1000 The time in seconds that elapses after a GPS fault occurs and before the associated alarm condition is set This delay helps prevent spurious alarms INPREF GPS The GPS input is selected as the reference when REFMODE FORCED PRS The PRS input is selected as the reference when REFMODE FORCED INP 1 Input 1 is selected as the reference when REFMODE FORCED INP2 Input 2 is selected as the reference when REFMODE FORCED Note When INPREF is used as a keyword with the RTRV SYNC command the input that is currently selected as the system reference is returned PRS CCALIGN NA Allows the user to clear an INPTRR alarm against the current reference by forcing the CC output into polarity alignment with the reference This is a non persistent value when the alignment is complete the value returns to its previous value NA lt aid gt GPS 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 59 Chapter 2 TL1 Command Syntax and Description Edit Sync ED SYNC Table 2 6 ED SYNC K
73. M OK no 1OC1 2 TO2 1 COMM alarm is currently active or 1OC1 2 TO2 1 COMM ALM an 1OC1 2 TO2 1 COMM alarm is currently active imccomm Indicates if a communication alarm from the IMC to the IOC2 1 module currently is active The returned values can be IMC1 2 COMM OK no IMC1 2 COMM alarm is currently active or IMC1 2 COMM ALM an IMC1 2 COMM alarm is currently active lt aid gt 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 lt aid gt PRS prsstatus The current status of the PRS input The status can be OK no alarms are currently active for the specified component or ALM one or more alarms are currently active for the specified component lt aid gt INP1 INP2 inpstatus The current status of the specified input output or system component The status can be OK no alarms are currently active for the specified component or ALM one or more alarms are currently active for the specified component lt aid gt OUTA OUTB OUTC OUTD outstatus The current status of the specified output module 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 the OUTgEQPT
74. ME The alarm elevation time 1440 minutes was Enabled or Disabled EQPT DISABLE ENABLE DISABLE 174 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table C 1 Event Identifiers Continued Appendix C Events Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE FACTORY When the SYS is EQPT NA NA commanded to reset to Factory defaults it generates an event indicating the factory settings are being restored This resets all modules installed in the system at the time the command is issued FLTDELAY The time in seconds EQPT 5 seconds 1 to 15 seconds before a faulted signal indicates it is not valid to be used as a system reference GPSFLTDEL The time in seconds EQPT 1 second 1 to 1000 seconds before a GPS fault indicates it is not valid INPREF Indicates when the T1 PRS PRS Select PRS input system automatically INP1 Select Input 1 selects a new reference INP2 Select Input 2 input GPS is selected as system Allows the user to f reference only in PRR mode of manually select the input operation to be used for the system reference The reference selection mode REFMODE must be set to FORCED LOCTIM The system local time EQPT 00 00 m hh Hours offset 12 offset was changed mm minutes offsegt 00 to 59 REFMODE Allows the system to EQPT AUTO a AUTO System uses Qlevel automatically select the
75. ODE Keyword and Values 000 20 e eee eee eee 143 2 35 SET TH Keywords and Values for all lt aidS gt 0 00000 eee eee 145 2 36 Wask labled sc dara Vien ea ce ooh aha S ere there eet Pose eRe eae 146 A 1 Security and Administrative Commands 00 0 eee eee eee 147 A 2 System Commands s c ccrr dares chute ey arin ck aides POEMS ey aed 148 A 3 Performance Monitoring Commands 000 cece eee eee 149 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 5 Table of Contents B 1 B 2 C 1 C 2 Alarms Bie tte Dats dA A yt cares Die Nee i a a a 151 Alarm Code Condition Descriptions 0 000 c eee eee 161 Eventilaentitlens 23 siye sea piven date dae Bite av nue send nk EA re eae ae Reg 165 Event Code Condition Descriptions 0 00 0 e eee eee 177 6 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 How to Use This Guide This section describes the format layout and purpose of this guide In This Preface Purpose of This Guide a Who Should Read This Guide Structure of This Guide a Conventions Used in This Guide a Warnings Cautions Recommendations and Notes a Related Documents and Information a Where to Find Answers to Product and Document Questions a Whats New In This Guide 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 7 How to Use This Guide Purpose of This G
76. OOF must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPOOF is set the alarm clears when the input signal is OOF free for the Clear Delay Time CLRDELAY T1 NSA IMMED NO MN MN MN INPPHASE The specified input port has a excessive phase measurement that is disqualifies it from being used T1 NSA IMMED NO MN MN MN INPQL Alarm indicating the received SSM is of lesser quality than the Local Oscillator s QLEVEL for a specified input T1 NSA IMMED NO MN MN MN 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 159 Appendix B Alarms Table B 1 Alarms Continued Alarm Default oon E Alarm Condition AID Service Eror Error Level Ss Delay Delay CONDTYPE poscnpiion Type Affecting Default Editable SSU PRS SUB INPFRQ The specified input port s T1 NSA IMMED NO MN IMN NR calculated received frequency is exceeding the pull in range of the local oscillator The received signals calculated frequency alarmed condition disqualifies the input as a possible reference After INPFRQ is set the alarm clears when the input frequency is within the defined pull in range limits INPTRR The specified CC input T1 NSA IMMED INO MN IMN IMN port has a Tip Ring reversal on it s connection to the system EXDSC Input h
77. Oscillator SQUELCH enters Free run mode SQUELCH Outputs are squelched turned off when the Local Oscillator enters Free run mode HOLDFLT ON Outputs are generated when the Local Oscillator ON enters Holdover mode SQUELCH Outputs are squelched turned off when the Local Oscillator enters Holdover mode Note 1 Used only in Japanese version Example To provision the interface type of the inputs as T1 inputs Input ED SYNC INP1 TP1000 FRMTYPE D4 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 2556 REPT EVT INP1 T1 FRMTYPE TC 05 02 10 13 35 56 INPUT FRAMING TYPE HAS CHANGED D4 64 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt tid gt lt uid gt lt ctag gt lt keyword gt lt value gt Parameter Value Description lt uid gt text string level is being changed The user name assigned to the user for which the access Note See Table 2 7 for lt keyword gt and lt value gt descriptions Table 2 7 ED USER SECU Keyword and Values for lt uid gt text string
78. R3 lt mgr3 gt lt sender3 gt lt iftout3 gt lt ifretry3 gt P MGR4 lt mgr4 gt lt sender4 gt lt iftout4 gt lt ifretry4 gt P MGR5 lt mgr5 gt lt sender5 gt lt iftout5 gt lt ifretry5 gt P lt snmpport gt lt trapport gt Table 2 15 RTRV COND Output Fields Field Description lt aid gt 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 expneqpt Indicates if the connection to the expansion output panel was lost The possible returned values can be either EXP OK no EXPFAIL alarm is currently active or EXP ALM an EXPFAIL alarm is currently active extalm1 Indicates if external equipment is currently generating alarm s The possible extalm2 returned values can be either EXT1 2 OK no EXTALM1 2 alarm is currently active or EXT1 2 ALM an EXTALM1 2 alarm is currently active ioc1eqpt Indicates if the system is equipped with an IOC module in the specified slot The ioc2eqpt possible returned values can be either IOC 1 2 EQPT an IOC1 2 EQPT event was received or 1OC1 2 UNEQPT no IOC1 2 EQPT event was received sysqlevel Indicates the system output quality level 1 through 9 lastdat The date the system was last provisioned by a user when the IOC was rebooted or th
79. REE RUN MODE Autonomous Message None 120 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt ctag gt Example To retrieve the NE type from the TimeProvider Input RTRV NETYPE TP1000 Normal Response TP SSU 05 02 10 13 37 39 M TP1000 COMPLD TimeProvider Autonomous Message None 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 121 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 This command has a default access level of USER Syntax RTRV NTP PEER lt tid gt lt ctag gt Command Output The following shows the event output format of the command Table 2 25 describes the fields in the response Event Response
80. RTMA UNEQUIPPED UNEQUIPPED RTMB UNEQUIPPED UNEQUIPPED RTMC UNEQUIPPED UNEQUIPPED RTMD UNEQUIPPED UNEQUIPPED E422A UNEQUIPPED E422B UNEQUIPPED E422C UNEQUIPPED E422D UNEQUIPPED Autonomous Message None 98 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt tid gt lt ctag gt Notes The information displayed for the system input output and expansion components is reported by the active IOC If neither IOC is active the information for the input and output components and some of the system components is determined by the IOC1 module if it is installed or the OC2 module if the OC1 module is not installed If the IMC module cannot read information from either IOC module the related information is not displayed in the command output If either an 1OC1 2 EQPT or IOC 1 2 COMM alarm is active then no IOC 1 2 information is displayed Command Output The following shows the output format of the command and Table 2 16 describes the various fields in the command output Response Format lt cer gt lt lf gt lt l1lf gt
81. RTMg g A B C D Clears alarms associated with RTMgEQPT alarms if the module is not to be replaced EXPN Clears alarms associated with EXPNEQPT alarms if the panel is not to be replaced TPIU Clears alarms associated with TPIUEQPT alarms if the panel is not to be replaced Example To clear the OUTEQPT alarm after permanently removing the Output module from group B Input RMV EQPT SYS TP1000 OUT 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 77 Chapter 2 TL1 Command Syntax and Description Remove Equipment RMV EQPT Response Example TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message None 78 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 or for the specified parameter a ALL Displays all active alarms EQPT Displays all active equipment alarms AIDTYPE EQPT a 11 Displays all active interface alarms AIDTYPE T1 This command has a default access level of USER Syntax RTRV ALM lt tid gt lt aid gt lt ctag gt or RTRV ALM ALL EQPT T1 lt tid gt lt aid gt lt ctag gt Parameter Value Description lt aid gt ALL Retrieves information for all alarms that are currently active or
82. RTRV SYNC Normal Retrieve Response lt cr gt lt lf gt lt 1lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt lt aid gt lt keyword gt lt value gt lt cr gt lt lf gt Table 2 29 RTRV SYNC Output Field Field Description lt aid gt The access identifier for the equipment component Refer to Edit Sync ED SYNC on page 58 for valid lt aid gt lt keyword gt The specific equipment parameter being requested Refer to Edit Sync ED SYNC on page 58 for valid lt keyword gt lt value gt The current setting of the requested equipment parameter Example To retrieve the current priority setting for input reference 2 Input RTRV SYNC INP2 TP1000 PRIORITY Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD INP2 PRIORITY 3 Autonomous Message None 132 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 a SSU The TimeProvider is provisioned in the Synchronization Supply Unit operating mode In SSU mode the system provides compliance with G 812 GR1244 and GR 378 a SUB The TimeProvider is provisioned in the Subtending SSU operating mode In SUB mode the system provides compo
83. RV LOG 10C1 TP1000 EVT Event Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD IOC1 EQPT BIBCKUP SC 05 02 10 13 37 39 BESTIME BACKUP REFERENCES DISQUALIFIED IOC1 EQPT CLKTYPE TC 05 02 10 13 35 56 CLOCK TYPE HAS CHANGED Alarm Response Format lt cr gt lt lf gt lt lf gt M sid date time lt cr gt lt lf gt ctag COMPLD lt cr gt lt lf gt lt aid gt aidtype ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt lf gt lt aid gt aidtype ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt lf gt lt aid gt aidtype ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt lf gt Table 2 24 RTRV LOG Alarm Output Fields Field Description aidtype Specifies if the event is associated with the internal operation of the system EQPT or external to the system or facility T1 ntfencde The notification code for the alarm or event The notification code can be CR critical alarm MJ major alarm MN minor alarm CL clearing event or NA non alarmed event or report condtype The TL1 alarm or event code that is associated with the event or alarm Note Table C 2 shows all of the possible TimeProvider event codes event condition types and Table B 2 shows all of the possible TimeProvider alarm condition types srveff Whether the event is service affecting SA or non service affecting NSA ocrdat The date the event occ
84. S ccc e re eee eee Ree eRe eek ada MERE ee eRe 16 Normal Response ss ntti se eee Sa te ee ae i oe oe ie Set 16 Large R SpONS E irs ceil eee rane Seer Guns gate ee ae ae eas Pee eG ee 17 Error Response arada e E E Boek Sas E Wie Rae Eels aa a sd are 18 In Process RESPONSE e oei A EEEE A wee O E A E 19 Autonomous Messages 2 2 2 hin a uncer seog beh okGaeERws ae wee oR AS cans 20 Command Security 6232 24 AN nts Mts tee Bled Bes AE oN Oh ate bier SNe cs Bh ae ote 23 Chapter 2 TL1 Command Syntax and Description TL1 Syntax GConventiGnS 20 n2cniited ees d esd ae aad eae cee Soe ee egle Bee i aad 28 Command Desernuons 2 234 tents Xe Site BE crt et Recah eB iis Ue oaks 28 Activate Feature ACT FEATURE 0 000 c eee 29 Activate Software Download Mode ACT SWDL 000000 eee eee 31 The Firmware Download Process 0000 e eee eee 32 Activate User AGT USER 2 etc coseeoe kd eda Hoey eee Sh koe Sk 37 Cancel User CANC USER ccc ciwse deeds eolen wet gee de eta oars Soe 38 Copy Memory GPY MEM 2 2 detest se wakce sade aarabpasineng ioles y ages 39 Delete Performance Monitoring Data DLT PM DATA 41 Delete Security DLT SECU 0 0 0 cc eee eee 42 Delete User Security DLT USER SECU 0 0 0 0 cee eee 43 Edit Circuit Identifier ED CKTID 26 5 5 2 2s 5 2a4e eat sine tiene am vie paw eal 44 Edit Command Security ED CMD SECU 2 0 00 eee 45 Edit Date ED DAT ec
85. SECU 0 05 91 Retrieve Condition RTRV COND 0 00 e eee eee 94 Retrieve Craft Data RTRV CRAFT 00000 c eee ee eee 99 Retrieve Date RIRV DAD iecsicrosceaes cos taes eck see vewals ead oes 107 Retrieve Equipment RTRV EQPT 00 0 2 cee eee eee 109 Retrieve GPS Status RTRV GPS STAT 0000 eee 111 Retrieve Header RTRV HDR 2 2 0 c ee eee eee 112 Retrieve Inventory RTRV INV 2 02 c eee ee 113 Retrieve LED Status RTRV LED 2 002 115 Retrieve Log RTRV LOG uscoiece a helene ete he Bee ee oe Be bReN 117 Retrieve Network Equipment Type RTRV NETYPE 44 121 Retrieve NTP Information RTRV NTP PEER 000 0 eae 122 Retrieve PM RT RV PM oj cca k eases ws geen eaee es Reba Re eRe ae 124 Retrieve Sync RTRV SYNC vs sc ee eee eased ee es ee gee bea eels 131 Retrieve System Mode RTRV SYS MODE 0000 nan 133 Retrieve Threshold RTRV TH 20 0200 ee 134 Retrieve User RTRV USER 0 00s eee eee ee 136 Retrieve User Security RTRV USER SECU 00000 eee 137 Set Attribute SET ATTR mieri sered nirt n eee bee Ek eee CR Ee i 140 Set Source Identifier SET SID n nananana 142 Set System Mode SET SYS MODE 0000 0 eee ees 143 Set Threshold SET TH go5 4 rk cea eee ed oe oS RA Gee eee 6 145 Appendix A TL1 Command by Function Appendix B Alarms
86. SSU 05 02 10 13 35 56 M TP1000 COMPLD T Autonomous Message TP SSU 05 02 10 13 35 56 A 2533 REPT EVT IMC EQPT USRDEL TC 05 02 10 13 35 56 USER HAS BEEN DELETED 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 43 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 Syntax ED CKTID lt tid gt lt ctag gt lt value gt Parameter Value Description lt aid gt GPS PRS INP1 INP2 The command s effect is on the specified input OUT og p or output g A B C D p 1 to 16 Note See Table 2 2 for lt keyword gt and RTMo p lt value gt descriptions g A B CID p 1 2 E4229 p g A B CID p 1 to 8 Table 2 2 ED DAT Keywords and Values for lt aid gt SYS lt keyword gt lt value gt Description Default CKTIDCHG up to 40 characters Example A valid CKTID is up to 40 characters and must be enclosed in quotes N A To change the circuit ID on INP1 to ABC123 Input Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 2535 REPT EVT
87. TIVATED NTP 30 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 This command has a default access level of ADMIN Syntax ACT SWDL lt tid gt lt aid gt lt ctag gt Parameter Value Description lt aid gt IMC The Information Management Card IMC is placed in firmware download mode to download firmware to the IMC module using the Ymodem file receiver IOC The Information Management Card IMC is placed in firmware download mode to download firmware to the Input Output Card IOC module using the Ymodem file receiver Note In systems that have redundant IOC modules both IOC modules should be operating with the same version of firmware The system automatically ensures that both IOC modules receive the same version of firmware lOCm The Information Management Card IMC is placed in firmware download mode to download firmware to the Input Output Card IOC module and
88. TPUT FRAMING TYPE HAS CHANGED lt value gt HOLDFLT HOLDOVER OUTPUT FAULT STRATEGY HAS CHANGED lt state gt OUTSTATE OUTPUT GROUP STATE HAS CHANGED lt value gt SSMBIT E1 OUTPUT SSM BIT HAS CHANGED lt bit position gt SSMENA OUTPUT GENERATION OF SSM HAS CHANGED lt value gt EIA 422 Output Event Conditions CKTIDCHG OUTPUT CIRCUIT ID HAS CHANGED lt cktid gt FREEFLT FREE RUN OUTPUT FAULT STRATEGY HAS CHANGED lt state gt FRMTYPE OUTPUT FRAMING TYPE HAS CHANGED lt value gt HOLDFLT HOLDOVER OUTPUT FAULT STRATEGY HAS CHANGED lt state gt OUTSTATE OUTPUT GROUP STATE HAS CHANGED lt value gt NTP Event Conditions AUTHEN NTP AUTHENTICATION lt state gt KEYGEN NTP AUTHENTICATION HAS CHANGED SERVER NTP SERVER CONFIGURATION HAS CHANGED SYS Event Conditions BRDGTIM BRIDGING TIME HAS CHANGED lt value gt CLRDELAY INPUT CLEAR DELAY HAS CHANGED lt value gt DATCHG SYSTEM DATE HAS CHANGED lt date gt ELEVTIME ALARM ELEVATION TIME HAS CHANGED lt state gt FACTORY PROVISIONED TO FACTORY DEFAULTS 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 179 Appendix C Events Table C 2 Event Code Condition Descriptions Continued Event ID Event Condition Description FLTDELAY INPUT FAULT DELAY HAS CHANGED lt value gt GPSCLRDEL GPS FAULT DELAY HAS CHANGED lt value gt GPSFLTDEL GPS FAULT DELAY HAS CHANGED lt value g
89. TYPE keyword 61 62 64 FUNC keyword 54 56 G gateway address setting 50 generating NTP keys 55 GPS input alarm condition descriptions 162 alarm list 154 155 alarm threshold setting 145 alarms retrieving 79 antenna position setting 51 circuit ID retrieving 90 circuit ID setting 44 craft data retrieving 102 enabling disabling monitor 51 equipment parameters retrieving 109 equipment parameters setting 48 51 event list 168 event log retrieving 117 retrieving status 111 status retrieving 94 sync parameters retrieving 131 Index F I sync parameters setting 58 59 GR 833 time and date format 21 49 H hardware version retrieving 113 header retrieving 112 HOLDFLT keyword 63 64 IBEX error code 18 IBMS error code 18 ICNV error code 18 IIAC error code 18 IICM error code 18 IICT error code 19 IITA error code 19 IMC alarm condition descriptions 161 alarm list 152 alarms retrieving 79 craft data retrieving 101 event list 165 168 event log retrieving 117 LED status retrieving 115 MAC retrieving 113 resetting 73 status retrieving 94 INACTTIME keyword 49 INIT LOG command 72 INIT SYS command 73 INPREF keyword 59 in process TL1 command response 19 inputs alarm condition descriptions 163 alarm list 158 160 alarm threshold setting 145 alarms retrieving 79 circuit ID retrieving 90 craft data retrieving 103 equipment parameters retrieving 109 equipment parameters setting 48 52 event list 170
90. The Istate is a provisioning configuration file for the module and a copy of the Istate from each of the IOC and IMC modules can be stored on each of the other modules Use the CPY MEM command to copy IStates in the following cases a The IMC Module is Replaced In this case before you remove the IMC module copy the IMC Istate to the active IOC module Replace the IMC module then copy the IMC Istate back to the replacement IMC module to provision it with the settings of the IMC module it replaced Note When the IMC Istate is copied from an IOC module to the IMC module all users are logged out of the system This happens because the IMC Istate can contain a different user list than the user list in effect before the Istate transfer Additionally other settings can change including communications parameters baud rate and IP address 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 39 Chapter 2 TL1 Command Syntax and Description Copy Memory CPY MEM A 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 lt uids gt and lt pids gt are known to avoid being locked out of the system a The IOC Module is Replaced in a Single IOC System In this case copying the IOC Istate to the IMC module replacing the IOC module then copying the IOC Istate back to the replacement IOC module effectively provisions the
91. U FRANKJ TP1000 GyRo 23 USER Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Legacy Autonomous Message TP SSU 05 02 10 13 35 56 A 2560 REPT EVT IMC EQPT USRADD TC 05 02 10 13 35 56 USER HAS BEEN ADDED GR833 Autonomous Message TP SSU 05 02 10 13 35 56 A 2560 REPT EVT IMC USRADD TC 05 02 10 13 35 56 USER HAS BEEN ADDED SNMP Syntax SNMP V1 and V2 users are called communities while in SNMP V3 they are called users SNMP users are separate from the TL1 users defined above The community user name is a string of up to 20 alphanumeric case sensitive characters The TimeProvider TL1 automatically assigns all characters as upper case if the SNMP community user name is case sensitive then enclose the name in quote marks to ensure case sensitivity ENT USER SECU lt tid gt lt uid gt lt ctag gt lt authpass gt lt uap gt lt privpass gt lt usertype gt lt engineid gt Parameter Value Description lt uid gt text string V1 V2 community name or V3 user name Up to twenty 20 alphanumeric characters must be enclosed in quotes to be case sensitive Note To use case sensitive names or users lt uid gt must be enclosed in quotes in the command line lt authpass gt text string Authentication password for V3 user Minimum length is 8 characters maxi
92. Values for lt cid gt text string lt keyword gt lt value gt Description Default ACCLVL NONE The specified command allows any user to use it even if N A the user is not currently logged on to the system USER The specified command allows users with an access level of USER ADMIN and SECURITY to use it ADMIN The specified command allows users with an access level of ADMIN and SECURITY to use it SECURITY The specified command allows users with an access level of SECURITY to use it 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 45 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 M TP1000 COMPLD r Autonomous Message IP SSU 05 02 10 1335856 A 2534 REPT EVT IMC EQPT ACCLVL TC 05 02 10 13 35 56 USER ACCESS LEVEL HAS CHANGED RTRV LOG 46 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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
93. alarm clears when the input signal is fault free for the Clear Delay Time CLRDELAY INPAIS The specified input port T1 NSA IMMED NO MN IMN MN is receiving an Alarm Indication Signal When AIS is detected the input is immediately removed from the possible reference list The AIS must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPAIS is set the alarm clears when the input signal is AIS free for the Clear Delay Time CLRDELAY 158 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table B 1 Alarms Continued Alarm ID or CONDTYPE Alarm Condition Description AID Type Service Affecting Error Delay Default Error Delay Editable Appendix B Alarms Alarm Default Level SSU PRS SUB INPLOS The specified input port has Loss Of Signal When LOS is detected the input is removed from the possible reference list The LOS must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPLOS is set the alarm clears when the input signal is LOS free for the Clear Delay Time CLRDELAY T1 NSA IMMED NO MN MN MN INPOOF The specified input port is receiving an Out Of Frame signal When OOF is detected the input is removed from the possible reference list The
94. ameter Value Description lt uid gt text string The user name for the user being set up Note The user name can be up to twenty 20 case insensitive alphanumeric characters lt pid gt text string The password for the user being set up Notes m The password can be up to twenty 20 characters long It must include at least two non alphabetic characters and must include at least one special character which is any printing character other than a letter of the alphabet a number a comma a colon or a semicolon m To use case sensitive passwords lt pid gt must be enclosed in quotes in the command line lt uap gt NONE The specified user is assigned an access level of NONE Note With an access level of NONE users can receive autonomous messages but have very limited command access USER The user being set up has USER access and is able to issue commands having an access level of NONE or USER ADMIN The user being set up has ADMIN access and is able to issue commands having an access level of NONE USER or ADMIN SECURITY The user being set up has SECURITY access and is able to issue all commands 68 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Enter User Security ENT USER SECU Example To add a user FRANK to the system with a case sensitive password of GyRo 23 and an access level of USER Input ENT USER SEC
95. ample the General Block or Parameter Block is the last block and is unused you can omit the colons and simply enter the semicolon terminating character to execute the command a The TimeProvider ignores extra spaces in the TL1 command line a TL1 commands are not case sensitive unless specified as such Command Descriptions The TL1 commands that are included in the TimeProvider s command set comprise the remainder of this chapter An entry is included for each command and the entries are organized in alphabetical order by verb modifier command code Each command entry is comprised of the following parts a A descriptive title for the command entry followed by the command s verb modifier command code enclosed in parentheses a A brief description of the command and the command s default access level a The command syntax which is followed by the parameters and keywords that can be used with the command a Further explanation follows the parameters keywords and values where necessary a An example of how to use the command completes each command entry 28 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Activate Feature ACT FEATURE Activate Feature ACT FEATURE This command enables the specified feature in the TimeProvider Once the feature has been enabled it cannot be disabled The NTP feature is identified by Symmetricom part number 920 58000
96. 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 The alarm level can be CR critical alarm MJ major alarm MN minor alarm NA non alarm event NR not reported or CL clearing event Example To display the current level set for the IMC module s OC1COMM alarm Input RTRV ATTR IMC TP1000 IOC1COMM Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD IMC IOC1COMM MN r Autonomous Message None 84 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt aid gt lt ctag gt Parameter Value Description lt aid gt IOCm Retrieves the BesTime status of the specified Input Output Card module m 1 for the slot marked IOC 1 on the main shelf m 2 for the slot marked IOC 2 on the main shelf Note See Table 2 12 for output descriptions Response Format lt cr gt lt lf g
97. and is used to provision equipment parameters To provision NTP parameters see ED EQPT for NTP Parameters on page 54 This command has a default access level of ADMIN Syntax ED EQPT lt tid gt lt aid gt lt ctag gt lt keyword gt lt value gt Parameter Value pDeseription See Table 2 5 for lt keyword gt and lt value gt descriptions lt aid gt SYS The command s effect is at the system level COMp The command s effect is on the communication port specified by p a p L for the local serial port p R for the remote serial port p forthe IP Ethernet port IlOCm The command s effect is on the IOC module specified by m a m 1 for the slot marked IOC 1 on the main shelf m 2 for the slot marked IOC 2 on the main shelf GPS The command s effect is on the GPS input PRS The command s effect is on the PRS input INPp The command s effect is on the input port specified by p p 1 forthe input marked INP 1 on the Input Connector module p 2 for the input marked INP 2 on the Input Connector module OUTg The command s effect is on the output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf RTMog p The command s effe
98. are version retrieving 113 source ID lt sid gt retrieving 112 setting 142 SRAC error code 19 SROF error code 19 SROU error code 19 srveff 81 119 SSMBIT keyword 62 63 SSMENA keyword 62 63 SSU mode setting 143 staging block 15 standby mode setting IOC 50 structure TL1 commands 14 SUB mode setting 143 subnet address setting 50 SWFA error code 19 syntax conventions TL1 28 system alarm condition descriptions 161 alarm list 151 152 alarms retrieving 79 craft data retrieving 100 equipment parameters retrieving 109 equipment parameters setting 48 49 event list 174 initializing to factory default 73 status retrieving 94 sync parameters retrieving 131 sync parameters setting 58 59 188 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 system mode retrieving 133 setting 143 T TDEV24 keyword 124 TDEV24 output example 129 threshold retrieving settings 134 setting 145 TIDQUIET keyword 49 TIMCHG keyword 47 time changing 47 retrieving 107 time and date format GR 833 21 49 TL1 command descriptions 31 146 TL1 command responses 16 error response 18 in process response 19 normal response 16 TL1 command structure 14 command code block 15 payload block 15 staging block 15 Index T X TL1 overview 13 TL1 syntax conventions 28 U user access levels 23 adding new 68 logging in 37 logging out 38 password editing 57 67 retrieving current 136 retrieving current se
99. as Japanese Composite Clock Jcc4 1 The framing type generated by the specified output group is provisioned as Japanese Composite Clock 4 62 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Edit Sync ED SYNC Table 2 6 ED SYNC Keywords and Values Continued lt keyword gt lt value gt Description Default FRMTYPE ISOLATED_ The framing type generated by the specified output cont d 1 group is provisioned as an isolated one test pattern FREEFLT ON Outputs are generated based on system SSM when SQUELCH the Local Oscillator enters Free run mode SQUELCH Outputs are squelched turned off when the Local Oscillator enters Free run mode AIS Outputs generate an AIS signal when the Local Oscillator enters Free run mode HOLDFLT ON Outputs are generated based on system SSM when ON the Local Oscillator enters Holdover mode SQUELCH Outputs are squelched turned off when the Local Oscillator enters Holdover mode AIS Outputs generate an AIS signal when the Local Oscillator enters Holdover mode SSMENA ENABLE ESF or E1 CCS outputs generate SSMs ENABLE DISABLE ESF or E1 CCS outputs do not generate SSMs SSMBIT 4 The output SSM is placed in bit position 4 ALL 5 The output SSM is placed in bit position 5 6 The output SSM is placed in bit position 6 7 The output SSM
100. as had excessive T1 NSA IMMED NO MN IMN IMN discontinuities This is indicated when there are more than 3 signal faults OOF BPV CRC or AIS within a 5 minute window The alarm clears when the 5 minute window contains less than 3 signal faults MTIE Input has exceeded at T1 NSA IMMED NO MN IMN MN least one of the MTIE alarm thresholds lt aid gt E422A E422B E422C E422D E422FAULT The EIA 422 Output T1 NSA IMMED NO NA INA NA module is not functioning lt aid gt RTMA p RTMB p RTMC p RTMD p S1LOS LOS on Side 1 T1 NSA IMMED NO MN IMN IMN S2LOS LOS on Side 2 T1 NSA IMMED NO NA NA_ NA EXSLIP Excessive Slip Rate T1 NSA IMMED NO NA INA JNA RTMFAULT The Retimer module is T1 NSA IMMED NO NA INA INA not functioning properly 160 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table B 2 Alarm Code Condition Descriptions Appendix B Alarms 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 EXTALM1 External Alarm 1 Set External Alarm 1 Cleared EXTALM2 External Alarm 2 Set External Alarm
101. ault Editable scu prs SUB lt aid gt PRS INPDISQ The specified input was T1 NSA FLT YES MN IMN IMN Disqualified or Qualified DELAY as a possible system reference The fault condition must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPDISQ is set the alarm clears when the input signal is fault free for the Clear Delay Time CLRDELAY INPLOS The specified input port T1 NSA IMMED NO MN IMN IMN has Loss Of Signal When LOS is detected the input is immediately removed from the possible reference list The LOS must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPLOS is set the alarm clears when the input signal is LOS free for the Clear Delay Time CLRDELAY 156 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table B 1 Alarms Continued Alarm ID or CONDTYPE Alarm Condition Description AID Type Service Affecting Error Delay Default Error Delay Editable Appendix B Alarms Alarm Default Level SSU PRS SUB INPFRQ The specified input port s calculated received frequency is exceeding the pull in range of the local oscillator The received signal s calculated frequency alarmed condition disqualifies the input as a possible reference After INPFRQ is set
102. cal alarm MJ a major alarm MN a minor alarm CL a cleared alarm or NA a non alarm event condtype The condition type which is the TL1 code that is associated with the alarm or event Table C 2 shows all of the possible TimeProvider event condition types and Table B 2 shows all of the possible TimeProvider alarm condition types condeff This defines an event s effect on the system CL indicates clearing of a standing condition Sc indicates a standing condition is raised and Tc indicates a transition of a condition Note All events listed in Table C 2 set CONDEFF to Tc If alarms listed in Table B 2 are provisioned as Not Alarmed NA CONDEFF is set to Sc when the alarm becomes active and CL when the alarm becomes inactive srveff Whether the alarm or event is service affecting SA or non service affecting NSA ocrdat The date the alarm or event occurred in the format YY MM DD ocrtim The time that the alarm or event occurred in the format HH MM SS condscr The condition string which is a description of the alarm or event It is a quoted text string preceded with the escape character Table C 2 shows all of the possible TimeProvider event condition strings and Table B 2 shows all of the possible TimeProvider alarm and clearing alarm condition strings Table B 2 shows all of the possible alarm condition types condtypes and alarm condition strings condscrs that might be returned by the TimeProvider in an Aut
103. can receive autonomous messages and has very limited command access m USER user can issue commands having an access level of NONE or USER a ADMIN user can issue commands having an access level of NONE USER and ADMIN a SECURITY user can issue all commands 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 137 Chapter 2 TL1 Command Syntax and Description Retrieve User Security RTRV USER SECU Table 2 31 RTRV USER SECU Output Fields Continued Field Description lt usertype gt The SNMP level of the specified user or community TL1 not included in the response message SNMPV1 SNMPV2C SNMPV3 SNMPMD5 SNMPMD5DES SNMPSHA SNMPSHADES lt engineid gt The engineid for the specified SNMP prinicpal This is a hexadecimal number with a dot separating each byte 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 TIMEPROVIDER 08 03 24 00 40 13 M 0 RTRV EC SECURITY S LAD LUSER USER TLINONE NONE S A TEST2 USER TEST3 ADMIN 4 SECURITY 1 NONE 2 USER 3 ADMIN 4 SECURITY SNMPV3SEC SECURITY SNMPV3 SNMPVLSEC SECURITY SNMPV1 SNMPMD5DESSECINF SECURITY SNMPMD5DES 00 C0 A8 05 59 SNMPMD 5USERINF USER SNMPMD5 AA BB CC DD 14
104. cess to all commands E Note The DLT SECU command is typically used only after the initial Example To delete all information from the user database which includes three entries in this example Input DLT SECU TP1000 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD T Field Description USRCLR All users have been deleted from the database Autonomous Message TP SSU 05 02 10 13 35 57 A 266 REPT EVT W IMC EQPT USRDEL TC 05 02 10 13 35 57 USER HAS BEEN DELETED 42 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 or to delete an SNMP principle Note The system does not allow the last security level user to be deleted if other users are defined in the system This command has a default access level of SECURITY Syntax DLT USER SECU lt tid gt lt uid gt lt ctag gt Parameter Value Description lt uid gt text string The user name assigned to the user being deleted Enclose the lt uid gt in double quote marks if the user or SNMP principle is case sensitive Example To delete user FRED from the system DLT USER SECU FRED TP1000 Normal Response TP
105. changed DISABLE The system does not automatically elevate alarms FACTORY none Sets the alarm level for all alarms to their factory settings N A SYS aid only Alarm ID NR The alarm level for the specified alarm is set as not reported N A NA The specified alarm is set as a non alarm event MN The alarm level for the specified alarm is set to minor MJ The alarm level for the specified alarm is set to major CR The alarm level for the specified alarm is set to critical Note See Table B 1 for a list of alarm identifiers and possible alarm levels that can be set Refer to Table B 1 for a list of all of the TimeProvider Alarm Identifiers Alarm IDs and a brief description of each The table also shows the possible alarm levels that can be set with the SET ATTR command whether or not the error delay is editable and certain other defaults for each Alarm ID Example To set the system level EXPFAIL event s alarm level to critical Input SET ATTR SYS TP1000 EXPFAIL CR Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD F Autonomous Message TP SSU 05 02 10 13 35 56 A 175 REPT EVT IMC EQPT ALMCHG TC 05 02 10 13 35 56 ALARM PARAMETER HAS CHANGED EXPFAIL CRITICAL r 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 141 Chapter 2 TL1 Command Syntax and Description Set Source Ident
106. ck contains the parameters associated with the command s operation In the TimeProvider s command syntax the Payload Block can take on either of the following two forms depending on the command 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 15 Chapter 1 TL1 Overview Responses a 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 Refer to Copy Memory CPY MEM on page 39 for an example of a command that uses a position defined payload block a Name Defined In a name defined payload block the parameters that make up the block take on the form lt keyword gt lt value gt The lt keyword gt identifies the parameter and lt value gt is that parameter s value Keywords are not case sensitive Refer to Edit Equipment ED EQPT on page 48 for an example of a command that uses a name defined payload block Responses When the TimeProvider receives and processes a command it returns one of the following types of responses a Normal Response a Large Response a Error Response In Process Response The following paragraphs explain these response types Normal Response The TimeProvider sends a Normal res
107. cronym or function immediately follows the first reference to the key if required TimeProvider Text in a source file or a system prompt or other text that Username appears on a screen ENGINE TDATA A command you enter at a system prompt or text you STATUS enter in response to a program prompt You must enter commands for case sensitive operating systems exactly as shown A re timing application A word or term being emphasized Symmetricom does not recommend A word or term given special emphasis Structure of This Guide on page 8 The blue text when viewed in a pdf file indicates a hyperlink to the indicated text 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 9 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 A N disregard warnings All warnings use this symbol Warnings are installation operation or maintenance procedures practices or statements that if not strictly observed may result in serious personal injury or even death Caution To avoid personal injury do not disregard cautions All A cautions use this s
108. ct is on the Retimer group and port specified by g p g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf p 1 for Port 1 on the Retimer module p 2 for Port 2 on the Retimer module 48 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Edit Equipment ED EQPT Parameter Value Beals ela See Table 2 5 for lt keyword gt and lt value gt descriptions lt aid gt E4229 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 for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf SNMP The command s effect is on the SNMP setup Table 2 5 ED EQPT Keywords and Values lt keyword gt lt value gt Description Default lt aid gt SYS INACTTIME 100 The amount of user command inactivity time to be set 1800 10000 This determines the amount of inactivity time before the user is automatically logged off of the system The range for time is 100 to 10000 in increments of 0 1 seconds A value of 0 disables au
109. curity level 137 user access level changing 65 V version retrieving 113 W warnings defined 10 X XON XOFF flow control setting 50 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 189 Index 190 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008
110. e Guide 097 58001 01 Revision G April 2008 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 Parameter Value ED PID lt tid gt lt uid gt lt ctag gt lt oldpid gt lt newpid gt Description lt uid gt text string The user name assigned to the user for which the password is being changed This must be the lt uid gt of the user logged into the current session lt oldpid gt text string The user s currently existing password Note This parameter must exactly match the existing password in the user database or a DENY response is returned lt newpid gt Example text string The user s new password Notes The password can be up to twenty 20 characters It must include at least two non alphabetic characters and must include at least one special character which is any printing character other than a letter of the alphabet a number a comma a colon or a semicolon m To use case sensitive passwords lt pid gt must be enclosed in quotes in the command line To change user Fred s password from FRED 1 to ETHEL 5 Input ED PID fred TP1000 FRE Normal Response M TP1000 COMPLD Autonomous Message U 05 02 10 13 35 56 TP SS A 2538 R EPT
111. e IOC module was removed or inserted The format is YY WM DD lasttim The time the system was last provisioned by a user when the IOC was rebooted or the IOC module was removed or inserted The format is HH MM SS lt aid gt IMC ioclcomm Indicates if an OC1 2 communication alarm currently is active The possible returned ioc2comm values can be either IOC 1 2 COMM OK no 10C1 2 COMM alarm is currently active or 1OC1 2 COMM ALM an 10C1 2 COMM alarm is currently active lt aid gt 10C1 lOC2 Note The following status conditions are reported by the IOC modules but are stored in the IMC When you issue the RTRV COND command the IMC reports the last status conditions it received from the IOC modules If a given IOC module is removed or develops a communication problem the status as reported by the IMC might not be accurate iocstatus The current status of the specified IOC module The status can be either OK no IOC alarms are currently active for the specified module or ALM one or more IOC alarms are currently active for the specified module 96 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Condition RTRV COND Table 2 15 RTRV COND Output Fields Continued Field Description ioccomm Indicates if a communication alarm from the IOC1 2 to the IOC2 1 module is currently active The returned values can be l OC1 2 TO2 1 COM
112. e 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 Syntax RTRV HDR lt tid gt lt ctag gt Example To retrieve the response header from the TimeProvider Input RTRV HDR TP1000 Normal Response TP SSU 05 02 10 13 37 39 M TP1000 COMPLD Response When Not Logged In TP SSU 05 02 10 13 39 12 M TP1000 DENY PLNA Autonomous Message None 112 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 RTIRV INV lt tid gt lt ctag gt Table 2 20 RTRV INV Output Fields Field Description p n The module s part number s n The module s serial number clei The Common Language Equipment Identification CLEI code for the module hw ver The revision number of the module s hardware fw ver The revision number of the module s firmware mac The media access control MAC address that uniquely identifies the Ethernet hardware for the IMC module The format is aa aa aa aa aa aa Command Output The following shows the output format of the command and Table 2 20 explains the various fields in the command output Response
113. eS Symmetricony TimeProvider 1000 and 1100 Edge Clock TL1 Reference Guide Revision G April 2008 Part Number 097 58001 01 Symmetricom Inc 2300 Orchard Parkway San Jose CA 95131 1017 U S A http www symmetricom com Copyright 2005 2008 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 Table of Contents Contents How to Use This Guide Purpose Of This Guide nc ces pet peice ed eae s be E Rae SER ee phe 8 Who Should Read This Guide c2 ses 2 seta ate Roe eh oe PROS aS Ee ed oe 8 siructure of TIS GUIE eta cua 4 beet a Dawe a BE Kew da eS Ree Seas 8 Conventions Used in This Guide 6 i228 au du ctdaa ete ee ve ade ed ve bees 9 Warnings Cautions Recommendations and Notes 0 000 eee 10 Related Documents and Information 02 0 cece eee 11 Where to Find Answers to Product and Document Questions 05 11 Whats New In This Guide nnana naaa 11 Chapter 1 TL1 Overview OVSINIGW sie toep palettes E baie RR EEE EAR a a Corks E e ora eed 14 TL1 Command Structure 0 cee eee eee 14 Command Code Block lt c oucsw setae he ia gee eee ieee Pe ehal ey ees 15 Staging BOCK 12 6 ee eiei ace eters sar ew See ee oe eh a ee AE cb he ee OR eee 15 Payload BIOCK aad stave sc ctieny Vee a tes Deaved Yon wae cee Ba See hati Geen 15 RESPONSE
114. elay Delay CONDTYPE Default Editable SSU PRS SUB SYNTHEOR The synthesizer EQPT SA IMMED NO MJ MJ MJ generating the modules stable output frequency has reached the defined End of Range for the type of oscillator used on the IOC lt aid gt GPS ANTCOMM Loss of communications T1 NSA GPSFLT NO MN IMN IMN to antenna DEL GPSPOS The GPS Antenna s Ti NSA GPSFLT YES MN IMN MN position is unknown DEL GPSPWR TimeProvider power to T1 NSA GPSFLT NO MN IMN IMN TPIU is either high or DEL low GPSSYS GPS System is T1 NSA GPSFLT YES MN IMN MN indicating an error with DEL BIST at startup TRAIM and or UTC ephemeris data GPSTRK The GPS Engine is not T1 NSA GPSFLT YES MN IMN MN tracking any satellites DEL INPDISQ The specified input was T1 NSA FLT YES MN IMN IMN Disqualified or Qualified DELAY as a possible system reference The fault condition must be continuously present for the Fault Delay Time FLTDELAY before disqualifying the input as a possible reference After INPDISQ is set the alarm clears when the input signal is fault free for the Clear Delay Time CLRDELAY 154 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table B 1 Alarms Continued Alarm ID or CONDTYPE Alarm Condition Description AID Type Service Affecting Error Delay Default Error Delay Editable Appendix B Alarms
115. ence Guide 097 58001 01 Revision G April 2008 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 Syntax DLT PM DATA lt tid gt lt aid gt lt ctag gt aid Description IOC m GPS GPS input on either of the two IOC modules m 1 or 2 IOC m PRS PRS input on either of the two IOC modules m 1 or 2 IOC m INP p Input 1 or Input 2 on either of the two IOC modules m 1 or2 andp 1 or 2 Example To delete all performance data associated with the specified module Input DLT PM DATA IOC1 INP2 TP1000 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD r 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 41 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 lt tid gt lt ctag gt installation of the TimeProvider When issued all existing user names and passwords are deleted from the user database Anyone who logs in to the TimeProvider in this condition has ac
116. escription Retrieve Craft Data RTRV CRAFT Table 2 16 RTRV CRAFT Output Fields Continued Field Description mode The user specified position mode AUTO MANUAL pos The antenna latitude longitude and height setting The format is dd mm ss ss N or S dd mm ss ss E or W hhhh hh where dd is degrees mm is minutes ss ss is fractional minutes and hhhh is altitude in meters elevmask The current elevation mask in degrees 5 6 45 lt aid gt PRS prsstatus The current status of the PRS OK ALM instate The state of the PRS input ENABLE DISABLE MONITOR qlevel The provisioned quality level for the PRS input 1 2 9 priority The provisioned priority level for the PRS input 1 2 3 4 frmtype The PRS input frequency setting 2M 5M 10M lt aid gt INPp inpstatus The current status of the specified input OK ALM instate The state of the specified input ENABLE DISABLE MONITOR qlevel The provisioned quality level for the specified input 1 2 9 priority The provisioned priority level for the specified input 1 2 3 4 frmtype The frame signal type provisioned for the specified input 2M CCS D4 ESF CC rqlevel The quality level received on the specified input 1 2 10 crcena The specified input is provisioned to utilize CRC4 checking ENABLE DISABLE ssmena The specified input is provisioned to read the received SSM ENABLE DISABLE ssmb
117. ew Retrieve Header RTRV HDR on page 112 Retrieve Inventory RTRV INV on page 113 Displays the response header information including the system identifier lt sid gt and the system date and time Retrieves the system inventory Retrieve LED Status RTRV LED on page 115 Retrieves the current state color of the various LED indicators that are on the panels of the IMC and IOC modules Retrieve Network Equipment Type RTRV NETYPE on page 121 Retrieves the network equipment NE type from the unit Retrieve NTP Information RTRV NTP PEER on page 122 Retrieves information about the NTP peer server Remove Equipment RMV EQPT on page 77 Allows the TimeProvider to test ping for network connectivity Table A 3 Performance Monitoring Commands Command Description Retrieve PM RTRV PM on page 124 Displays the current set of performance monitoring data for one input channel Delete Performance Monitoring Data DLT PM DATA on page 41 Deletes the current set of performance monitoring data for one input channel Set Threshold SET TH on page 145 Sets the alarm threshold for performance monitored data for example MTIE and Fractional Frequency Offset Retrieve Threshold RTRV TH on page 134 Displays the alarm level set for a particular alarm Set Attribute SET ATTR on page 140 Sets the alarm level that an event generates 097 58001 01 Revis
118. eywords and Values Continued lt keyword gt lt value gt Description Default QLEVEL 1 The user assigned quality level of the GPS input is 1 Note QLEVEL is specified as PRC PRS primary reference used when an clock source heen pane 2 The user assigned quality level of the GPS input is Seternme e ified as UNK STU traceability unk received quality specified as sync traceability unknown level If QLEVEL 3 The user assigned quality level of the GPS input is is provisioned specified as TYPE II ST2 stratum 2 below the quality level of the local 4 The user assigned quality level of the GPS input is oscillator the specified as TYPE I eae The 5 The user assigned quality level of the GPS input is input QLEVEL specified as TYPE V TNC transit node clock setting determines 6 The user assigned quality level of the GPS input is if the switching specified as TYPE III ST3E stratum 3E strategy is revertive or 7 The user assigned quality level of the GPS input is non revertive specified as TYPE IV ST3 stratum 3 Thi ing i l Sa S 8 The user assigned quality level of the GPS input is REFMODE is set specified as 811OPT3 SMC G 811 option 3 SONET to AUTO minimum clock 9 The user assigned quality level of the GPS input is specified as DUS do not use for timing synchronization PRIORITY 1 The priority level of the input is set to 1 1 2 The priority level of the input is set to 2 3 T
119. from the lt monval gt Input Notes To select a specific set of accumulated FFOFF 60 data from the previous 24 hours enter the start date st artdat start time starttim stop date stopdat and stop time stoptim If any startdat or starttm combination is null or outside of the previous 24 hour window the current 1 Hour 1 Minute Fractional Frequency Offset data is displayed The first line of the record has the first measurement requested the timestamp lt sampletim gt lt sampledat gt is associated with this measurement RTRV PM IOC1 GPS TP1000 FFOFF 60 Response Format lt cr gt lt lf gt lt 1f gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt TOCm INPp FFOFF 60 lt monval gt lt vldty gt lt sampledat gt lt sampletim gt lt cr gt lt lf gt WES Ka Sp Sep Ss op Sa Sp yp Sa yp RO Sp Se 8 CEO lt 1 We gt Sap Sty Sp Sy Seo kaag L gt er gt f gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 125 Chapter 2 TL1 Command Syntax and Description Retrieve PM RT RV 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 2 6 837 101 77237 31 47 32 183 129 64 51 27 52 41 70 14 7 63 18 89 12 58 40 101 27 103 4 10 a1 21 12 4 4 5 7715 19 113 66 t 42 10 52 70 94 22 87 16 74 113 16 75
120. gt IOCH BIST lt cr gt lt l1f gt lt IOC condscr gt lt cr gt lt lf gt active alarm conditions are shown on separate lines E Note An asterisk indicates that multiple lines could be listed all 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 87 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 IMC condscr RAM FAULT NVRAM FAULT GPS 1PPS FAULT may occur during IOC startup NETWORK FAULT SOFTWARE FAULT UNKOWN FAULT fault number NO FAULTS IOC condscr OUTPUT GROUP A CALIBRATION FAULT OUTPUT GROUP B CALIBRATION FAULT OUTPUT GROUP C CALIBRATION FAULT OUTPUT GROUP D CALIBRATION FAULT OUTPUT GROUP A FAULT OUTPUT GROUP B FAULT OUTPUT GROUP C FAULT OUTPUT GROUP D FAULT OUTPUT SYNTHESIZER UNLOCKED VCXO CONTROL VOLTAGE FAULT OCXO CURRENT LIMIT EXCEEDED RUBIDIUM UNLOCKED E1 PLL UNLOCKED T1 PLL UNLOCKED 5V POWER SUPPLY FAULT 3 3V POWER SUPPLY FAULT IMC POWER SUPPLY FAULT 15V POWER SUPPLY FAULT 1 8V POWER SUPPLY FAULT 6V POWER SUPPLY FAULT GPS POWER SUPPY FAULT FPGA ACCESS FAULT FPGA 40Hz FAULT UNKNOWN FAULT fault number NO FAULTS 88 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Example Chapter 2 TL1 Command Syntax and Description Retrieve Built I
121. gt lt lf gt sid date time lt cr gt lt 1lf gt M ctag COMPLD lt cr gt lt lf gt textblk lt cr gt lt l1lf gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 17 Chapter 1 TL1 Overview Responses Error Response The TimeProvider sends an Error response when a command is mis typed an invalid command is issued or some other operator error is performed The format of an Error response is as follows Note that M and DENY identify the response as an Error response lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag DENY lt cr gt lt lf gt errcde lt cr gt lt 1lf gt la Table 1 2 explains each field that is contained in the Error response Table 1 2 Error Response Fields Field Description sid 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 time The time of the response in the format HH MM SS where HH is the hour in 24 hour format MM is the minutes and SS is the seconds 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 i
122. haracter which is any printing character other than a letter of the alphabet a number a comma a colon or a semicolon m To use case sensitive passwords lt newpid gt must be enclosed in quotes in the command line Example To change the password for user FRED from FRED 1 to D1n0 br Input ENT PID FRED TP1000 D1n0 br Normal Response M TP SSU 05 02 10 13 35 56 TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 174 REPT EVT IMC EQPT PIDCHG TC 05 02 10 13 35 56 USER PASSWORD HAS CHANGED 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 67 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 You also use this command to enter SNMP communities users 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 The first user you create must be at the Security level After you create this user that user must log into the system using the Activate User ACT USER command to further provision the system This command has a default access level of SECURITY This command s access level cannot be changed Syntax ENT USER SECU lt tid gt lt uid gt lt ctag gt lt pid gt lt uap gt Par
123. he priority level of the input is set to 3 4 The priority level of the input is set to 4 Note If the QLEVEL on all inputs are equal then the input with the highest PRIORITY is selected The input PRIORITY settings determine if the switching strategy is revertive or non revertive This setting is used when REFMODE is set to AUTO lt aid gt PRS QLEVEL Refer to the QLEVEL description under the lt aid gt GPS heading in this table PRIORITY Refer to the PRIORITY description under the lt aid gt GPS heading in this table 60 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Edit Sync ED SYNC Table 2 6 ED SYNC Keywords and Values Continued lt keyword gt lt value gt Description Default FRMTYPE 1 544M The PRS input frequency is provisioned as 2M 1 544 MHz 2M The PRS input frequency is provisioned as 2 MHz 2048 kHz 5M The PRS input frequency is provisioned as 5 MHz 6 312M The PRS input frequency is provisioned as 6 312 MHz 10M The PRS input frequency is provisioned as 10 MHz Note If the input frequency does not match the FRMTYPE setting an input loss of signal INPLOS condition results lt aid gt INPp QLEVEL Refer to the QLEVEL description under the lt aid gt GPS heading in this table PRIORITY Refer to the PRIORITY description under the lt aid gt GPS
124. heading in this table FRMTYPE 2M Specified input frame signal type is 2M 2M Note When the Pa ESF TimeProvider is in CAS Specified input frame signal type is CAS Subtending mode CCS Specified input frame signal type is CCS see Set System Mode D4 Specified input frame signal type is D4 Super Frame PESME Esp Specified input frame signal type is ESF Extended on page 143 l Super Frame the frame signal type is 1 544M Specified input frame signal type is 1 544 MHZ automatically set to Composite 6 312M Specified input frame signal type is 6 312 MHz Clock CC or JCC by the system CC Specified input frame signal type is Composite Clock The Composite o l Clock FRMTYPE JCC Specified input frame signal type is Japanese cannot otherwise Composite Clock be selected by the JCC4 Specified input frame signal type is Japanese user Composite Clock 400 Hz CRCENA ENABLE Enables the use of CRC4 checking on the input DISABLE DISABLE Disables the use of CRC4 checking on the input Note If an input is provisioned to read SSMs SSMENA ENABLE CRC4 must be provisioned first 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 61 Chapter 2 TL1 Command Syntax and Description Edit Sync ED SYNC Table 2 6 ED SYNC Keywords and Values Continued lt keyword gt lt value gt Description Default SSMENA ENABLE The input is p
125. ient i Ried et et o a bate ee ee Deke aes dead 47 Edit Equipment ED EQPT sso 2h cots bade d 2 ards kone Sob echis BA eee oe 48 ED EQPT for NTP Parameters 225 2csdencak eats ab SAet bed eh ee Rak De 54 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 3 Table of Contents Edit Password ED PID cut cpteas ee hee a5 hts ait tad tot Oi re Bee E tt 57 Edit Sync ED SYNG Jaee Loe toe acc eraan ste pete x tiene arene Pagal Gag 58 Edit User Security ED USER SECU 0 0 0 65 Enter Password ENT PID 2 on iccc8 Cee ek dees bee ether Re Eaweses 67 Enter User Security ENT USER SECU 0 0 00 c eee ees 68 Generate Event GEN EV1 i 2 45 se640ea46 vaaduw gated he whebdn odes oo 71 Initialize Event Log INIT LOG x2 00062 vale aise we ante sige ris 6 0e wale Aint vince 72 Initialize System INIT SYS s 2c60 eoe4 este ek oe eae Nee ee ek teed es 73 Operate Alarm Cutoff OPR ACO ALL 00000 e eee eee 75 Ping PING marsi iraso fe nee a E a ee eee ee ews ESE 76 Remove Equipment RMV EQPT sannana anaana 77 Retrieve Alarm Condition RTRV ALM sesanan 0 ee eee eee eee 79 Retrieve Attribute RTRV ATTR 0 0202 ees 82 Retrieve BesTime Status RTRV BESTIME STAT 000 05 85 Retrieve Built In Self Test RTRV BIST 0 0002 e eee eee 87 Retrieve Circuit Identification RTRV CKTID 0 02 ee eee eee 90 Retrieve Command Security RTRV CMD
126. ifier SET SID S et 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 lt tid gt lt ctag gt lt keyword gt lt value gt Table 2 33 SET SID Keyword and Value lt keyword gt lt value gt Description Default SIDCHG 20 character The TimeProvider s source identifier N A text string Note The SID can be up to twenty 20 printing characters including the hyphen character If the SID contains a hyphen it does not require quotes Example To set the system s SID from BLUE to TP SSU Input S ET SID TP1000 SIDCHG TP SSU Normal Response M TP SSU 05 02 10 13 35 56 TP1000 COMPLD Autonomous Message TP S A 449 SU 05 02 10 13 35 56 REPT EVT IMC EQPT SIDCHG TC 05 02 10 13 35 56 SYSTEM S SOURCE ID HAS CHANGED TP SSU 142 TimePro vider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 In SSU mode
127. input marked INP 1 on the Input Connector module p 2 for the input marked INP 2 on the Input Connector module RTMg Sets the alarm level on the Retimer group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf E4229 Sets the alarm level on the EIA 422 output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf 140 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Set Attribute SET ATTR Table 2 32 SET ATTR Keywords and Values for all lt aids gt lt keyword gt lt value gt Description Default BRDGTIM 300 to In PRR mode this sets the length of time in seconds the 900 SYS aid 500000 system remains in bridging mode seconds onl y DISABLE Disables the Bridging mode ELEVTIME ENABLE Minor alarms elevate to Major and Major alarms elevate to DISABLE SYS aid Critical after the system elevation time has elapsed only Note The system elevation time is 86400 seconds 24 hours and cannot be
128. ion Retrieve Craft Data RTRV CRAFT RTMB 1 OK ENABLE 2 RETIME RETIME ON RTMB 2 OK ENABLE 2 RETIME RETIME ON RTMC 1 UNEQUIPPED DISABLE 2 CUTTHRU CU RTMC 2 UNEQUIPPED DISABLE 2 CUTTHRU CU RTMD 1 UNEQUIPPED DISABLE 2 CUTTHRU CU RTMD 2 UNEQUIPPED DISABLE 2 CUTTHRU CU E422A OK DISABLE 2M SQUELCH ON E422B OK DISABLE 2M SQUELCH ON E422C OK DISABLE 2M SQUELCH ON E422D OK DISABLE 2M SQUELCH ON NTP AUTHENTICATION ENABLE NTPs SERVER 254 255 255 254 0 16 1024 NO Autonomous Message None HRU ON HRU ON HRU ON HRU ON 106 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt tid gt lt aid gt lt ctag gt Parameter Value Description lt aid gt SYS The command s effect is at the system level Command Output The following shows the output format of the command and Table 2 17 explains the various fields in the command output Response Format lt cr gt lt lf gt lt lf gt M sid date time lt cr gt lt lf gt ctag COMPLD lt c
129. ion G April 2008 TimeProvider TL1 Reference Guide 149 Appendix A 150 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 The set and clear alarm conditional description is the text that appears when the event occurs In the following example INPLos is the Alarm ID and Los FAULT Is the set condition description INP1 T1 CR INPLOS NSA 05 01 17 15 10 03 LOS FAULT Table B 1 Alarms Alarm ID or CONDTYPE Alarm Condition Description AID Type Service Affecting Error Delay Default Error Delay Editable Alarm Default Level SSU PRS SUB lt aid gt SYS COMPAT System components for example IOC software and hardware are not compatible EQPT NSA IMMED NO MJ IMJ MJ EXTALM1 The external alarm used to monitor alarms generated by external equipment EQPT NSA IMMED NO MJ IMJ MJ EXTALM2 The external alarm used to monitor alarms generated by external equipment EQPT NSA IMMED NO CR ICR CR PWRA The IMC has detected the
130. is placed in bit position 7 8 The output SSM is placed in bit position 8 ALL The output SSM is placed in all bit positions lt aid gt RTMg p RTMLBO 0 Sets the Line Build out length to 0 to 133 ft 0 Note For the E1 Retimer the IPNV 1 Sets the Line Build out length to 133 to 266 ft Invalid Sets the Line Build out length to 266 to 399 ft Parameter DENY code is returned 3 Sets the Line Build out length to 399 to 533 ft 4 Sets the Line Build out length to 533 to 650 ft FREEFLT CUTTHRU Cut thru mode is engaged when the Local Oscillator RETIME enters Free run mode RETIME Cut thru mode is not engaged when the Local Oscillator enters Free run mode 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 63 Chapter 2 TL1 Command Syntax and Description Edit Sync ED SYNC Table 2 6 ED SYNC Keywords and Values Continued lt keyword gt lt value gt 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 lt aid gt E422g FRMTYPE 1 544M The framing type generated by the specified EIA 422 1 544M output group is provisioned as 1 544 MHz 2M The framing type generated by the specified EIA 422 output group is provisioned as 2 MHz FREEFLT ON Outputs are generated when the Local
131. it Equipment ED EQPT on page 48 for details You can only run the legacy format when you are managing the TimeProvider with TimeCraft 1 2 or earlier versions or TimePictra 3 7 or earlier versions To use the GR833 format you must have TimeCraft 1 3 or later versions or TimePictra 3 8 or later versions Legacy Event Response Format lt cr gt lt lf gt lt 1f gt sid date time lt cr gt lt lf gt alrmcde atag REPT EVT EQPT Tl lt cr gt lt lf gt aid aidtype condtype condeff ocrdat ocrtim condscr lt cr lf gt GR 833 Event Response Format lt cr gt lt lf gt lt 1f gt sid date time lt cr gt lt lf gt alrmcde atag REPT EVT AIDTYPE lt cr gt lt lf gt aid condtype condeff ocrdat ocrtim condscr lt cr 1f gt Alarm Response Format lt cr gt lt lf gt lt l1f gt sid date time lt cr gt lt lf gt alrmcde atag REPT ALM AIDTYPE lt cr gt lt lf gt aid aidtype ntfcncde condtype srveff ocrdat ocrtim condscr lt cr l1f gt Table 1 5 explains each field that is contained in an Autonomous Message Table 1 5 Autonomous Message Fields Field Description sid 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 message in the format YY MM DD where YY is the 2 digit year MM is the 2 digit represen
132. it The bit position at which the specified input is provisioned to read SSM 4 5 6 7 8 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 103 Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data RTRV CRAFT Table 2 16 RTRV CRAFT Output Fields Continued Field Description lt aid gt OUTg outstatus The current status of the specified output group OK ALM UNEQUIPPED outstate The state of the specified output group ENABLE DISABLE frmtype The framing type that the specified output group is provisioned to generate 2M CAS D4 ESF CC ISOLATED_1 freeflt The type of signal to be generated on the specified output group when the Local Oscillator enters Free run mode ON SQUELCH AIS holdfit The type of signal to be generated on the specified output group when the Local Oscillator enters Holdover mode ON SQUELCH AIS lt aid gt 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 0 1 2 3 4 freeflt The type of signal to be generated on the specified Retimer group and port when the Local Oscillator enters Free run mode RETIME CUTTHRU holdfit The type of signal to be generated on the specified Retimer gr
133. l The firmware upgrade of the IOC was successful IMCBIST The user has requested EQPT INA a PASSED test s passed the IMC to perform a FAILED test s failed Built in Self Test INACTTIME Set the communication EQPT 1800 0 Disable timeout inactivity timeout If no m 100 to 10000 seconds user command is entered within the specified time the user s session is terminated INITLOG The event log has EQPT NA NA initialized IPADDR The IMC Ethernet EQPT 0 0 0 0 1 0 0 1 to 254 255 255 254 address has changed IPGATE The IMC Ethernet gateway EQPT 0 0 0 0 1 0 0 1 to 254 255 255 254 address has changed IPSUB The IMC Ethernet subnet EQPT 255 255 255 0 1 0 0 1 to 254 255 255 254 mask has changed ISDIFF Indicates that the CRC of EQPT NA NA two Istates images stored on separate modules are different 166 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table C 1 Event Identifiers Continued Appendix C Events Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE ISEQ Indicates that the CRC of EQPT INA NA two Istate images stored on separate modules are equal LOGECHO Allows the system tobe EQPT ENABLE a ENABLE Echo the configured to echo the login logout events login or logout events DISABLE Do not echo the login logout events LOGIN A user has logged into EQPT NA NA the system LOGOUT A user has
134. l operation of the system EQPT or external to the system or facility T1 ntfencde The notification code for the alarm or event The notification code can be CR critical alarm MJ major alarm or MN minor alarm If the alarm is set to NA then this field is empty condtype The TL1 alarm code that is associated with the event or alarm Note Table B 2 shows all of the possible TimeProvider TL1 alarm codes condition types siveff Whether the event is service affecting SA or non service affecting NSA ocrdat The date the event occurred in the format YY MM DD 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 Note Table B 2 shows all of the possible TimeProvider alarm descriptions condition strings Example To display all currently active alarms from the system Input RTRV ALM ALL TP1000 Legacy Response Example TP SSU 05 02 10 13437239 M TP1000 COMPLD SYS EQPT MJ EXPFAIL SA 05 02 10 13 37 39 EXPANSION CONNECTIVITY FAILED TOC1 EQPT MJ CLKHOLD SA 05 02 10 13 37 39 CLOCK ENTERED HOLDOVER MODE TOC2 EQPT MJ CLKHOLD SA 05 02 10 13 37 39 CLOCK ENTERED HOLDOVER MODE GR833 Response Example Te SSU 05 02 10 13337739 M TP1000 COMPLD SYS MJ EXPFAIL SA 05 02 10 1
135. larm ID Set Alarm Condition Description Clear Alarm Condition Description 10C1 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 IOC State has Changed Unequipped IOC State has Changed Equipped SYNTHEOR Output Generator Exceeded Pull in Range Output Generator Within Pull in Range GPS Alarm Conditions ANTCOMM GPS Antenna Comm Fault GPS Antenna Comm Fault Cleared GPSPOS GPS Antenna Position Unknown GPS Antenna Position Known GPSPWR GPS Power Fault GPS Power Fault Cleared GPSSYS GPS System Fault GPS System OK GPSTRK GPS is Not Tracking Satellites GPS is Tracking Satellites INPDISQ Input Disqualified as Possible Reference Input Qualified as Possible Reference INPLOS LOS Fault LOS Fault Cleared INPPHASE Phase Error Exceeded Threshold Phase Error Within Threshold EXDSC Excessive Discontinuity Fault Excessive Discontinuity Cleared MTIE MTIE Threshold Exceeded MTIE Within Threshold FFOFF FFOFF Threshold Exceeded FFOFF Within Threshold TPIUSIG TPIU Signal Fault TPIU Signal Fault Cleared PRS Alarm Conditions INPDISQ Input Disqualified as Possible Reference Input Qualified as Possible Reference INPLOS LOS Fault LOS Fault Cleared INPFRQ Frequency Threshold Exceeded Frequency Within Threshold INPPHASE Phase Error Exceeded Threshold Phase Error Within Threshold EXDSC Exce
136. logged out of EQPT INA NA the system NTP A user has changed the EQPT INA NA NTP configuration PIDCHG The user s password EQPT pid User password up to 20 was changed in the alphanumeric characters database RESET When the IMC is EQPT NA NA commanded to reset it generates an event indicating that it is being restarted SIDCHG The system s source EQPT NA 20 character name used to identify identification was the network element changed in the database UIDCHG The user s name was EQPT luid uid User name can be up to 20 changed in the database characters USRADD The IMC user database EQPT uid uid Assigned user name was changed to add a pid pid Assigned user password User uap uap Assigned user access level USRDEL No users defined inthe EQPT NA NA user database USRDEL The user database was EQPT uid uid Username changed to delete a user 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 167 Appendix C Events Table C 1 Event Identifiers Continued Event ID or CONDTYPE Event Description AID TYPE Default Value Value Description XFERFAIL The transfer of the IMC Istate to the IOC was unsuccessful The transfer of IOC Istate to the IMC was unsuccessful The transfer of IOC Istate to the redundant IOC was unsuccessful EQPT NA NA XFEROK The transfer of IMC Istate to the IOC was successful The transfer
137. loss of power on the A connection EQPT NSA IMMED NO MJ IMJ MJ PWRB The IMC has detected the loss of power on the B connection EQPT NSA IMMED NO MJ MJ MJ IOC1EQPT IOC1EQPT indicates that the IOC was physically inserted or removed from the system EQPT NSA IMMED NO MJ MJ MJ IOC2EQPT IOC2EQPT indicates that the IOC was physically inserted or removed from the system EQPT NSA IMMED NO MJ MJ MJ 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 151 Appendix B Alarms Table B 1 Alarms Continued Alarm ID or CONDTYPE Alarm Condition Description AID Type Service Affecting Error Delay Default Error Delay Editable Alarm Default Level SSU PRS SUB EXPNEQPT The Expansion Panel was physically inserted or removed from the system EQPT NSA IMMED NO MJ MJ MJ lt aid gt IMC 10C1COMM A communication alarm with either of the OC1 modules EQPT NSA IMMED NO MN MN MN IOC2COMM A communication alarm with either of the IOC2 modules EQPT NSA IMMED NO MN MN MN IMCFAIL A summary alarm of IMC BIST faults EQPT SA IMMED NO MJ MJ MJ IMCTCPIP TCP IP activity is excessive a DoS attack could be in progress EQPT SA IMMED NO MN
138. lt cr gt lt lf gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 91 Chapter 2 TL1 Command Syntax and Description Retrieve Command Security RTRV CMD SECU Table 2 14 RTRV CMD SECU Output Fields Field Description command The identifier of the command for which the access level is displayed The command identifier is the part of the command syntax that appears before the first colon access The access level for the specified command The access level can be one of the following m NONE command can be issued by all users m USER command can be issued by users with an access level of USER ADMIN or SECURITY ADMIN command can be issued by users with an access level of ADMIN or SECURITY SECURITY command can be issued by users with an access level of SECURITY Example To display the current access level set for all TL1 commands Input RTRV CMD SECU ALL TP1000 92 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Command Security RTRV CMD SECU Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD ACT SWDL ADMIN ACT USER NONE U E CANC USER NONE CPY MEM ADMIN DLT SECU DLT USER D S ECURITY ECU SECURITY U ADMIN IN IN D PID USER FE S UO l UO gt 4 E gt O Fl i 10 td D U
139. lt lastdat gt lt lasttim gt lt cr gt lt lf gt IMC lt ioclcomm gt lt ioc2comm gt lt cr gt lt 1lf gt IOC1 lt iocstatus gt lt ioccomm gt lt imccomm gt lt cr gt lt lf gt IOC2 lt iocstatus gt lt ioccomm gt lt imccomm gt lt cr gt lt lf gt GPS lt gpsstatus gt lt cr gt lt lf gt PRS lt prsstatus gt lt cr gt lt lf gt INP1 lt inpstatus gt lt cr gt lt lf gt INP2 lt inpstatus gt lt cr gt lt lf gt OUTA lt outstatus gt lt cr gt lt lf gt OUTB lt outstatus gt lt cr gt lt lf gt OUTC lt outstatus gt lt cr gt lt lf gt OUTD lt outstatus gt lt cr gt lt lf gt RTMA lt rtmlstatus gt lt rtm2status gt lt cr gt lt lf gt RTMB lt rtmlstatus gt lt rtm2status gt lt cr gt lt lf gt RTMC lt rtmlstatus gt lt rtm2status gt lt cr gt lt lf gt RTMD lt rtmlstatus gt lt rtm2status gt lt cr gt lt lf gt E422A lt outstatus gt lt cr gt lt lf gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 95 Chapter 2 TL1 Command Syntax and Description Retrieve Condition RTRV COND T E s s s ag s s E422B lt outstatus gt lt cr gt lt lf gt E422C lt outstatus gt lt cr gt lt lf gt 422D lt outstatus gt lt cr gt lt lf gt P MGR1 lt mgr1 gt lt sender1 gt lt iftout1l gt lt ifretryl gt P MGR2 lt mgr2 gt lt sender2 gt lt iftout2 gt lt ifretry2 gt P MG
140. lt param gt EVT or null Generate all events non alarm for the specified lt aid gt SET Generate all SET alarms for the specified lt aid gt CLEAR Generate all CLEAR alarms for the specified lt aid Example To generate a set of CLEAR alarms Input GEN EVT IMC TP1000 CLEAR Normal Response lt cer gt lt lf gt lt lf gt sid date time lt cr gt lt 1lf gt M ctag COMPLDcr gt lt 1f gt A lt aid gt ntfcncde condtype srveff ocrdat ocrtim condscr lt cr gt lt lf gt where indicates zero or more of the preceding element Error Response lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt 1lf gt M ctag DENY lt cr gt lt l1f gt lt errcde gt lt cr gt lt lf gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 71 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 lt tid gt lt aid gt lt ctag gt Parameter Value Description lt aid gt IMC The command s effect is on the Information Management Card module Example To clear the event log on the IMC module Input INIT LOG IMC TP1000 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13
141. mand 48 NTP 54 ED PID command 57 ED SYNC command 58 ED USER SECU command 65 EIA 422 output alarm condition descriptions 163 alarm list 160 alarms retrieving 80 circuit ID retrieving 90 circuit ID setting 44 craft data retrieving 104 equipment parameters retrieving 109 equipment parameters setting 49 52 event list 173 event log retrieving 117 status retrieving 95 sync parameters retrieving 131 sync parameters setting 58 64 elevation mask antenna setting 51 ELEVMASK keyword 51 ELEVTIME keyword 141 ENT PID command 67 ENT USER SECU command 68 equipment parameters provisioning 48 error codes 18 19 IBEX 18 IBMS 18 ICNV 18 IIAC 18 IICM 18 IICT 19 IITA 19 IPEX 19 IPMS 19 IPNV 19 ISCH 19 ISPC 19 PLNC 19 SDBE 19 SDNR 19 SRAC 19 SROF 19 SROU 19 SWFA 19 184 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 error command response 18 event log clearing 72 events condition effect 118 condition type 118 list 165 176 notification code 118 occurrence date 119 occurrence time 119 retrieving 117 EVT keyword 118 expansion panel alarm 96 100 status retrieving 94 expneapt 96 100 extalm 96 100 external equipment alarm 96 100 F factory default initializing system to 73 FACTORY keyword 73 141 FFOFF keyword 146 FFOFF output example 125 FFOFF 60 keyword 124 firmware download 32 FLOW keyword 50 FLTDELAY keyword 59 FREEFLT keyword 63 64 FRM
142. mer group and port specified by g p g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf p 1 for Port 1 on the Retimer module p 2 for Port 2 on the Retimer module E4229 The command s effect is on the ElIA 422 output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf 58 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Edit Sync ED SYNC Table 2 6 ED SYNC Keywords and Values lt keyword gt lt value gt Description Default lt aid gt SYS CLRDELAY 0 1000 The time in seconds 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 FLTDELAY 1 15 The time in seconds that elapses after an LOS AIS or OOF fault occurs and before the associated alarm condition is set This delay helps prevent spurious alarms REFMODE AUTO The system automatically selects the reference input based on the Q
143. meters setting 48 52 event list 172 event log retrieving 117 Index N R status retrieving 95 sync parameters retrieving 131 sync parameters setting 58 62 OUTSTATE keyword 52 overview TL1 13 P password editing 57 67 payload block 15 peer NTP server configuring 54 retrieving data 122 performance monitoring deleting data 41 retrieving data 124 setting thresholds 145 PHASE keyword 124 PHASE output example 126 PING command 76 PLHA error code 19 POS keyword 51 PREFERRED keyword 54 PRIORITY keyword 60 61 PRR mode setting 143 PRS input alarm condition descriptions 162 alarm list 156 157 alarm threshold setting 145 alarms retrieving 79 circuit ID retrieving 90 circuit ID setting 44 craft data retrieving 103 equipment parameters retrieving 109 equipment parameters setting 48 52 event log retrieving 117 status retrieving 94 sync parameters retrieving 131 sync parameters setting 58 60 purpose of this guide 8 Q QLEVEL keyword 60 61 R rebooting IOC IMC 73 recommendations defined 10 REFMODE keyword 59 relays deactivating alarm 75 RESET keyword 73 resetting IOC IMC 73 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 187 Index S S responses TL1 command 16 retimer alarm condition descriptions 163 alarm list 160 alarm threshold setting 145 alarms retrieving 80 circuit ID retrieving 90 circuit ID setting 44 craft data retrieving 104 eq
144. module s flash memory and reboots that module If the shelf contains only one IOC module that module s flash memory is reprogrammed and the module is rebooted In these cases the system outputs are interrupted for up to 30 minutes until the upgraded IOC module enters Fast Locked mode If the system determines that all of the above criteria are true then the system places the active IOC module in Standby mode and the IOC module that was in Standby mode is placed into Active mode The system then reprograms the standby IOC module s flash memory and reboots it After the module reboots the system waits up to 30 minutes for its control loop to lock After its control loop locks the system places it in Active mode and places the other IOC module in Standby mode The system then reprograms the standby IOC module s flash memory and reboots it In this case the system outputs are not interrupted If at any time the above process fails for either IOC module for example if an IOC module fails to transition from Standby to Active mode the upgrade process aborts and the IOC modules return to normal operation using the existing versions of firmware 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 33 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 sys
145. module is removed from the shelf lt aid gt RTMA RTMB RTMC RTMD rtm1status The current status of the indicated port on the specified Retimer module The status rtm2status 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 the RTMgEQPT module is removed from the shelf lt aid gt E422A E422B E422C E422D outstatus The current status of the specified EIA 422 output module 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 the E422gEQPT module is removed from the shelf Example To display the current state and status for all AlDs 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 97 Chapter 2 TL1 Command Syntax and Description Retrieve Condition RTRV COND Input RTRV COND ALL TP1000 Response Example TP SSU 05 02 10 W3237 39 M TP1000 COMPLD SYS PWRA OK PWRB OK EXP OK FOCZ EOPT 2 05 02 10 1323723 IMC IOCLCOMM OK IOC2COMM OK EXT1 OK EXT2 OK IOC1 EQPT gu TOC1 OK IOC1TO2COMM OK IMC1COMM OK TOC2 0OK LOC2TO1COMM OK IMC2COMM OK GPS OK PRS SOK INP1 OK INP2 OK OUTA OK OUTB OK OUTC OK OUTD OK
146. mum is 64 characters Notes The following characters are not allowed space colon semicolon dash single quote and double quote m Leave this field blank for SNMP V1 and V2 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 69 Chapter 2 TL1 Command Syntax and Description Enter User Security ENT USER SECU Parameter Value Description lt uap gt NONE The specified user is assigned an access level of NONE Note With an access level of NONE users can receive autonomous messages but have very limited command access USER The user being set up has USER access and is able to issue commands having an access level of NONE or USER ADMIN The user being set up has ADMIN access and is able to issue commands having an access level of NONE USER or ADMIN SECURITY The user being set up has SECURITY access and is able to issue all commands lt privpass gt text string Privacy password for V3 user Minimum length is 8 characters maximum is 64 characters Notes The following characters are not allowed space colon semicolon dash single quote and double quote m Leave this field blank for SNMP V1 and V2 or V3 user without Privacy lt usertype gt SNMPV1 SNMP V1 community SNMPV2 SNMP V2 community SNMPV3 SNMP V3 user without authentication privacy SNMPMD5 SNMP V3 user with MD5 authentication and n
147. n The ACT SWDL command places either the IMC or IOC module depending on the specified AID in the firmware download mode so that firmware upgrades can be downloaded to the modules If IOCm m 1 or 2 is the specified AID firmware is transferred from the specified IOC to the redundant IOC Note Firmware transfer between IOCs is not allowed if the destination IOC is active Firmware download to the IMC or IOC module When the TimeProvider receives the ACT SWDL command for either the IMC or IOC module it automatically logs all users off of the system and locks the system against new logins The system then disconnects TL1 from the connection that sent the ACT SWDL command and starts the TimeProvider s internal Ymodem file receiver on that connection Note The Ymodem file receiver is not used in IOC to IOC firmware transfers A Ymodem file sender utility for example SynCraft or HyperTerminal is required for firmware downloads and it is this file sender utility that initiates the file transfer If the file transfer is not initiated by a Ymodem file sender within approximately 60 seconds of the ACT SWDL command being sent the unit returns an error response and the module returns to normal operation If the file transfer is initiated within 60 seconds the transfer of the file to the module takes place 32 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description The
148. n Self Test RTRV BIST To display the currently active faulted built in self test information for IOC1 Input RTRV BIST 10C1 TP1000 Response Example TP SSU 05 02 10 13 35 56 M TP1000 COMPLD IOCI BIST OUTPUT GROUP A FAULT El PLL UNLOCK ED IMC POW ER SUP PLY FAULT Autonomous Message None 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 89 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 lt tid gt lt aid gt lt ctag gt Parameter Value Description lt aid gt GPS Retrieves the circuit identification cktid for the designated PRS aid INPp OUTo p RTMgf p E422gf p Command Output The following shows the output format of the command Response Format lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt GPS lt cktid gt lt cr gt lt lf gt PRS lt cktid gt lt cr gt lt 1f gt INP1 lt cktid gt lt cr gt lt l1f gt INP2 lt cktid gt lt cr gt lt l1f gt OUTA 1 lt cktid gt lt cr gt lt lf gt OUTA 2 lt cktid gt lt cr gt lt lf gt OUTD 15 lt cktid gt lt cr gt lt lf gt OUTD 16 lt cktid gt lt cr gt lt lf gt
149. n is reported by the active IOC IMC Retrieves all conditions related to the Information Management Card module IOCm Retrieves current setup and conditions related to the system level functions of the Input Output Card module specified by m m 1 for the slot marked IOC 1 on the main shelf a m 2 for the slot marked IOC 2 on the main shelf Notes m f neither IOC is active the information for the input and output components and some of the system components are determined by the IOC1 module if it is installed or the IOC2 module if the IOC1 module is not installed a f either an IOC1 2 EQPT or IOC1 2 COMM alarm is active then no IOC1 2 information is displayed GPS Retrieves GPS input state and any alarm events associated with the GPS input PRS Retrieves PRS input state and any alarm events associated with the PRS input INPp Retrieves input state and any alarm events associated with the input specified by p p 1 for the input marked INP 1 on the Input Connector module p 2 for the input marked INP 2 on the Input Connector module Note This information is reported by the active IOC 94 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Condition RTRV COND Parameter Value Description lt aid gt OUTg Retrieves status of the output group specified by g cont d g
150. n the response errcde The error code which identifies the condition that caused the Error response to be returned See Table 1 3 for a description of each error code Table 1 3 describes each error code that might be returned in an Error response Table 1 3 Error Codes Returned in Error Responses F Meaning IBEX Extra Block in Command IBMS Missing Block in Command ICNV Command Not Valid invalid TL1 syntax IAC Invalid AID Code IICM Invalid Command invalid command or command with insufficient security clearance 18 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 1 TL1 Overview Responses Table 1 3 Error Codes Returned in Error Responses Continued Pa Meaning IICT Invalid CTAG IITA Invalid Target Identifier IPEX Extra Parameter IPMS Parameter Missing IPNV Parameter Not Valid ISCH Invalid Character syntax ISPC Invalid Punctuation syntax PLNA Privilege Login Not Active SDBE Database Error SDNR Data Not Ready SRAC Requested Access Configuration Not Valid SROF Requested Operation Failed SROU Requested Operation Unnecessary SWFA Working Unit Failed In Process Response If the TimeProvider cannot send a Normal response a Large 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
151. ndow the current 1 Hour 1 Second Phase data 1 nS resolution is displayed The first line of the record has the first measurement requested the timestamp lt sampletim gt lt sampledat gt are associated with this measurement Input RTRV PM IOC1 GPS TP1000 PHASE1S Response Format lt cr gt lt lf gt lt 1lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt TOCm INPp PHASE1S lt manval gt lt vldty gt lt sampledat gt lt sampletim gt lt cr gt lt lf gt MLD SLO SL SL SO SL Sy Sy lt gt lt gt lt Cr gt lt lfi gt MSL lt gt SS SO lt lt SK gt lt Cr gt lt lf gt lt cr gt lt lf gt lt l1lf gt 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 127 Chapter 2 TL1 Command Syntax and Description Retrieve PM RTRV PM Response Example TIMEPROVIDI M TP1000 IOC1 GE ER 05 0 RTRV PS PHAS 2 03 20 20 51 E1S 80 COMPL 05 02 03 19 20 42 eae 2 1 2 2 0 2 1 0 0 2 0 tirao 1 10 2 2 r she 1p 2g Slee p78 Op dy sy pels eZ po 3 TE Tasty arenor In a 1 1 12 2 1 50 T r 0 ae 1 0 1 3 2 17 09 24 15 0 r r af 272 4 07 2 NO p 1 aly Ho Oy Opp Soy Shel ol 1 0 070 gt 0 14 07 Lyly 0 3 1 1 0 3 f a EO EA E ie r o i Ver 0 eae 34 2 0 0 0 0 0 1 1 0 0 70 0 0 0 1 0 1 70 2 v3 SL ya Wg Lp lpn
152. ned an access level of NONE anyone with access to the unit s Serial or Ethernet ports can execute the command A user doesn t even have to be logged into the system to use commands that have an assigned access level of NONE a USER When a given command is assigned USER access level any valid system user having a user access level of either USER ADMIN or SECURITY can execute the command after logging into the system a ADMIN When a given command is assigned ADMIN access level any valid system user having a user access level of either ADMIN or SECURITY can execute the command after logging into the system a SECURITY When a given command is assigned SECURITY access level only valid system users having a user access level of SECURITY can execute the command after logging into the system Note The factory default access level can be changed for most of the TimeProvider TL1 commands however 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 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 23 Chapter 1 TL1 Overview Command Security Table 1 6 lists each of the TimeProvider s TL1 commands in alphabetical order The command type and default factory set access level is included in Table 1 6 for each command Table 1 6 TimeProvider TL1 Command Types and Access Levels Factory Set
153. nput cannot be selected as a system reference or used as a BesTime backup reference lt aid gt INPp INSTATE ENABLE The specified input is enabled ENABLE 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 reference or used as a BesTime backup reference lt aid gt OUTg OUTSTATE ENABLE The specified output group is enabled DISABLE DISABLE The specified output group is disabled lt aid gt E422g OUTSTATE ENABLE The specified EIA 422 output group is enabled DISABLE DISABLE The specified EIA 422 output group is disabled lt aid gt RTMg p RTMSTATE ENABLE The specified Retimer group is enabled ENABLE DISABLE The specified Retimer output group is disabled SLIPCLR NA Clears a current Slip alarm from the specified port NA lt aid gt SNMP IFTOUTX 0 100 SNMP INFORM timeout in seconds for manager x 15 x 1 5 When the timeout occurs the agent sends the INFORM message again IFRETRYx 0 10 SNMP INFORM retry limit for INFORM to manager x 0 x 1 5 52 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Edit Equipment ED EQPT Table 2 5 ED EQPT Keywords and Values Continued lt keyword gt lt
154. nses described above the TimeProvider might return Autonomous Messages to report alarms configuration changes or condition changes Frequently an Autonomous Message is returned at approximately the same time as the TL1 response that is associated with a command because the command happens to cause a change in the units state Autonomous Messages are not directly correlated with commands and they do not contain correlation tags ctags They should however have an lt atag gt which increments by one from 1 to 999999 for each autonomous event session The display of Autonomous Messages can be enabled or disabled using the ED EQPT TL1 command with the AOMERGE keyword E Note By default Autonomous Messages are displayed in the user s 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 Note that REPT identifies the response as an Autonomous Message EVT for an event and ALM for an alarm 20 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 1 TL1 Overview Autonomous Messages TimeProvider release 3 2 adds a second response format that meets GR 833 A new keyword EVTFORMAT allows you to select between the TimeProvider s legacy format and the GR 833 format see Ed
155. null in the entire system SYS Retrieves information for all currently active system level alarms IMC Retrieves information for all currently active alarms from the Information Management Card module IlOCm Retrieves information for all currently active alarms from the Input Output Card module specified by m a m 1 for the slot marked IOC 1 on the main shelf m m 2 for the slot marked IOC 2 on the main shelf GPS Retrieves information for all currently active alarms from the GPS module PRS Retrieves information for all currently active alarms from the PRS module INPp Retrieves information for all currently active alarms from the specified input port a p 1 forthe input marked INP 1 on the Input Connector module a p 2 for the input marked INP 2 on the Input Connector module 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 79 Chapter 2 TL1 Command Syntax and Description Retrieve Alarm Condition RTRV ALM Parameter Value Description lt aid gt RTMo p Retrieves information for all currently active alarms from the cont d specified Retimer module and port g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf p 1 for Port 1 on the Retimer module a p
156. o privacy SNMPMD5 SNMP V3 user with MD5 authentication and DES privacy DES SNMPSHA SNMP V3 user with SHA 1 authentication and no privacy SNMPSHA_ SNMP V3 user with SHA 1 authentication and DES DES privacy lt engineid gt INFORM The engine ID of the SNMP manager This is used for any V3 user including authentication and or privacy The format is hexadecimal numbers separated by a dot for example 00 12 56 AB CD EF Maximum length is 32 bytes Notes a For V1 and V2 communities this field is ignored When setting up a user for trap notification purposes leave this field empty m When lt engineid gt is specified the SNMP user can only be used as an Inform user it can no longer be used as an Access user 70 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Generate Event GEN EVT Generate Event GEN EVT This command generates a set of events or alarms messages on every available user interface for example TL1 and SNMP for the SNMP interface see the TP1000 MIB for definition If alarms are generated the alarm levels and severity codes are the default alarm levels Syntax GEN EVT tid lt aid gt lt ctag gt lt param gt Parameter Value Description lt aid gt ALL or null Access Identifiers IMC IlOCm m 1 2 GPS PRS INPp p 1 2 OUTg g A B C D RTMg g A B C D E422g g A B C D
157. ocal oscillator onthe EQPT NA NA specified IOC is in Fast Lock mode CLKLOCK The local oscillator on the EQPT NA NA specified IOC is in Lock mode SCAVAIL The specified IOC EQPT OFF a ON SmartClock is available module was tracking a a OFF SmartClock is not reference for at least 32 available Hours allowing the SmartClock algorithm to be engaged Input Event Codes CKTIDCHG A user has modified the T1 GPS The ID can be up to 40 characters Circuit ID for the input in length CRCENA Allows the user to T1 DISABLE ENABLE DISABLE provision the E1 CAS CCS inputs to enable or disable the use of CRC4 checking If the E1 input is provisioned to read SSMs CRC4 is automatically enabled 170 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table C 1 Event Identifiers Continued Appendix C Events Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE FRMTYPE Allows the user to T1 PRC INPUT 1 544M 1 544 MHz provision the type of input 2M 2M 2 048 MHz framing or the input INPUT 1 2M_ 5M 5 MHz frequency INPUT 2 2M_ 6 312M 6 312 MHz 10M 10 MHz Allows the user to CAS CAS Input provision the output CCS CCS Input framing type D4 Super Frame Input ESF Extended Super Frame Input CC Composite Clock Input JCC G 703 64K 8K JCC4 G 703 64K 8K 0 4K INSTATE The state of the input T1 ENABLE a DISABLE
158. ode block 15 command descriptions TL1 31 146 commands ACT FEATURE 29 ACT SWDL 31 ACT USER 37 CANC USER 38 CPY MEM 39 DLT PM DATA 41 DLT SECU 41 42 DLT USER SECU 43 ED CKTID 44 ED CMD SECU 45 ED DAT 47 ED EQPT 48 ED EQPT NTP 54 ED PID 57 ED SYNC 58 ED USER SECU 65 ENT PID 67 ENT USER SECU 68 INIT LOG 72 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 183 Index D E INIT SYS 73 OPR ACO ALL 75 PING 76 RMV EQPT 77 RTRV ALM 79 RTRV ATTR 82 RTRV BESTIME STAT 85 RTRV BIST 87 RTRV CKTID 90 RTRV CMD SECU 91 RTRV COND 94 RTRV CRAFT 99 RTRV DAT 107 RTRV EQPT 109 RTRV GPS STAT 111 RTRV HDR 112 RTRV INV 113 RTRV LED 115 RTRV LOG 117 RTRV NETYPE 121 RTRV NTP PEER 122 RTRV PM 124 RTRV SYNC 131 RTRV SYS MODE 133 RTRV TH 134 RTRV USER 136 RTRV USER SECU 137 SET ATTR 140 SET SID 142 SET SYS MODE 143 SET TH 145 condeff 118 condition effect 118 condition type alarms 81 119 events 118 condtype 81 118 119 Conventions warnings cautions recommendations and notes 10 copying memory 39 CPY MEM command 39 craft data retrieving 99 CRCENA keyword 61 CTS RTS flow control setting 50 D DATCHG keyword 47 date changing 47 retrieving 107 date and time format GR 833 21 49 default command access levels 24 25 DLT SECU command 41 42 DLT USER SECU command 43 downloading firmware 32 E ECHO keyword 49 ED CKTID command 44 ED CMD SECU command 45 ED DAT command 47 ED EQPT com
159. of IOC Istate to the IMC was successful The transfer of IOC Istate to the redundant IOC was successful EQPT NA NA GPS Event Codes CKTIDCHG A user has modified the Circuit ID for the GPS input T1 GPS The ID can be up to 40 characters in length MODE User set request for system position when using GPS or when position is automatically found EQPT AUTO AUTO MANUAL POS User set request for GPS Antenna Latitude Longitude Height EQPT dd mm ss ss N or S dd mm ss ss E or W hhhh h dd mm ss ss N S dd mm ss ss E W hhhh hh ELEVMASK User set request for GPS Elevation Mask EQPT dd 5 to 45 default is 10 degrees RESET GPS power has been reset EQPT NA NA IOC Event Codes CCALIGN Allows the user to clear the INPTRR alarm or clear INPTRR and force alignment between the CC output and a CC input T1 NA NA 168 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table C 1 Event Identifiers Continued Event ID or CONDTYPE Event Description AID TYPE Default Value Appendix C Events Value Description CLKTYPE The specified IOC sets the clock type to the specified value The value is used to define module pull in range and SSM generation during Holdover EQPT TYPEI ST3E TYPEI ST2 TYPEII INPREF The specified input was selected as system
160. ommand it must match the Source Identifier sid that is set within the unit or the unit will not respond to the command If the command is not directly sent to the unit as when the command is routed to the unit via a Gateway NE called indirect routing a non null tid is required The Access Identifier aid The aid uniquely identifies the entity within the associated target unit In the TL1 syntax descriptions provided in Chapter 2 of this manual the lt aid gt syntax tag is used specifically to denote modules inputs outputs or ports Other more specific syntax tags are used to denote types of entities such as lt uid gt a user identifier or lt cid gt a command identifier The position of the aid block within the command string always occurs between the second and third block separator character The Correlation Tag ctag The ctag is used to correlate commands and responses It can be any alphanumeric string up to six characters in length In the TimeProvider use of the ctag is not mandatory but is strongly recommended If the value for the ctag is null in the command string the unit returns a zero 0 as the ctag in responses a The General Block In the TimeProvider the General Block is not used so its value should always be null If the General Block is the last block in the command syntax it and the remaining block separator characters can be omitted from the command string Payload Block The Payload Blo
161. on block separator character and the command is terminated by a semicolon terminating character The semicolon indicates that the command statement is completed and the command is then executed Figure 1 1 shows the typical structure of a TL1 command and the paragraphs that follow further explain the elements that constitute each of the main blocks Block Terminating Separator Character cid tid aid ctag payload L l Command Staging Payload Code Block Block Block Figure 1 1 Typical TL1 Command Structure 14 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 TL1 command ED is the verb and DAT is the modifier indicating that the command will edit a date object Staging Block The Staging Block is comprised of the following blocks each separated by the block separator character a The Target Identifier tid The tid identifies the specific TimeProvider unit to which the command applies The position of the tid is mandatory within the command string but it is usually optional sense its value can be null If it is used in the c
162. on the ESF or E1 of SSM CAS CCS input to read DISABLE Disable the or not to read the reading of SSM received SSM THRCHG PM Threshold has EQPT 1 through 1 through 10000000 changed 10000000 Output Event Codes CKTIDCHG A user has modified the T1 GPS The ID can be up to 40 characters Circuit ID for the output in length CRCENA Allows the user to T1 ENABLE ENABLE DISABLE provision E1 outputs to enable CRC FRMTYPE Allows the user to T1 OUTPUT 2M_ 1 544M 1 544 MHz provision the type of output framing or the output frequency Allows the user to provision the output framing type 2M 2 048 MHz 6 312M 6 312 MHz CAS CAS Output CCS CCS Output D4 Super Frame Output ESF Extended Super Frame Output CC Composite Clock Output ISOLATED_1 for T1 outputs generate an isolated 1 test pattern 172 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table C 1 Event Identifiers Continued Appendix C Events Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE FREEFLT _ Defines if the output fault T1 SQUELCH a ON In fault mode generate is set or not set when the outputs based upon system LO enters Free run mode SSM of operation The output AIS In fault mode generate groups are provisioned AIS outputs for fault strategies SQUELCH In fault mode outputs are turned off HOLDFLT _ Defines if the
163. on the GPS system input PRS The command s effect is on the PRS system input INPp The command s effect is on the input port specified by p p 1 for the input marked INP 1 on the Input Connector module p 2 for the input marked INP 2 on the Input Connector module OUTg The command s effect is on the output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf gis D for the group marked D on the main shelf RTMo p The command s effect is on the Retimer group and port specified by g p g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf a p 1 for Port 1 on the Retimer module p 2 for Port 2 on the Retimer module E4229 The command s effect is on the EIA 422 output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf gis D for the group marked D on the main shelf 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 131 Chapter 2 TL1 Command Syntax and Description Retrieve Sync
164. onomous Message Table C 2 shows all of the possible event condition types condtypes and event condition strings condscrs that might be returned by the TimeProvider in an Autonomous Message 22 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 1 TL1 Overview Command Security Command Security To protect system resources and information from unauthorized access the TimeProvider implements the concept of access levels for commands When security is enabled on the TimeProvider most of the units TL1 commands require that users be logged into the system in order to access them Each user in the system has a user access level assigned to them and it is their user access level that determines which commands they can use Caution Security is initially not enabled on the TimeProvider With security not enabled anyone can execute any of the unit s TL1 commands severely compromising the integrity of the system 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 Refer to the TimeProvider User Guide 097 58001 02 for information on defining the first user Each of the TimeProvider s TL1 commands have one of the following four access levels assigned to them by default a NONE When a given command is assig
165. or statements that alert you to important information which may make your task easier or increase your understanding E Note All notes use this symbol Notes contain installation 10 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 How to Use This Guide Related Documents and Information Related Documents and Information Other helpful documents are listed below See your Symmetricom representative or sales office for a complete list of available documentation TimeProvider Node Clock User s Guide part number 097 58001 02 Software Release Notice part number 097 58001 24 TimePictra management software See the User s manual provided on the system CD SynCraft management software Help files within the application designed to enhance product usability Contact your local representative or sales office for a complete list of courses and outlines E Note Symmetricom offers a number of applicable training courses 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 No Revision F of this guide has been issued Revision G of this guide contains the following new information Added a description of the GR 833 response format in Autonomous Messages
166. or the current displayed in the current session session DISABLE Disables the autonomous messages from being displayed in the current session BAUD The IMC serial port baud EQPT 9600 2400 9600 19200 38400 rate has changed 57600 115200 CMDCHG __ The command access EQPT ACCLVL USER NONE USER ADMIN level was changed SECURITY ECHO The communication EQPT DISABLE a ENABLE User keystrokes session s echo setting are echoed has changed DISABLE User keystrokes are not echoed EVTFORMAT The autonomous EQPT LEGACY a LEGACY TimeProvider s message response block format has changed legacy message block format GR833 GR833 compliant message block format 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 165 Appendix C Events Table C 1 Event Identifiers Continued Event ID AID or Event Description TYPE Default Value Value Description CONDTYPE FEATURE A System feature has EQPT NTP The NTP feature has been been enabled enabled FLOW The IMC serial port flow EQPT NONE a NONE No flow control control has changed SW Software flow control XON XOFF a HW Hardware flow control CTS RTS a SWHW Use both types of flow control FWFAIL The firmware upgrade of EQPT NA NA IMC was unsuccessful The firmware upgrade of the IOC was unsuccessful FWOK The firmware upgrade of EQPT NA NA IMC was successfu
167. oup and port when the Local Oscillator enters Holdover mode RETIME CUTTHRU rtmslip The number of slips permitted in a 24 hour period O 1 255 lt aid gt E422g outstatus The current status of the specified EIA 422 output group OK ALM UNEQUIPPED outstate frmtype The state of the specified EIA 422 output group ENABLE DISABLE The framing type that the specified EIA 422 output group is provisioned to generate 1 544MHz 2M freeflt The type of signal to be generated on the specified EIA 422 output group when the Local Oscillator enters Free run mode ON SQUELCH 104 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data RTRV CRAFT Table 2 16 RTRV CRAFT Output Fields Continued Field Description holdfit The type of signal to be generated on the specified EIA 422 output group when the Local Oscillator enters Holdover mode ON SQUELCH lt aid gt NTP AUTHENTICATION authen Displays the NTP configuration ENABLE DISABLE lt aid gt NTP Server serverip The IP address of NTP server keyid The Authentication Identification value 0 1 65535 minpoll The minimum time in seconds between Server time requests 16 32 64 128 256 512 1024 maxpoll The maximum time in seconds between Server time requests 16 32 64 128 256 512 1024
168. output fault T1 ON ON In fault mode generate are set or not set when outputs based upon system the LO enters Holdover SSM mode of operation The AIS In fault mode generate output groups are AIS outputs provisioned for fault SQUELCH In fault mode strategies outputs are turned off OUTSTATE The specified output T1 DISABLE a ENABLE Enable the output state has changed to generate the defined signal type DISABLE Disable the output SSMBIT Allows the user to T1 ALL 4 5 6 7 8 ALL provision E1 bit position and generate SSMs on the specified bit position CRC must be enabled to allow SSM generation EIA 422 Output Event Codes CKTIDCHG A user has modified the T1 GPS The ID can be up to 40 characters Circuit ID for the output in length FRMTYPE Allows the user to T1 OUTPUT 1 544M 1 544 MHz provision the type of input 1 544M 2M 2 048 MHz framing or the input frequency Allows the user to provision the output framing type FREEFLT Defines if the output fault T1 SQUELCH ON In fault mode generate is set or not set when the LO enters Free run mode of operation The output groups are provisioned for fault strategies outputs based upon system SSM AIS In fault mode generate AIS outputs SQUELCH In fault mode outputs are turned off 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 173 Appendix C Events Table C 1 Event Identifiers Continued
169. ponse when it receives and can properly process a TL1 command The response is always in uppercase letters The format of a Normal response is as follows The M indicates that the message is a response to a TL1 command When the response is COMPLD and the command requires a response message then one or more lines are returned and the response is terminated by a semicolon The syntax for the command response is lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt textblk lt cr gt lt lf gt textblk lt cr gt lt lf gt LG_textblk lt cr gt lt lf gt Note The textblk and LG_textblk fields are only returned with the Normal response when the command requires such a message be returned 16 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 1 TL1 Overview Responses Table 1 1 explains each field that is contained in the Normal response Table 1 1 Normal Response Fields Field Description sid 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 time The time of the response in the format HH MM SS where HH is the hour in 24 hour format MM is the minutes and SS
170. preferred The Preferred Server setting YES NO Example To display all current state status and provisioning information Input RTRV CRAFT TP1000 Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD SYS PWRA OK PWRB OK EXP OK EXT1 OK EXT2 OK IOC1 EQPT IOC2 EQPT 1 05 02 02 15 53 10 PRR AUTO GPS 5 5 0 ENABLE 10 100 IMC IOCLCOMM OK IOC2COMM OK CO CoO CO IO IO ML MR MI C1 C23 9600 NONE DISABLE 9600 NONE DISABLE 192 168 2146 192 168 21 17255 255 255 0 DISABLE OK IOC1TO2COMM OK IMC1COMM OK INSRV ACTIVE LOCKED TYPEI OK LIOC2TO1COMM OK IMC2COMM OK OOSRV STANDBY ST2 GPS OK ENABLE 1 1 05 02 03 17 18 34 AUTO 30 28 8 39N 97 40 35 21W 266 4 10 PRS OK ENABLE 2 1 2M IN IN OUT OUT OU OU RT RT Pils P25 M ENA ENA E 2 1 2M E1 2 DISABLE DISABLE 8 3 E 2 1 2M E1 2 DISABLE DISABLE 8 DISABLE 2M ON ON DISABLE 2M SQUELCH ON B B B B ENABLE 2M SQUELCH ON ENABLE CC ON ON OK ENABLE 0 RETIME RETIME ON OK ENABLE 0 RETIME RETIME ON 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 105 Chapter 2 TL1 Command Syntax and Descript
171. r s currently provisioned system operating mode Set System Mode SET SYS MODE on page 143 Provisions the TimeProvider system s operating mode to SSU SUB or PRR Operate Alarm Cutoff OPR ACO ALL on page 75 Deactivates opens the minor major and critical audible alarm relays Set Source Identifier SET SID on page 142 Provisions the TimeProvider system s source identifier SID Retrieve Alarm Condition RTRV ALM on page 79 Retrieves information on currently active alarms 148 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Appendix A Table A 2 System Commands Continued Command Description Retrieve BesTime Status RTRV BESTIME STAT on page 85 Displays the BesTime status the data indicates predicted BesTime ensemble information Retrieve Built In Self Test RTRV BIST on page 87 Displays all currently active faulted built in self test information for either the IMC or IOC or both Retrieve Condition RTRV COND on page 94 Retrieves information about the current state and status of system components Retrieve Craft Data RTRV CRAFT on page 99 Retrieves information about the system state clock mode of operation input provisioning and output provisioning Retrieve GPS Status RTRV GPS STAT on page 111 Displays the position of the GPS receiver UTC time and status information for each of the GPS satellites in vi
172. r gt lt lf gt SYS date time offset lt cr gt lt lf gt Table 2 17 RTRV DAT Output Fields Field Description date The currently set system date in the format yy mm dd a yy the 2 digit year mm the 2 digit representation of the month a dd the day of the month time The currently set system time in the format hh mm ss a hhis the hour in 24 hour format mmis the minutes m ssis the seconds offset The currently set UTC offset in the format thh mm hhis the local time s hour offset from UTC 12 hours mmis the local time s minute offset from UTC 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 107 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 M TP1000 COMPLD SYS 05 02 10 13 37 39 00 00 Autonomous Message None 108 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 and descriptions of their possible lt values gt E Note See Edit Equipment ED EQPT on page 48 for lt keywords gt Syntax RTRV EQPT lt tid gt lt aid gt
173. rence Guide 097 58001 01 Revision G April 2008 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 including SNMMP v1 v2C and V3 usertypes This command has a default access level of SECURITY Syntax RTRV USER SECU lt tid gt lt uid gt lt ctag gt Parameter Value Description lt uid gt text string The user name assigned to the user whose access level is retrieved null The access levels of all system users are retrieved Command Output The following shows the output format of the command and Table 2 31 explains the various fields in the command output If more than 20 lines are returned the response is divided into two blocks lt cr gt lt 1lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt username access lt usertype gt lt engineid gt lt cr gt lt lf gt username access lt usertype gt lt engineid gt lt cr gt lt lf gt username access lt usertype gt lt engineid gt lt cr gt lt lf gt Table 2 31 RTRV USER SECU Output Fields Field Description username The user name assigned to the user whose access level is displayed access The access level for the specified user The access level can be one of the following a NONE user
174. rently logged onto the TimeProvider Cancel User CANC USER on page 38 Terminates the specified user s session and logs the user out of the system Enter Password ENT PID on page 67 Allows a security level user to edit any user s password in the user database Edit Password ED PID on page 57 Allows users to edit their own password in the user database Enter User Security ENT USER SECU on page 68 Enters a new user in the user database Retrieve User Security RTRV USER SECU on page 137 Displays the access level of the specified user or the access level of all users Edit User Security ED USER SECU on page 65 Changes the specified user s access level Delete Security DLT SECU on page 42 Deletes all of the information from the user database Delete User Security DLT USER SECU on page 43 Allows a security level user to delete any user in the user list Retrieve Command Security RTRV CMD SECU on page 91 Retrieves the access level set for a specified command or all commands Edit Command Security ED CMD SECU on page 45 Changes the access level of the specified command Activate Software Download Mode ACT SWDL on page 31 Places the information management card IMC in the firmware download mode prior to a firmware download 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 147 Appendix A Table A 2 Sy
175. replacement IOC module with the settings of the IOC module it replaced a Both IOC Modules are Replaced Concurrently In this case copying the IOC Istate from the active IOC module to the IMC module replacing both IOC modules then copying the IOC Istate back to the replacement IOC modules effectively provisions the replacement IOC modules with the settings of the IOC modules they replaced Example Notes IOC modules are capable of transferring their Istates to each other automatically When both IOC modules are to be replaced it might desirable to allow this transfer to occur automatically Replace the IOC module that is in standby mode Allow the replacement IOC module to reboot and qualify the reference inputs This provides enough time for the Istate of the active IOC module to automatically transfer to the replacement IOC module Force the replacement card to the active state Replace the other IOC module The Istate transfers automatically to that module To copy the IMC Istate from the IMC module to the active IOC module as a prelude to replacing the IMC module Inpu CPY t MEM TP1000 IMC IOC IMC Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD y Autonomous Message TP SS A 314 R IMC SUCCI ESSF U 05 02 10 13 35 56 EPT EVT EQPT XFEROK TC 05 02 10 13 35 56 CONFIGURATION TRANSFER UL wi 40 TimeProvider TL1 Refer
176. ril 2008 TimeProvider TL1 Reference Guide 129 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 IDEV 1 0 9 COMPL 05 02 03 12 00 00 ITOC2 PRS TDEV 5 0 4 COMPL 05 02 03 12 00 00 TOC2 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 TOC2 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 130 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt tid gt lt aid gt lt ctag gt lt keyword gt Description Parameter Value See Table 2 6 for lt keywords gt and descriptions of their possible lt values gt lt aid gt SYS The command s effect is on system level input settings GPS The command s effect is
177. riod Table 2 36 Mask Table MTIE 1 MTIE 5 MTIE 10 MTIE 50 MTIE 100 MTIE 500 FFOFF 60 DEFAULT 10 000 50 000 100 000 500 000 1 000 000 5000 000 10 000 000 GPS R 150 150 150 150 150 155 50 000 PRS 10 10 12 25 39 155 1000 DS1 302 312 325 325 550 1002 12 000 OCN 600 1000 1000 1000 1000 1002 370 000 PRC 25 25 25 25 39 155 1000 TYPEI 750 750 1000 2000 2000 2000 2900 TYPEII 302 312 325 425 1000 1000 1000 Example To set the GPS FFOFF parameter Input SET TH GPS C FFOFF 60 1000 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 1166 REPT EVT GPS EQPT THRCHG TC 05 02 10 13 35 56 PM THRESHOLD HAS CHANGED FFOFF 60 146 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 Table A 1 Security and Administrative Commands Command Description Activate Feature ACT FEATURE on page 29 Activates the NTP feature in the TimeProvider Activate User ACT USER on page 37 Logs the specified existing user onto the system and begins a user session Retrieve User RTRV USER on page 136 Lists all users that are cur
178. rovisioned operating mode SSU SUB PRR 100 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data RTRV CRAFT Table 2 16 RTRV CRAFT Output Fields Continued Field Description refmode The reference selection mode AUTO FORCED inpref The input reference selected when the reference mode REFMODE is set to FORCED GPS PRS INP1 INP2 NONE 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 1000 fltdelay The time that elapses after an LOS AIS or OOF fault occurs and before the associated alarm condition is set This delay helps prevent spurious alarms O 1 15 inacttime The amount of user command inactivity time which determines the amount of inactivity time before the user is automatically logged off of the system 0 Disabled 100 101 10000 logecho Indicates if login and logout events are echoed to the local terminal ENABLE DISABLE evtformat Indicates the event format LEGACY GR833 gpsclrdel The time that elapses after a GPS fault clears and before the associated alarm condition clears This delay helps prevent an alarm from clearing before the GPS is stable 0 1 1000 gpsfltdel The time that elapses after a GPS faul
179. rovisioned to read the received SSM DISABLE DISABLE The input is provisioned to not read ignore the received SSM SSMBIT 4 The specified input is provisioned to read the E1 8 CCS SSM at bit position 4 5 The specified input is provisioned to read the E1 CCS SSM at bit position 5 6 The specified input is provisioned to read the E1 CCS SSM at bit position 6 7 The specified input is provisioned to read the E1 CCS SSM at bit position 7 8 The specified input is provisioned to read the E1 CCS SSM at bit position 8 lt aid gt OUTg FRMTYPE 8K The framing type generated by the specified output 2M group is provisioned as 8 kHz 1 544M The framing type generated by the specified output group is provisioned as 1 544 MHz 2M The framing type generated by the specified output group is provisioned as 2 MHz 6 312M 1 The framing type generated by the specified output group is provisioned as 6 312 MHz CAS The framing type generated by the specified output group is provisioned as CAS CCS The framing type generated by the specified output group is provisioned as CCS D4 The framing type generated by the specified output group is provisioned as D4 Super Frame ESF The framing type generated by the specified output group is provisioned as ESF Extended Super Frame CC The framing type generated by the specified output group is provisioned as Composite Clock JCC 1 The framing type generated by the specified output group is provisioned
180. s 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 Syntax OPR ACO ALL lt tid gt lt ctag gt Example To deactivate the audible alarm relays Input OPR ACO ALL TP1000 Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD t Autonomous Message TP SSU 05 02 10 13 35 56 A 2564 REPT EVT IMC EQPT ACO TC 05 02 10 13 35 56 AUDIO ALARM IS DEACTIVATED 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 75 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 lt tid gt lt ctag gt lt ipaddr gt Parameter Value Description lt ipaddr gt IP dot notation The IP address of the host system to be pinged from the TimeProvider The range is 1 0 0 1 to 254 254 254 254 Example To ping IP address 198 162 12 10 from the TimeProvider Input PING TP1000 192 168 12 10 Response Example TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Host 192 168 12 10 is alive Roundtrip time was 165 milliseconds Autonomous Message None 76 TimeProvider TL1 Reference Guide 097 58001 01 Revision G
181. shelf 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 117 Chapter 2 TL1 Command Syntax and Description Retrieve Log RTRV LOG Table 2 22 RTRV LOG Keywords for all lt aids gt lt keyword gt Description Value ALL or null Retrieves both alarmed and non alarmed events for the specified aid N A EVT Retrieves non alarmed events for the specified aid N A ALM Retrieves alarmed events for the specified aid N A index A specified value to skip that number of events before displaying data 1 to 500 count A specified value to retrieve that number of recent events or alarms 1 to 500 start date Start date of the event history to display YY MM DD stop date Stop date of the event history to display YY MM DD Command Output The following shows the event output format of the command and Table 2 23 explain the various fields in the output The Alarm format follows this explanation of events and Table 2 24 explains the fields in the alarm output Event Response Format lt er gt lt Li gt lt Li gt sid date time lt cr gt lt lf gt alrmcde atag REPT EVT AIDTYPE lt cr gt lt lf gt aid aidtype condtype condeff ocrdat ocrtim condscr lt cr l1f gt aid aidtype condtype condeff ocrdat ocrtim condscr lt cr lf gt aid aidtype condtype condeff ocrdat ocrtim condscr lt cr l1f gt Table 2 23 RTRV LOG Event Output Fields
182. site clock input tracking phase following compliant with GR 378 a PRR The TimeProvider is provisioned in the Primary Reference Receiver operating mode In PRR mode the GPS input is the only reference available for the system and the BesTime algorithm is engaged This command has a default access level of USER Syntax RTRV SYS MODE lt tid gt lt ctag gt Example To retrieve the currently provisioned system operating mode Input RTRV SYS MODE TP1000 Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD SYS EQPT SYSMODE SSU Autonomous Message None 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 133 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 lt tid gt lt aid gt lt ctag gt lt keyword gt Parameter Value Description lt aid gt GPS The command s effect is on the GPS system input PRS The command s effect is on the PRS system input INPp The command s effect is on the input port specified by p p 1 for the input marked INP 1 on the Input Connector module m p 2 for the input marked INP 2 on the Input Connector module RTMg The command s effect is on
183. ssive Discontinuity Fault Excessive Discontinuity Cleared MTIE MTIE Threshold Exceeded MTIE Within Threshold FFOFF FFOFF Threshold Exceeded FFOFF Within Threshold 162 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Table B 2 Alarm Code Condition Descriptions Continued Appendix B Alarms 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 INPOOF OOF Fault OOF Fault Cleared INPFRQ Frequency Threshold Exceeded Frequency Within Threshold INPPHASE Phase Error Exceeded Threshold Phase Error Within Threshold INPQL Quality Level SSM Exceeded Threshold Quality Level SSM Within Threshold INPTRR Tip Ring Connections Reversed Tip Ring Connections Correct EXDSC Excessive Discontinuity Fault Excessive Discontinuity Cleared MTIE MTIE Threshold Exceeded MTIE Within Threshold FFOFF FFOFF Threshold Exceeded FFOFF Within Threshold E422g Alarm Conditions E422EQPT EIA 422 Module is Unequipped EIA 422 Module is Equipped E422FAULT ElA 422 Module has a Fault EIA 422 Module Fault Cleared OUTg Alarm Conditions OUTEQPT Output Module is Unequipped Output Module is Equipped RTMg p Alarm Conditions RTMEQPT Retimer Module is Unequipped Retimer Module
184. stem Commands Command Copy Memory CPY MEM on page 39 Description Saves a module s Istate in another module s flash memory Retrieve Date RTRV DAT on page 107 Retrieves the system date time and local offset Edit Date ED DAT on page 47 Changes the system date and time Retrieve Equipment RTRV EQPT on page 109 Retrieves currently provisioned equipment parameters Edit Equipment ED EQPT on page 48 Used to provision equipment parameters Retrieve Sync RTRV SYNC on page 131 Edit Sync ED SYNC on page 58 Retrieves equipment parameters associated with provisioning of the synchronization interfaces for the system inputs and outputs Changes factory settings and input and output port parameter settings Retrieve Circuit Identification RTRV CKTID on page 90 Retrieves the circuit ID for the specified input or output Edit Circuit Identifier ED CKTID on page 44 Changes the circuit ID for the specified input or output Retrieve Attribute RTRV ATTR on page 82 Retrieves the alarm level set for a specified alarm Initialize Event Log INIT LOG on page 72 Clears the event log on the IMC module Retrieve Log RTRV LOG on page 117 Retrieves all events in the event log Initialize System INIT SYS on page 73 Initializes the specified module or the system Retrieve System Mode RTRV SYS MODE on page 133 Retrieves the TimeProvide
185. stem USER RTRV SYS MODE System USER RTRV TH System USER RTRV USER Session USER RTRV USER SECU Administrative SECURITY SET ATTR System ADMIN SET SID System ADMIN SET SYS MODE System ADMIN SET TH System ADMIN 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 25 Chapter 1 TL1 Overview Command Security 26 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description This chapter describes each of the TimeProvider s TL1 commands in detail In This Chapter a TL1 Syntax Conventions Command Descriptions 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 27 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 lt cr gt Carriage return character ASCII 0x0D lt lf gt Line feed character ASCII 0x0A ae Indicates the command parameter or data is optional his gt Indicates a variable The variable s value is actually sent in the command or returned in the response Ca Indicates numeric data that can be either positive or negative In addition the following general rules apply to the TL1 syntax and command entry a Adjacent colons indicate unused fields If an unused field is the last parameter in the command string for ex
186. t INACTTIME COMMUNICATION TIMEOUT HAS CHANGED lt value gt INPREF SYSTEM REFERENCE INPUT HAS CHANGED lt selected reference gt LOCTIM SYSTEM S LOCAL TIME OFFSET HAS CHANGED lt time offset gt LOGECHO RECORD LOGIN EVENT lt value gt REFMODE SYSTEM REFERENCE MODE HAS CHANGED lt mode gt TIMCHG SYSTEM TIME HAS CHANGE lt time gt SYSMODE SYSTEM MODE OF OPERATION HAS CHANGED lt state gt UTC GPS HAS SET SYSTEM TIME TO UTC lt UTC date UTC time gt Retimer Event Conditions CKTIDCHG RETIMER CIRCUIT ID HAS CHANGED lt cktid gt FREEFLT FREE RUN OUTPUT FAULT STRATEGY HAS CHANGED lt state gt HOLDFLT HOLDOVER OUTPUT FAULT STRATEGY HAS CHANGED lt state gt RTMLBO PORT LBO HAS CHANGED lt value gt RTMSTATE PORT STATE HAS CHANGED lt value gt SLIPCHG SLIP THRESHOLD HAS CHANGED lt value gt SLIPCLR SLIP COUNTER HAS BEEN CLEARED SNMP Event Conditions SNMP MGR1 SNMP MANAGER 1 HAS CHANGED lt ip gt SNMP MGR2 SNMP MANAGER 2 HAS CHANGED lt ip gt SNMP MGR3 SNMP MANAGER 3 HAS CHANGED lt ip gt SNMP MGR4 SNMP MANAGER 4 HAS CHANGED lt ip gt SNMP MGR5 SNMP MANAGER 5 HAS CHANGED lt ip gt SNMP SENDER SNMP SENDER 1 HAS CHANGED lt ip gt SNMP SENDER2 SNMP SENDER 1 HAS CHANGED lt ip gt SNMP SENDER3 SNMP SENDER 1 HAS CHANGED lt ip gt SNMP SENDER4 SNMP SENDER 1 HAS CHANGED lt ip gt 180 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008
187. t lt lf gt M sid date time lt cr gt lt lf gt ctag COMPLD lt cr gt lt lf gt TOCm SYS lt tfom gt lt cr gt lt lf gt TOCm PRS lt prs_wt gt lt cr gt lt lf gt TOCm INP1 lt inpl_wt gt lt cr gt lt l1f gt TOCm INP2 lt inp2_wt gt lt cr gt lt l1f gt TOCm LO lt lo_wt gt lt cr gt lt lf gt Table 2 12 RTRV BESTIME STAT Output Fields Field Description tfom Time Figure of Merit estimated 2 Sigma accuracy of the system 1PPS prs_wt PRS Input reference weight indicates the amount of influence weight the PRS reference on the system timing when the system is not referenced to GPS 1 00 indicates only input being used 0 00 indicates input not being used at all inp1_wt Input 1 2 reference weight indicates the amount of influence weight the Input 1 2 inp2_wt reference on the system timing when the system is not referenced to GPS 1 00 indicates only input being used 0 00 indicates input not being used at all lt lo_wt gt LO weight indicates the amount of influence weight the LO stability has on the system timing when the system is not referenced to GPS m 1 00 indicates only input being used a 0 00 indicates input not being used at all 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 85 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 I10C1 TP1
188. t cr gt lt lf gt lt aid gt indicator state lt cr gt lt lf gt lt aid gt indicator state lt cr gt lt lf gt Table 2 21 RTRV LED Output Fields Field Description indicator The name of the LED indicator for which the state is retrieved This corresponds to the label on the panel of the unit state The current state of the LED indicator OFF The indicator is currently not lit GREEN The indicator is currently lit and the color is green ORANGE The indicator is currently lit and the color is orange YELLOW The indicator is currently lit and the color is yellow RED The indicator is currently lit and the color is red FLASHING_GREEN The indicator is currently alternating between OFF and GREEN at a 0 5 second rate 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 115 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 Response Example M TP100 IMC IMC IMC IMC IMC IMC IMC IMC IMC IOC1 IOC1 IOC1 IOC1 TOC TOCIT IOC1 IOC1 IOC1 TOCIT TOC2 TOC25 IOC2 IOC2 IOC2 TOC2 IOC2 IOC2 IOC2
189. t occurs and before the associated alarm condition is set This delay helps prevent spurious alarms 1 2 1000 lt aid gt IMC iocicomm Indicates if an OC1 2 communication alarm currently is active ioc2comm m 10C01 2 COMM OK no 10C1 2 COMM alarm is currently active a 10C1 2 COMM ALM an IOC1 2 COMM alarm is currently active lt aid gt COML COMR baud The serial port s baud rate setting 2400 9600 19200 38400 57600 115200 flow The type of serial port flow control set NONE SW HW SWHW echo Indicates if input is echoed to the local terminal on the port ENABLE DISABLE lt aid gt COMI ipaddr The IP address of the Network Element ipgate The IP address of the default gateway 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 101 Chapter 2 TL1 Command Syntax and Description Retrieve Craft Data RTRV CRAFT Table 2 16 RTRV CRAFT Output Fields Continued Field Description ipsubnet The subnet mask echo Indicates if input is echoed to the local terminal on the port ENABLE DISABLE lt aid gt 10C1 OC2 Note The following status conditions are reported by the IOC modules but are stored in the IMC module When the RTRV COND command is received by the unit the IMC module reports the last status conditions it received from the IOC modules If OC1 2 EQPT UNEQUIPPED or IOC1 2 COMM ALM then IOC data is not displayed
190. tation of the month and DD is the day of the month time The time of the message in the format HH MM SS where HH is the hour in 24 hour format MM is the minutes and SS is the seconds almcde The alarm code which can be one of the following C The event being reported is a Critical alarm The event being reported is a Major alarm The event being reported is a Minor alarm A The event being reported is a Non alarm Event atag The Autonomous Message tag which is a number up to six digits long that increments by one each time an event is generated It wraps back to 1 after reaching 999999 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 21 Chapter 1 TL1 Overview Autonomous Messages Table 1 5 Autonomous Message Fields Continued Field Description reptype The type of report It can be either EVT the event is a non alarm event or ALM the event is an alarm event aid The access identifier which denotes the system component that the reported alarm or event applies to 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 ntfencde The notification code for the alarm or event The notification code can be CR a criti
191. te 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 This command has a default access level of ADMIN Syntax Parameter Value SET ATTR lt tid gt lt aid gt lt ctag gt lt keyword gt lt value gt Description See Table 2 32 for lt keyword gt and lt value gt descriptions lt aid gt SYS The command s effect is at the system level IMC Sets the alarm level for the specified Information Management Card module alarm to the specified value 1locm Sets the alarm level for the specified alarm in the specified Input Output Card module to the specified value m 1 forthe slot marked IOC 1 on the main shelf m 2 for the slot marked IOC 2 on the main shelf GPS Sets the alarm level for the GPS alarm to the specified value PRS OUTg Sets the alarm level for the PRS alarm to the specified value Sets the alarm level on the Output group specified by g g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf INPp Sets the alarm level for the alarm related to the specified input port to the specified value p 1 for the
192. ted with the PM ID lt alarm threshold gt MTIE 1 100000 Performance threshold that generates an alarm FFOFF 60 1 10000000 see Table 2 32 SLIPCHG 0 60 lt pm status gt OK ALM PM measurement status OK measurement within range a ALM measurement is over threshold Example To retrieve the value set for the performance threshold Input RTRV TH PRS TP1000 Response Example P SSU 05 02 10 13 37 39 M TP1000 COMPLD MTIE 1 750 0K E 5 750 OK E 10 1000 0K E 50 2000 0K E 100 2000 0K MTIE 500 2000 0K FFOFF 60 2700 OK INPFRQ 2000 OK SLIPCHG 25 OK r H HHH Autonomous Message None 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 135 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 Syntax RTRV USER lt tid gt lt ctag gt Example To retrieve a listing of all currently logged on users Input RTRV USER TP1000 Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD FRANKJ FRED BILLG Autonomous Message None 136 TimeProvider TL1 Refe
193. tem 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 The system remains locked against logins at this point The target IOC reboots after transfer is complete If the transfer cannot be completed the unit returns an error response and the IMC module returns to normal operation Note The Ymodem file receiver is not used in IOC to IOC firmware transfers Example 1 In this example the ACT SWDL command is issued to download a firmware file to the IMC module but the firmware download is not initiated within 60 seconds Notice the Progress Indicator that follows the in process response The unit returns a string of C s lt cccccccccc one C after approximately every second of wait time to indicate that the IMC module is waiting for an external Ymodem file sender to initiate the download process Input ACT SWDL IMC TP1000 Response Example TP SSU 05 03 09 14 07 45 A 395 REPT EVT IMC EQPT FWLOAD TC 05 03 09 14 07 45 BEGINNING FIRMWARE UPGRADE 7 CCCCCCCCCCCCCCCCCCCCCCCCCCCOCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCIP TP1000 lt TP SSU 05 03 09 14 09 03 M TP1000 DENY SROF TP SSU 05 03 09 14 09 03 A 397 REPT EVT IMC EQPT FWFAIL TC 05 03 09 14 09 02 FIRMWARE UPGRADE UNSUCCESSFUL Example 2 In this example the ACT SWDL command is issued to download a
194. tes if the password is case sensitive Minimum length is 8 characters maximum is 64 characters Notes The following characters are not allowed space colon semicolon dash single quote and double quote a Leave this field blank for SNMP v1 and v2 or v3 user without Privacy Example To change the access level for user FRED to ADMIN Input ED USER SECU FRED TP1000 ACCLVL ADMIN Normal Response TP SSU 05 02 10 13 35 56 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 2562 REPT EVT IMC EQPT ACCLVL TC 05 02 10 13 35 56 USER ACCESS LEVEL HAS CHANGED 66 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 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 lt tid gt lt uid gt lt ctag gt lt newpid gt Parameter Value Description lt uid gt text string The user name assigned to the user for which the password is being changed lt newpid gt text string The user s new password Notes The password can be up to twenty 20 characters It must include at least two non alphabetic characters and must include at least one special c
195. tes of 1 ns resolution data TDEV24 TDEV measurement over the previous 24 hour period displayed in ns as a decimal value Table 2 27 RTRV PM Keyword Modifier Fields Field Description lt startdat gt Starting date for data sample lt starttim gt Starting time for data sample lt stopdat gt Stopping date for data sample lt stoptim gt Stopping time for data sample 124 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve PM RTRV PM Table 2 28 RTRV PM Output Fields Field Value Description lt aid gt Specified AID used in the command lt monval gt The requested performance data an absolute value lt vidty gt COMPL NA OFF Indicates if the data sample is considered a valid measurement by the system COMPL Data is valid over specified time period NA Data is not available OFF Port is disabled lt sampledat gt For Phase and FFOFF data the date represents the date of the first data sample of the data set For MTIE and TDEV data the date represents the last date the data was calculated lt sampletim gt For Phase and FFOFF data the time represents the time of the first data sample of the data set For MTIE and TDEV data the time represents the last time the data was calculated Example To retrieve FFOFF data A value that indicates the difference or delta
196. the Retimer module specified by g g A for the Retimer module in slot A g B for the Retimer module in slot B g C for the Retimer module in slot C g D for the Retimer module in slot D Normal Response for threshold attributes lt cr gt lt lf gt lt lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt E 1 lt alarm threshold gt lt pm status gt lt cr gt lt lf gt E 5 lt alarm threshold gt lt pm status gt lt cr gt lt lf gt E 10 lt alarm threshold gt lt pm status gt lt cr gt lt lf gt E 50 lt alarm threshold gt lt pm status gt lt cr gt lt lf gt E 100 lt alarm threshold gt lt pm status gt lt cr gt lt lf gt E 500 lt alarm threshold gt lt pm status gt lt cr gt lt lf gt OFF 60 lt alarm threshold gt lt pm status gt lt cr gt lt lf gt NPFRQ 5000000 lt pm status gt lt cr gt lt lf gt LIPCHG alarm threshold gt lt pm status gt lt cr gt lt lf gt lt aid lt aid gt lt aid lt aid lt aid gt sE lt aid lt aid gt lt aid gt Zee HHHHH gt gt gt lt aid gt gt gt gt 7M T S I F 134 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve Threshold RTRV TH Table 2 30 RTRV TH Output Fields Field Value Description lt aid gt The aid associa
197. the slot marked IOC 2 on the main shelf Note See Table 2 8 for the lt keyword gt description Table 2 8 INIT SYS Keywords lt keyword gt Description Default lt aid gt SYS FACTORY Resets system settings to factory default values N A lt aid gt IMC OCm RESET Performs a reset reboot of the specified card which reinitializes N A volatile memory but does not affect non volatile persistent memory Note Prior to resetting an IOC module all alarms associated with the module are cleared and if the specified IOC module is the active module it is placed in Standby mode Resetting an IOC ina non redundant system will squelch the outputs until the system enters FAST LOCK 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 73 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 M TP1000 COMPLD Autonomous Message TP SSU 05 02 10 13 35 56 A 258 REPT EVT IOC2 EQPT RESET TC 05 02 10 13 35 56 MODULE HAS BEEN RESET 74 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Operate Alarm Cutoff OPR ACO ALL Operate Alarm Cutoff OPR ACO ALL This command deactivates open
198. the system provides compliance with G 812 GR1244 and GR 378 SUB The TimeProvider is provisioned in the Subtending SSU operating mode In SUB mode the system provides composite clock input tracking phase following compliant with GR 378 PRR The TimeProvider is provisioned in the Primary Reference Receiver operating mode In PRR mode the GPS input is the only reference available for the system and the BesTime algorithm is engaged This command has a default access level of ADMIN Syntax S ET SYS MODE lt tid gt lt ctag gt lt keyword gt lt value gt Table 2 34 SET SYS MODE Keyword and Values lt keyword gt lt value gt Description Default SYSMODE_ SSU The TimeProvider is fully provisionable SSU SUB The TimeProvider is provisioned to the Subtending operating mode Selection of this mode places the following restrictions on inputs The PRS and GPS input can be disabled or placed in monitor mode but is not selectable as a reference Framing type for the INP1 and INP2 is set to CC and cannot be changed PRR The TimeProvider is provisioned as a Primary Reference Receiver The GPS input is enabled as the reference and manual reference selection is disabled Example To set the system s operating mode to subtending Input S ET SYS MODE TP1000 SYSMODE SUB Normal Response M TP SSU 05 02 10 13 35 56 TP1000 COMPLD 097 5800
199. tomatic logoff LOGECHO ENABLE Login and logout events are echoed to the local terminal ENABLE and stored in the event log DISABLE Login and logout events are not echoed to the local terminal and are not stored in the event log EVTFORMAT LEGACY Allows the system to be configured to generate two LEGACY response block formats TimeProvider s legacy format or GR833 the format defined by GR 833 lt aid gt COML COMR COMI AOMERGE ENABLE Autonomous messages are displayed in the current ENABLE session DISABLE Autonomous messages are not displayed in the current session ECHO ENABLE Input is echoed to the local terminal DISABLE DISABLE Input is not echoed to the local terminal TIDQUIET ENABLE The TID is not echoed in response messages DISABLE DISABLE The TID is echoed in response messages 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 49 Chapter 2 TL1 Command Syntax and Description Edit Equipment ED EQPT Table 2 5 ED EQPT Keywords and Values Continued lt keyword gt lt value gt Description Default lt aid gt 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 19200 The specified serial port s baud rate is set to 19200 baud 28800 The specified serial port s baud rate is set to 28800 baud
200. uide 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 It also describes keywords used during provisioning and provides a troubleshooting guide Who Should Read This Guide This guide is a command reference intended for engineers and telecommunications professionals who provision and manage the TimeProvider Node Clock Chapter 1 TL1 Overview is for those who need a basic understanding of the Transaction Language 1 TL1 protocol and how it is implemented in the TimeProvider Chapter 2 TL1 Command Syntax and Description describes TimeProvider TL1 commands in detail commands are listed in alphabetical order Appendix A TL1 Command by Function is a list of commands grouped by task security and administration system performance and performance monitoring Appendix B Alarms and Appendix C Events provide a list of alarms and events along with a description of the cause of the event Structure of This Guide This guide contains the following sections Chapter Title Description Chapter 1 TL1 Overview Provides a basic overview of the Transaction Language 1 TL1 used by the TimeProvider Chapter 2 TL1 Command Syntax and Description Describes each of the TimePro
201. uipment parameters setting 48 52 event list 176 event log retrieving 117 status retrieving 95 sync parameters retrieving 131 sync parameters setting 58 63 retrieving craft data 99 RMV EQPT command 77 RTMLBO keyword 63 RTRV ALM command 79 RTRV ATTR command 82 RTRV BESTIME STAT command 85 RTRV BISTcommand 87 RTRV CKTID command 90 RTRV CMD SECU command 91 RTRV COND command 94 RTRV CRAFT command 99 RTRV DAT command 107 RTRV EQPT command 109 RTRV GPS STAT command 111 RTRV HDR command 112 RTRV INV command 113 RTRV LED command 115 RTRV LOG command 117 RTRV NETYPE command 121 RTRV NTP PEER command 122 RTRV PM command 124 RTRV SYNC command 131 RTRV SYS MODE command 133 RTRV TH command 134 RTRV USER command 136 RTRV USER SECU command 137 S SDBE error code 19 SDNR error code 19 security access level changing 65 adding a user 68 changing command level 45 delete all users 42 delete any user 43 password editing 57 67 retrieving command levels 91 retrieving current users 136 retrieving user security level 137 TL1 commands 23 user access levels 23 security level retrieving 91 self test information retrieving 87 serial number retrieving 113 server address NTP setting 54 SERVERIP keyword 54 service affecting alarms 81 119 SET ATTR command 140 SET SID command 142 SET SYS MODE command 143 SET TH command 145 SIDCHG keyword 142 SLIPCHG keyword 146 SNMP status retrieving 95 SNMP parameters setting 52 softw
202. urement requested the timestamp lt sampletim gt lt sampledat gt are associated with this measurement 126 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve PM RTRV PM Input RTRV PM IOC1 GPS TP1000 PHASE Response Format lt cr gt lt lf gt lt 1lf gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt TOCm INPp PHASE lt monval gt lt vldty gt lt sampledat gt lt sampletim gt lt cr gt lt lf gt WS SpE Map Say Sa Sy Sap Sp Ss Op Ra yp lt a Oo lt C gt lt 1 tS We Sy Se pS Say Sep Sa pap Sa pha yy lt a o OES E gt Response Example TIMEPROVIDER 05 02 10 13 37 39 M TP1000 COMPLD IOC1 GPS PHASE 93 7 COMPL 05 02 03 20 15 32 Wd 85 0 4 89 Le 4 13 97 05 1 1 85 2 1 0 871 97 0 9 OQ Ay lAy dle 2 ly Rl O a sy 16 97 25 0 0 67 056 0 270 2 1e07 101 0 97 1 87 1 070 3 0 27 0 0 0 6 0 15 0 0 0 07 1470 25 0 2 0 0 7 0 9 1 1 0 6 0 3 0 6 059 0 9 0 9 0 6 1 2 0 6 4 1 M2 peep le ly Ls Bp HOw 87H by ale Syl op Rls 5 p02 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 stop date stopdat and stop time stoptim If any startdat or starttim combination is null or outside of the previous 24 hour wi
203. urred in the format YY MM DD ocrtim The time that the event occurred in the format HH MM SS 097 58001 01 Revision G April 2008 TimeProvider TL1 Reference Guide 119 Chapter 2 TL1 Command Syntax and Description Retrieve Log RTRV LOG Table 2 24 RTRV LOG Alarm Output Fields Continued Field Description condscr Example 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 Table B 2 shows all of the possible TimeProvider alarm and clearing alarm condition strings To retrieve all alarmed and non alarmed events which have an aid field of OC1 Input RTRV LOG IOC1 TP1000 ALL Response Example M TP1000 COMPLD TP SSU 05 02 10 13 37 39 TOC1 EQPT MN CLKWARM SA 05 02 10 12 00 10 CLOCK ENTERED WARM UP MODE TOC1 EQPT CL CLKWARM SA 05 02 10 12 07 37 CLOCK EXITED WARM UP MODE TOC1 EQPT MJ CLKFREE SA 05 02 10 12 07 37 CLOCK ENTERED FREE RUN MODE IOC1 EQPT NA IOCMODE NSA 05 02 10 12 07 40 IOC MODE IS ACTIVE TOC1 EQPT MJ CLKFREE SA 05 02 10 12 00 01 CLOCK ENTERED FREE RUN MODE TOC1 EQPT CL CLKFREE SA 05 02 10 12 00 01 CLOCK EXITED FREE RUN MODE TOC1 EQPT CR CLKFREE SA 05 02 10 12 00 01 CLOCK ENTERED F
204. vider s TL1 commands in detail Appendix A TL1 Command by Function Provides task oriented lists of security and administrative commands system commands and performance monitoring commands Appendix B Alarms Provides a list of all alarms and a description of their cause Appendix C Events Provides a list of all events and a description of their cause Index Provides references to individual topics within this guide 8 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 How to Use This Guide Conventions Used in This Guide Conventions Used in This Guide This guide uses the following conventions a Acronyms and Abbreviations Terms are spelled out the first time they appear in text Thereafter only the acronym or abbreviation is used a Revision Control The title page lists the printing date and versions of the product this guide describes a Typographical Conventions This guide uses the typographical conventions described in the table below When text appears this way It means TimeProvider TL1 Reference Guide The title of a document CRITICAL PORT A J1 An operating mode alarm state status or chassis label Select File Open Click the Open option on the File menu Press Enter Press Print Scrn A named keyboard key The key name is shown as it appears on the keyboard An explanation of the key s a
205. vider TL1 Reference Guide 109 Chapter 2 TL1 Command Syntax and Description Retrieve Equipment RTRV EQPT Parameter Value Description lt aid gt NTP Equipment settings for the NTP cont d m Peer Server a Authentication Note See ED EQPT for NTP Parameters on page 54 for lt keywords gt and descriptions of their possible lt values gt Normal Retrieve Response lt cr gt lt lf gt lt 1f gt sid date time lt cr gt lt lf gt M ctag COMPLD lt cr gt lt lf gt lt aid gt lt keyword gt lt value gt lt cr gt lt lf gt t Table 2 18 RTRV EQPT Output Field Field Description lt aid gt The access identifier for the equipment component refer to Edit Equipment ED EQPT on page 48 for valid lt aid gt lt keyword gt The specific equipment parameter being requested refer to Edit Equipment ED EQPT on page 48 for valid lt keyword gt lt value gt The current setting of the requested equipment parameter Example To display the current baud rate setting for the local serial communications COML port Input RTRV EQPT COML TP1000 BAUD Response Example TP SSU 05 02 10 13 37 39 M TP1000 COMPLD COML BAUD 9600 r Autonomous Message None 110 TimeProvider TL1 Reference Guide 097 58001 01 Revision G April 2008 Chapter 2 TL1 Command Syntax and Description Retrieve GPS Status RTRV GPS STAT Retrieve GPS Status RTRV GPS STAT This command displays the
206. x Symbols lt sid gt retrieving 112 setting 142 A access levels default command 24 25 access levels user 23 ACCLVL keyword 45 65 ACT FEATURE command 29 activating NTP 29 active mode IOC setting 50 ACT SWDL command 31 ACT USER command 37 adding a user 68 address IP setting 50 alarm condition descriptions 161 163 condition type 81 119 deactivating relays 75 expansion panel 96 100 external equipment 96 100 list 151 160 notification code 81 119 occurrence date 81 119 occurrence time 81 119 retrieving 79 retrieving attributes 82 service affecting 81 119 setting level 140 thresholds retrieving 134 thresholds setting 145 ALARM ID keyword 83 141 ALL keyword 83 118 ALM keyword 118 antenna elevation mask setting 51 retrieving position 111 setting position 51 AOMERGE keyword 49 audience intended 8 AUTHEN keyword 55 authentication NTP configuring 55 autonomous messages 20 Index Symbols C B BAUD keyword 50 baud rate retrieving 101 setting 50 BIST retrieving results 87 BRDGTIM keyword 141 C CANC USER command 38 cautions defined 10 circuit identifier editing 44 retrieving 90 CKTIDCHG keyword 44 CLEI retrieving 113 CLKTYPE keyword 51 CLRDELAY keyword 59 comm port baud rate retrieving 101 baud rate setting 50 craft data retrieving 101 echo enabling and disabling 49 equipment parameters retrieving 109 equipment parameters setting 48 49 50 flow control setting 50 command c
207. y aid IMC Retrieves events with an aid field of IMC IOC Retrieves events with an aid field of IOC locm Retrieves events with an aid field of OCm where a m 1 for the slot marked IOC 1 on the main shelf m m 2 for the slot marked IOC 2 on the main shelf GPS Retrieves events with an aid field of GPS PRS Retrieves events with an aid field of PRS INPp Retrieves events with an aid field of INPp where a p 1 for the input marked INP 1 on the Input Connector module p 2 for the input marked INP 2 on the Input Connector module OUTg Retrieves events with an aid field of OUTg where g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf RTMg Retrieves events with an aid field of RTMg where g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main shelf E4229 Retrieves events with an aid field of E4229 where g A for the group marked A on the main shelf g B for the group marked B on the main shelf g C for the group marked C on the main shelf g D for the group marked D on the main
208. ymbol Cautions are installation operation or maintenance procedures practices conditions or statements that if not strictly observed may result in damage to or destruction of the equipment Cautions are also used to indicate a long term health hazard ESD Caution To avoid personal injury and electrostatic discharge A ESD damage to equipment do not disregard ESD cautions All ESD cautions use this symbol ESD cautions are installation operation or maintenance procedures practices conditions or statements that if not strictly observed may result in possible personal injury electrostatic discharge damage to or destruction of static sensitive components of the equipment Electrical Shock Caution To avoid electrical shock and possible Ay personal injury do not disregard electrical shock cautions All electrical shock cautions use this symbol Electrical shock cautions are practices procedures or statements that if not strictly observed may result in possible personal injury electrical shock damage to or destruction of components of the equipment Recommendation All recommendations use this symbol Recommendations indicate manufacturer tested methods or known functionality Recommendations contain installation operation or maintenance procedures practices conditions or statements that provide important information for optimum performance results operation or maintenance procedures practices conditions

TimeProvider 1000 and 1100 Edge Clock

Contents

Download Pdf Manuals

Related Search

Related Contents