S320 TL1 Reference Guide - CALIENT Technologies · The foregoing limitations shall apply even if...

S320 TL1 Reference Guide

S320 TL1 Reference Guide

CALIENT Technologies Inc.

S320 TL1 Reference Guide 2

© 2013 CALIENT Technologies, Inc. All rights reserved.

CALIENT, CALIENT Technologies, the CALIENT design logo, and the tag line "Move the light not the fiber" are registered trademarks of CALIENT Technologies, Inc. in the U.S. and other countries. All other marks belong to their respective owners.

Confidential and Proprietary Information This document contains confidential and proprietary information of CALIENT Technologies, which is protected by the copyright laws of the United States, international copyright treaties, and all other applicable national laws. Any unauthorized use, reproduction, or transfer of any information in this document is strictly prohibited. This document contains information regarding technology that is protected under one or more pending or issued United States and foreign patents. This manual may not be copied wholly or in part without prior written permission from CALIENT Technologies. To obtain such permission, please contact:

CALIENT Technologies 25 Castilian Drive Goleta, CA 93117 USA Phone: +1.805.562.5500 www.calient.net Service and Support CALIENT offers a wide range of product support programs including installation support, repair services, maintenance services and technical training. If you need technical assistance with CALIENT’s products, please visit our automated customer support portal: http://support.calient.net or email [email protected]. If you are experiencing a service-affecting emergency, please contact us on the following numbers: Within US: 1.877.682.1160 International: country code +1.877.682.1160 If your call is not answered immediately, please leave a message. Messages are retrieved continuously. Document Part Number: 460xxx-00

http://www.calient.net/



End-User License CALIENT TECHNOLOGIES, INC. ("CALIENT") AGREES TO LICENSE THIS SOFTWARE TO YOU ONLY UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS LICENSE AGREEMENT. READ THE TERMS AND CONDITIONS OF THIS LICENSE CAREFULLY BEFORE ACCEPTING THIS AGREEMENT IN ANY FORM. BY ACCEPTING, YOU AGREE TO BE BOUND BY THE TERMS AND CONDITIONS OF THIS AGREEMENT. INSTALLATION AND USE OF THIS SOFTWARE SHALL BE DEEMED ACCEPTANCE OF THE TERMS AND CONDITIONS BELOW. IF YOU DO NOT AGREE TO BE BOUND BY THIS AGREEMENT, YOU MUST CEASE THE PROCESS OF INSTALLING THIS SOFTWARE.

1. License to Use. You are granted a nonexclusive and nontransferable license ("License") to install and use the accompanying software in machine-readable form, together with accompanying documentation ("Software") in the use and administration of Calient's optical switch product. Other than one (1) static back-up copy, the production of which is expressly permitted hereby, or restoration in the event of equipment repair or change, each installation of the Software on a device or server requires its own license, including payment of license fees (if required). You are not permitted to lease, rent, distribute or sublicense the Software (or copies thereof) or to use the Software (or copies thereof) in any other unauthorized manner. No license is granted to you in the source code of the Software. You agree to indemnify, hold harmless and defend Calient and its licensors from and against any claims or suits, including attorneys' fees and expenses, which arise or result from any other use or distribution of the Software to the extent such claims or suits arise from your use and/or distribution of the Software.

2. Restrictions. The Software is copyrighted and title to all copies is retained by Calient and/or its licensors. No license, right, title, or interest in any Calient or third party trademark, trade name, trade dress, patent or service mark is granted hereunder. You shall not remove, obliterate or cancel from view any copyright, trademark, patent or other proprietary rights notice appearing on or embedded in the Software. You shall reproduce the same on all copies of the Software (in any form), whether such copies are in whole or in part. Unless enforcement of this provision is prohibited by applicable law, you shall not modify, decompile, disassemble, decrypt, extract, or otherwise reverse engineer the Software. If you are a European Union ("EU") resident, information necessary to achieve interoperability of the Software with other programs within the meaning of the EU Directive on the Legal Protection of Computer Programs is available to you from Calient upon written request. The Software may contain program components provided by third parties. All rights, title and interest in and to such program components remain in and for the benefit of such third parties. Copying and redistribution of such program components is by permission of such third parties, who may enforce these rights independently.

3. Confidentiality. The Software is confidential and proprietary information of Calient and/or its licensors ("Confidential Information"). You shall not disclose Confidential Information and shall use it only for the purposes specifically permitted by this License. You acknowledge that you do not acquire any rights of ownership or title in the Confidential Information, which remains the sole property of Calient and/or its licensors. This License will not affect any other confidential information disclosure agreement between the parties.

4. Disclaimer of Warranty. THE SOFTWARE IS PROVIDED "AS IS" AND CALIENT DISCLAIMS

ALL WARRANTIES AND REPRESENTATIONS, WHETHER EXPRESS OR IMPLIED, WITH RESPECT TO THE SOFTWARE INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WARRANTIES ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE, OR WARRANTIES CONCERNING THE NON INFRINGEMENT OF THIRD PARTY RIGHTS.



5. Limitation of Liability. IN NO EVENT WILL CALIENT BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF CALIENT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

The foregoing limitations shall apply even if the above stated warranty fails of its essential purpose.

6. Termination. This License is effective until terminated. You may terminate this License at any time by destroying and/or returning to Calient all copies of the Software including any documentation. This License will terminate immediately without notice from Calient if you fail to comply with any provision of this License. Upon termination, you must return and/or destroy all copies of the Software.

7. Export Regulations. The Software, including technical data, is subject to U.S. export control laws, including the U.S. Export Administration Act and its associated regulations, and may be subject to export or import regulations in other countries. You agree to comply strictly with all such regulations and acknowledge that you have the responsibility to obtain licenses to export, re export, or import the Software.

8. U.S. Government Restricted Rights. If you are acquiring the Software including accompanying documentation on behalf of the U.S. Government, the following provisions apply. If the Software is supplied to the Department of Defense ("DOD"), the Software is subject to "Restricted Rights", as that term is defined in the DOD Supplement to the Federal Acquisition Regulations ("DFAR") in paragraph 252.227 7013(c) (1). If the Software is supplied to any unit or agency of the United States Government other than DOD, the Government's rights in the Software will be as defined in paragraph 52.227 19(c) (2) of the Federal Acquisition Regulations ("FAR"). Use, duplication, reproduction or disclosure by the Government is subject to such restrictions or successor provisions, and/or the software is considered "commercial computer software" governed by FAR 12.212(a) and/or DFAR 227.7202-1(a). Contractor/Manufacturer is: Calient Technologies, Inc., Goleta, CA 93117.

9. Governing Law. This Agreement is made under, shall be governed by and construed in accordance with the laws of the State of California, U.S.A., excluding its choice of law provisions. Jurisdiction and venue for any dispute hereunder shall be in and for the County of Santa Clara, CA. The United Nations Convention on Contracts for the International Sale of Goods (1980) is hereby excluded in its entirety from application to this License Agreement.

10. Severability. If any of the above provisions are held to be in violation of applicable law, void, or unenforceable in any jurisdiction, then such provisions are herewith waived to the extent necessary for the License to be otherwise enforceable in such jurisdiction. However, if in Calient's opinion deletion of any provisions of the License by operation of this paragraph unreasonably compromises the rights or liabilities of Calient or its licensors, Calient reserves the right to terminate the License as your sole and exclusive remedy.

11. Integration. With the exception of Calient's terms and conditions of sale, and confidentiality agreements between the parties (if any), this Agreement is the entire agreement between you and Calient relating to the Software and: (i) supersedes all prior or contemporaneous oral or written communications, proposals and representations with respect to its subject matter; and (ii) prevails over any conflicting or additional terms of any quote, order, acknowledgement, or similar communication between the parties during the term of this Agreement. No modification to this Agreement will be binding, unless in writing and signed by a duly authorized representative of each party.



Contents

1 INTRODUCTION ................................................................................................................. 11

1.1 Command Line Interface .................................................................................. 11

1.2 Terminal Access Connections ......................................................................... 11 1.2.1 Foundation Software ....................................................................................... 12 1.2.2 Connecting using TELNET .............................................................................. 12 1.2.3 Connecting using the Serial Craft Port ............................................................ 13 1.2.4 TL1 Command Help ........................................................................................ 14 1.2.5 Listing Command-Specific Responses ............................................................ 14 1.2.6 User Access Levels ......................................................................................... 15 1.2.7 Conventions and Notations ............................................................................. 16

2 SCOPE ................................................................................................................................ 17

2.1 Sample Configuration Worksheet.................................................................... 17

2.2 S320 TL1 Commands ........................................................................................ 18 2.2.1 TL1 Command Availability ............................................................................... 20

3 TL1 MESSAGE STRUCTURE ............................................................................................ 22

3.1 Message Types .................................................................................................. 22

3.2 Input Messages ................................................................................................. 22

3.3 Command Code ................................................................................................. 22

3.4 Staging Block .................................................................................................... 23

3.5 Payload Block .................................................................................................... 23

3.6 Output Messages .............................................................................................. 23

3.7 Acknowledgments ............................................................................................ 23

3.8 Responses ......................................................................................................... 24

3.9 Autonomous Messages .................................................................................... 24



3.10 Access Parameters ........................................................................................... 24 3.10.1 AID .................................................................................................................. 25 3.10.2 CTAG .............................................................................................................. 25 3.10.3 TID................................................................................................................... 25

3.11 Other Parameters .............................................................................................. 25 3.11.1 Access ............................................................................................................. 25 3.11.2 Admin .............................................................................................................. 26 3.11.3 Alarm_id .......................................................................................................... 26 3.11.4 BkuprstType .................................................................................................... 26 3.11.5 CircuitId ........................................................................................................... 26 3.11.6 Condtype ......................................................................................................... 26 3.11.7 ConnName ...................................................................................................... 30 3.11.8 ConnType ........................................................................................................ 30 3.11.9 Dateform.......................................................................................................... 30 3.11.10 Dstend ......................................................................................................... 31 3.11.11 DstPort ........................................................................................................ 31 3.11.12 Dstservice .................................................................................................... 31 3.11.13 Dststart ........................................................................................................ 32 3.11.14 Duration ....................................................................................................... 32 3.11.15 EqptId .......................................................................................................... 32 3.11.16 FaultType .................................................................................................... 32 3.11.17 Filename ...................................................................................................... 32 3.11.18 FileType ....................................................................................................... 32 3.11.19 Gateway ...................................................................................................... 33 3.11.20 GroupName ................................................................................................. 33 3.11.21 Indrstat ........................................................................................................ 33 3.11.22 Kind ............................................................................................................. 33 3.11.23 Location ....................................................................................................... 34 3.11.24 Msg .............................................................................................................. 34 3.11.25 Multi ............................................................................................................. 34 3.11.26 NewDate ...................................................................................................... 34 3.11.27 NewTime ..................................................................................................... 34 3.11.28 Ntfcncde ...................................................................................................... 34 3.11.29 NTPservice .................................................................................................. 35 3.11.30 Nwmask ....................................................................................................... 35 3.11.31 OprType ...................................................................................................... 35 3.11.32 Optlosscrit ................................................................................................... 35 3.11.33 Optlossdegr ................................................................................................. 36 3.11.34 Page ............................................................................................................ 36 3.11.35 Ph ................................................................................................................ 36 3.11.36 Pid ............................................................................................................... 36 3.11.37 Pidofld ......................................................................................................... 36 3.11.38 Pidnew ......................................................................................................... 37 3.11.39 Service ........................................................................................................ 37 3.11.40 Sessid .......................................................................................................... 37 3.11.41 Sid ............................................................................................................... 37 3.11.42 SoakInt ........................................................................................................ 37 3.11.43 SourceId ...................................................................................................... 37



3.11.44 Src ............................................................................................................... 37 3.11.45 SrcPort ........................................................................................................ 38 3.11.46 Syscontact ................................................................................................... 38 3.11.47 Syslocation .................................................................................................. 38 3.11.48 Timeform ..................................................................................................... 38 3.11.49 TMOUT ........................................................................................................ 38 3.11.50 Uap .............................................................................................................. 39 3.11.51 Uid ............................................................................................................... 39 3.11.52 Uidnew ........................................................................................................ 39 3.11.53 Uout ............................................................................................................. 39 3.11.54 Utc ............................................................................................................... 39 3.11.55 Variant ......................................................................................................... 39 3.11.56 Warn (1-4) ................................................................................................... 40 3.11.57 Waveband ................................................................................................... 40

4 NODE CONFIGURATION AND PROVISIONING COMMANDS ....................................... 41

4.1 Node Configuration ........................................................................................... 41 4.1.1 RTRV-IP: Retrieving IP Address ..................................................................... 41 4.1.2 SET-IP: Setting IP Address ............................................................................. 42

4.2 Equipment Provisioning ................................................................................... 43 4.2.1 RTRV-ALM-EQPT: Retrieving Alarms on Equipment ..................................... 43 4.2.2 RTRV-DET-EQPT: Retrieving Equipment Details ........................................... 44 4.2.3 RTRV-ENV-EQPT: Retrieving Environmental Information .............................. 45 4.2.4 RTRV-PORT: Retrieving Port Information ....................................................... 45 4.2.5 RTRV-PORT-SUM: Retrieving Port Summary Information ............................. 46 4.2.6 RTRV-EQPT: Retrieve equipment inventory ................................................... 47

4.3 Cross-Connection Provisioning ...................................................................... 47 4.3.1 ACT-CRS: Activating Cross-Connections ....................................................... 48 4.3.2 CANC-CRS: Canceling Cross-Connections .................................................... 49 4.3.3 DLT-CRS: Deleting Cross-Connection ............................................................ 50 4.3.4 ENT-CRS: Entering a Cross-Connection ........................................................ 50 4.3.5 REC-CRS: Recovering a Cross-Connection ................................................... 51 4.3.6 RTRV-ALM-CRS: Retrieving Alarms on Connections ..................................... 52 4.3.7 RTRV-CRS: Retrieving Connections ............................................................... 52 4.3.8 RTRV-DFLT-CRS: Retrieve current default values ......................................... 53 4.3.9 ENT-CRS-ENH: Create cross-connections between two ports ....................... 54 4.3.10 Cross-Connection Sets ................................................................................... 54 4.3.11 OPR-CRSSET-SAVE: Save Connection Set .................................................. 55 4.3.12 OPR-CRSSET-LPBK: Loop-back mode .......................................................... 56 4.3.13 OPR-CRSSET-RECALL: Recall Connection Set ............................................ 56 4.3.14 DLT-CRSSET: Delete Connection Set ............................................................ 57 4.3.15 SET-ATTR-CRSDFLT ..................................................................................... 58 4.3.16 RTRV-CRSSET: Retrieve Connection Set Details .......................................... 58 4.3.17 RTRV-SAVERECALL: Status of Last Set Operation ....................................... 59 4.3.18 ED-PORT: Editing Port Parameters ................................................................ 60 4.3.19 ENT-CRS-BULK: Add multiple cross-connections .......................................... 61



4.3.20 DLT-CRS-BULK: Delete multiple connections ................................................ 61 4.3.21 DLT-CRS-ALL: Remove all cross connections ............................................... 62 4.3.22 RTRV-STATUS-BULK ..................................................................................... 62 4.3.23 ENT-GRP-PORT: Adding ports to the port group ........................................... 63

4.4 System Configuration ....................................................................................... 63 4.4.1 INIT-SYS: Resetting System ........................................................................... 64 4.4.2 RTRV-CFG-DAT: Retrieving CFG Date .......................................................... 64 4.4.3 RTRV-CFG-NE: Retrieving NE Contact and Location .................................... 65 4.4.4 RTRV-HDR: Retrieving Header ....................................................................... 66 4.4.5 RTRV-NE: Retrieving Network Element .......................................................... 66 4.4.6 RTRV-TOD: Retrieving Time of Day ............................................................... 67

