1. Use pursuant to applicable agreementsTitle pageAlcatel-Lucent1646 Synchronous Multiplexer Compact | Release 2.2TL1 Commands Guide3KC18039ACAATQZZAIssue 1 | February 2012Alcatel-Lucent ProprietaryUse pursuant to applicable agreements

2. 3KC18039ACAATQZZA Table of ContentsIssue 1, Feb 2012INTRODUCTION INTRODUCTION ...............................................................................................1 1.1 GENERAL............................................................................................................................1 1.2 CONVENTIONS................................................................................................................... 1 1.2.1 TL1 SYNTAX CHARACTERS........................................................................................ 1 1.2.2 VALID CHARACTER SET.............................................................................................. 2 1.2.3 PARAMETER VALUE SET NOTATION ........................................................................7 1.2.4 COMMAND INPUT FORMAT NOTATION .................................................................... 8 1.2.5 OUTPUT RESPONSE FORMAT NOTATION ...............................................................8 1.3 COMMAND ENTRY ............................................................................................................10 1.3.1 DIRECT INPUT COMMAND ENTRY MODE ................................................................. 10 1.4 COMMAND DESCRIPTIONS..............................................................................................10 1.4.1 COMMAND HEADER .................................................................................................... 10 1.4.2 PURPOSE...................................................................................................................... 11 1.4.3 COMMAND INPUT FORMAT ........................................................................................ 11 1.4.4 INPUT PARAMETERS................................................................................................... 12 1.4.4.1 TID Parameter Block...................................................................................................12 1.4.4.2 AID Parameter Block...................................................................................................13 1.4.4.3 CTAG Parameter Block............................................................................................... 13 1.4.4.4 General (Delayed Activation) Parameter Block........................................................... 14 1.4.4.5 Positional Parameter Block .........................................................................................14 1.4.4.6 Keyword Parameter Block...........................................................................................14 1.4.4.7 State Parameter Block ................................................................................................15 1.4.5 SUCCESSFUL RESPONSE FORMAT .......................................................................... 15 1.4.6 OUTPUT PARAMETERS...............................................................................................15 1.4.7 UNSUCCESSFUL RESPONSE FORMAT..................................................................... 15 1.4.8 ERROR CODES.............................................................................................................16 1.4.9 EXAMPLES .................................................................................................................... 16 1.4.10 RELATED COMMANDS ..............................................................................................16 1.4.11 RELATED AUTONOMOUS RESPONSES ..................................................................16 1.5 AUTONOMOUS RESPONSE FORMAT .............................................................................16 1.5.1 RESPONSE HEADER ................................................................................................... 16 1.5.2 PURPOSE...................................................................................................................... 16 1.5.3 RESPONSE FORMAT ................................................................................................... 17 1.5.4 OUTPUT PARAMETERS...............................................................................................17 1.5.5 EXAMPLES .................................................................................................................... 17 1.5.6 RELATED COMMANDS ................................................................................................ 17 1.5.7 RELATED AUTONOMOUS RESPONSES .................................................................... 17 1.6 COMMAND RESPONSES ..................................................................................................17 1.6.1 ACKNOWLEDGEMENT RESPONSE FORMAT ........................................................... 19Alcatel-Lucent 2008 - All Rights Reservedi 3. 3KC18039ACAATQZZAIssue 1, Feb 2012 Table of Contents1.6.2 SUCCESSFUL RESPONSE FORMAT ..........................................................................191.6.3 UNSUCCESSFUL RESPONSE FORMAT.....................................................................201.6.4 RETRIEVALS ................................................................................................................. 221.6.5 CONTINUATION MESSAGE FORMAT (OUTPUT GREATER THAN 4096 BYTES) ... 231.7 AUTONOMOUS RESPONSES ........................................................................................... 241.7.1 AUTONOMOUS MESSAGE FORMAT .......................................................................... 241.7.2 AUTONOMOUS KEEP^ALIVE MESSAGE FORMAT.................................................... 251.8 AID ADDRESSING ..............................................................................................................251.8.1 Simple Element Format..................................................................................................261.8.2 Compound Element Format ...........................................................................................261.8.3 Compound Subordinate Element Format....................................................................... 261.8.4 Valid Examples of correct usage of & and && operators ...............................................271.8.4 && and & Ranging and Grouping ...................................................................................291.9 DELAYED ACTIVATION ..................................................................................................... 301.10 USER SECURITY.............................................................................................................. 311.10.1 DEFAULT USER IDENTIFIER (UIDS)......................................................................... 311.10.1.1 Capabilities Restricted to the System Administrator ................................................311.11 General Syntax Errors ..................................................................................................... 321.12 APPENDICES....................................................................................................................33 TL1 COMMANDS ACT-USER ........................................................................................................ 35 ALW-USER-SECU ............................................................................................41 CANC-COPY-RFILE ......................................................................................... 45 CANC-USER-SECU..........................................................................................49 CANC-USER ..................................................................................................... 53 CNTRL-VCPATH .............................................................................................. 57 CNVT-CCTPR-RATE ........................................................................................61 CNVT-CCTU-RATE........................................................................................... 69 COPY-RFILE..................................................................................................... 75 DLT-ASAP-PROF ............................................................................................. 81 DLT-AUX...........................................................................................................85 DLT-CRS-RATE................................................................................................89 DLT-CRSPROT-RATE ...................................................................................... 95 DLT-EQPT ........................................................................................................ 101 DLT-FFP-STMN ................................................................................................ 105 DLT-NE-IPRT.................................................................................................... 109 DLT-NE-IPT ...................................................................................................... 113 DLT-NETIF........................................................................................................ 117ii 1646SMC R2.2 - TL1 Commands and Messages 4. 3KC18039ACAATQZZATable of Contents Issue 1, Feb 2012 DLT-NTP-ADDR................................................................................................ 121 DLT-OVHCCRS ................................................................................................ 125 DLT-TH-PROF .................................................................................................. 129 DLT-USER-SECU ............................................................................................. 133 DLT-VCG .......................................................................................................... 137 ED-ASAP-PROF ............................................................................................... 141 ED-AUN............................................................................................................. 149 ED-BITS-OUT ................................................................................................... 155 ED-BITS ............................................................................................................ 161 ED-CMD-SECU ................................................................................................. 165 ED-CRSPROT-RATE ........................................................................................ 169 ED-DAT ............................................................................................................. 177 ED-E1................................................................................................................ 181 ED-E3................................................................................................................ 185 ED-EOS............................................................................................................. 189 ED-EQPT .......................................................................................................... 193 ED-FFP-STMN .................................................................................................. 197 ED-GBE ............................................................................................................ 203 ED-IP-ADDR ..................................................................................................... 207 ED-LAC-STATE ................................................................................................ 211 ED-LAN ............................................................................................................. 215 ED-MAU ............................................................................................................ 219 ED-MGRLIST .................................................................................................... 223 ED-NE-TL1........................................................................................................ 227 ED-NETIF.......................................................................................................... 231 ED-NTP ............................................................................................................. 235 ED-OSADDRS .................................................................................................. 239 ED-OSIAREA .................................................................................................... 243 ED-OW .............................................................................................................. 247 ED-PID .............................................................................................................. 251 ED-PTF ............................................................................................................. 255 ED-RINGMAP ................................................................................................... 261 ED-SECU .......................................................................................................... 265 ED-SQLMAP ..................................................................................................... 269 ED-STMN .......................................................................................................... 2731646SMC R2.2 - TL1 Commands and Messages iii 5. 3KC18039ACAATQZZAIssue 1, Feb 2012 Table of Contents ED-SYNCN-OUT ............................................................................................... 283 ED-SYNCN........................................................................................................ 291 ED-T1 ................................................................................................................ 297 ED-T3 ................................................................................................................ 301 ED-TH-PROF .................................................................................................... 305 ED-ULCOMPMR ............................................................................................... 311 ED-USER-SECU ............................................................................................... 315 ED-VCG ............................................................................................................ 323 ENT-ASAP-PROF ............................................................................................. 329 ENT-AUX........................................................................................................... 335 ENT-CRS-RATE................................................................................................ 341 ENT-CRSPROT-RATE...................................................................................... 351 ENT-EQPT ........................................................................................................ 365 ENT-FFP-STMN ................................................................................................ 369 ENT-NE-IPRT.................................................................................................... 377 ENT-NE-IPT ...................................................................................................... 381 ENT-NETIF........................................................................................................ 385 ENT-NTP-ADDR ............................................................................................... 389 ENT-OVHCCRS ................................................................................................ 393 ENT-TH-PROF .................................................................................................. 397 ENT-USER-SECU ............................................................................................. 401 ENT-VCG .......................................................................................................... 409 INH-USER-SECU .............................................................................................. 413 INIT-REG-GBE.................................................................................................. 417 INIT-REG-MAU ................................................................................................. 421 INIT-REG-SDHFACILITY .................................................................................. 425 INIT-SYS-NEW.................................................................................................. 431 INIT-SYS ........................................................................................................... 433 MON-LCAS ....................................................................................................... 437 OPR-ACO-COM ................................................................................................ 443 OPR-EXT-CONT ............................................................................................... 445 OPR-LPBK-E1 .................................................................................................. 447 OPR-LPBK-E3 .................................................................................................. 451 OPR-LPBK-GBE............................................................................................... 455 OPR-LPBK-MAU .............................................................................................. 459iv 1646SMC R2.2 - TL1 Commands and Messages 6. 3KC18039ACAATQZZATable of Contents Issue 1, Feb 2012 OPR-LPBK-STMN ............................................................................................ 463 OPR-LPBK-T1 .................................................................................................. 467 OPR-LPBK-T3 .................................................................................................. 471 OPR-PROTNSW-RATE .................................................................................... 475 OPR-PROTNSW-STMN.................................................................................... 483 OPR-SYNCNSW-OUT ...................................................................................... 491 OPR-SYNCNSW ............................................................................................... 495 RD-SYNCN ....................................................................................................... 499 RLS-EXT-CONT................................................................................................ 503 RLS-LPBK-E1................................................................................................... 505 RLS-LPBK-E3................................................................................................... 509 RLS-LPBK-GBE ............................................................................................... 513 RLS-LPBK-MAU ............................................................................................... 517 RLS-LPBK-STMN ............................................................................................. 521 RLS-LPBK-T1 ................................................................................................... 525 RLS-LPBK-T3 ................................................................................................... 529 RLS-PROTNSW-RATE ..................................................................................... 533 RLS-PROTNSW-STMN .................................................................................... 537 RLS-SYNCNSW-OUT ....................................................................................... 541 RLS-SYNCNSW................................................................................................ 545 RTRV-ALLOWED ............................................................................................. 549 RTRV-ALM-ALL................................................................................................ 553 RTRV-ALM-BITS .............................................................................................. 567 RTRV-ALM-E1 .................................................................................................. 571 RTRV-ALM-E3 .................................................................................................. 577 RTRV-ALM-ENV ............................................................................................... 583 RTRV-ALM-EOS ............................................................................................... 587 RTRV-ALM-EQPT............................................................................................. 591 RTRV-ALM-GBE............................................................................................... 597 RTRV-ALM-LOVCN .......................................................................................... 603 RTRV-ALM-MAU............................................................................................... 611 RTRV-ALM-STMN ............................................................................................ 617 RTRV-ALM-T1 .................................................................................................. 625 RTRV-ALM-T3 .................................................................................................. 631 RTRV-ALM-TIMING .......................................................................................... 6351646SMC R2.2 - TL1 Commands and Messagesv 7. 3KC18039ACAATQZZAIssue 1, Feb 2012Table of Contents RTRV-ALM-VCG............................................................................................... 641 RTRV-ALM-VCN ............................................................................................... 647 RTRV-ASAP-PROF........................................................................................... 655 RTRV-ATTR-ENV ............................................................................................. 663 RTRV-ATTR-SECULOG ................................................................................... 667 RTRV-AUDIT-SECULOG.................................................................................. 671 RTRV-AUN........................................................................................................ 683 RTRV-AUX ........................................................................................................ 689 RTRV-BITS-OUT............................................................................................... 693 RTRV-BITS ....................................................................................................... 699 RTRV-CHAN-BLSR .......................................................................................... 703 RTRV-CMD-SECU ............................................................................................ 707 RTRV-COND-LOG ............................................................................................ 711 RTRV-CRS-RATE ............................................................................................. 719 RTRV-CRS........................................................................................................ 727 RTRV-CRSPROT-RATE ................................................................................... 735 RTRV-CRSPROT .............................................................................................. 745 RTRV-DB-LABEL ............................................................................................. 753 RTRV-DDM ....................................................................................................... 757 RTRV-DFLT-SECU ........................................................................................... 761 RTRV-DOSM-RSRC ......................................................................................... 767 RTRV-E1 ........................................................................................................... 773 RTRV-E3 ........................................................................................................... 777 RTRV-EOS........................................................................................................ 781 RTRV-EQPT...................................................................................................... 785 RTRV-EXT-CONT ............................................................................................. 791 RTRV-FFP-ALL................................................................................................. 795 RTRV-FFP-STMN ............................................................................................. 805 RTRV-GBE........................................................................................................ 817 RTRV-HDR........................................................................................................ 821 RTRV-IP-ADDR................................................................................................. 825 RTRV-IP-PRMTR .............................................................................................. 827 RTRV-ISU-STATUS .......................................................................................... 829 RTRV-LAC-DFLT.............................................................................................. 833 RTRV-LAC-STATE ........................................................................................... 837vi 1646SMC R2.2 - TL1 Commands and Messages 8. 3KC18039ACAATQZZA Table of Contents Issue 1, Feb 2012 RTRV-LAN ........................................................................................................ 841 RTRV-LPBK-E1 ................................................................................................ 845 RTRV-LPBK-E3 ................................................................................................ 849 RTRV-LPBK-GBE............................................................................................. 853 RTRV-LPBK-MAU ............................................................................................ 857 RTRV-LPBK-STMN .......................................................................................... 861 RTRV-LPBK-T1 ................................................................................................ 865 RTRV-LPBK-T3 ................................................................................................ 869 RTRV-MACGLB-STATUS ................................................................................ 873 RTRV-MAU ....................................................................................................... 877 RTRV-MGRLIST ............................................................................................... 881 RTRV-NE-IPRT ................................................................................................. 883 RTRV-NE-IPT.................................................................................................... 887 RTRV-NE-TL1 ................................................................................................... 891 RTRV-NETIF ..................................................................................................... 895 RTRV-NTP-ADDR............................................................................................. 899 RTRV-NTP ........................................................................................................ 901 RTRV-OSADDRS.............................................................................................. 905 RTRV-OSIAREA ............................................................................................... 909 RTRV-OVHCCRS.............................................................................................. 913 RTRV-OW ......................................................................................................... 917 RTRV-PATHSL ................................................................................................. 921 RTRV-PATHTRC .............................................................................................. 925 RTRV-PM-GBE ................................................................................................. 933 RTRV-PM-MAU................................................................................................. 941 RTRV-PM-SDHFACILITY ................................................................................. 949 RTRV-PMGLB-STATUS ................................................................................... 959 RTRV-PMMODE-GBE ...................................................................................... 965 RTRV-PMMODE-MAU ...................................................................................... 969 RTRV-PMMODE-SDHFACILITY....................................................................... 973 RTRV-PRMTR-NE............................................................................................. 979 RTRV-PTF......................................................................................................... 983 RTRV-RI............................................................................................................ 993 RTRV-RINGMAP............................................................................................... 999 RTRV-SECTRC................................................................................................. 10031646SMC R2.2 - TL1 Commands and Messages vii 9. 3KC18039ACAATQZZAIssue 1, Feb 2012 Table of Contents RTRV-SQLMAP ................................................................................................ 1009 RTRV-STATUS ................................................................................................. 1013 RTRV-STMN ..................................................................................................... 1017 RTRV-SYNCN-MSG.......................................................................................... 1027 RTRV-SYNCN-OUT .......................................................................................... 1031 RTRV-SYNCN ................................................................................................... 1039 RTRV-T1 ........................................................................................................... 1047 RTRV-T3 ........................................................................................................... 1051 RTRV-TCAP-ASGNMT ..................................................................................... 1055 RTRV-TH-PROF................................................................................................ 1061 RTRV-TL1-SYNTAX ......................................................................................... 1067 RTRV-ULCOMPMR .......................................................................................... 1071 RTRV-USER-SECU .......................................................................................... 1075 RTRV-USER ..................................................................................................... 1083 RTRV-VCG........................................................................................................ 1091 SET-ATTR-ENV ................................................................................................ 1097 SET-ATTR-SECUDFLT..................................................................................... 1101 SET-ATTR-SECULOG ...................................................................................... 1107 SET-IP-PRMTR................................................................................................. 1111 SET-LAC-DFLT................................................................................................. 1115 SET-PMMODE-GBE ......................................................................................... 1119 SET-PMMODE-MAU......................................................................................... 1123 SET-PMMODE-SDHFACILITY ......................................................................... 1127 SET-PRMTR-NE ............................................................................................... 1133 SET-SID ............................................................................................................ 1135 STA-MACGLB................................................................................................... 1139 STA-PMGLB ..................................................................................................... 1143 AUTONOMOUS MESSAGE DESCRIPTIONS KEEP^ALIVE^MESSAGE ................................................................................ 1147 REPT^ALM^BITS............................................................................................. 1149 REPT^ALM^E1................................................................................................. 1153 REPT^ALM^E3................................................................................................. 1157 REPT^ALM^ENV.............................................................................................. 1161 REPT^ALM^EOS ............................................................................................. 1165 REPT^ALM^EQPT ........................................................................................... 1169viii1646SMC R2.2 - TL1 Commands and Messages 10. 3KC18039ACAATQZZATable of ContentsIssue 1, Feb 2012 REPT^ALM^GBE ............................................................................................. 1173 REPT^ALM^LOVCN ........................................................................................ 1177 REPT^ALM^MAU ............................................................................................. 1183 REPT^ALM^STMN........................................................................................... 1187 REPT^ALM^T1................................................................................................. 1193 REPT^ALM^T3................................................................................................. 1197 REPT^ALM^TIMING ........................................................................................ 1201 REPT^ALM^VCG ............................................................................................. 1205 REPT^ALM^VCN ............................................................................................. 1209 REPT^CANC .................................................................................................... 1215 REPT^COPY^RFILE ........................................................................................ 1217 REPT^EVT^EQPT............................................................................................ 1221 REPT^EVT^FFP ............................................................................................... 1225 REPT^EVT^LAC .............................................................................................. 1229 REPT^EVT^LOVCN ......................................................................................... 1231 REPT^EVT^MGRLIST...................................................................................... 1235 REPT^EVT^SECU............................................................................................ 1237 REPT^EVT^SESSION...................................................................................... 1241 REPT^EVT^TIMING ......................................................................................... 1245 REPT^EVT^VCN .............................................................................................. 1249 REPT^INFORMATION...................................................................................... 1253APPENDICES APPENDIX A: ACRONYMS AND ABBREVIATIONS....................................... 1255A.1 ACRONMYNS AND ABBREVIATIONS.............................................................................. 1255 APPENDIX B: ACCESS IDENTIFIERS ............................................................ 1257B.1 General Facility AID Format: ............................................................................................ 1257B.2 General Timing Reference AID Format: .......................................................................... 1257B.3 General Equipment AID Format:...................................................................................... 1257B.4 Facility AIDs ....................................................................................................................... 1258B.5 Fast Facility Protection Group AIDs................................................................................ 1261B.6 Timing Reference AIDs ..................................................................................................... 1261B.7 Equipment AIDs................................................................................................................. 1262B.8 Common AIDs.................................................................................................................... 1263B.9 ASAP AIDs.......................................................................................................................... 1263B.10 THP AIDs .......................................................................................................................... 1265 APPENDIX C: CONDITION TYPES.................................................................. 1267C.1. Equipment Condition Types ........................................................................................... 12671646SMC R2.2 - TL1 Commands and Messages ix 11. 3KC18039ACAATQZZAIssue 1, Feb 2012Table of ContentsC.2. Facility Condition Types.................................................................................................. 1268C.3. System Common Condition Types................................................................................. 1272C.4. Transient Condition Types.............................................................................................. 1273ASAP TABLES .......................................................................................................................... 1275APPENDIX D: ERROR CODES........................................................................ 1285D.1. ERROR CODE MNEMONICS ........................................................................................... 1285D.2. COMMAND PARSER ERROR CODES ............................................................................ 1286APPENDIX E: COMMAND ENTRY MENUS..................................................... 1287APPENDIX F: MONITORED PM PARAMETERS............................................. 1289F.1 Monitored Types................................................................................................................ 1290APPENDIX G: STATE TRANSITIONS ............................................................. 1291APPENDIX H: USER COMMAND PRIVILEGE DEFAULTS AND LOG INDICATION........................................................................................................................... 1293H.1. GENERAL USER PRIVILEGES AND LOG INDICATION................................................. 1293H.2. USER PRIVILEGE DEFAULTS AND LOG INDICATION ................................................. 1293APPENDIX I: VDT FUNCTION KEYS............................................................... 1301APPENDIX J: DEFAULT EQUIPMENT DRAWINGS ....................................... 1303APPENDIX K: FACTORY DEFAULTS FOR TL1 COMMAND PARAMETERS 1305K.1 GENERAL ........................................................................................................................... 1305K.2 PARAMETER DEFAULTS.................................................................................................. 1305x1646SMC R2.2 - TL1 Commands and Messages 12. 3KC18039ACAATQZZAIssue 1, Feb 2012INTRODUCTION1.1 GENERALThis Manual describes the Transaction Language 1 (TL1) command and response messages availablein this release of the NE. These messages consist of input commands, command output response(successful and unsuccessful) messages, acknowledgement output messages, and autonomousoutput messages.The general description and syntax for these messages is provided in this section (section 1) of themanual.A description of each input command and its associated output (successful and unsuccessful)responses is presented in section 2 in alphabetical order by command code.A description of each autonomous output message is presented in section 3 in alphabetical order byresponse code.Supplementary information is included in the appendices which follow section 3. A list of theappendices is provided at the end of this Introduction.This manual is intended for use by personnel involved in system installation and acceptance, technicalsupport, facility provisioning, plant maintenance, remote administration, and Operations SupportSystems development.1.2 CONVENTIONSThe following conventions, described below, are used in this manual.1.2.1 TL1 SYNTAX CHARACTERSThe following symbols are used as TL1 command input and response output syntax characters. Someof these symbols are also used in this manual for notational purposes in describing command inputformat and response output format, but these characters are only used as a literal character in anactual command input or response output as described below.1646SMC R2.2 - TL1 Commands and Messages1 13. 3KC18039ACAATQZZAIssue 1, Feb 2012 INTRODUCTIONSymbol Description:A colon is used to separate parameter blocks in an input command or in a parsable text output message.,A comma is used to separate parameters within a parameter block of an input command or an output response message.;A semi-colon is used as a terminator to indicate the completion, and identify the end, of an input command, a successful or unsuccessful output message, or an autonomous message. A semi-colon does not appear within a parsable text string or within free form, non-parsable, informational text.>A greater-than sign is used as a continuation message terminator and indicates additional output associated with the response will follow. A greater-than sign does not appear within a parsable text string or within free form informational text.) Vertical Tab ()21646SMC R2.2 - TL1 Commands and Messages 14. 3KC18039ACAATQZZA INTRODUCTIONIssue 1, Feb 2012 Space () Form Feed () Line Feed () Carriage return ()The valid character set for non-string (i.e., characters not enclosed in double quotes "") commandinput and command output (i.e. characters not enclosed in backslash double quotes sequences " ")is: Upper and lower case alphabetical characters unless otherwise specified in a commandsdescriptions. Decimal numbers 0 through 9 Special characters:CharacterDescription-underscore+addition or plus sign%percent sign#number or pound sign.single period (for decimal representation)(-) negative number representation where is a numerical value In addition, the following special characters are reserved for TL1 command input syntax and maynot be used as part of a parameters value unless otherwise specified in a commands descriptionCharacterDescription:colon;semi-colon,comma-hyphen or dash sign=equal sign&ampersand"quotation markThe maximum acceptable value of a numeric parameter is 4294967295. Beyond that limit, the parserwill reject the command with a syntax error.The following ASCII characters are allowed (valid) to be entered as input parameter values whenenclosed in double quotes (): Upper and lower case alphabetical characters unless otherwise specified in a commandsdescription.1646SMC R2.2 - TL1 Commands and Messages 3 15. 3KC18039ACAATQZZAIssue 1, Feb 2012 INTRODUCTION Decimal numbers 0 through 9 Special characters:Character Description_ underscore+ addition or plus sign% percent sign# number or pound sign. single period (for decimal representation)! exclamation& ampersand* asterisk()parenthesis apostrophe, comma- dash. period/ forward dash: colon= equal sign? question markspace character, ASCII code 32[]square brackets^ caret$ dollar sign{}curly brackets| pipe~ tilde@ at sign NOTE: terminator characters are excluded from the allowed ones. The following ASCII characters are allowed (valid) to be displayed as text string in output parameter values: Upper and lower case alphabetical characters unless otherwise specified in a commands description. Decimal numbers 0 through 9 Special characters:41646SMC R2.2 - TL1 Commands and Messages 16. 3KC18039ACAATQZZA INTRODUCTIONIssue 1, Feb 2012CharacterDescription_underscore+addition or plus sign%percent sign#number or pound sign.single period (for decimal representation)!exclamation&ampersand*asterisk() parenthesisapostrophe,comma-dash.period/forward dash:colon=equal sign?question mark space character, ASCII code 32[] square brackets^caret$dollar sign{} curly brackets|pipe~tilde@at sign SONET NEs may support the display of the incoming trace. The incoming trace may contain characters outside the character set listed as valid ASCII characters in a output text string parameter . Character substitution (where the incoming trace character is replaced with a character from the valid character set) occurs for these special cases. All alpha characters entered by the user must in upper case except: Command code (verb-modifier-modifier), which may be entered in either upper or lower case, or a mixture of upper and lower case. Values for CTAG (Correlation Tag), which may be entered in upper or lower case. Values for PID (Password Identifier), UID (User Identifier), which must be entered in the same case as when created. Values for TID (Target Identifier), which is converted to upper case for comparison to the provisioned SID (Site Identifier) value.1646SMC R2.2 - TL1 Commands and Messages5 17. 3KC18039ACAATQZZAIssue 1, Feb 2012 INTRODUCTION Values for SID (Site Identifier), which is converted to upper case for comparison to the entered TID (Target Identifier) value. Values for ISUKEY which may be entered in upper or lower case, or mixture of upper and lower case in the STAISU command. Values for WARN which may be entered in upper or lower case, or mixture of upper and lower case in the SET-ATTR-SECULOG command. Values for LOCATION which may be entered in upper or lower case, or mixture of upper and lower case in the COPY-RFILE and RTRV-FILE commands. Values for NODENAME (TCP/IP Network Name) which must be entered using the case as shown in the ED-IP-PRMTR command. Format affectors are ignored by the systems command parser when entered in a command input message in the following cases: Before or after a command verb or verb modifier in a command code. Before or after a command syntax punctuation or operator character, that is:Character Description: colon, comma; semi-colon- dash= equal& ampersand&&double ampersand&-ampersand dash&&- double ampersand dash.++.period plus sign plus sign period( left parenthesis) right parenthesis Before or after a command parameter name or a parameter value. The case of characters displayed by output messages will be the same case as entered or as when created except: Values for TID (Target Identifier), which is always displayed in upper case. Values for SID (Site Identifier), which is always displayed in upper case. Values for -[-], which is always displayed in upper case.61646SMC R2.2 - TL1 Commands and Messages 18. 3KC18039ACAATQZZA INTRODUCTION Issue 1, Feb 2012 Values for parameters names, which are always displayed in upper case. Command echo is always displayed in the same case as entered except for the Command codewhich as noted above is always displayed in upper case.The system will ignore all leading zeroes (that are not enclosed in double quotes "") in a commandinput parameter (e.g., DAT=000002, DAT=02 are accepted). The retrieval output parameter willdisplay the entered parameter in the fixed format specified in such command descriptions (e.g., in theprevious example, the output DAT parameter would be displayed as DAT=02 for both cases).Whenever a parameter value takes a negative number (real or integer), this value must be precededby the minus sign, and enclosed between parentheses. Valid examples are (-3) or ( -2.4).1.2.3 PARAMETER VALUE SET NOTATIONIn most cases, an input parameter of a command has more than one possible value. A parameters setof values, or domain, is defined in this manual by using the following notation:NotationDescription, A comma is used to separate parameter values when multiple values exist.- A hyphen is used to indicate a range of values for the parameter, or a range ofvalues within an argument of a compound parameter. For example, 1-12indicates a value set of 12 discrete values from one through twelve. A hyphenmay also be a literal character of a compound parameters value. Enclosing less-than and greater-than signs are used to enclose a description ofthe parameters domain when this is more understandable than an exactdefinition of the domain. For example, < 1 - 6 VALID CTAG CHARACTERS >describes the CTAG domain of 1-6 case sensitive alphanumeric characters.Enclosing braces are used to enclose a set of values. Enclosing braces may benested.For example:Enclosing braces as used to enclose a set of values.{1}4 describesa value setconsisting of the valuesLOFandLOS.Enclosing braces as used to enclose an argument of a compound parameterwhen a range of values exist for the argument of the compound parameter. {1}3 - {1}2 }describes a value set of 256 discrete values from ABC-1-1through ABC-16-16 (note that the hyphens outside of the braces are literalcharactersintheparameters value).Braces as used to enclose a value subset that has been named to provideadditional clarity. A value subset may be named when the possible values of aparameter consist of more than one type of value (or when naming the value setprovides additional clarity). When a value subset is named, the name of thevalue subset and the value subset are separated by a colon (:). {1}1 -{1}0 - {0-1}9, Day:{0-1}8 }describes a value set that consists of two types of value subsets, one valuesubset named Date and the other value subset named Day.: A colon is used to separate the name of a value subset and the value subsetwhen the value subset has been named for additional clarity. Refer to theexample above.The parameter value is used to indicate a parameter value of "no value". is used indescribing input parameters when an unpopulated (not entered) parameter value has an explicitdefinition other than another specific parameter value or "previously existing value". is used indescribing output parameters when no displayed output parameter value is part of the outputparameter value set.1646SMC R2.2 - TL1 Commands and Messages 7 19. 3KC18039ACAATQZZAIssue 1, Feb 2012 INTRODUCTIONAssuming the output parameter is supported for a given output response (i.e., output parameter issupported for specified retrieval of a provisioned AID), if or a Null value is a part of the outputparameter set and if or a null value is assigned to a keyword defined output parameter thenthat output parameter will display no output to the right of the "=" sign.1.2.4 COMMAND INPUT FORMAT NOTATIONThe following notation is used in this manual to describe a commands input format:NotationDescription[...] Enclosing brackets are used to enclose an optional command input parameter. Enclosing less-than and greater-than signs are used to indicate a valuesubstitution. The enclosing less-than and greater-than signs are not part of theactual input command. Generally, this notation is only used in this section toprovide additional clarity in the syntax descriptions for an input command.Also refer to section 1.2.1., TL1 Syntax Characters, for a description of the TL1 command input syntaxcharacters, and to section 1.4.3, Command Input Format, for a description of each command inputparameter block.1.2.5 OUTPUT RESPONSE FORMAT NOTATIONThe following notation is used in this manual to describe a commands output response message or anautonomous output response message:8 1646SMC R2.2 - TL1 Commands and Messages 20. 3KC18039ACAATQZZAINTRODUCTIONIssue 1, Feb 2012NotationDescription^ A caret is used to identify a space in a output response message. Generally, thisnotation is only used in this section to provide additional clarity in the syntaxdescriptions for output messages.cr"cr" (carriage return) is used to indicate a carriage return in an output responsemessage. Generally, this notation is only used in this section to provide additionalclarity in the syntax descriptions for output messages.lf"lf" (line feed) is used to indicate a line feed in an output response message.Generally, this notation is only used in this section to provide additional clarity inthe syntax descriptions for output messages.(...) Enclosing parenthesis may be used to enclose a group of symbols in an outputresponse, generally to provide additional notational clarity. Enclosing parenthesisare also used in the non-parsable command echo line to enclose the SessionNumber pertaining to the output response message. The enclosing parenthesisare not part of the actual output message, except when used in the commandecho line of an output response.[...] Enclosing brackets are used to enclose an optional item or group of items (forexample, a parameter or output response message line) in an output response.Enclosing brackets are also used in the non-parsable command echo line toenclose the CTAG value pertaining to the output response message. Theenclosing brackets are not part of the actual output message, except when usedin the command echo line of an output response. Enclosing less-than and greater-than signs are used to indicate a valuesubstitution. The enclosing less-than and greater-than signs are not part of theactual output message.{...} Enclosing braces are used to enclose a set of values. Generally, enclosingbraces are used in the notation for the non-parsable command echo line and indescribing an output parameters value set. The enclosing braces are not part ofthe actual output message., A comma is used to separate parameters within an output response message,and is also used as part of a parameters value set notation to separateparameter values. When used to separate parameter values within a value set,the separating comma is not part of the actual output message.- A hyphen is used in describing an output parameters value set to indicate arange of values for the parameter, or a range of values within an argument of acompound parameter. A hyphen may also be a literal character of a compoundparameters value.* An asterisk that is following enclosing brackets or parenthesis is used to indicatethe enclosed item may appear in an output response message zero, one or moretimes. The enclosing brackets or parenthesis and asterisk are not part of theactual output message. Generally, this notation is only used in this section toprovide additional clarity in the syntax descriptions for output messages.+ A plus sign that is following enclosing brackets or parenthesis is used to indicatethe enclosed item may appear in an output response message one or moretimes. The enclosing brackets or parenthesis and plus sign are not part of theactual output message. Generally, this notation is only used in this section toprovide additional clarity in the syntax descriptions for output messages.1646SMC R2.2 - TL1 Commands and Messages9 21. 3KC18039ACAATQZZAIssue 1, Feb 2012INTRODUCTION1.3 COMMAND ENTRY Network and User access is provided through TCP/IP on the LAN port of the LAN Switch board. One command entry mode is available, Direct Input Command Entry mode. In Direct Input Command Entry mode, commands are entered in their entirety by the user. 1.3.1 DIRECT INPUT COMMAND ENTRY MODE In Direct Input Command Entry mode, commands are entered by typing the desired command on the command input line, ending with a ; (semi-colon).1.4 COMMAND DESCRIPTIONS Command descriptions for each command are located in section 2 of this manual. Each command description consists of the following subsections: Command Headerconsists of the command code and name. Purposeprovides information on the function of the command. Input Format shows the commands TL1 input syntax. Refer to section 1.4.3, Command Input Format, for a description of the format and notation for a TL1 command as used in this manual. Input Parameters describes the input parameters and parameter values that can be used with the command. With regards to the input order of the Keyword-defined parameters as the appear in this manual, Keyword-defined parameters may be entered in any order (the keyword defines the parameter value being entered). Refer to section 1.4.4., Input Parameter Descriptions, for a description of the format used for this section of a command description. Successful Response Format shows the normal (successful) response format for thecommand. With regards to the output order of the Keyword-defined parameters as theappear in this manual, the system may generate an output response message with thekeyword parameters in non-alphabetical order (the keyword in the output responsedefines the parameter value being reported). Refer to section 1.6., CommandResponse Messages, for a description and syntax of command output responsemessages. Output Parametersdescribes the output parameters and parameter values shown in the output response message, if any, except for parameters in the response header. An Output Parameters section is not shown if the command does not provide output parameters. Refer to paragraph 1.4.6., Output Parameter Descriptions, for a description of the format used for this section of a command description. Unsuccessful Response Format shows the error (unsuccessful) response format for thecommand. Refer to section 1.6., Command Response Messages, for a descriptionand syntax of command output response messages. Error Codes lists the error codes associated with the commands unsuccessful response. Examples provides one or more illustrations on the use of the command. Related Commands provides a list of closely related or prerequisite (commands that must be executed before the described command can be executed) commands. Related Autonomous Responsesprovides a list of closely related autonomous response messages, if any. 1.4.1 COMMAND HEADER The Command Header section of a command description is at the top of the first page of the commands description. The command header consists of two parts, the command code which provides the command verb and one or two modifiers as applicable:101646SMC R2.2 - TL1 Commands and Messages 22. 3KC18039ACAATQZZA INTRODUCTION Issue 1, Feb 2012 COMMAND CODE: ACT-USERand the command name, which provides the commands full name: COMMAND NAME: ACTIVATE USER1.4.2 PURPOSEThe Purpose section of a command description describes the use or effect of the command anddiscusses the commands functionality.1.4.3 COMMAND INPUT FORMATThe Input Format section of a command description shows the commands valid TL1 syntax. A TL1command is an input message which consists of a command code, blocks of parameters, andpunctuation. The input message begins with the command verb and must end with a semicolon ( ; )terminator. The general command input format takes the form:VERB-MODIFIER[-MODIFIER]:[TID]:[AID]:[CTAG]:[GENERAL]:[POSITIONAL]:[KEYWORD]:[STATE];The maximum character length of any input message is 1024 characters.When this limit is reached, the incomplete truncated command as typed is sent to the parser which will threturn a syntax error (unless the 1024 character happens to be a semicolon), as it would for anyincomplete command.A few commands (for example, the Telcordia CONN-TACC-T1 and OPR-PROTNSW-rr command)have an input format where all parameter blocks following the General Block are positional parameterblocks. In these cases, the command input format takes the form:VERB-MODIFIER[-MODIFIER]:[TID]:[AID]:[CTAG]:[GENERAL]:[POSITIONAL]: ... :[POSITIONAL];A series of parameter blocks follow the command code. Parameter blocks contain zero, one or moreparameters. Parameter blocks are separated from the command code, and from each other, by acolon ( : ). Parameters within a parameter block are separated from each other by a comma ( , ). Allparameter blocks are not required by all commands, nor are all parameters always required for eachblock.Brackets [...] are used in the command input format to indicate optional parameters within a block.Absence of brackets indicate the parameter must be entered. The brackets are not entered as part ofthe actual command and are only shown for notational purposes. The syntax characters , (comma) or :(colon) can also be optional (as described below), but brackets are not necessarily used to indicatethat they are optional.If one or more parameter blocks are omitted from the end of a command (no parameters are enteredin the last block(s) of a command), the trailing colons associated with them may be omitted. In addition,if one or more parameters are omitted from the end of a parameter block, the trailing commasassociated with them may be omitted. However, if an optional parameter value in a positionalparameter block is omitted with other positional parameter values following, all of the interveningplace-holder commas must be provided to indicate no value is being entered for that positionalparameter. No additional commas are needed if an optional keyword parameter is omitted from akeyword parameter block; only commas separating each keyword parameter are required in thekeyword parameter block.Trailing commas at the end of a Positional, AID, or State block are optional. The parser accepts 0 to ntrailing commas (e.g.,[a],, or [a]) where n is the maximum number of input parameters in a block minus1.Commas in the Keyword block are used to separate keyword parameters.An Example of syntactically correct keyword parameter block is:PARM1=VALUE1, PARM2=VALUE2Examples of syntactically incorrect keyword parameter blocks are:,,PARM1=VALUE1, PARM2=VALUE2 (incorrect because of the two leading commas)PARM1=VALUE1,,PARM2=VALUE2 (incorrect because of the two separating commas)1646SMC R2.2 - TL1 Commands and Messages11 23. 3KC18039ACAATQZZAIssue 1, Feb 2012 INTRODUCTION PARM1=VALUE1, PARM2=VALUE2,, (incorrect because of the two trailing commas) Trailing colons at the end of any command are optional. The parser accepts 0 to n trailing colons (e.g.,RTRV-HDR:::; or RTRV-HDR;) where n is the maximum number of blocks minus 1. 1.4.4 INPUT PARAMETERS The Input Parameters section of a command description describes all required and optional parameters listed in the Input Format section of a command description, and describes the possible values, default value, and any addressing or restrictions for each parameter. The general format of the Input Parameters section is: PARM {0-1}7Default:{0-1}6Addressing:Any parameter addressing or grouping rulesDescription: Description of the parameter. Values are:PARM_VALUE Values Name: Description of the input parameters values.Restrictions:Any restrictions pertaining to the parameter or parameters values. where:PARM: The parameter identifier. A positional parameter is identified by PARM, a keywordparameter is identified by PARM=.PARAMETER_VALUE_SET: The parameters set of values or domain.Default:The default value of the parameter if the parameter is omitted from the input command(the parameter value assumed by the system and/or obtained via an associatedretrieve command if the parameter is not entered in the command).Addressing:Any parameter ranging and grouping addressing rules.Description: The input parameters name and a brief description of the parameter.PARM_VALUE: The parameters value identifier and description for each of the parameters values. PARM_VALUE is only shown when applicable, for example, its not shown for the TID or CTAG parameters.Restrictions: Tny restrictions pertaining to the parameter or the parameters values. Restrictions are only described when applicable. Input parameters in this release will all abide by the following rules. Omitting an optional keyword or positional parameter from a TL1 command other than an "ED" or a "SET" type TL1 command will have the identical effect as actually entering that TL1 parameter with its default value assigned. Except for keyword defined CMDMDE or MODE parameter (whose default is always NORM), omitting an optional keyword or positional parameter from an "ED" or a "SET" type TL1 command will have no effect on that parameter (i.e. the default is "previously existing value" for "ED" or "SET" TL1 command). Upper or lower case alphabetical characters (a-z, A-Z), decimal numbers (0 through 9), and the special characters underscore (_), plus (+), percentage (%), pound (#) will be the only valid characters for symbolic name values (eg., UID parameter values). Dash (-) is also allowed for separating compound values (eg., TL1 command names, TID, SID, AID parameter values). 1.4.4.1 TID Parameter Block The Target Identifier (TID) is optional and is the first block after the command code. The TID value is used to specify the target system for remotely issued commands. If unpopulated (not entered), the system assumes a TID value of the (upper case) Site Identifier (SID) value. If a value is entered for TID, that value is converted to upper case and compared with the provisioned (upper case) SID value. The command is denied if the converted upper case TID value and provisioned (upper case) SID value dont match and DCC is not supported.121646SMC R2.2 - TL1 Commands and Messages 24. 3KC18039ACAATQZZAINTRODUCTIONIssue 1, Feb 2012A TID is the first parameter block after the command code. TID may be optional.Valid values for TID are:1 to 20 alphanumeric characters or hyphens (-). A TID value begins with an alpha character and endwith an alphanumeric character. Consecutive hyphens (-) will not be allowed. OR1 to 20 characters quoted string, that is any string of maximum 20 characters, including specialcharacters, included in double quotes.The values for TID may be entered in upper or lower case. If unpopulated (not entered), the systemassumes a TID value of the (upper case) Site Identifier (SID) value.1.4.4.2 AID Parameter BlockThe Access Identifier (AID) value is generally a letters and digits compounded value and directs aninput command to its intended equipment, facility, or data entity.An AID is the second parameter block after the command code. An AID may be optional, and may bea compounded value comprised of alphanumeric characters and dashes (where dashes areseparators).An AID value directs an input command to its intended equipment, facility, or data entity.1.4.4.3 CTAG Parameter BlockThe Correlation Tag (CTAG) is an optional block and is used to correlate an input command with itsassociated output message by copying the commands CTAG value into the appropriate field of thecommands output response. An optional CTAG value can be generated by the OS for everycommand. If an invalid CTAG value is identified in a command, the NE denies the command andresponds with the error code IICT and with the number "0" in the CTAG field(s) in the TL1 response,except for the actual command echo. Note that the CTAG value received in a command need not beunique.The CTAG shall be the third parameter block after the command code. The CTAG is optional, and ifpresent and valid it shall be used to correlate an input command with its associated output message bycopying the commands CTAG value into the appropriate field of the commands output response.In the case where an invalid CTAG value is received with a command, or the NE is unable to parse theCTAG field in the input command, the NE shall deny the command with a IICT (Input, InvalidCorrelation Tag) error code, and shall provide a single decimal character zero (0) CTAG value in thedeny output response for the command, except for the actual command echo.In the case where the CTAG value is not received with a command, i.e. CTAG is missing, the NE shallaccept the command if not otherwise invalid, and shall use an internally generated CTAG in theresponse.Valid values for CTAG shall consist of a TL1 identifier or non-zero decimal number of no more than 6characters from GR-831 listed below: ::= | Where ::= ( | )* and ::= [D] * [.] + The definition of a letter is ::= A | B | ... | Z | a | b | ... | z and the definition of a digit is ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 91646SMC R2.2 - TL1 Commands and Messages 13 25. 3KC18039ACAATQZZAIssue 1, Feb 2012INTRODUCTION 1.4.4.4 General (Delayed Activation) Parameter Block Delayed Activation is not supported in this release. The general block is used for specifying delayed activation (DA) parameters. Delayed activation is only supported by those commands that include the general block in the commands input format. Brackets are used to indicate an optional parameter value. If one or more parameter values are omitted from the end of the block, the trailing commas associated with them may be omitted. However, if a parameter value is omitted with other positional parameter values following, all of the intervening place-holder commas must be provided to indicate no value is being entered for that parameter. The system assumes the default parameter value for omitted optional parameter values. The format of the general block is: :[],[],[],[] 1.4.4.5 Positional Parameter Block Parameters in the positional block are defined by their position or sequence in the block. Brackets are used to indicate optional parameter values. Absence of brackets indicate the parameter value must be entered. If one or more parameter values are omitted from the end of the block, the trailing commas associated with them may be omitted. However, if an optional parameter value is omitted with other positional parameter values following, all of the intervening place-holder commas must be provided to indicate no value is being entered for that parameter. The system assumes the default or existing parameter value for omitted optional parameter values. Parameter value combinations are verified by the system whether the value is determined from a default value or explicitly entered in the command. The format for a positional parameter block is: :[],[],[],....,[] For notational simplicity, the enclosing less-than and greater-than signs are not shown in a command description when describing a commands TL1 syntax. Only the parameter name, and any brackets to identify an optional parameter, is shown in the parameter block (:[PARAMETER#1],[PARAMETER#2] etc.), but the appropriate parameter value is entered for a parameter in an actual input command. 1.4.4.6 Keyword Parameter Block Parameters in the keyword block are defined by the use of a keyword parameter name. A value for a keyword parameter is specified by entering the parameter name followed by an = (equal sign) followed by the parameter value. Keyword parameters may be entered in any order within the keyword block but must be separated by a comma. Only commas separating each keyword parameter are required in the keyword parameter block, but the keyword block may not begin or end with a comma. Brackets are used to indicate optional parameters and their associated comma separators. Absence of brackets indicate the parameter and any comma separator must be entered. The system assumes the default parameter value for omitted keyword parameters. Parameter value combinations are verified by the system whether the value is determined from a default value or explicitly entered in the command. The format for a keyword parameter block is: :[KEYWORD#1=VALUE#1][,KEYWORD#2=VALUE#2]....[,KEYWORD#n=VALUE#n] For notational simplicity, keyword input parameters in a command input description are (generally) shown in alphabetical order, but the keyword input parameter value is not shown when describing a commands TL1 input syntax. Only the keyword input parameter name followed by an equal sign, and any brackets to identify an optional parameter, is shown in the input parameter block (:[KEYWORD#1=][,KEYWORD#2=] etc.), but the keyword input parameter and keyword value is entered in an actual input command. For keyword output parameters, the parameters in a command ouput description are also (generally) shown in alphabetical order. The keyword output parameter name followed by an equal sign followed by , and any brackets to identify an optional parameter, is shown in the output parameter block (:[KEYWORD#1=] [,KEYWORD#2=] etc.).141646SMC R2.2 - TL1 Commands and Messages 26. 3KC18039ACAATQZZA INTRODUCTION Issue 1, Feb 20121.4.4.7 State Parameter BlockThe state parameter block is a positional block with parameters defined by their position or sequencein the block. The state block is only supported by those commands that include it in the commandsinput format. When supported, up to two parameters are possible for the state block, the PST (PrimaryState) parameter and SST (Secondary State) parameter. Brackets are used to indicate optionalparameter values. Absence of brackets indicate the parameter value must be entered. If the SSTparameter value is omitted from the end of the block, the trailing comma associated with it may beomitted. However, if an optional PST parameter value is omitted with a SST positional parameter valuefollowing, the intervening place-holder comma must be provided to indicate no value is being enteredfor the PST parameter. The system assumes the default parameter value for omitted optionalparameter values. Parameter value combinations are verified by the system whether the value isdetermined from a default value or explicitly entered in the command.The format for a state parameter block is::[],[]For notational simplicity, the enclosing less-than and greater-than signs are not shown in a commanddescription when describing a commands TL1 syntax. Only the parameter name, and any brackets toidentify an optional parameter, is shown in the parameter block (:[PST,[SST]]), but the appropriateparameter value is entered for a parameter in an actual input command.1.4.5 SUCCESSFUL RESPONSE FORMATCommand response messages provide information about responses that would result from entering acommand. Commands entered result in response messages which provide results or status of thecommand. A successfully executed command results in a successful response. If a successfulresponse cannot be sent within two seconds of receipt of an input command, an In-Progressacknowledgement response message is sent to the user. Refer to section 1.6., Command Response,for a description and syntax of command output response messages.1.4.6 OUTPUT PARAMETERSThe Output Parameters section of a command description describes all output parameters included inthe commands successful response message, except those in the response header. If the commanddoes not produce output parameters, this section does not appear. The format of the OutputParameters section is:PARM{ PARAMETER VALUE SET }Description: Description of the Output parameter. Values are: PARM_VALUE Values Name: Description of the output parameters values.where:PARM: the output parameters identifier.PARAMETER VALUE SET:the output parameters set of values or domain.PARM_VALUE: the parameters value identifier and description for each of the output parameters values. PARM_VALUE is only shown when applicable.1.4.7 UNSUCCESSFUL RESPONSE FORMATCommand response messages provide information about responses that would result from entering acommand. Commands entered result in response messages which provide results or status of thecommand. Commands which did not execute properly result in an unsuccessful response. If anunsuccessful response cannot be sent within two seconds of receipt of an input command, anIn-Progress acknowledgement response message is sent to the user. Refer to section 1.6, CommandResponse, for a description and syntax of command output response messages.1646SMC R2.2 - TL1 Commands and Messages15 27. 3KC18039ACAATQZZAIssue 1, Feb 2012 INTRODUCTION 1.4.8 ERROR CODES The Error Codes section of a command description lists the error codes associated with the commands unsuccessful response. The error code acronym, the expanded error code description, and any informational error description text that may be generated by the system for the Error Code, is provided for each Error Code listed. Error Codes common to all commands that are generated because of a Command Parser/Common Application error are shown in Appendix D, Error Codes, and are not duplicated in this section. Only non-Parser generated Error Codes are shown in this subsection. The Command Parser/Common Application error codes are also described in section 1.11. 1.4.9 EXAMPLES The Examples section of a command description illustrates the use of the command. 1.4.10 RELATED COMMANDS The Related Commands section of a command description provides a list of closely related or prerequisite commands. 1.4.11 RELATED AUTONOMOUS RESPONSES The Related Autonomous Messages section of a command description provides a list of closely related autonomous messages, if any.1.5 AUTONOMOUS RESPONSE FORMAT Autonomous response descriptions for each autonomous response are located in section 3 of this manual. Refer to section 1.7, Autonomous Responses, for a description and syntax of autonomous response messages. Each autonomous response description consists of the following subsections: Response Headerconsists of the response code and name. Purpose provides information on the function or cause of the autonomous response. Response Formatshows the response format for the autonomous response. Output Parameters describes the parameters and parameter values shown in the autonomous response, except for parameters in the response header. The description format for this section is the same as that used for describing a commands output parameter. (Refer to paragraph 1.4.6., Output Parameter Descriptions.) Examples provides one or more illustrations of the autonomous response. Related Commands identifies any closely related commands, if any. Related Autonomous Responses provides a list of closely related autonomous responses, if any. 1.5.1 RESPONSE HEADER The autonomous response Header section of an autonomous response description is at the top of the first page of the autonomous response description. The autonomous response header consists of two parts, the autonomous response code which provides the response verb (e.g., REPT) and one or two modifiers, as applicable, separated by a ^ (caret) to represent a space: RESPONSE CODE: REPT^EVT^EQPT and the autonomous response name, which provides the full name of the autonomous response: RESPONSE NAME: REPORT EVENT EQUIPMENT 1.5.2 PURPOSE The Purpose section of the autonomous response description describes the use or cause of the autonomous response.16 1646SMC R2.2 - TL1 Commands and Messages 28. 3KC18039ACAATQZZAINTRODUCTION Issue 1, Feb 20121.5.3 RESPONSE FORMATRefer to section 1.7., Autonomous Responses, for a description and syntax of command outputresponse.1.5.4 OUTPUT PARAMETERSSee section 1.4.6.1.5.5 EXAMPLESThe Examples section of each autonomous response description illustrates the autonomous response.1.5.6 RELATED COMMANDSThe Related Commands section of an autonomous response description provides a list of closelyrelated commands, if any.1.5.7 RELATED AUTONOMOUS RESPONSESThe Related Response section of an autonomous response description provides a list of closelyrelated responses, if any.1.6 COMMAND RESPONSESCommand response messages provide information (data, status, etc.) as a result of entering acommand. A successfully executed command results in a successful response. Commands which didnot execute properly result in an unsuccessful response. If a successful or unsuccessful responsecannot be sent within two seconds of receipt of an input command, one In-Progress acknowledgementresponse message is sent to the user.All responses, except an Acknowledgement Response, begin with a header line: cr lf lf ^^^^^ where: SID is the upper case Site Identifier as created by the SET-SID command. YY-MM-DDis the year-month-day, where YY is the last two digits of the year, MM is the month, and DD is the day of the month. HH:MM:SS is the current time of day, where HH is the hour with a range from 00 to 23, MM is the minutes, SS is the seconds, with a range for MM and SS is from 00 to 59.The last response line before the message terminator is a non-parsable command echo line. Theformat of a command echo line is: ^^^/*^^[]^()^*/ or ^^^/*^^[]^(CRON:)^*/ or ^^^/*^^[]^([-])^*/ or^^^/*^^[]^()^*/ with a composite format representation of1646SMC R2.2 - TL1 Commands and Messages 17 29. 3KC18039ACAATQZZAIssue 1, Feb 2012 INTRODUCTION ^^^/*^^[]^({,CRON:,[-]})^*/ where:is an exact matching of the input command entered, except for commands that have password as an input parameter (ACT-USER, ENT-USER, ED-PID commands) do not display any parameter values after the CTAG as part of the command echo.is the associated CTAG value, displayed within brackets [...]. is the communication port number and virtual channel number, if any, used to enter the command, displayed within parentheses (...).CRON:is the delayed activation order number used to enter thecommand, displayed within parentheses (...).[-] is the communication port number (if any) and LAN session number used to enter the command, displayed within parentheses (...) is the LAN session number used to enter the command, displayed within parentheses (...) The last response line, as well as any other comment line in the response, shall not contain any terminator character (e.g. ";" at the end of the command echo). This is because any terminator char will be interpreted as the end of the response by the NMA system. So, the only allowed terminator char in a response shall be the last char of the response itself. The maximum character length of any output response line is 1024 characters (before the output is truncated excluding cr lf). Output response lines that are longer than the terminal display line automatically wrap to the first character position of the next line if the terminal is supporting an auto-wrap capability. The system does not insert a "cr lf" within a single output response line to prevent line "run-off" on terminals that do not have an auto-wrap capability. Up to six two-character acknowledgment codes (IP, OK, RL, NG, NA, PF) and five completion codes (i.e.., COMPLD, DELAY, PRTL, CANCLD and DENY) can be supported in the output responses. Two two-character acknowledgment codes (IP, and OK) and four completion codes (i.e.., COMPLD, PRTL, CANCLD and DENY) can be supported in the output responses. When a valid TL1 command with an AID field that specifies an input range of AIDs is executed, only one complete (COMPLD), partially complete (PRTL), or fail message (DENY) for the entire elements will be sent to the user. The output response will support the following completion codes: DELAY: Represents successful queuing of the input command submitted for delayed activation. CANCLD: Represents the cancellation of an in-progress operation (e.g., cancellation of databasebackup in progress). COMPLD: Represents total successful execution of the input command. PRTL: Represents partial successful execution of the input command. This response code isreturned for output response to input commands specifying multiple AIDs of which only a subset(but not an empty subset) have been successfully executed. If all AIDs have failed to beexecuted, the response code will be DENY. DENY: Represents total denial of the input command.181646SMC R2.2 - TL1 Commands and Messages 30. 3KC18039ACAATQZZA INTRODUCTION Issue 1, Feb 2012Commands which uses a range will send response(s) (whether one or multiple responses) containingthe same CTAG.1.6.1 ACKNOWLEDGEMENT RESPONSE FORMATIP (In-Progress) Acknowledgement Message: If the system experiences an excessive delay in theprocessing of an input command such that a response to a command (successful or unsuccessful)cannot be sent within two seconds of receipt of the command, one command acknowledgementresponse (In-Progress message) will be automatically generated and sent to the user. Anacknowledgement response does not interrupt other output responses currently in progress. The IP(In-Progress) acknowledgement message indicates the command has been initiated and a completionmessage follows.The "cr lf lf" at the beginning of an acknowledgement message, any non-parsable (/* ... */) linescontaining informational text in an acknowledgement response, and the non-parsable command echoline in an acknowledgement response shall be always presentThe general format of an IP acknowledgement message is:[cr lf lf]IP^ cr lf[^^^/*^^*/ cr lf ]*[^^^/*^^[]^()^*/ cr lf ]^^ cr lfM^^^COMPLD cr lf[^^^ cr lf ]*[^^^/*^^*/ cr lf ]* *[^^^/*^^[]^() ^*/ cr lf ];Unless otherwise specified in the individual I/O manual pages, the output format for any TL1 commandthat has successfully executed is:1646SMC R2.2 - TL1 Commands and Messages 19 31. 3KC18039ACAATQZZAIssue 1, Feb 2012INTRODUCTION cr lf lf ^^^^^ cr lf M^^^COMPLD cr lf [^^^[AID1[,AID2]]:[,]:[keyword1=[,keywordN=]]:[PST[,SST]] cr lf]* [^^^/* */ cr lf]* [^^^/*^^[]^()^*/ cr lf] ; 1.6.3 UNSUCCESSFUL RESPONSE FORMAT A single unsuccessful response message is generated if: A command (other than to establish a log-on session) with a single AID specified fails to execute. A Retrieval or Non-Retrieval command is issued using &&-ranging or &-grouping and the command fails to execute for all of the specified AIDs for a single error code (fails to execute for only one type of error - Single Error Denial Response generated). A Retrieval or Non-Retrieval command is issued using &&-ranging or &-grouping and the command fails to execute for all of the specified AIDs for multiple error codes (fails to execute for more than one type of error - Multiple Error Denial Response generated). An ACT-USER command to establish a log-on session fails to execute (Session Attempt Denial Response generated). The information displayed in an unsuccessful response message varies for different commands and is specified in the command description. If a parsable line of output data is provided, the field provides information about the location of any error(s) in the input command. Single Error Denial Response: The general format of a Single Error Denial Response is: cr lf lf ^^^^^ cr lf M^^^DENY cr lf ^^^ cr lf [^^^/*^^*/ cr lf ] ([^^^[AID1[,AID2]]:[,]:[keyword1=[,keywordN=]]:[PST[,SST]] cr lf ]* [^^^/*^^*/ * * lf ]cr [^^^/*^^*/ cr lf] ) [^^^/*^^[]^()^*/ cr lf ] ; Multiple Error Denial Response: The general format of a Multiple Error Denial Response is:201646SMC R2.2 - TL1 Commands and Messages 32. 3KC18039ACAATQZZA INTRODUCTION Issue 1, Feb 2012cr lf lf^^^^^ cr lfM^^^DENY cr lf^^^MERR cr lf(^^^[[,]]:ERCDE=[,,]:[keyword1=[,keywordN=]]:[PST[,SST]] cr lf[^^^/*^^*/ cr lf ]*[^^^/*^^*/ cr +lf ]*[^^^/*^^*/ cr lf ] )[^^^/*^Multiple ERRor^*/ cr lf ][^^^/*^^[]^()^*/ cr lf ];Session Attempt Denial Response: In the special case where a user attempts to log-on to thesystem (with the ACT-USER command) but enters an incorrect UID (User Identifier) or an incorrectPID (Password Identifier), the system will generate the following unsuccessful response message. Forsecurity reasons, an Error Code is not provided with this response.cr lf lf^^^^^ cr lfM^^^DENY cr lf^^^/*^session^not^active^*/ cr lf; and additional expanded error description text will not be provided for any command orany unparsable character sequence prior to a user successfully logging into the system. The outputresponse is:cr lf lf^^^^^ cr lfM^^^DENY cr lf^^^/*^session^not^active^*/ cr lf;Unless otherwise specified in the individual I/O manual pages, the output format for any TL1 commandthat has partially completed is:1646SMC R2.2 - TL1 Commands and Messages 21 33. 3KC18039ACAATQZZAIssue 1, Feb 2012INTRODUCTION cr lf lf ^^^^^ cr lf M^^^PRTL cr lf (^^^[[,]]:ERCDE=[,,]:[keyword1=[,keywordN=]]:[PST[,SST]] cr lf [^^^/*^^*/ cr lf] [^^^/*^^*/ cr lf]** + [^^^/*^^*/ cr lf] ) [^^^/*^^[]^()^*/ cr lf] ; 1.6.4 RETRIEVALS Successful RETRIEVAL Response: Unless otherwise specified in the individual I/O manual pages, the general format of a Successful Retrieval Response is: cr lf lf ^^^^^ cr lf M^^^COMPLD cr lf [^^^[AID1[,AID2]]:[,]:[keyword1=[,keywordN=]]:[PST[,SST]] cr lf]* [^^^/* */ cr lf]* [^^^/*^^[]^()^*/ cr lf] ; Partially Successful RETRIEVAL Response: Unless otherwise specified in the individual I/O manual pages, the general format of a Partially Successful Retrieval Response is: cr lf lf ^^^^^ cr lf M^^^PRTL cr lf (^^^"[[,]]:[ERCDE=,][,]:[keyword1=[,keywordN=]]:[PST[,SST]]" cr lf [^^^/*^^*/ cr lf ] [^^^/*^^*/* cr lf ]* [^^^/*^^*/ cr lf ] )+ [^^^/*^^[]^()^*/ cr lf] ; The optional use of those parts of the syntax format above described, included in the parenthesis followed by the plus sign "(...)+", shall be considered as following described: Those rows of the response that are related to AIDs with erro