5 SECURITY MANAGEMENT COMMANDS ........................................................................ 68

5.1 Security Management ....................................................................................... 68 5.1.1 RTRV-DFLT-SECU: Retrieving Default Security ............................................. 68 5.1.2 SET-ATTR-SECUDFLT: Setting Security Attribute Default ............................. 69

5.2 User Administration .......................................................................................... 69 5.2.1 ACT-USER: Login ........................................................................................... 70 5.2.2 ALW-USER-SECU: Allowing User Security .................................................... 71 5.2.3 CANC-USER: Logging off ............................................................................... 71 5.2.4 DLT-USER-SECU: Deleting User Security ..................................................... 72 5.2.5 ED-PID: Changing User Password ................................................................. 72 5.2.6 ED-USER-SECU: Editing User Security ......................................................... 73 5.2.7 ENT-USER-SECU: Entering User Security ..................................................... 73 5.2.8 INH-USER-SECU: Inhibiting User Security ..................................................... 74 5.2.9 RTRV-ALM-SECU: Retrieving Alarms on Security ......................................... 75 5.2.10 RTRV-USER: Retrieving User List .................................................................. 75

5.3 Session Administration .................................................................................... 76 5.3.1 CANC-SESS: Canceling a Session ................................................................. 76 5.3.2 RTRV-SESS: Retrieving Session List ............................................................. 77 5.3.3 SND-SESS-MSG: Sending a Session Message ............................................. 78

6 PERFORMANCE MONITORING COMMANDS ................................................................. 79

6.1 Fault Monitoring ................................................................................................ 79 6.1.1 RTRV-FAULT-EQPT: Retrieve Equipment Fault History ................................ 79 6.1.2 CLR-FAULT-EQPT: Clearing Equipment Fault History ................................... 80 6.1.3 Alarms and Event Monitoring .......................................................................... 80 6.1.4 ACK-ALM: Clearing/Acknowledging Alarm ..................................................... 81 6.1.5 RTRV-ALM-nnn: Retrieving Alarms ................................................................ 82 6.1.6 RTRV-ATTR-COM: Retrieving Attributes Command ...................................... 82 6.1.7 RTRV-LOG-ALM: Retrieving Alarm Log .......................................................... 84 6.1.8 RTRV-LOG-EVT: Retrieving Log Event .......................................................... 84 6.1.9 SET-ATTR-COM: Setting Attributes Command .............................................. 85 6.1.10 SET-SOAK: ..................................................................................................... 86



6.1.11 RTRV-SOAK: Retrieve soak interval ............................................................... 86 6.1.12 RTRV-UPTIME: Retrieve system uptime ........................................................ 87

7 MAINTENANCE COMMANDS ........................................................................................... 88

7.1 Backup and Restore Commands ..................................................................... 88 7.1.1 OPR-BKUPRST: Operating Back-up Restore ................................................. 88 7.1.2 RTRV-BKUPRST: Retrieving Back-up Restore .............................................. 89

7.2 Software Upgrade ............................................................................................. 89

A AUTONOMOUS MESSAGE COMMANDS ........................................................................ 90

B COMMAND USAGE BY USER ACCESS .......................................................................... 93

Commands by User Privilege ...................................................................................... 93

C ERROR CODES AND ALARMS ........................................................................................ 97

D COMMAND STATES ........................................................................................................ 106



Preface The S320 TL1 Reference Guide lists all commands and messages supported by the S320 TL1 Agent. This document also provides input formats and response (output) examples for those commands and messages.

Audience The S320 TL1 Reference Guide is written for both the network operations center craft personnel and field service personnel who configure, provision and monitor the equipment. It is assumed that these readers are familiar with TL1.



1 INTRODUCTION

TL1 is a set of ASCII-based instructions (or “messages”) that an Operations Support System (OSS) uses to manage a Network Element (NE) and its resources. This chapter includes these topics:

• TL1 history • Standards documents • TL1 agent • Command Line Interface • Types of connections • TL1 Command line help • User access levels • Conventions and notation

1.1 Command Line Interface TL1 is the only standard, cross-vendor command line interface (CLI). It is well documented and has a well-defined syntax making it suitable for both humans and computers. Most network elements come with CLI. These interfaces, accessible via TELNET and over a serial line, allow operators to type in ASCII commands to query and control the network element. The S320 supports a Transaction Language One (TL1) interface based on Telcordia standards including GR-831, GR-199-CORE and GR-833-CORE. A TL1 user id can run multiple sessions concurrently, up to the maximum of 8. The TL1 interface is accessible through:

• the serial port • Telnet

1.2 Terminal Access Connections You can access the S320 TL1 Agent via TELNET, by means of Ethernet or by the craft serial interface (see Figure 1-2).



1.2.1 Foundation Software

TELNET Port 3082 or 3083

Craft Serial Interface

User sessions

Figure 1 TL1 Connections

1.2.2 Connecting using TELNET The S320 TL1 Agent supports eight simultaneous sessions. To connect via TELNET, specify the node IP address and the port socket that provides the communication path. Two ports are used: 3082 and 3083, and each port represents a mode of operation. For example:

• telnet 192.168.110.13 3082 • telnet 192.168.110.13 3083



The table below describes the differences between the two modes of operation.

TL1-RAW vs. TL1-TELNET Modes Port Socket

Mode Description

3082 TL1-RAW With this mode, you do not interact with the TL1 Agent, and you do not receive the agent> prompts at the console.

When provisioning in bulk, select this mode for executing automated scripts.

The online help is not available with this mode.

3083 TL1-TELNET Typically, this mode is used for individual configuration or provisioning. This mode enables you to interact with the TL1 Agent through the console where you receive prompts and messages.

The online help is available with this mode.

1.2.3 Connecting using the Serial Craft Port Unlike the TELNET connection, the TL1 service over the craft serial port is always enabled. To use the craft interface, connect the supplied S320 serial cable between the host PC (or console) and the craft serial port located on the S320 shelf. Once connected, use a standard terminal emulation program (such as the “HyperTerminal” accessory in Microsoft Windows) to interact with the S320 TL1 agent. Table 1-2 lists the terminal emulation settings.

Item Value Data rate 11520 baud Bits 8 Parity None Stop bit 1 Set local echo Off Flow control None Terminal setting VT100 or ASCII Echo Off Line wrap Auto



1.2.4 TL1 Command Help Once a TL1 connection to the S320 equipment is established, TL1 command help is available by typing a question mark (?) at the agent prompt. When a question mark (?) is typed at an empty line, the TL1 interface displays all messages defined in the network element. The TL1 Agent provides two ways of getting help information: general and command-specific responses.

1.2.4.1 Listing General Responses

If the entry before the question mark (?) does not provide a specific command match, the TL1 Agent responds with a list of all available commands for the entry. Enter ? to display another screen of commands or Q to return to the agent> prompt.

Note: The question mark (?) entered does not echo on the screen. For example:

agent> dlt Ambiguous command, possible matches are: DLT-ADJ-CTRLCH DLT-ADJ DLT-CRSSET DLT-CRS DLT-USER-SECU ---Type ? to continue or q to quit

1.2.5 Listing Command-Specific Responses If the entry before “?” provides a unique command match, the TL1 Agent returns the input format of that command.

agent> act-user

ACT-USER:[TID]:<uid>:[CTAG]::<pid>; All possible matches are listed if the command entered has similar matches. Enter the intended command with a colon (:) followed by a question mark (?). For example:

agent> rtrv-port

Ambiguous command, possible matches are:

RTRV-PORT-SUM

RTRV-PORT---Type ? to continue or q to quit---

agent> rtrv-port-sum:?

RTRV-PORT-SUM:[TID]:<eqptId>:[CTAG]::;



Note:

The colon (:) and question mark (?) entered do not echo on the screen

1.2.6 User Access Levels To maintain security and prevent unauthorized actions, the TL1 Agent supports four different user groups and each group has different privileges. See section 1.2.6.1. The TL1 Agent issues a DENY message when you do not have sufficient privileges to access a particular command. Refer to Appendix B, Command Usage by User Access, for a complete listing of TL1 commands accessible by user privileges. Note:

Only the Admin user privilege is supported in this release.

1.2.6.1 TL1 User Access Levels

• Admin: The Administrator is a super-user. This user level has full access to all functions and activities of the equipment, including installation, provisioning, monitoring, maintenance and security functions.

• Field: This privilege level allows users to access and change equipment information,

including debug access, logs, and other tools for diagnosing equipment problems. Typically, this privilege level is assigned to field service or development engineers.

• Prov: This Prov level is primarily for users who need to provision cross-connections, including viewing operational parameters and configuring equipment. This user level can also provision and view ports and connections, as well as view equipment events and alarms.

• IM: The Install and Maintenance user level can issue commands related to installation

and maintenance activities. In addition to access to all provisioning activities, this user can perform maintenance such as running software diagnostics, upgrading software, specifying fail-over conditions.

• ReadOnly: This level can log on and retrieve information about the equipment. The

ReadOnly user level may not perform any other operations.



1.2.7 Conventions and Notations Uppercase characters in format expression appear as they are in the message. Table 1-4 lists syntactical characters. Note: Semicolons (;), commas (,), colons (:), and dashes (–) are transmitted exactly as shown.

Table 1 Syntactical characters

Characters Description

; A semicolon indicates the end of a message or delimiter between messages. For a delimiter, press Enter to obtain the agent prompt.

, A comma separates parameters within a parameter block. : A colon separates parameter

− A dash is used to separate the verb, the first and second modifier.

“ “ A pair of quotes is used to delimit an expression that can be parsed.

[ ]

One or more parameters (including delimiters) enclosed within brackets indicates the parameters are optional. An optional parameter means that if a user inputs an empty field for an optional parameter, then a default value is substituted automatically in the transmitted input field.

< > The brackets are used to enclose one or more information items such as <date> or <time>. The brackets are not transmitted.

A single or double asterisk is used to specify multiple or a range of values.



2 SCOPE

This chapter provides a sample worksheet that can be used as a guide to start configuring the S320 equipment and provisioning cross-connections. It also contains a table of supported TL1 commands in this release. Refer to Appendix E, Configuration and Provisioning Worksheets, for an expanded set of worksheets. For users who are familiar with TL1, Table 2-2 lists all Calient TL1 commands alphabetically along with page references to those commands. Refer to Chapter 3, TL1 Message Structure, for parameter options. For a task-oriented approach, refer to the following chapters:

• Chapter 4, Node Configuration and Provisioning Commands • Chapter 5, Security Management Commands • Chapter 6, Performance Monitoring Commands • Chapter 7, Maintenance Commands

2.1 Sample Configuration Worksheet

Sample Worksheet Tasks

TL1 Commands

Parameters

1. Log in to the TL1 Agent

ACT-USER <uid> = admin <pid> = S320 c***

2. Configure node IP address and name

SET-IP <eqptId> = 0.26 [<ipAddr>] = 192.168.110.13 [<nwmask>] = 255.255.255.0 [<gateway>] = 192.168.110.1 Note: cp 0.26 and 0.27 slot not exist

3. Provision connection ENT-CRS <srcport> = 1.1.1 <dstport> = 1.2.1 <groupName> = Calient [<connType>] = 1way or 2way [<connName>] = SF_LA [<waveband>] = Cband

4. Log out the TL1 Agent CANC-USER [<uid>]



2.2 S320 TL1 Commands

S320 TL1 Commands

Intended to:

ACK-ALM acknowledge alarm

ACT-CRS activate a cross-connection

ACT-USER log in to the S320 equipment

ALW-MSG allow autonomous message

ALW-USER-SECU activate a user

CANC-CRS cancel (deactivate) a cross-connection

CANC-SESS terminate a session

CANC-USER log off the S320 equipment

CLR-FAULT-EQPT clears the equipment fault history

DLT-CRS delete a cross-connection

DLT-CRS-ALL delete all cross-connections

DLT-CRS-BULK delete multiple cross-connections from a list

DLT-CRSSET delete a cross-connection set

DLT-USER-SECU delete a user

ED-PID change user password

ED-USER-SECU edit User Security Parameters

ENT-CRS enter (provision) a cross-connection

ENT-CRS-BULK enter (provision) multiple cross-connections

ENT-CRS-ENH Change existing cross-connections or enable new ones

ENT-USER-SECU enter (provision) a new user

INH-MSG inhibit autonomous messages



INH-USER-SECU inhibit a user

OPR-CRSSET-LPBK generate a set of cross-connections for the internally generated loopback set

OPR-CRSSET-RECALL establishes the set of cross-connections defined by the named set

OPR-CRSSET-SAVE saves all current cross-connections into the named set

RTRV-ALM-ALL retrieve active alarms

RTRV-ALM-COM retrieve common alarms

RTRV-ALM-CRS retrieve transit connection alarms

RTRV-ALM-ENV retrieve environmental alarms

RTRV-ALM-EQPT retrieve equipment related alarms

RTRV-ALM-SECU retrieve security related alarms

RTRV-BKUPRST retrieve the last backup

RTRV-CRS retrieve a list of cross-connections

RTRV-EQPT retrieve hardware inventory information

RTRV-DFLT-CRS Retrieve default cross-connection default values

RTRV-FAULT-EQPT retrieve the fault list of a cross-connection

RTRV-IP retrieve IP parameters

RTRV-LOG-ALM retrieve alarm logs

RTRV-LOG-EVT retrieve event logs

RTRV-NE retrieve the name, serial #, software version and status

RTRV-PORT retrieve the port

RTRV-PORT-SUM retrieve input/output power

RTRV-SAVERECALL retrieve latest system recall

RTRV-SOAK retrieve alarm soak interval

RTRV-SESS retrieve active user session

RTRV-STATUS-BULK Retrieve the status of the previous bulk request

RTRV-UPTIME retrieve system and in service up time



RTRV-USER retrieve current user login

SET-ATTR-CRSDFLT set default cross-connection value

SET-IP configure system IP Address

SET-SOAK set Alarm Soak Interval

SND-SESS-MSG send Session Message

2.2.1 TL1 Command Availability The following commands will be available in a later release:

S320 TL1 Commands

Intended to:

DLT-GRP-PORT deletes a portgroup

ED-PORT edit port parameters

INIT-SYS reset the S320 equipment

OPR-BKUPRST back-up the database

REC-CRS recovers (retries) a cross-connection

RTRV-BKUPRST Retrieve the last backup

RTRV-CFG-DAT retrieve the date and time format

RTRV-CFG-NE retrieve system contact and location

RTRV-CRSSET retrieve a list of all cross-connection sets

RTRV-DET-EQPT retrieve equipment details

RTRV-DFLT-SECU retrieve default session parameters

RTRV-ENV-EQPT retrieve equipment environmental information

RTRV-GRP-CRS retrieve cross-connection group

RTRV-HDR retrieve header



3 TL1 MESSAGE STRUCTURE

TL1 messages consist of ASCII strings exchanged between management systems and TL1 managed NEs. Valid characters for TL1 messages include all printable ASCII characters. This chapter describes message and parameter types defined for the TL1 messages, including:

• Input message format • Output message format • Input/output message interactions • Parameter types

3.1 Message Types There are two categories of messages: input and output. Input messages are used to issue command requests to the NE. Output messages relate either to responses to given command messages or are autonomous, generated by the NE as a result of some condition change on the NE.

3.2 Input Messages Input Command messages are built on blocks.

• Command code • Staging block • Payload blocks

The blocks are each separated from each other by a colon (:) and the message is terminated with a semicolon (;). Each of the subcomponents itself has a unique form. The basic format of a command message is as follows:

<command_code>:<staging_block>:<payload_blocks>;

3.3 Command Code Command codes consist of a verb plus a modifier. The verb indicates the class of command being issued to the NE; it identifies the action to be taken on the NE as a result of the TL1 message. The modifier refines and qualifies the command being specified. Verb: SET-ATTR-COM



Modifier: qualifying the verb to add the attributes referring to “add” to the equipment

3.4 Staging Block Before a command can be acted upon, it needs to identify those resources to which it pertains. The staging block is used to perform this task, which includes:

• identifying the NE on which the command is to be performed • identifying the actual resources within the NE on which the command is to be performed • a correlation tag (CTAG), allowing the command response to be correlated by the

invoker with the original request • an optional general block Staging blocks take the following form:

:[TID]:[<src>]:[CTAG]:[<general_blocks>]:

3.5 Payload Block The payload block consists of zero or more data blocks, each separated by commas. Each data block itself may have multiple components, each further separated by commas. These data components may be positional, in which case commas are used to convey empty fields, or they may be names defined in which case they take the form [INOPTDEGR=<inoptdegr>]. The following is an example of a message including the payload:

ENT-USER-SECU:[TID]:<uid>:[CTAG]::<pid>, [<cid>],

<uap>:[MULTI=<multi>], [ACCESS=<access>];

3.6 Output Messages There are three classes of output messages: acknowledgments, responses, and autonomous

3.7 Acknowledgments Acknowledgments are brief messages that provide an update on the status of a given command. The acknowledgment is sent when processing is complete. When formed, the response is automatically sent without further OSS intervention. The input command messages that generate acknowledgements are normally used for:

• Logging on and off the equipment. • Administering the user security level.



• Configuring or modifying network connections. • Configuring or modifying equipment.

3.8 Responses The message-specific information output response is sent when a requested task has been completed. The response may be “COMPLD” if successful or “DENY” if erroneous. The input command messages that generate output response messages are normally used for:

• Obtaining current equipment configuration information. • Obtaining status information.

The basic format of a response message is shown below: Response header:

TL1-Agent 2001-07-01 23:05:51 Response identifier

M0 COMPLD Text block /* ED-USER-SECU OK. user msmith modified. */ Terminator ;

3.9 Autonomous Messages Autonomous messages are used to report alarms, configuration changes, or condition changes. Many of these messages, such as those relating to alarm conditions, are spontaneously triggered by the NE itself without intervention.

3.10 Access Parameters Access parameters include:

• AID • ATAG • CTAG • TID



3.10.1 AID The Access Identification code (AID) directs an input command to its intended physical or data entity inside the NE. Equipment modules and facilities are typical examples of entities addressed by the access code. Note:

In the S320 TL1 implementation, AID corresponds to the <src> input parameter in the command input formats.

3.10.2 CTAG A correlation tag (CTAG) is used to correlate input and output messages. The value of CTAG consists of up to six ASCII, alphanumeric characters. If a CTAG value is not provided, 0 is used.

3.10.3 TID The target identifier (TID) represents the target network element that receives the TL1 command. It corresponds to the network element’s (NE) name, A message sent to an NE may be addressed at that NE or routed by it to its target NE. If an NE is the only target possible for a message sent on a connection, then the TID may be omitted from that message. Otherwise, a TID must be specified.

3.11 Other Parameters This section describes other parameters used in S320 TL1.

3.11.1 Access Used in ED-USER-SECU and ENT-USER-SECU commands, this parameter indicates the mode of service access that is provided by S320 equipment.

Options Description

Both Default setting. Access S320 equipment using TL1 or the Web Service.

TL1 Access S320 equipment using TL1 only. Web Access S320 equipment using the Web Service only.



3.11.2 Admin This parameter specifies the name of the administrative group to which the user belongs. The name consists of up to 35 alphanumeric characters, including special characters such as periods (.) and underscores (_). No spaces allowed.

3.11.3 Alarm_id Used in the ACK-ALM command, this parameter identifies an individual alarm. Assigned by the S320 equipment, you can obtain the alarm_id by issuing the RTRV-ALM command.

3.11.4 BkuprstType Used in the OPR-BKUPRST command, this parameter specifies the type of operational action.

Options Description

Backup Back-up data on the node. Restore Restore data on the node.

3.11.5 CircuitId Associated with cross-connections commands, this parameter specifies the connection identifier, which uses the following format: source port_id–destination port_id or source port_id>destination port_id. For example 1.1.1>1.2.1. The circuitId is returned as the output of the ENT_CRS command, and is automatically assigned based on the ENT_CRS input parameters. Note: A dash (-) indicates a bi-directional connection and an angle bracket (>) indicates a uni-directional connection.

3.11.6 Condtype Condition Type is used in SET-ATTR-COM, RTRV-ATTR-COM, as well as retrieve alarm and retrieve log commands. This parameter identifies the specific alarm on which the command should operate. If condtype is not specified, all alarms are returned. See the table below for a list of supported TL1 condition types:



Condtype options Description A-MOD Alarm severity is modified. CFG-BU Backup completed. CFG-BU-FAIL Backup failed. CFG-CRC Failed configuration registry CRC check. CFG-FAIL Failed to write configuration strategy. CFG-LD Configuration data is loaded. CFG-RST Restore completed. CFG-RST-FAIL Restore failed. CFG-SWM Switch matrix configuration failed. DL-COMPLD Software download completed. DL-FAIL Software download failed. DL-STA Software download initiated. EQPT-FAIL Equipment failed. EQPT-ACT Equipment activated successfully. EQPT-ACT-FAIL Equipment activation failed. EQPT-ALW Equipment enabled successfully. EQPT-ALW-FAIL Equipment enable failed. EQPT-CANC Equipment deactivated successfully. EQPT-CANC-FAIL Equipment deactivation failed. EQPT-DEGR Equipment degraded. EQPT-DLT Equipment deleted successfully. EQPT-DLT-FAIL Equipment deleted failed. EQPT-DSP DSP failed. EQPT-INH Equipment disabled successfully. EQPT-INH-FAIL Equipment cannot be disabled. EQPT-INS Equipment inserted. EQPT-MF Equipment has multiple faults. EQPT-MISSING Equipment is missing EQPT-MM Equipment mismatch. EQPT-OK Equipment OK. EQPT-REM Equipment removed. FAN Fan failed. IF-DOWN Physical interface is down. INSTL-COMPLD Software installation completed. INSTL-FAIL Software installation failed. INSTL-STA Software installation initiated. LOG-DLT Log file deleted. LOG-FAIL Unable to open log file.



LOG-UPLD Upload log file. LOG-UPLD-FAIL Upload log file failed. LOS-ENET NP Port Loss of Carrier MEM-FAIL Memory allocation failed. MON-CL Monitor is returned to normal. MON-MJ Major threshold is crossed. MON-MN Minor threshold is crossed. MON-MOD Monitor threshold is modified. MON-RESET Monitor threshold is reset. MTX-ALW Matrix enabled. MTX-CAL Matrix calibration failed. MTX-FIBER Fibering mismatch. MTX-INH Matrix disabled. MTX-MIRROR Mirror failed. MTX-PS Matrix protection switch successful. NTP NTP server failed. OPR-CV Transit connection receive hardware failure. OPXMT-HW Transit connection transmit hardware failure. PROCROVLD CPU over utilized. PS CP role changed. PWR Power supply warning. REPLUNITMISS Equipment is missing. REPLUNITMISS-TM Equipment missing transition module. S-CFG System configuration change. SEC-AUTOLOG-DIS Auto-logoff disabled. SEC- AUTOLOG-EN Auto-logoff enabled. SEC-AUTOLOGOFF User logged off automatically. SEC-CRED User log in failed, invalid credentials. SEC-DIS User login failed, user ID disabled. SEC-INIT-FAIL Authentication manager could not reinitialize after

failover. SEC-LOGIN-ON User login failed, already logged on. SEC-LOGOFF User is logged off. SEC-LOGON User is logged on. SEC-PERM User login failed, denied access. SEC-SESSTMO-MOD Session timeout value changed. SEC-U-ADD Administrator added a user. SEC-U-ADD-FAIL Administrator was unable to add a user. SEC-U-ALW Administrator enabled a user.



SEC-U-DLT Administrator deleted a user. SEC-U-DLT-FAIL Administrator failed to delete a user. SEC-U-INH Administrator disabled a user. SEC-U-MOD Administrator modified a user. SEC-U-MOD-FAIL Administrator failed to modify a user. SEC-U-PASS Administrator changed a user’s password. SEC-U-PASS-AGE Administrator enforced a password change. SEC-U-PERM Administrator changed a user’s permission. SEC-U-ROLE Administrator changed a user’s role SFT Subsystem restarted. SVC-ALW Service is enabled. SVC-ALW-FAIL Service failed to be enabled. SVC-INH Service is disabled. SVC-INH-FAIL Service cannot be disabled. SVC-IPNOTIFY Service notified of IP address change. SVC-IPNOTIFY-FAIL Failed to notify service that IP address changed. SVC-IPNOTIFY-FAIL-ALL

Failed to notify all services that IP address changed.

SVC-RECFG Service is reconfigured. SVC-REG Service is registered. SVC-RESET Service is reset. SVC-RESET-FAIL Service failed to be reset. T-ADC ADC bus error detected. TC-ACT Transit connection is activated. TC-ACT-FAIL Transit connection failed to be activated. TC-ADD Transit connection is added. TC-CANC Transit connection is deactivated. TC-CANC-FAIL Transit connection failed to be deactivated. TC-DLT Transit connection is deleted. TC-FAIL Transit connection failed to be added. TC-NHW Transit connection is added without all hardware

present. T-DISK Flash disk usage exceeded threshold TIMER-MOD Timer is changed. T-INOPTCRIT Transit connection receive signal critical. T-INOPTDEGR Transit connection receive signal degraded. T-LAN LAN traffic exceeded threshold. T-MEM Memory usage exceeded threshold. T-OPTLOSSCRIT Light loss through the matrix is below the critical



threshold. T-OPTLOSSDEGR Light loss through the matrix is below the degraded

threshold. T-OUTOPTCRIT Transit connection transmit signal critical. T-OUTOPTDEGR Transit connection transmit signal degraded. T-T Temperature exceeded.

3.11.7 ConnName Used in the ENT-CRS command, this parameter defines an identifier to describe a source connection port and the destination connection port. This identifier consists between 1 to 35 alphanumeric characters, including special characters such as periods (.) and underscores (_). For example, “SF_LA” means the source connection port is in San Francisco and the destination connection port in Los Angeles.

Note:

The connname must be unique within a customer group, and do not use duplicate connection names for the same customer.

3.11.8 ConnType Used in the ENT-CRS command, this parameter defines the direction of a connection.

Options Description 1 way Unidirectional 2 way Bi-directional

3.11.9 Dateform Used in ED-CFG-DAT and RTRV-CFG-DAT commands, this parameter defines the input/output format for the date.



Note:

The dateform parameter only affects the appearance of the date format on the WebGUI interface, The date format in the TL1 interface remains unchanged. Date is expressed in the following formats:

• mm/dd/yy (for example, 01/21/03) • mm/dd/yyyy (for example, 01/21/2003) • mmm dd yyyy (for example, Jan 21 2003) • yy/mm/dd (for example, 03/01/21) • yyyy/mm/dd (for example, 2003/01/21) • dd/mm/yy (for example, 21/01/03) • dd/mm/yyyy (for example, 21/01/2003)

3.11.10 Dstend Used in ED-CFG-DAT and RTRV-CFG-DAT commands, this parameter specifies the end of daylight savings. Enter in month (1–12), day (1–31), and hour (0–23). For example, to specify daylight savings ending on October 26

th at 3 PM, the format is 10.26.15.

3.11.11 DstPort Used in the cross connection related commands, this parameter specifies the destination port in a connection. The format is: s.c[a|b].p. For example, 1.1.1

3.11.12 Dstservice Used in ED-CFG-DAT and RTRV-CFG-DAT commands, this parameter specifies the daylight savings time. Use the enable option to activate DST or the disable option to deactivate DST.



3.11.13 Dststart Used in ED-CFG-DAT and RTRV-CFG-DAT commands, this parameter specifies the start of daylight savings. Enter in month (1–12), day (1–31), and hour (0–23). For example, to specify daylight savings starting on April 26th at 3 PM, the format is 4.26.15.

3.11.14 Duration Used in the SET-INDR command, this parameter specifies the amount of time expressed in seconds that the port is maintained in the state. If duration is not specified, a default of 30 seconds is used.

3.11.15 EqptId This parameter specifies the equipment identifier for the S320.

3.11.16 FaultType Used in the RTRV-FAULT-EQPT command, this parameter specifies the type of faults that are associated with fault reports. The fault types are:

• Active: This is the default setting. Faults are reported, but not cleared. • Inactive: Faults are reported and cleared.

3.11.17 Filename Used in OPR-DL, RTRV-DL, RTRV-INSTL, and OPR-INSTL commands, this parameter specifies the name of the file to be downloaded and installed.

3.11.18 FileType Used in the OPR-BKUPRST command, this parameter specifies the type of the file to be backed up or restored. Only one option is available in the current release: data. N: This is the default setting and only applicable parameters (those which have not been previously overridden) are provisioned on to member ports.



Y or 1: All parameters are forced onto the member ports of a port group.

3.11.19 Gateway Used in the SET-IP command, this parameter specifies the gateway 32-bit internet protocol address of the node. Express the address in the industry-standard format: xxx.xxx.xxx.xxx, where xxx is between 0 and 255.

3.11.20 GroupName Used in ENT-CRS and RTRV-CRS commands, this parameter defines the name of the group serviced by a connection. The group name consists of between 1 to 35 alphanumeric characters, including special characters such as periods (.) and underscores (_). The option “all” is reserved for the RTRV-CRS command and cannot be used as a group name when provisioning a connection. “all” is case sensitive; it must be entered in lower-case letters.

3.11.21 Indrstat Used in the SET-INDR command, this parameter specifies the state of the indicator being set. Options are Norm and Alm.

Note:

Per Telcordia specifications, indrstat is a required field. In the current release, Calient makes no distinction between the two options.

3.11.22 Kind Used in the SET-ATTR-COM command, this parameter specifies an alarm category. The only option is: system.



3.11.23 Location Used in the OPR-BKUPRST command, this parameter specifies the location where the database is backed-up and restored. The two options are:

• Local: Back up to or restore from the local flash drive. • Remote: Back to or restore from the network FTP server.

3.11.24 Msg Used in the SND-SESS-MSG command, this parameter specifies a message string that is sent by an administrator. This message consists up to 150 ASCII characters.

3.11.25 Multi Used in ED-USER-SECU and ENT-USER-SECU commands, this parameter specifies multiple sessions privilege for the user. When specified, the user can log in to multiple EMS sessions at the same time. The options are:

• N: The user cannot log in to multiple Element Management Systems simultaneously. • Y: This is the default setting. The user has simultaneous sessions privilege and can log

in to multiple Element Management Systems simultaneously.

3.11.26 NewDate Used in the ED-DAT command, this parameter specifies the date. The format is yy-mm-dd.

3.11.27 NewTime Used in the ED-DAT command, this parameter specifies the time. The format is hh.mm.ss.

3.11.28 Ntfcncde This parameter specifies the notification code used to set the alarm severity.



Options Description CR Critical MJ Major MN Minor

NA Not alarmed (only used in the RTRV-LOG-EVT command)

CL Alarms cleared; no outstanding alarms.

3.11.29 NTPservice Used in the ED-CFG-DAT command, this parameter specifies the network time protocol. When this parameter is enabled, parameter TIMESET cannot be used. The options are:

• Enable: Enable NTP service. • Disable: Disable NTP service.

Note:

This parameter is not supported in the current release.

3.11.30 Nwmask Used in the SET-IP command, this parameter specifies the network mask of the node. The mask is expressed in a 32-bit internet protocol address format, xxx.xxx.xxx.xxx, where xxx is between 0 and 255.

3.11.31 OprType Used in OPR-INSTL, OPR-DL, RTRV-INSTL, and RTRV-DL commands, this parameter specifies the type of file to download. The current release supports one option: swpkg.

3.11.32 Optlosscrit Used in the ED-CFG-SWC command, this parameter specifies the critical optical signal loss threshold through the system. The threshold values range from 4 dB to 40 dB. A critical alarm is set when the threshold is reached. Default is 12.0 dB.



3.11.33 Optlossdegr Used in the ED-CFG-SWC command, this parameter specifies the degraded optical signal loss threshold through the system. The threshold values range from 3 dB to 15 dB. A critical alarm is set when the threshold is reached. Default is 8.0 dB.

3.11.34 Page Used in the SET-ATTR-SECUDFLT command, this parameter specifies the password aging interval expressed in days. At the end of this interval, the user receives a message that the existing password must be replaced with a new one. The valid range is 20 to 90 days. The default is 30 days.

3.11.35 Ph Used in the INIT-SYS command, this parameter specifies the degree of thoroughness of the system initialization. “Cold start” is the highest phase initialization that causes the processor to unconditionally execute the same routine as in system power-up. The phase is expressed as an integer between 0 and 10. The higher the number, the stronger the reset. 10 resets the switch. 9 checks if the version of the software in the memory is the same as the version in flash.

3.11.36 Pid Used in ED-USER-SECU and ENT-USER-SECU commands, this parameter specifies the user’s password. Passwords may contain from 3 to 10 characters. It must have at least two non-alphabetic characters with at least one special character. Legal characters include semicolon (;), colon (:), comma (,), question mark (?), single quote mark (‘) and double quote mark (“). In addition, the password may not contain the associated UID.

3.11.37 Pidofld See Pid.



3.11.38 Pidnew See Pid.

3.11.39 Service Used in ALW-SRV, INH-SRV, and RTRV-SRV commands, this parameter specifies the type of element management system (EMS) service. The options are:

• NBCorbaSvc • TL1 Service • WebService

3.11.40 Sessid Used in the CANC-SESS, RTRV-SESS, and SND-SESS-MSG commands, this parameter indicates a session identifier that is assigned by the S320 equipment when a user logs in to a node. The identifier is used to track that particular user session. There can be only 8 simultaneous sessions. However, the session identifier can be almost any number. The format is tN or wN, where N is a numeric identifier assigned to the user session by the S320 equipment. The t indicates a TL1 session while the w indicates a WebService session.

3.11.41 Sid

3.11.42 SoakInt Used in the SET-SOAK command, this parameter specifies the amount of time to wait before setting or clearing an alarm. The valid range is 0 to 15 seconds.

3.11.43 SourceId Used in CLR-FAULT-EQPT and RTRV-FAULT-EQPT commands, this parameter specifies the type of equipment from which the S320 retrieves fault history.

3.11.44 Src While considered optional, src is not used. It’s placed here to be Bellcore compliant.



3.11.45 SrcPort This parameter specifies the source port in a connection. Refer to DstPort in Section 3-15 for format description.

3.11.46 Syscontact Used in the ED-CFG-NE command, this parameter specifies the name of the person who overseas the S320 equipment. The name consists of up to 30 alphanumeric characters. Spaces allowed.

3.11.47 Syslocation Used in the ED-CFG-NE command, this parameter specifies the location of the S320 equipment. The location consists of up to 30 alphanumeric characters. Spaces allowed.

3.11.48 Timeform Used in ED-CFG-DAT command, this parameter specifies the input/output format for the time. Note: The timeform parameter only affects the appearance of the date format on the WebView interface, the date format in the TL1 interface remains unchanged. The options are:

• hh:mm:ss tt (for example, 2:15:25PM) • hh:mm: tt (for example, 2:15PM) • HH:mm:ss (for example, 14:15:25) • HH:mm (for example, 14:15)

3.11.49 TMOUT Used in the SET-ATTR-SECUDFLT command, this parameter specifies the node’s system-wide security parameters. Timeout is the amount of time a user session remains inactive before the S320 software automatically cancels (logs off) the session. The default timeout is 15 minutes, and the value ranges from 10 to 30 minutes.



3.11.50 Uap Used in ED-USER-SECU and ENT-USER-SECU commands, this parameter defines the user’s access privilege. Refer to Appendix B, Command Usage by User Access, for a listing of user privileges. User role options are:

• Administrator: can perform all functions, and controls other users’ access to the system. • Provisioner: can issue commands related to provisioning. • Field: can issue commands related to field activities. • IM: can issue commands related to installation and maintenance activities. • Read Only: can see the status of the system and view information, but is not permitted to

issue an commands related to provisioning.

3.11.51 Uid Used in ED-USER-SECU and ENT-USER-SECU commands, this parameter specifies the user name or descriptor. It consists of up to 8 alphanumeric characters, including periods (.) and underscores (_). For example, “J_smith.”

3.11.52 Uidnew Used in the ED-USER-SECU command, this parameter specifies the new user identifier of an existing user, and has the same format as uid. When changing security privileges that do not include changing the uid, the uidnew field must be the same as the uid field.

3.11.53 Uout Used in the RTRV-DFLT-SECU command, this parameter specifies the UID aging interval. If during the aging interval a UID is not used to log on to the system, the UID is disabled.

3.11.54 Utc Used in ED-CFG-DAT and RTRV-CFG-DAT commands, this parameter specifies the time zone. Values are –12 to 12.

3.11.55 Variant Used in ED-GRP-PORT and ED-PORT commands, this parameter specifies the attenuation threshold.



3.11.56 Warn (1-4) Used in the SET-ATTR-SECUDFLT command, this parameter specifies security warning messages. Each text string message consists up to 80 ASCII characters.

3.11.57 Waveband Used in the ENT-CRS command, this parameter specifies the waveband constraint when making a connection. The options are:

• Wband: For wavelengths between 1260−1625 nm. • CBand: For wavelengths between 1530−1565 nm • LBand: For wavelengths between 1565−1610 nm • XLBand: For wavelengths between 1610−1625 nm • OBand: For wavelengths between 1260−1360 nm



4 NODE CONFIGURATION AND PROVISIONING COMMANDS

This chapter provides commands to configure and provision the S320 equipment. Configuration involves tasks such as setting IP address, and date/time. Provisioning involves tasks such as setting up a circuit/path (cross-connection) through the switch matrix. The commands are organized into the following task groups:

• Node configuration • Equipment Provisioning • Cross-Connection Provisioning • Cross-Connection Sets • System configuration

Note: Typing a question mark (?) after the command displays the syntax of that command.

4.1 Node Configuration The following table lists the node (S320 equipment) configuration commands.

Table 4-1: Node Configuration Commands

Used to…

RTRV-IP Retrieve the node’s IP address

SET-IP Set the node’s IP address

Note: Ensure that you have first logged in using the ACT-USER command before issuing any commands, or you will receive a PLNA (Login not active) error code.

4.1.1 RTRV-IP: Retrieving IP Address This command retrieves a node’s IP address parameters. User Access: All Levels



Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-IP:[TID]:[<eqptId>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “[IP=<ip>],[MASK=<mask>],[GATEWAY=<gateway>],[PORT=<port>]” ;

Input Format: agent> RTRV-IP;

Output Format: TL1AGENT 12-04-30 18:31:16 M 0 COMPLD "IP=192.168.102.180,MASK=255.255.255.0,GATEWAY=192.168.102.1" ;

4.1.2 SET-IP: Setting IP Address Note: CALIENT recommends updating the ipAddr, nw-mask, and gateway parameters the first time this command is issued. If not specified, the parameter uses the default value, 255.255.255.255. The S320 equipment uses the current setting for that parameter until it’s changed. User Access: Admin, IM, Field Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: SET-IP:[TID]:<eqptId>:[CTAG]::[<ipaddr>],[<nwmask>],[<gateway>];

Output Format Syntax: SID DATE TIME M CTAG COMPLD

Input Format: agent> SET-IP::0.26:::172.16.10.96,255.255.255.0,172.16.10.1;

Output Format: TL1AGENT 12-04-30 18:31:16



M 0 COMPLD "IP=172.16.10.96,MASK=255.255.255.0,GATEWAY=172.16.10.1" Note: After changing an IP address, all active user sessions (TL1 and Web Server) of the changed address are disconnected. You need to restart those sessions.

4.2 Equipment Provisioning The S320 equipment consists of the S320 shelf.

Equipment Provisioning Commands

Used to… Activate equipment

ED-CFG-NE Edit current configuration.

RTRV-ALM-EQPT Retrieve alarms.

RTRV-CFG-SWC Retrieve the current configuration.

RTRV-DET-EQPT Retrieve equipment details.

RTRV-ENV-EQPT Retrieve equipment environmental details.


4.2.1 RTRV-ALM-EQPT: Retrieving Alarms on Equipment This command retrieves alarm information. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms Note: All RTRV-ALM-ALL commands share the same input and output formats. The syntax returned shows RTRV-ALM-ALL regardless which alarm condition you specified.



Input Format Syntax: RTRV-ALM-EQPT;

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>:[conddescr>]” ;

Input Format: agent> RTRV-ALM-EQPT;

Output Format: SJC-LAB-1 08-02-12 11:10:52 M 0 COMPLD "0.28:MJ,REPLUNITMISS,NSA,08-02-12,18-55-19:\"AlarmId=5: Description=Card Missing\"" ;

4.2.2 RTRV-DET-EQPT: Retrieving Equipment Details This command retrieves the equipment details. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-DET-EQPT:[TID]:<eqptId>:[CTAG];


Input Format: agent> rtrv-det-eqpt::cp-act

Output Format: TL1AGENT 13-06-24 12:52:47 M 0 COMPLD "cp-act:HWPARTNUM=270294-01,REVISION=B,SERIALNUM=F00014892,MFGDATE=01-24-2013,FPGAREVNUM=0204" ;



4.2.3 RTRV-ENV-EQPT: Retrieving Environmental Information

This command retrieves the environmental information. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-ENV-EQPT:[TID]:<eqptId>:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:[<EQUIPTYPE=<EquipType>],[FLASHDISK=<flashdisk>],[MEMORY=<memory>],[CPU=<cpu>]

Input Format: agent> rtrv-env-eqpt::cp-act

Output Format: TL1AGENT 13-06-24 12:51:26 M 0 COMPLD "cp-act:EqptType=CP,ROOTDSKUSED=57%,OPTDSKUSED=69%,VOLATILEDSKUSED=1%,TOTALMEMORY=701720,TEMPERATURE1=30,TEMPERATURE2=36" ;

4.2.4 RTRV-PORT: Retrieving Port Information This command retrieves port information and lists the DRV card association for this port. It lists both Input DRV and Output DRV. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-PORT:[TID]:<eqptId>:[CTAG]::[<owner>],[<portcategory>];



Output Format Syntax: SID DATE TIME M CTAG COMPLD "<AID>:<portType>,<inOwner>,<outOwner>: [INOPTDEGR=<inoptdegr>], [INOPTCRIT=<inoptcrit>], [OUTOPTDEGR=<outoptdegr>], [OUTOPTCRIT=<outoptcrit>], [INOPTHI=<inopthi>], [ALIAS=<alias>], [POWERMODE=<powermode>], [OUTPOWER=<outpower>], [VARIANT=<variant>], [INAS=<inas>],[INOS=<inos>],[INOC=<inoc>], >], [OUTAS=<outas>], [OUTOS=<outos>], [PORTID=<portId>]” ;

Input Format: agent> rtrv-port::2.2.1

Output Format: TL1AGENT 12-06-29 14:54:15 M 0 COMPLD "2.2.1:WX,TRANSIT,TRANSIT:INOPTDEGR=-15.00,INOPTCRIT=-35.00,OUTOPTDEGR=-23.00,OUTOPTCRIT=-26.00,INOPTHI=13.00,ALIAS=,INAS=IS,INOS=IS,INOC=OK,OUTAS=IS,OUTOS=IS,OUTOC=OK,PORTID=33711617" ;

4.2.5 RTRV-PORT-SUM: Retrieving Port Summary Information

This command retrieves port summary includes connection information, as well as input power/output power information. The power information takes into account the wavelength values provided at the time of connection creation as long as the port (input or output) is part of the connection. If the port is not part of the connection, then default WIDE-BAND settings are considered. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms Input Format Syntax: RTRV-PORT-SUM:[TID]:<eqptId>:[CTAG];

Input Format: agent> rtrv-port-sum::2.2.1 Output Format: TL1AGENT 12-06-29 14:54:21 M 0 COMPLD



"2.2.1:ALIAS=NONE,INPWR=5.04688,OUTPWR=12.2578,CONNNAME1=2.2.1>2.2.1,CONNSTATE1=NONE,CONNNAME2=2.2.1>2.2.1,CONNSTATE2=NONE" ;

4.2.6 RTRV-EQPT: Retrieve equipment inventory

This command retrieves provisioning data associated with the switch hardware. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax:

Input Format: agent> rtrv-eqpt::0 Output Format: TL1AGENT 13-02-12 13:22:52 M 0 COMPLD "1LHI-0:TYPE=HVCARD,AS=0,OS=1,RS=4,AL=3" "1LHI-1:TYPE=HVCARD,AS=0,OS=1,RS=4,AL=3" "1LHI-2:TYPE=HVCARD,AS=0,OS=1,RS=4,AL=3" "1LHI-3:TYPE=HVCARD,AS=0,OS=1,RS=4,AL=3" ;

4.3 Cross-Connection Provisioning Before provisioning a cross-connection, make sure the S320 equipment has been provisioned Cross-connections can be provisioned even if there are no physical fiber-optic cables connected to the shelf, however, an additional step is required after light is added. The state of the connection determines which command can be issued. Refer to Appendix D, Command States, for a description of CRS commands and connection states. The table below lists the TL1 commands used to provision and maintain cross-connections.



Connection Provisioning Commands

Description

ACT-CRS Activate or re-activate a cross-connection.

CANC-CRS Cancel (deactivate) a cross-connection.

DLT-CRS Delete a cross-connection.

ENT-CRS Enter (provision) a cross-connection.

REC-CRS Recover (retry) a cross-connection.

RTRV-ALM-CRS Retrieve alarm information on transit connections.

RTRV-CRS Retrieve a list of cross-connections on the system.

ENT-CRS-ENH Enter a cross-connection after delete existing old cross-connection(s) with same source or destination resource

Note: Ensure that you have first logged in using the ACT-USER command before issuing any commands or you will receive a PLNA (Login not active) error code.

4.3.1 ACT-CRS: Activating Cross-Connections This command activates (monitors for alarms) or reactivates a cross-connection that had previously been deactivated by the CANC-CRS command. This command moves the connection from an under management state (AS_UMA) to an in-service state (AS_IS). User Access: Admin, Prov, Field Error Generation: Refer to Appendix C, Error Codes and Alarms Note: Prov / Field User Accounts cannot activate connections created by other users

Input Format Syntax: ACT-CRS:[TID]:[<srcPort>],[<dstPort>]:[CTAG]::[<circuitid>], [<groupName>],[<connName>];




Input Format: agent> ACT-CRS:::::1.1.4>1.1.5;

Output Format: TL1AGENT 12-04-30 20:55:36M 0 COMPLD ;

4.3.2 CANC-CRS: Canceling Cross-Connections

This command cancels (deactivates) a previously active cross-connection, moving the connection state from in-service (AS_IS) to under management (AS_UMA). While in an AS_UMA state, the connection still functions normally; however, alarms are not logged. When a connection is deactivated, all outstanding alarms associated with the connection are cleared. Use the ACT-CRS command to fully return the card to service (i.e., turn alarm monitoring back on). User Access: Admin Prov* Field* Note: Cannot de-activate connections created by other users Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: CANC-CRS:[TID]:[<srcPort>],[<dstPort>]:[CTAG]::[<circuitid>],[<groupName>],[<connName>];


Input Format: agent> CANC-CRS:::::1.1.4>1.1.5;




4.3.3 DLT-CRS: Deleting Cross-Connection

This command deletes an existing cross-connection, removing it from the equipment database. Use the ENT-CRS command to return the connection to service. User Access: Admin, Prov, Field Error Generation: Refer to Appendix C, Error Codes and Alarms Note: Prov & Field User Accounts cannot delete connections created by other users

Input Format Syntax: DLT-CRS:[TID]:[<srcPort>],[<dstPort>]:[CTAG]::[<circuitid>], [<groupName>],[<connName>];


Input Format: agent> DLT-CRS:::::1.1.4>1.1.5;


4.3.4 ENT-CRS: Entering a Cross-Connection This command creates an input/output cross-connection between two fiber paths. Note: After a cross-connection is created, it needs to be activated (ACT-CRS) in order to be monitored for alarms. User Access: Admin, Prov, Field Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: ENT-CRS:[TID]:<srcPort>,<dstPort>:[CTAG]:: [<groupName>],[<connType>],[<connName>],[<waveband>];

Output Format Syntax:



SID DATE TIME M CTAG COMPLD /* ENT-CRS OK. <srcPort>,<dstPort>*/

Input Format: agent> ENT-CRS::1.1.4,1.1.5:::,1way,,cband;

Output Format: TL1AGENT 12-04-30 20:55:36M 0 COMPLD /* ENT-CRS OK. 1.1.4>1.1.5 */ ;

4.3.5 REC-CRS: Recovering a Cross-Connection This command retries a cross-connection between two ports. After correcting a fiber problem on a cross-connection and it failed, you can manually retry (refresh) that cross-connection. During the retry, the connection is re-made on the switch matrix. Note: If a cross-connection was created (ENT-CRS) when no light was present at the input port, it is necessary to perform the REC-CRS command AFTER adding light to the port. User Access: Admin, Prov, Field Error Generation: Refer to Appendix C, Error Codes and Alarms Input Format Syntax: REC-CRS:[TID]:[<src>]:[CTAG]::[<circuitid>],[<groupName>],[<connName>];


Input Format: agent> REC-CRS:::::1.1.4>1.1.5;




4.3.6 RTRV-ALM-CRS: Retrieving Alarms on Connections This command retrieves alarms information for a specified connection or all connections. User Access: All levels: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-ALM-CRS;

Output Format Syntax: SID DATE TIME M CTAG COMPLD /* <Status of Active Alarm List> */

Input Format: agent> RTRV-ALM-CRS;

Output Format: TL1AGENT 70-01-03 12:10:14 M 0 COMPLD "2.3.6>3.5.6:CR,T-INOPTCRIT,SA,70-01-03,10-20-26:\"AlarmId=87: Description=Transit Connection Receive Signal Critical\"" ; Note: All RTRV-ALM-ALL commands share the same input and output formats. The syntax returned shows RTRV-ALM-ALL regardless which alarm condition you specified. agent> rtrv-alm-crs; TL1AGENT 12-04-30 20:58:17 M 0 COMPLD "21.1>29.1:CR,T-INOPTCRIT,SA,06-02-06,02-28-59:\"AlarmId=20: Description=Transit Connection Receive Signal Critical\"" ;

4.3.7 RTRV-CRS: Retrieving Connections This command retrieves information for a specified connection or all connections. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms



Input Format Syntax: RTRV-CRS:::::[<groupName>],[<circuitId>],[connName>];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID:[SRC_PORT=<src_port>].[DST_PORT=<dst_port>],[GROUPNAME=<groupName>],[CONNNAME=<connName>],[CONNTYPE=<connType>],[AS=<AS>,[OS=<os>],[OC=<oc>],[PS=<ps>],[AL=<al>] ;

Input Format: agent> RTRV-CRS;

Output Format: TL1AGENT 12-04-30 20:58:17M 0 COMPLD "1.1.4>1.1.5:SRCPORT=1.1.4,DSTPORT=1.1.5,GRPNAME=SYSTEM,CONNNAME=1.1.4>1.1.5,CONNTYPE=1WAY,AS=UMA,OS=RDY,OC=OK,PS=UPR,AL=CL" ;

4.3.8 RTRV-DFLT-CRS: Retrieve current default values

This command retrieves current default values for cross-connections and related parameters. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-DFLT-CRS:[TID]:[<src>]:[CTAG]


Input Format: agent> RTRV-DFLT-CRS; Output Format TL1AGENT 13-02-12 12:22:16 M 0 COMPLD



"AUTOFOCUS=YES,NOLIGHTCONN=NO,OPTIMIZECONN=YES" ;

4.3.9 ENT-CRS-ENH: Create cross-connections between two ports

This comman creates cross-connections between two ports, even if any of these two ports were involved in other cross-connects. This command returns the SUCCESS or DENY status, as well as the list of cross-connects that are deleted (if any). User Access: Admin Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: ENT-CRS-ENH:[TID]:<srcPort>,<dstPort>:[CTAG]::[<groupName>],[<connType>], [<connName>],[<waveband>];


Input Format: agent> ent-crs-enh::1.1.1,1.1.2 Output Format TL1AGENT 12-04-30 20:58:17 M 0 COMPLD /* ENT-CRS-ENH OK. 1.1.1-1.1.2: Deleted Old xConns: None */ ;

4.3.10 Cross-Connection Sets Up to fifty named sets of cross-connects can be saved. A cross-connection set consists of all the source_port to destination_port connections contained in the set. Cross-connection sets are stored in the database. It is an error to attempt to overwrite a connection set, and attempts to do so will be denied. In order to modify an existing set, delete the cross-connection set with DLT-CRSSET, modify the connections, then save the new connection set with the same name.



The TL1 commands relating to cross-connection sets are listed below:

Cross-Connection Sets Commands

Description

OPR-CRSSET-SAVE

This command saves all current cross-connections into the named set.

OPR-CRSSET-LPBK

This command establishes the set of cross-connections for the internally generated loopback set.

OPR-CRSSET-RECALL

This command establishes the set of cross-connections defined by the named set.

OPR-CRSSET-UNLOAD This command removes the set

of cross-connections defined by the named set.

DLT-CRSSET Delete a cross-connection set

RTRV-CRSSET Retrieve a list of all cross-

connection sets

RTRV-SAVERECALL

Retrieve result of last save/recall cross-connection set operation

4.3.11 OPR-CRSSET-SAVE: Save Connection Set

This command saves all current cross-connections into the named set. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: OPR-CRSSET-SAVE:[TID]:<connSetName>:[CTAG]::[<description>];


Input Format:



agent> OPR-CRSSET-SAVE::SJCLAB1:::San Jose Lab XconnSet 1;


4.3.12 OPR-CRSSET-LPBK: Loop-back mode This command establishes the set of cross-connections for the internally generated loopback set. User Access: Admin Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: OPR-CRSSET-LPBK:[TID]:[<src>]:[CTAG];


Input Format: agent> OPR-CRSSET-LPBK:::;

Output Format: TL1AGENT 12-04-30 20:58:17M 0 COMPLD ; TL1AGENT 12-04-30 20:58:17 A 22 REPT MSG "Broadcast message from admin: Recalling Cross Connect Set LOOPBACK." ; TL1AGENT 12-04-30 20:58:17 A 24 REPT MSG "Broadcast message from admin: Recall of Cross Connect Set LOOPBACK completed successfully." ;

4.3.13 OPR-CRSSET-RECALL: Recall Connection Set This command establishes the set of cross-connections defined by the named set.



User Access: Admin Error Generation: Refer to Appendix C, Error Codes and Alarms When a cross-connection set is recalled, a broadcast message is automatically sent out to all logged in users indicating the change

Input Format Syntax: OPR-CRSSET-RECALL:[TID]:<connSetName>:[CTAG]::[<force>];


Input Format: agent> OPR-CRSSET-RECALL::SJCLAB1;

Output Format: TL1AGENT 12-04-30 20:58:17M 0 COMPLD ; TL1AGENT 12-04-30 20:58:17 A 22 REPT MSG "Broadcast message from admin: Recalling Cross Connect Set SJCLAB1." ; TL1AGENT 12-04-30 20:58:17 A 24 REPT MSG "Broadcast message from admin: Recall of Cross Connect Set SJCLAB1 completed successfully."

4.3.14 DLT-CRSSET: Delete Connection Set This command will delete the named cross-connection set. User Access: Admin Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: DLT-CRSSET:[TID]:<connSetName>:[CTAG]::;


Input Format: agent> DLT-CRSSET::SJCLAB1;

Output Format:



TL1AGENT 12-04-30 20:58:17M 0 COMPLD ;

4.3.15 SET-ATTR-CRSDFLT

This command changes the default value used when creating cross-connections. User Access: Admin Refer to Appendix C, Error Codes and Alarms


SET-ATTR-CRSDFLT:[TID]:[<src>]:[CTAG]::[AUTOFOCUS=<autofocus>],[NOLIGHTCONN=<nolightconn>], [OPTIMIZECONN=<optimizeconn>];


Input Format:

agent> SET-ATTR-CRSDFLT:::::AUTOFOCUS=1,NOLIGHTCONN=0,OPTIMIZECONN=1

Output Format:

TL1AGENT 13-06-24 10:44:07

M 0 COMPLD

;

4.3.16 RTRV-CRSSET: Retrieve Connection Set Details Details of a cross-connection set may be retrieved with RTRV-CRSSET. User Access: All levels, Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-CRSSET:[TID]:[<connSetName>]:[CTAG]::; agent> rtrv-crsset:




Input Format: agent> rtrv-crsset:

Output Format: TL1AGENT 13-06-24 12:49:19 M 0 COMPLD "BIBULK1:136,ADMIN,13-05-17,13-35-34:\"\"" "BIBULK2:136,ADMIN,13-05-17,13-40-36:\"\"" "BULKCONN:1,ADMIN,13-06-24,11-44-15:\"\"" "BULKCONNBIALL:136,ADMIN,13-06-22,18-53-05:\"\"" "BULKCONNBIIL:136,ADMIN,13-06-23,00-00-01:\"\"" "UNILOOP:272,ADMIN,13-05-17,13-34-01:\"\"" "USHA:3,ADMIN,13-06-24,12-49-04:\"\"" ;

4.3.17 RTRV-SAVERECALL: Status of Last Set Operation This command will display the status of the last save or recall operation. User Access: All levels, Error Generation: Refer to Appendix C, Error Codes and Alarms

Parameters Description

AID System

saveRecallType Relates to the type of last operation performed and includes: save, recall, delete, or idle.

connSet Cross-connection set name involved in the last operation. The field remains empty if there was no save or recall operation.

Result State of the last operation. The value can value can be completed, deny or fail.

ConnectionCount Number of cross-connections in the set.

UserId ID of the person performing the last operation.

Date Date of the last operation.

Time Time of the last operation.



Description Optional text

Input Format Syntax: RTRV-SAVERECALL:[TID]:[<src>]:[CTAG]::;

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:<saveRecallType>,[consent>]:[RESULT=<result>],[CONNECTIONCOUNT=<conncount>],[USERID=<userid>],[DATE=<date>],[TIME=<time>],[DESCRIPTION=<description>]”

Input Format: agent> RTRV-SAVERECALL;

Output Format: TL1AGENT 12-04-30 20:58:17M 0 COMPLD "SYSTEM:SAVE,SJCLAB1:RESULT=\"Completed\",CONNECTIONCOUNT=320,USERID=ADMIN,DATE=08-02-13,TIME=10-25-18,DESCRIPTION=\"San Jose Lab XconnSet 1\":"

4.3.18 ED-PORT: Editing Port Parameters This command edits (modifies) an existing port’s configuration parameters, and connection ownership. User Access: Admin, Prov: Error Generation: Refer to Appendix C, Error Codes and Alarms


ED-PORT:[TID]:<eqptId>:[CTAG]::[<owner>]:[INOPTDEGR=<inoptdegr>],[INOPTCRIT=<inoptcrit>],[INOPTHI=<inopthi>],[OUTOPTDEGR=<outoptdegr>],[OUTOPTCRIT=<outoptcrit>], [POWERMODE=<powermode>],[OUTPOWER=<outpower>],[VARIANT=<variant>],[ALIAS=<alias>],[PROT=<prot>],[LINK=<link>],[REMOTEPORTLABEL=<remoteportlabel>],[BANDWIDTH=<bandwidth>],[LSPENCODE=<lspencode>],[MINPRIOR=<minprior>],[SWCAP=<swcap>],[COLOR=<color>];


Input Format: agent> ed-port::1::::INOPTDEGR=-10,INOPTCRIT=-12,INOPTHI=13,OUTOPTDEGR=-15, OUTOPTCRIT=-18,ALIAS=alias1

Output Format: TL1AGENT 13-06-24 12:36:33 M 0 COMPLD ;



4.3.19 ENT-CRS-BULK: Add multiple cross-connections This command allows the user to make multiple connections on an arbitrary batch of connections that have been entered and separated using the ampersand character. The connections can be combination of bi-directional or uni-directional. User Access: Admin, Prov: Error Generation: Refer to Appendix C, Error Codes and Alarms.


ENT-CRS-BULK:[TID]:<connList>:[CTAG]::[<connSetName>],[<wavelength>], [<overwrite>],[<comment>];


Input Format:

agent> ent-crs-bulk::1>2&3>4&10-19;


4.3.20 DLT-CRS-BULK: Delete multiple connections

This command allows the user to delete connections on an arbitrary batch of connections that have been entered and separated using the ampersand character. The connections can be combination of bi-directional or uni-directional. User Access: Admin, Prov: Error Generation: Refer to Appendix C, Error Codes and Alarms.

Input Format Syntax: DLT-CRS-BULK:[TID]:[<connList>]:[CTAG]::;


Input Format: agent> dlt-crs-bulk::1>2&11-12;

Output Format:



TL1AGENT 13-05-01 20:34:15 M 0 COMPLD ;

4.3.21 DLT-CRS-ALL: Remove all cross connections

This command removes all existing cross connections on the system. User Access: Admin, Prov: Error Generation: Refer to Appendix C, Error Codes and Alarms.

Input Format Syntax: DLT-CRS-ALL:[TID]::[CTAG]::;


Input Format: agent> dlt-crs-all


4.3.22 RTRV-STATUS-BULK

This command retrieves the status of previously executed Bulk Connection commands. User Access: Admin, Prov: Error Generation: Refer to Appendix C, Error Codes and Alarms.

Input Format Syntax: RTRV-STATUS-BULK:[TID]:[<src>]:[CTAG]::;




Input Format:

agent> rtrv-status-bulk::;

Output Format: TL1AGENT 13-05-01 20:45:36 M 0 COMPLD "SYSTEM:RECALL,BULKCONN:RESULT=\"Completed\",CONNECTIONCOUNT=2,USERID=ADMIN,DATE=13-05-01,TIME=20-01-30,DESCRIPTION=\"\":" ;

4.3.23 ENT-GRP-PORT: Adding ports to the port group This command adds ports to the portgroup.

Input Format Syntax: ENT-GRP-PORT: ENT-GRP-PORTWX:[TID]:<portGrp>:[CTAG]::[<portId&portId>]; Input Format agent> ENT-GRP-PORT::PG12:::1.1.1&1.1.2 Output Format TL1AGENT 12-01-15 05:43:24 M 0 COMPLD ;

4.4 System Configuration The table below lists the commands used to set and retrieve system-wide information.

System Configuration Commands

Used to…

INIT-SYS reset the system.

RTRV-CFG-DAT Retrieve the format of date and time.

RTRV-HDR Comply with Bellcore requirement.

RTRV-NE Retrieve node information.



RTRV-TOD Retrieve the node’s current time of day.


4.4.1 INIT-SYS: Resetting System This command resets the system at various levels of phases. User Access: Admin Error Generation: Refer to Appendix C, Error Codes and Alarms


INIT-SYS:[TID]:[<eqptId>]:[CTAG]::<ph>;

/* Phase needs to be an integer between 1 or 2 where 1 for Restart Services and 2 for Reboot */


SID DATE TIME

M CTAG COMPLD

Input Format:

agent> init-sys:::::1

Output Format:

TL1AGENT 13-06-24 12:40:00

M 0 COMPLD

;

4.4.2 RTRV-CFG-DAT: Retrieving CFG Date This command retrieves the format of date and time.



User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-CFG-DAT:[TID]:[<src>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<datefrom>=<value>,<timeform>=<value>,<ntpservice>=<value>,<dstservice>=<value>,<ntp>=<ipAddr>,<dststart>=<value>,<dstend>=<value>,<utc><value>”

Input Format: agent> RTRV-CFG-DAT;

Output Format: TL1AGENT 12-04-30 20:58:17M 0 COMPLD "DATEFORM=\"dd/mm/yyyy\",TIMEFORM=\"HH:mm:ss\",NTPSERVICE=Y,DSTSERVICE=N,NTP=216.244.192.3,DSTSTART=4.1.0,DSTE ND=10.1.0,UTC=-8" ;

4.4.3 RTRV-CFG-NE: Retrieving NE Contact and Location This command retrieves the system contact and location information. User Access: Admin Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-CFG-NE:[TID]:[<src>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<syscontact>=<value>,<syslocation>=<value>”

Input Format: agent> RTRV-CFG-NE;

Output Format: TL1AGENT 12-04-30 20:58:17M 0 COMPLD "SYSTEMCONTACT=SJC-LAB-1,SYSTEMLOCATION=SANJOSE" ;



4.4.4 RTRV-HDR: Retrieving Header This command complies with Telcordia specification. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms Note: Do not issue any commands while S320 equipment is initializing or you will receive an error message.

Input Format Syntax: RTRV-HDR:[TID]:[<src>]:[CTAG];


Input Format: agent> RTRV-HDR:::;


4.4.5 RTRV-NE: Retrieving Network Element

This command retrieves the node name, serial number, software version, and current status. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-NE:[TID]:[<src>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:[SERIALNUMBER=<serialnumber>],[SWPACKAGE=<swpackage>],[STATUS=<status>]” ;

Input Format: agent> RTRV-NE;




M 0 COMPLD "Test-Board:SERIALNUMBER= C00000376,SWPACKAGE=B5.1.8-1,STATUS=OK,CHASSISTYPE=S320" ;

4.4.6 RTRV-TOD: Retrieving Time of Day This command retrieves the node time of day. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-TOD:[TID]:[<src>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<currdate>,<currtime>”

Input Format: agent> RTRV-TOD;

Output Format: TL1AGENT 12-04-30 21:05:19M 0 COMPLD "2012,04,30,21,05,19" ;



5 SECURITY MANAGEMENT COMMANDS

This chapter provides the S320 TL1 commands to provision users and also monitor the node’s user database and session activity. For an explanation of the S320 TL1 user access levels, see User Access Levels in Section 1-8. For information about the privileges required for each TL1 command, see Commands by User Privilege on Section B-1. The security management commands are organized into the following task groups:

• Security Management • User Administration • Session Administration

5.1 Security Management The Security Management TL1 commands are used to provision system-wide security parameters.

5.1.1 RTRV-DFLT-SECU: Retrieving Default Security This command returns the default values for the node’s system-wide security parameters. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms Input Format Syntax: RTRV-DFLT-SECU:[TID]:[<src>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD "[PAGE=<page>], [UOUT=<uout>], [TMOUT=<tmout>], [WARN=<warn>],[WARN1=<warn1>],[WARN2=<warn2>],[WARN3=<warn3>], [WARN4=<warn>4]" ;

Input Format: agent> rtrv-dflt-secu:




M 0 COMPLD "TMOUT=15,PAGE=30,UOUT=45,WARN=\"NOTICE\",WARN1=\"This is a private computer system.\",WARN2=\"Unauthorized access or use may lead to prosecution.\",WARN3=\"\",WARN4=\"\"" ;

5.1.2 SET-ATTR-SECUDFLT: Setting Security Attribute Default

The Set Attribute Security Default (SET-ATTR-SECUDFLT) command sets the system-wide default values associated with several security parameters. Input Format Syntax: SET-ATTR-SECUDFLT:[TID]:[<src>]:[CTAG]::[PAGE=<page>],[TMOUT=<tmout>],[UOUT=<uout>],[WARN=<warn>],[WARN1=<warn1>],[WARN2=<warn2>],[WARN3=<warn3>],[WARN4=<warn4>];


Input Format: agent> set-attr-secudflt:


5.2 User Administration When logging-in to S320 for the first time, use the default user ID (admin) and default password (pxc***). The table below lists the TL1 commands used to provision and administer a user.

User Administration Commands

Used to…

ACT-USER Login.

ALW-USER-SECU Allow (re-activate) a user.



CANC-USER Logoff.

DLT-USER-SECU Delete a user.

ED-PID Change user password

ED-USER-SECU Edit a user’s securities.

ENT-USER-SECU Enter (provision) a new user.

INH-USER-SECU Inhibit (deactivate) a user.

RTRV-ALM-SECU Retrieve user security information.

RTRV-USER Retrieve the list of users currently logged-in.

5.2.1 ACT-USER: Login This command enables a valid user login. At initial login (that is, before changing the default user settings), use the default user ID (admin) and default password (pxc***) to log in. At subsequent login, use your assigned user ID and password. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms Note: For security purposes, the password does not echo back on the console.

Input Format Syntax: ACT-USER:[TID]:<uid>:[CTAG]::<pid>;

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<uId>:<currenTime>,<currentDate>” /*<MTOD>*/ ;

Input Format: agent> act-user::admin:::******;

Output Format: TL1AGENT 12-04-30 20:53:49 M 0 COMPLD "admin:admin,2" /* securitynotice........................ */;



5.2.2 ALW-USER-SECU: Allowing User Security This command restores a user access that was temporarily restricted by the INH_USER_SECU command. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: ALW-USER-SECU:[TID]:[<src>]:[CTAG]::<uid>;


Input Format: agent> ALW-USER-SECU:::::tech1;


5.2.3 CANC-USER: Logging off This command cancels (logs off) a user session. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms Note Up to a maximum of 10 simultaneous sessions (between all services) are allowed. Be sure to log off when not using a session. If the session is not released properly, use the CANC-SESS to forcibly end sessions (admin privilege required). Input Format Syntax: CANC-USER:[TID]:[<uid>]:[CTAG];


Input Format: agent>CANC-USER;

Output Format:



TL1AGENT 12-04-30 20:53:49M 0 COMPLD ;

5.2.4 DLT-USER-SECU: Deleting User Security This command deletes a user from the user database. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms Note: To maintain the node’s user database, you will not be able to delete the last user with the Admin privilege.

Input Format Syntax: DLT-USER-SECU:[TID]:<uid>:[CTAG];


Input Format: agent>DLT-USER-SECU::TECH1;


5.2.5 ED-PID: Changing User Password This command changes your personal and/or the current user password. User Access: Admin, IM, Field Error Generation: Refer to Appendix C, Error Codes and Alarms Calient uses the symbolic naming scheme of the Telcordia specification, GR0835: at least 2 non-alphabetic characters with at least one special character not contain the associated uid (user id) not contain these characters: “:” (colon), “;” (semi-colon), “-” (dash), “,” (comma), “?” (question mark), “‘” (single-quote mark), and “““(double-quote mark). the new password must be different from the current one a new password may not be changed again for three days Note: A password has a limited life span based on the aging configuration (see SET-ATTR-SECUDFLT: Setting System Security Default Parameters in Section 5-3). When a password expires, the only two commands that are allowed for the user are ED-PID and CANC-USER.



After changing the password, you must log out of the system and log in again using the new password in order to gain proper access to the system.

Input Format Syntax: ED-PID:[TID]:<uid>:[CTAG]::<oldpid>,<newpid>;


Input Format: agent>ED-PID::TECH1:::*****,****;


5.2.6 ED-USER-SECU: Editing User Security This command modifies a user’s role and access privilege. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms Note: Changing a user name deletes that user and a new user is created by using the uidnew parameter. These events are reported in that sequence.

Input Format Syntax: ED-USER-SECU:[TID]:<uid>:[CTAG]::<uidnew>,<pid>,[<cid>], <uap>:[MULTI=<multi>],[ACCESS=<access>];


Input Format: agent>ED-USER-SECU::TECH1:::,*****,,field:multi=n;


5.2.7 ENT-USER-SECU: Entering User Security This command creates a new user in the user database.



User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: ENT-USER-SECU:[TID]:<uid>:[CTAG]::<pid>,[<cid>],<uap>:[MULTI=<multi>],[ACCESS=<access>];


Input Format: agent>ENT-USER-SECU::TECH2:::*****,,admin;


5.2.8 INH-USER-SECU: Inhibiting User Security This command prevents a user from logging-in. Before issuing the INH-USER-SECU command, issue a RTRV-SESS to see which users are currently active. If the user to be inhibited is currently logged in when the INH-USER-SECU command is issued, the session will remain active, and the command is ignored. If the user who is going to be disabled is logged in, issue a SND-SESS-MSG command to alert the user that he or she is about to be logged off. If the user fails to log off, issue a CANC-SESS to automatically log off the user. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Ensure that there is at least one Admin user active. Inhibiting all users that have Admin capability will effectively remove the ability to administer the node’s user database.

Input Format Syntax: INH-USER-SECU:[TID]:[<src>]:[CTAG]::<uid>;


CAUTION



SID DATE TIME M CTAG COMPLD

Input Format: agent>INH-USER-SECU:::::TECH2;


5.2.9 RTRV-ALM-SECU: Retrieving Alarms on Security This command retrieves a list of active security related alarms. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format: agent> RTRV-ALM-SECU;

Output Format: TL1AGENT 12-04-30 20:53:49M 0 COMPLD /* Active Alarm List Empty */ ;

5.2.10 RTRV-USER: Retrieving User List This command retrieves a user or a list of users along with associated privileges from the node’s user database. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-USER:[TID]:[<uid>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<UID>:<CID>,<UAP>:[PAGE=<page>],[UOUT=<uout>],[WEB=<web>],[TL1=<tl1>],[DISABLE=<disable>],[MULTI=<multi>]” ;

Input Format: agent> rtrv-user;



Output Format: TL1AGENT 12-04-30 20:53:49M 0 COMPLD "admin:,ADMIN:PAGE=35,UOUT=50,WEB=YES,TL1=YES,DISABLE=NO,MULTI=YES" "field:,ADMIN:PAGE=35,UOUT=50,WEB=YES,TL1=YES,DISABLE=NO,MULTI=YES" "install:,IM:PAGE=35,UOUT=50,WEB=YES,TL1=YES,DISABLE=NO,MULTI=YES" "prov:,PROV:PAGE=35,UOUT=50,WEB=YES,TL1=YES,DISABLE=NO,MULTI=YES" "read:,READONLY:PAGE=35,UOUT=50,WEB=YES,TL1=YES,DISABLE=NO,MULTI=YES" ;

5.3 Session Administration The table below lists the TL1 commands used to monitor user sessions.

Session Administration Commands

Used to…

CANC-SESS Cancel a user session (log a user off )

RTRV-SESS Retrieve the node’s active sessions.

SND-SESS-MSG Broadcast a message to all sessions

5.3.1 CANC-SESS: Canceling a Session This command immediately cancels (ends) a user session previously created by an ACT-USER command. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: CANC-SESS:[TID]:<sessId>:[CTAG];


Input Format: agent> CANC-SESS::t30;




M 0 COMPLD ;

5.3.2 RTRV-SESS: Retrieving Session List This command returns active session information or all active sessions or single sessions. By entering an individual session ID, it can also return individual session information. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-SESS:[TID]:[<sessId>]:[CTAG];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:USER=<user>],ROLE=<role>],[SERVICE=service>],ADDRESS<address>],{LOGONDATE=<logondate],LOGONTIME=<logontime>]”

Input Format to retrieve all sessions: agent> RTRV-SESS;

Output Format for all active sessions: TL1AGENT 70-01-03 06:06:49 M 0 COMPLD "t30:User=admin,Role=ADMIN,Service=TL1,Address=192.168.101.128,LogonDate=70-01-03,LogonTime=06-03-59" "t31:User=admin,Role=ADMIN,Service=TL1,Address=192.168.101.128,LogonDate=70-01-03,LogonTime=06-05-26" "t32:User=admin,Role=ADMIN,Service=TL1,Address=192.168.101.128,LogonDate=70-01-03,LogonTime=06-05-42" ;

Input Format to retrieve a single active session: agent> rtrv-sess::t30

Output Format for a single active session: TL1AGENT 70-01-03 06:08:08 M 0 COMPLD "t30:User=admin,Role=ADMIN,Service=TL1,Address=192.168.101.128,LogonDate=70-01-03,LogonTime=06-03-59"



5.3.3 SND-SESS-MSG: Sending a Session Message This command sends a message to some or all the users currently logged-in. User Access: Admin only Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: SND-SESS-MSG:[TID]:[<sessId>]:[CTAG]::<msg>;

Output Format Syntax: SID DATE TIME M CTAG COMPLD /*<MESSAGE:<message>*/

Input Format to a single session: agent> snd-sess-msg::t32:::contact administrator

Output Format: TL1AGENT 70-01-03 06:18:08 M 0 COMPLD /* Message: 'contact administrator' is sent to t32 */ ;

Input Format to a all sessions: agent> snd-sess-msg:::::contact administrator

Output Format: TL1AGENT 70-01-03 06:19:30 A 73 REPT MSG "Broadcast message from admin: contact administrator" ; TL1AGENT 70-01-03 06:19:30 M 0 COMPLD /* Message: 'contact administrator' is sent to All sessions */ ;



6 PERFORMANCE MONITORING COMMANDS

This chapter describes commands to monitor alarm and event activities. The commands are organized into the following task groups:

• Fault Monitoring • Alarms and Event Monitoring

6.1 Fault Monitoring Faults cause an alarm to be generated by crossing a threshold for a sustained period of time. A fault report is generated for each alarm as an aid in troubleshooting the fault source. Different faults can generate the same alarms, so examining the fault report will isolate the fault source. Note: Ensure that you have first logged in using the ACT-USER command before issuing any commands, or you will receive a PLNA (Login not active) error code.

6.1.1 RTRV-FAULT-EQPT: Retrieve Equipment Fault History This command retrieves the fault history of the specified equipment. The fault history is stored in the fault-report database. Faults are generated due to the occurrence of some event. The database contains two types of faults:

• Active — faults that have been reported but have not been cleared. • Inactive — faults that have been reported and cleared. Inactive faults provide a fault

history.

Currently, faults are only generated for connections. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-FAULT-EQPT:[TID]:<sourceid>:[CTAG]::[<faultType>];




SID DATE TIME M CTAG COMPLD

Input Format: agent> RTRV-FAULT-EQPT::1.1.4>1.1.5;


6.1.2 CLR-FAULT-EQPT: Clearing Equipment Fault History This command clears the fault history of the specified equipment. The fault history includes inactive faults that have been reported but have not been cleared. Clearing the fault history removes all inactive alarms from the history. User Access: Admin, Prov, Field Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: CLR-FAULT-EQPT:[TID]:<sourceId>:[CTAG];


Input Format: agent>CLR-FAULT-EQPT::1.1.4>1.1.5;


6.1.3 Alarms and Event Monitoring Alarms indicate that a problem exists within the node. The source of the problem can be with either hardware or software. Alarms are generated by faults crossing a threshold for a sustained period of time (soak interval). Information specific to each of the alarms defined within the system return is written to an alarm log. Events are simple text strings that contain a limited amount of data. They provide a history trail of provisioning activities. Events are written to an event log and can be accessed by using the RTRV-LOG-EVT command. The table below lists the TL1 commands used to monitor alarms and events.



Alarm/Event Monitoring Commands

Description

ACK-ALM acknowledge an active alarm

RTRV-ALM-ALL retrieve a node’s active alarm list

RTRV-LOG-ALM retrieve a node’s alarm log

RTRV-LOG-EVT retrieve a node’s event log

SET-ATTR-COM set or change the severity of a node alarm


6.1.4 ACK-ALM: Clearing/Acknowledging Alarm This command clears or acknowledges an active alarm. User Access: Admin, IM, Field Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: ACK-ALM:[TID]:<alarmId>:[CTAG];


Input Format: agent> ACK-ALM::89;

Output Format: TL1AGENT 12-04-30 20:53:49A 33 REPT ACK EQPT "0.13a:MJ,REPLUNITMISS,NSA,08-02-13,14-56-53,,:\"AlarmId=89: Description=Card Missing\"" ; TL1AGENT 12-04-30 20:53:49M 0 COMPLD ;



6.1.5 RTRV-ALM-nnn: Retrieving Alarms The alarms retrieved are based on the event types you specified. These include: RTRV-ALM-nnn commands share the same output formats. The syntax returned shows RTRV-ALM-ALL regardless which alarm type you specified. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: agent> RTRV-ALM-nnn;

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>:[conddescr>]”

Input Format: agent> RTRV-ALM-ALL;

Output Format: agent> rtrv-alm-all TL1AGENT 70-01-06 11:13:38 M 0 COMPLD "1.0:MJ,FAN,NSA,70-01-01,00-00-48:\"AlarmId=1: Action=ACK,Description=Fan Failed\"" "1.0:MJ,EQPT-PROTNA,NSA,70-01-01,00-00-49:\"AlarmId=2: Action=ACK,Description=Standby Software Not Installed\"" "1.0:MJ,FAN,NSA,70-01-01,00-00-52:\"AlarmId=3: Action=ACK,Description=Fan Failed\"" "1.0:MJ,FAN,NSA,70-01-01,00-00-55:\"AlarmId=4: Action=ACK,Description=Fan Failed\"" "1.0:MJ,T-DISK,NSA,70-01-01,00-00-58:\"AlarmId=5: Description=Disk Usage exceeded threshold\"" ; "0.13b:MJ,EQPT-PROTNA,NSA,08-02-13,14-55-20:\"AlarmId=90: Description=No Standby Card Available\"" ;

6.1.6 RTRV-ATTR-COM: Retrieving Attributes Command This command retrieves the list of alarms and their associated severity that can be configured on the node. This command can distinguish between classes of conditions and allows for separate reporting of each. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms Input Format Syntax:



RTRV-ATTR-COM:[TID]:<kind>:[CTAG]::[<condtype>];


Input Format: agent> RTRV-ATTR-COM::SYSTEM;

Output Format: TL1AGENT 12-04-30 20:53:49M 0 COMPLD "SYSTEM:MJ,SW-UPG,," "SYSTEM:MJ,FAN,," "SYSTEM:MJ,T-T,," "SYSTEM:NA,PWR,," "SYSTEM:MJ,PROCROVLD,," "SYSTEM:MJ,SFT,," "SYSTEM:MJ,T-MEM,," "SYSTEM:MJ,T-LAN,," "SYSTEM:MJ,T-ADC,," "SYSTEM:MJ,T-DISK,," "SYSTEM:CR,EQPT,," "SYSTEM:MJ,REPLUNITMISS,," "SYSTEM:MJ,EQPT-MM,," "SYSTEM:CR,EQPT-MF,," "SYSTEM:MJ,EQPT-PROTNA,," "SYSTEM:MJ,REPLUNITMISS-TM,," "SYSTEM:MJ,EQPT-TM,," "SYSTEM:MJ,EQPT-NOPRT,," "SYSTEM:MJ,T-INOPTDEGR,," "SYSTEM:CR,T-INOPTCRIT,," "SYSTEM:MJ,T-OUTOPTDEGR,," "SYSTEM:CR,T-OUTOPTCRIT,," "SYSTEM:MJ,OPRCV-HW,," "SYSTEM:MJ,OPXMT-HW,," "SYSTEM:MJ,T-OPTLOSSDEGR,," "SYSTEM:CR,T-OPTLOSSCRIT,," "SYSTEM:MJ,CRS-PROTNA,," "SYSTEM:MJ,T-INOPTHI,," "SYSTEM:MJ,OPTPWRCTRL,," "SYSTEM:MJ,MTX-MIRROR,," "SYSTEM:MN,MTX-CAL,," "SYSTEM:MN,MTX-FIBER,," "SYSTEM:MJ,MTX-SWHS,," "SYSTEM:MJ,MTX-SWID,," "SYSTEM:CR,MEM-FAIL,," "SYSTEM:MJ,IF-DOWN,," "SYSTEM:MJ,NOTIFY-DOWN,," "SYSTEM:MJ,CONN-UNPROTECTED,," ;



6.1.7 RTRV-LOG-ALM: Retrieving Alarm Log This command retrieves the node’s alarm log according to the specified filter conditions. Refer to Appendix C, Error Codes and Alarms, for a description of alarms. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms Input Format Syntax: RTRV-LOG-ALM:[TID]:[<src>]:[CTAG]::[<ntfcncde>],[<condtype>],[<srveff>];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:<nrfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>:[<conddescr>]”

Input Format: agent> RTRV-LOG-ALM;

Output Format: TL1AGENT 70-01-03 12:11:06 M 0 COMPLD "1.0:MJ,EQPT-PROTNA,NSA,70-01-02,09-22-11:\"AlarmId=1: Description=Standby Software Not Installed\"" "1.1.1>1.1.2:CR,T-INOPTCRIT,SA,70-01-03,07-28-26:\"AlarmId=50: Description=Transit Connection Receive Signal Critical\"" "1.1.1>1.1.2:CL,T-INOPTCRIT,SA,70-01-03,07-28-48:\"AlarmId=50: Description=Transit Connection Receive Signal Critical\"" "2.3.6>3.5.6:CR,T-INOPTCRIT,SA,70-01-03,10-20-26:\"AlarmId=87: Description=Transit Connection Receive Signal Critical\"" "5.6.7>4.3.2:CR,T-INOPTCRIT,SA,70-01-03,10-33-26:\"AlarmId=96: Description=Transit Connection Receive Signal Critical\"" "5.6.7>4.3.2:CL,T-INOPTCRIT,SA,70-01-03,10-39-49:\"AlarmId=96: Description=Transit Connection Receive Signal Critical\"" "5.6.7>4.3.2:CR,T-INOPTCRIT,SA,70-01-03,10-40-26:\"AlarmId=98: Description=Transit Connection Receive Signal Critical\"" "5.6.7>4.3.2:CL,T-INOPTCRIT,SA,70-01-03,10-48-11:\"AlarmId=98: Description=Transit Connection Receive Signal Critical\"" ;

6.1.8 RTRV-LOG-EVT: Retrieving Log Event This command retrieves the node’s event log according to the specified filter conditions. User Access: All Levels



Error Generation: Refer to Appendix C, Error Codes and Alarms


RTRV-LOG-EVT:[TID]:[<src>]:[CTAG]::[<condtype>];

Output Format Syntax: SID DATE TIME M CTAG COMPLD “<AID>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,[<conddescr>]” ;

Input Format: agent> RTRV-LOG-EVT;

Output Format: TL1AGENT 12-06-29 15:29:24 M 0 COMPLD "admin:SEC-U-ADD,TC,12-06-29,10-37-04:\"Administrator added user\"" "TL1Service:SVC-REG,TC,12-06-29,10-38-21:\"Service registered\"" "admin:SEC-LOGON,TC,12-06-29,10-57-10:\"User login\"" "admin:SEC-LOGOFF,TC,12-06-29,10-57-36:\"User logged off\"" "admin:SEC-LOGON,TC,12-06-29,14-34-25:\"User login\"" "admin:SEC-LOGON,TC,12-06-29,14-49-09:\"User login\"" "admin:SEC-LOGOFF,TC,12-06-29,14-49-30:\"User logged off\"" "admin:SEC-LOGON,TC,12-06-29,14-49-48:\"User login\"" ;

6.1.9 SET-ATTR-COM: Setting Attributes Command This command changes (sets) the severity of the alarms logged by the node. User Access: Admin, IM, Field Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: SET-ATTR-COM:[TID]:<kind>:[CTAG]::<ntfcncde>,<condtype>;


Input Format: agent> SET-ATTR-COM::SYSTEM:::MN,eqpt;




6.1.10 SET-SOAK: This command sets the soak interval used for alarm scheduling. The soak interval is the amount of time an alarm has to continuously remain beyond a threshold before it is set or cleared. It is not uncommon for the power level of the light over a connection to fluctuate above and below an alarm threshold. Setting the soak interval helps to avoid setting or clearing an alarm for brief fluctuations beyond a threshold. User Access: Admin, IM, Field Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: SET-SOAK:[TID]:[<src>]:[CTAG]::<soakint>;


Input Format: agent> SET-SOAK:::::10;


6.1.11 RTRV-SOAK: Retrieve soak interval This command retrieves the current soak interval used for alarm scheduling. The soak interval is the amount of time an alarm has to continuously remain beyond a threshold before it is set or cleared. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms Input Format Syntax: RTRV-SOAK:::; Output Format Syntax: SID DATE TIME M CTAG COMPLD “[SOAKINTERVAL=<soakinterval>]”

Input Format: agent> RTRV-SOAK:::;

Output Format: TL1AGENT 12-04-30 20:53:49M 0 COMPLD "SoakInterval=15" ;



6.1.12 RTRV-UPTIME: Retrieve system uptime This command retrieves both the system uptime and the service uptime in seconds recorded since the last time either of these options was reset on the switch. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms


Input Format: RTRV-UPTIME:[<tid>]:<aid>:<ctag>;

Output Format: TL1AGENT 13-06-11 11:36:16 M 0 COMPLD ":SYSUPTIME=91685,SERVUPTIME=91056" ; agent> rtrv-uptime ;



7 MAINTENANCE COMMANDS

This chapter provides commands to perform maintenance tasks on the S320 equipment. Some maintenance tasks, such as backing-up the database, are performed routinely while others, such as performing a software upgrade, are performed as needed. The commands are organized into the following task groups:

• Backup and Restore • Software Upgrade

7.1 Backup and Restore Commands There are two methods used for back-up and restore: local and remote. Local pertains to the local flash disk and remote pertains to the network FTP server. The following table lists the TL1 commands used to back-up and restore the S320 database. Note: Ensure the user has first logged in using the ACT-USER command before issuing any commands, or you will receive a PLNA (Login not active) error code.

7.1.1 OPR-BKUPRST: Operating Back-up Restore This command backs-up the S320 database. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: OPR-BKUPRST:[TID]:[<src>]:[CTAG]::<location>,<bkuprsttype>,<fileType>; Output Format Syntax: SID DATE TIME M CTAG COMPLD Input Format: agent> opr-bkuprst:::::local,backup,data Output Format: TL1AGENT 13-06-24 12:44:04 M 0 COMPLD /* Backup Completed Successfully. */ ;



7.1.2 RTRV-BKUPRST: Retrieving Back-up Restore This command retrieves the last back-up/restore activity on the node. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms

Input Format Syntax: RTRV-BKUPRST:[TID]:[<src>]:[CTAG]; “AID:[STATE=<state>],[LOCATION=<Location],[BKUORST_TYPE=<BkuprstType>],[RESULT=<result>],[DATE=<date>],[TIME=<time>]”


Input Format: agent> opr-bkuprst:::::remote,backup,data


7.2 Software Upgrade1 Software upgrades to the S320 are performed by:

1. Using the OPR-DL command to download the new software image from the FTP server to a “staging area” directory located on the S320.

2. Using the OPR-INSTALL command to install the software download. 3. After a file transfer is initiated, the RTRV-DL can be used to confirm the download is

completed before initiating the OPR-INSTALL command. 4. After installation, the RTRV-INSTL command can be used to verify the installation was

completed. 5. Once the software installation is completed, the S320 should be rebooted using the INIT-

SYS command

1 Upgrade commands mentioned in this section are not yet available. CALIENT intends to provide a complete solution for Software Upgrades.



A AUTONOMOUS MESSAGE COMMANDS

Autonomous messages are used to report alarms, configuration changes, or condition changes. Many of these messages, such as those relating to alarm conditions, are spontaneously triggered by the network element itself without intervention. Other messages, such as those relating to the reporting of periodic condition states, are scheduled by the NE operator. This appendix provides these topics:

• Autonomous Messages Commands • Autonomous Messages Types

ALW-MSG: Allowing Autonomous Messages This command re-enables the TL1 agent’s ability to send autonomous messages during the current session. Autonomous messages can be inhibited based on severity. This command is issued after a previous INH-MSG had been sent earlier in the session. User Access: All levels Error Generation: Refer to Appendix C, Error Codes and Alarms Input Format Syntax: ALW-MSG:[TID]:[<src>]:[CTAG]::[<ntfcncde>],<msgtype>; Output Format Syntax: SID DATE TIME M CTAG COMPLD Input Format: agent> alw-msg:::::,all; Output Format: TL1AGENT 12-04-30 20:53:49M 0 COMPLD ; INH-MSG: Inhibiting Autonomous Messages This command prevents the TL1 agent from sending autonomous messages during the current session. Use the ALW-MSG command to re-enable the sending of autonomous messages. User Access: All Levels Error Generation: Refer to Appendix C, Error Codes and Alarms



Note: This command is only valid for the current session. The next time you log in, the TL1 Agent resumes the autonomous messages. Input Format Syntax: INH-MSG:[TID]:[<src>]:[CTAG]::[<ntfcncde>],<msgtype>; Output Format Syntax: SID DATE TIME M CTAG COMPLD Input Format: agent> INH-MSG:::::,all;

Output Format: TL1AGENT 12-04-30 20:53:49M 0 COMPLD ; Autonomous Message Types There are three types of autonomous messages sent by the TL1 Agent:

• REPT ALM • REPT DBCHG • REPT EVT

Note: The REPT ALM message issued is based on the condition type. REPT ALM: Report Alarm This message cannot be issued from the console. It is displayed on the console after receipt from the TL1 agent. For example, Output Format: TL1AGENT 12-04-30 20:53:49** 15 REPT ALM ENV "0.11b:MJ,T-ADC,NSA,02-12-04,13-01-35,,:\"AlarmId=42: Description=ADC Bus Errors detected\"" ; REPT DBCHG: Report Database Change This message cannot be issued from the console. It is displayed on the console after receipt from the TL1 Agent. This autonomous message reports the database changes that have occurred as a result of commands to change: Equipment provisioning or configuration The value of the TID or SID The value of the keywords defined in the common block or specific block Examples of events or commands that trigger this message include DLT, ED, ENT, RMV, RST, and SET. For security reasons, the following commands will not generate REPT DBCHG messages:



• ED-USER-SECU • ENT-USER-SECU

Note: Because the REPT DBCHG messages are broadcast to all users currently logged, in, you may notice the REPT DBCHG messages for commands that you did not issue. These messages are due to other users logged-in on other consoles. For each external update that has occurred, the response includes one line of data in quotes, followed by a carriage return and a line feed. Within the quotes, the format resembles the structure of the input commands. ; REPT ENV: Report Environmental Event This message cannot be issued from the console. It is displayed on the console after receipt from the TL1 agent. If an environmental alarm is triggered by the system, then the TL1 agent will display the appropriate autonomous alarm as a result. Report Event Messages There are two types of event messages: REPT EVT SECU: Report Event Security REPT EVT COM: Report Event Commons These messages cannot be issued from the console. They are displayed on the console after receipt from the TL1 agent. These autonomous messages result in a display of an event on the console. For example: Output Format: calient 02-11-25 11:18:25 A 350 REPT EVT SECU "admin:SEC-LOGON,TC,02-11-25,11-18-25,,,,:\"User login\"" ; calient 02-12-04 13:01:35 A 14 REPT EVT COM "0.11b:MON-MJ,TC,02-12-04,13-01-35,,,,:\"Monitor major threshold crossed\"" ;



B COMMAND USAGE BY USER ACCESS

Commands by User Privilege

The table below contains a list of the S320 TL1 commands along with the user access privileges required to successfully execute each command.

S320 TL1 Commands Admin IM Prov Field ReadOnly

ACK-ALM X X X

ACT-CRS X X X

ACT-USER X X X x X

ALW-MSG X X X X

ALW-USER-SECU X

CANC-CRS X X X

CANC-SESS X

CANC-USER X X X X X

CLR-FAULT-EQPT X X X

DLT-CRS X X X

DLT-GRP-PORT X

DLT-CRS-ALL X

DLT-CRS-BULK X

DLT-CRSSET X X X X

DLT-USER-SECU X



ED-PID X

ED-PORT X

ED-USER-SECU X X X

ENT-CRS X

ENT-CRS-BULK X

ENT-CRS-ENH X

ENT-USER-SECU X

INH-MSG X X X X

INH-USER-SECU X

INIT-SYS X

OPR-BKUPRST X X X

OPR-CRSSET-LPBK X

OPR-CRSSET-RECALL X X X X

OPR-CRSSET-SAVE X X X X

REC-CRS X X X

RTRV-ALM-ALL X X X X X

RTRV-ALM-COM X X X X X

RTRV-ALM-CRS X X X X X

RTRV-ALM-ENV X X X X X

RTRV-ALM-EQPT X X X X X

RTRV-ALM-SECU X X X X X

RTRV-BKUPRST X

RTRV-CFG-DAT X

RTRV-CFG-NE X

RTRV-CRS X

RTRV-CRSSET X



RTRV-DET-EQPT X

RTRV-DFLT-SECU X

RTRV-DFLT-CRS X X X X X

RTRV-ENV-EQPT X

RTRV-EQPT X X X X X

RTRV-FAULT-EQPT X

RTRV-GRP-CRS X

RTRV-HDR X

RTRV-IP X

RTRV-LOG-ALM X

RTRV-LOG-EVT X

RTRV-NE X

RTRV-PORT X

RTRV-PORT-SUM X

RTRV-SAVERECALL X

RTRV-SOAK X

RTRV-SESS X

RTRV-STATUS-BULK X X X X X

RTRV-UPTIME X X X X X

RTRV-USER X X X X X

SET-IP X X X

SET-SOAK X X X

SND-SESS-MSG X



C ERROR CODES AND ALARMS

The S320 provides error codes and alarms to help diagnose and troubleshoot equipment. This appendix includes these topics:

• TL1 Error Message • TL1 Alarms • Alarms Notification

Interpreting TL1 Error Messages Errors may be generated by any input command message and are displayed on the console. The following example shows the error format: sid date time M ctag DENY <errcde> /* <errmsg> */ ; The following tables lists error codes that are command-specific and error codes that appear for all commands. With the exception of simple input errors, such as improper message syntax or improper parameter format, error codes and messages help identify a solution to the cause of the error. To determine the solution of an error:

1. Look up the error message in the tables. 2. Determine if a RTRV message can be issued. If so, issue an appropriate RTRV

message to obtain more information. 3. Analyze the returned information, and take appropriate action. 4. If necessary, contact Calient Technologies Service and Support

Error Codes Associated with TL1 Commands

Error Codes Description

ACT-CRS IDNV Customer Name or Circuit does not exist IIFM Invalid format of customer_name or circuitId

string RCIN Requested Circuit ID does not exist



ACT-EQPT IDNV Invalid Data. Invalid (hardware not present) or unsupported equipment

IIFM Invalid format of eqptId

SNVS Invalid state transition

ENEQ Bad slot specified ACT-USER No error codes given for Act-User for security

reasons other than defaults

ALW-MSG IDNV Invalid event_kind should be empty or all

ALW-SRV IDNV Invalid service name

SRQN Access to this service is denied

ALW-USER-SECU IDNV No such user

IIFM Invalid format of UID string

CANC-CRS IDNV Customer Name or Circuit does not exist IIFM Invalid format of customer_name or circuitId

string RCIN Requested CircuitID does not exist

CANC-EQPT ENEQ Bad slot specified

IDNV Invalid Data. Invalid (hardware not present) or unsupported equipment

IIFM Invalid format of eqptId

SNVS Invalid state transition

CANC-SESS IDNV Session does not exist

IIFM Invalid Session ID

CLR-FAULT-EQPT IIFM Invalid circuit ID string

RCIN Requested Circuit ID does not exist

DLT-CRS IDNV Customer Name or Circuit does not exist

IIFM 1. Invalid format of customer_name or circuitId string 2. Invalid format of eqptId

RCIN Requested CircuitID does not exist

DLT-CRSSET SROF 1. Command rejected, there is an outstanding



Save/Recall request. 2. Specified Set is invalid. 3. Specified Set does not exist. 4. Error in deleting file.

DLT-USER-SECU IIFM Invalid UID string

SLBM Cannot delete last enabled admin

SRAC Unable to obtain session

IDMS Data missing, No value was set.

IIFM Invalid date or time format

ED-USER-SECU IDNV 1. Invalid MULTI value 2. Invalid Access value 3. Invalid role

IIFM 1. Invalid UID string 2. Invalid PID string

IPNV CID parameter not valid

PIUI User name already exists


ENT-CRS ENEQ No hardware present for that connection

IDNV 1. Invalid Data. Invalid (hardware not present) or unsupported equipment. 2. Invalid Port descriptor. Card might have been deleted.

SRCN Port already in connection. Connection already exists.

ENT-USER-SECU IDNV 1. Invalid MULTI value 2. Invalid Access value 3. Invalid role (uap)

IIFM 1. Invalid PID string 2. Invalid UID string

IPNV CID parameter not valid

PIUI User name already exists


INH-MSG IDNV Invalid event_kind

INH-SRV IDNV Invalid service name

INH-USER-SECU IIFM Invalid UID string

SLBM Cannot disable last enabled admin

OPR-BKUPRST This command uses all common error codes

OPR-CRSSET-RECALL SROF 1. Command rejected, there is an outstanding Save/Recall request. 2. Specified set is invalid.



3. Specified set does not exist. 4. Error in reading file. 5. Failed to make one or more XConnects.

OPR-CRSSET-SAVE SROF 1. Command rejected, there is an outstanding Save/Recall request. 2. Specified set is invalid. 3. Set already exists. 4. Set limit is reached. 5. Error in writing file.

RTRV-BKUPRST This command uses all common error codes

RTRV-CFG-DAT This command uses all common error codes

RTRV-CFG-NE This command uses all common error codes

RTRV-CFG-SWC This command uses all common error codes

RTRV-CRS IDNV 1. Customer does not exist 2. Invalid circuit ID

RTRV-CRSSET IIFM Invalid set name.

SRO 1. Specified set is invalid. 2. Specified set does not exist.

RTRV-DET-EQPT ENRI Not Equipped for Retrieving Specified Information

RTRV-ENV-EQPT ENRI Not Equipped for Retrieving Specified Information

RTRV-FAULT-EQPT This command uses all common error codes

RTRV-FTP This command uses all common error codes

RTRV-LOG-ALM IDNV Invalid severity value

RTRV-LOG-EVT IDNV Invalid severity value SLNS Log file not exist

RTRV-NE This command uses all common error codes

RTRV-SAVERECALL SROF 1. Specified set is invalid. 2. Specified set does not exist.

RTRV-SESS IIFM Invalid Session ID string

SROF Failed to retrieve user role

RTRV-SOAK This command uses all common error codes

RTRV-SRV IDNV Invalid service name

RTRV-TOD This command uses all common error codes

RTRV-USER IDNV Specified user not found



SET-ATTR-COM IDNV 1. Invalid NTFCode 2. Invalid KIND 3. Unable to find specified Condtype

IIFM Invalid condtype. Expects a number.

SROF Unable to get Alarm CFG list

SET-ATTR-SECUDFLT IDNV Invalid value for minutes

SET-FTP IIFM 1. Invalid ipAddress string 2. Invalid directory string 3. Invalid UID string or PID string

SET-IP IIFM 1. Invalid ipAddress string 2. Invalid network mask string 3. Invalid gateway string

SET-SOAK IDRG Interval out of range IIFM Invalid soak interval

SND-SESS-MSG

IDNV Invalid Session IIFM 1. Invalid Message string 2. Invalid Session ID

string SRAC Unable to find session specified SROF Unable to get sessionInfo List

Common Alarm Codes

Error Codes Description

IBEX Extra block, beyond the required Telcordia blocks

IDMS Data missing

IDNV Invalid Data (list for some specific commands)

IIAC Invalid Access Identifier (AID)

IICM Invalid Command

IICT Invalid Correlation Tag

IIFM Invalid Data Format

IISP Invalid Syntax or Punctuation

IITA Invalid Target Identifier

IPEX Invalid Payload block or extra parameters

IPMS Missing Parameter

PICC Privilege Invalid Command Code

PLNA Privilege Login not active



SROF System Requested Operation Failed

SSRE System Resource Error, unable to write configuration registry

SSNF Server Not Found

TL1 Alarms and Events The S320 dynamically generates an alarm when it detects a problem with a physical entity or software component that potentially can compromise its operation. The table describes the system alarms.

Table: System Alarms and Descriptions

Alarms Descriptions Default Severity

Service Affect

AID

EQPT A hardware failure of, or

communication failures with a card

CR

SA*

CARD

EQPT-MF Multiple Cards Failed CR SA CARD

IF-DOWN Physical Interface is down MJ NSA CARD

T-OPTLOSSDEGR

The loss through the matrix has exceeded the degraded threshold

MJ

NSA

CONN

T-OPTLOSSCRIT

The loss through the matrix has exceeded critical threshold

CR

SA

CONN

NOTIFY-DOWN Notify Down Received MJ NSA CONN

OPTPWRCTRL Connection output power not maintainable MJ NSA CONN

T-INOPTDEGR Power is below the

degraded threshold for specified interval

MJ

NSA

CONN

T-INOPTCRIT Power is below the critical

threshold for specified interval

CR

SA

CONN

T-INOPTHI Transit Connection receive signal too high MJ NSA CONN

T-OUTOPTDEGR

Power is below the degraded threshold for a specified interval

MJ

NSA

CONN

T-OUTOPTCRIT Power is below the critical

threshold for specified interval

CR

SA

CONN



OPRCV-HW Hardware failure occurs on the receiving end MJ NSA CONN

OMT-HW Hardware failure occurs on

the transmitting end MJ

NSA

CONN

Table: Environmental Alarms and Descriptions

Alarms Descriptions Default Severity

Service Affect

AID

FAN A fan has failed MJ NSA IOSC

FAN_ACCESS_ALARM Fan Control Unit Access Failed

MJ NSA

PROCROVLD

The CP CPU has exceeded a % utilized threshold

MJ

NSA

CARD

LINK_A_DOWN_ALARM External Link A Down CR SA

LINK_B_DOWN_ALARM External Link B Down CR NSA

PWR Power has failed MJ NSA CARD

PWR_FEEDA_ALARM Power Feed Unit-A Failed MJ NSA

PWR_FEEDB_ALARM Power Feed Unit-B Failed MJ NSA

PWR_UNITONE_ALARM Power Feed Unit A Failed MJ NSA

SFT†

A software subsystem has been restarted

MJ

NSA

SWUIBOARD_ACCESS_ALARM

Switch UI Board Access Failed

MJ

NSA

SW-UPG† A software upgrade attempt has

MJ

NSA



failed

T-DISK

Not enough free space on the file system

MJ

NSA

CARD

TEMP_ACCESS_ALARM

Temperature Sensor Unit Access Failed

MJ

NSA

T-MEM A card is low on memory MJ NSA CARD

TRANCONN_POWER_LOSS_ALARM Connection

Loss above threshold

CR

SA

T-T

Operating temperature is exceeded MJ

NSA

CARD

*Service affecting ** Non-service affecting

Event Descriptions Service Affect

RTC_FAILED_EVT RTC Access

Failed NSA

LINK_SWITCHOVER_EVT Bond0 Active Interface Changed

NSA

Alarms Notification The presence of alarms can be detected from three sources:

• REPT ALM autonomous message o This message is sent to all users currently logged in when the S320 detects an

alarm. The message includes the time the alarm was generated, the severity of the alarm, and the description of the alarm.

• RTRV-ALM-ALL message o This message is issued to retrieve the active S320 alarms. The retrieved

message includes an alarm identifier so that individual alarms can be acted on. It also includes enough alarm description to correct any problem that might exist.



• RTRV-LOG-ALM message o This message is issued to retrieve the active S320 alarm log. The alarm log

contains all alarms generated by the S320 that have been cleared.



D COMMAND STATES

Both the EQPT and CRS commands are affected by the administrative states, which determine what command can be issued. The administrative states include:

• Out-Of-Service-Not-Provisioned (OOS-NP) • Out-of-Service (OOS) • Under-Management (UMA) • In-Service (IS)

The following tables describe the relationship between the EQPT commands and equipment states and the relationship between the CRS commands and connection states, indicating which commands can be issued from each state. If it is valid to execute the command in the equipment state, the intersection of a command row and a state column will indicate the equipment state after successful execution of the command.

Equipment Commands

Equipment States

Commands OOS-NP OOS UMA IS

ACT-EQPT Invalid Invalid IS Invalid

CANC-EQPT Invalid Invalid Invalid UMA

RMV-EQPT Invalid Invalid OOS OOS

RST-EQPT Invalid UMA Invalid Invalid



Connection Commands

Connection States

Commands OOS-NP UMA IS

ACT-EQPT Invalid IS Invalid

CANC-EQPT Invalid Invalid UMA

RMV-EQPT Invalid OOS-NP OOS-NP

RST-EQPT UMA Invalid Invalid

S320 TL1 Reference Guide - CALIENT Technologies · The foregoing limitations shall apply even if...

Documents

Transcript of S320 TL1 Reference Guide - CALIENT Technologies · The foregoing limitations shall apply even if...