You are on page 1of 680

Administration Guide and CLI Reference for the Avaya IG550 Integrated Gateway

03-601883 Issue 2 January 2008

2008 Avaya Inc. All Rights Reserved. Notice While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document may be incorporated in future releases. For full legal page information, please see the complete document, Avaya Legal Page for Software Documentation, Document number 03-600758. To locate this document on the website, simply go to http://www.avaya.com/support and search for the document number in the search box. Documentation disclaimer Avaya Inc. is not responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya. Customer and/or End User agree to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation to the extent made by the Customer or End User. Link disclaimer Avaya Inc. is not responsible for the contents or reliability of any linked websites referenced elsewhere within this documentation, and Avaya does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all of the time and we have no control over the availability of the linked pages. Warranty Avaya Inc. provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avayas standard warranty language, as well as information regarding support for this product, while under warranty, is available through the following website: http://www.avaya.com/support Copyright Except where expressly stated otherwise, the Product is protected by copyright and other laws respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal, as well as a civil, offense under the applicable law. Avaya support Avaya provides a telephone number for you to use to report problems or to ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya website: http://www.avaya.com/support

Contents

Chapter 1: Configuration overview. . . . . . . . . . . . . . . . . . . . .


Configuration of J-series Services Router . . . . . . . . . . . . . . . . . . . . . Configuration using CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PIM for configuration of TGM550 and some J-series Service Router functions . Saving configuration changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of configuration changes CLI commands . . . . . . . . . . . . Firmware version control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

23
23 24 25 25 26 26

Chapter 2: Accessing the TGM550 Telephony Gateway Module and the J-Series Router . . . . . . . . . . . . . . . . . . . .
Accessing the CLI of the Juniper J-Series Services Router . . . . . . . . . . . . Accessing the TGM550 CLI . . . . . . . . . . . . Logging into the CLI . . . . . . . . . . . . . . CLI help. . . . . . . . . . . . . . . . . . . . . Accessing the TGM550 CLI via local network Accessing CLI with a console device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27
27 28 28 29 29 29 30 30 31 31 31 32 32 33 33 33 34 35 35 36 38 38 40 40 40 41 41 42

Accessing the CLI via modem . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing the TGM550 CLI via a USB modem . . . . . . . . . . . . . . . . . Accessing the TGM550 CLI from the router interface . . . . . . . . . . . . . . Accessing PIM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing Avaya Communication Manager . . . . . . . . . . . . . . . . . . . . . Managing login permissions . . . . . . . . . . . . . . . . . . . . . . . . . Security overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing users and passwords . . . . . . . . . . . . . . . . . . . . . Privilege level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring usernames . . . . . . . . . . . . . . . . . . . . . . . . Authenticating TGM550 service logins with Access Security Gateway (ASG) authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling ASG authentication . . . . . . . . . . . . . . . . . . . . . Replacing the ASG authentication file . . . . . . . . . . . . . . . . Configuring ASG authentication . . . . . . . . . . . . . . . . . . . Displaying ASG authentication information . . . . . . . . . . . . . Summary of ASG authentication CLI Commands . . . . . . . . . . SSH protocol support . . . . . . . . . . . . . . . . . . . . . . . . . . . SSH configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of SSH configuration commands . . . . . . . . . . . . . SCP protocol support . . . . . . . . . . . . . . . . . . . . . . . . . . . SCP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of SCP configuration commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2 January 2008

Contents

RADIUS authentication . . . . . . . . . . . . . . . . . . . . . . . . Using RADIUS authentication. . . . . . . . . . . . . . . . . . . Configuring RADIUS authentication . . . . . . . . . . . . . . . Changing RADIUS parameters . . . . . . . . . . . . . . . . . . Disabling RADIUS authentication. . . . . . . . . . . . . . . . . Displaying RADIUS parameters. . . . . . . . . . . . . . . . . . Summary of RADIUS authentication configuration commands

. . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

42 42 42 43 43 43 44 44 45 45 46 46 47 47 48 49 49

Special security features . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling and disabling recovery password . . . . . . . . . . . . . . Enabling and disabling telnet access . . . . . . . . . . . . . . . . . Managing gateway secrets . . . . . . . . . . . . . . . . . . . . . . . Configuring the Master Configuration Key. . . . . . . . . . . . . Summary of Master Configuration Key configuration commands Enabling SYN cookies . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring SYN cookies . . . . . . . . . . . . . . . . . . . . . . Maintaining SYN cookies . . . . . . . . . . . . . . . . . . . . . . Summary of SYN cookies configuration commands . . . . . . .

Chapter 3: Basic device configuration . . . . . . . . . . . . . . . . . . .


Configuring the Server . . . . . . . . . . . . . . . . . . . . . . Survivability and migration options . . . . . . . . . . . . . Configuring the MGC list . . . . . . . . . . . . . . . . . . . Setting the TGM550 Telephony Gateway Modules MGC Determining results . . . . . . . . . . . . . . . . . . . . Showing the current MGC list. . . . . . . . . . . . . . . Removing one or more MGCs. . . . . . . . . . . . . . . Changing the MGC list. . . . . . . . . . . . . . . . . . . Setting reset times. . . . . . . . . . . . . . . . . . . . . . . Accessing the registered MGC . . . . . . . . . . . . . . . . Summary of MGC list configuration commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

51
51 52 53 53 54 54 55 55 55 56 56 57 58 59 60 60 61 61 62 63

Viewing the status of the device . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of device status commands . . . . . . . . . . . . . . . . . . . . . . Viewing voice channel availability and TIM status from the J-series router interface . . . . . . . . . . . . . . . . . . . . . . . . Software and firmware management . . . . . . . . . . . . . File transfer . . . . . . . . . . . . . . . . . . . . . . . . Software and firmware upgrades . . . . . . . . . . . . . Managing the firmware banks. . . . . . . . . . . . . Upgrading software and firmware using FTP/TFTP . Uploading software and firmware from the gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4 IG550 Integrated Gateway Administration and CLI Reference

Contents

Summary of software and firmware management commands . Backing up and restoring configuration files . . . . . . . . . . . . Backing up/restoring a configuration file using FTP/TFTP/SCP Summary of configuration file backup and restore commands Listing the files on the TGM550 Telephony Gateway Module . . . Summary of file listing commands . . . . . . . . . . . . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

64 65 65 66 67 67

Chapter 4: Configuring Standard Local Survivability (SLS) . . . . . . .


SLS service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Avaya phones supported in SLS . . . . . . . . . . . . . . . . . . . . . . . . Call processing in SLS mode . . . . . . . . . . . . . . . . . . . . . . . . . . Call processing not supported by SLS . . . . . . . . . . . . . . . . . . . . . Provisioning data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PIM configuration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Entering SLS mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unregistered state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setup state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Registered state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Teardown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SLS interaction with specific TGM550 Telephony Gateway Module features Direct Inward Dialing in SLS mode . . . . . . . . . . . . . . . . . . . . . Multiple call appearances in SLS mode . . . . . . . . . . . . . . . . . . Hold in SLS mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Call Transfer in SLS mode . . . . . . . . . . . . . . . . . . . . . . . . . IP Softphone shared administrative identity in SLS mode . . . . . . . . Emergency Transfer in SLS mode . . . . . . . . . . . . . . . . . . . . . SLS logging activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example of CDR log entries and format . . . . . . . . . . . . . . . . . . Configuring SLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Communication Manager for SLS . . . . . . . . . . . . . Using PIM to manage SLS administration on the gateway . . . . . . . . . Enabling and disabling SLS. . . . . . . . . . . . . . . . . . . . . . . . . . Activating changes in SLS . . . . . . . . . . . . . . . . . . . . . . . . . . Using the CLI to manually configure SLS administration on the gateway. Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Planning and preparing the SLS data set . . . . . . . . . . . . . . . . Configuring the SLS data through the CLI . . . . . . . . . . . . . . . . Administering Station parameters . . . . . . . . . . . . . . . . . . . . Administering DS1 parameters . . . . . . . . . . . . . . . . . . . . . . Administering BRI parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

69
69 70 71 72 72 73 74 74 74 75 75 75 76 76 77 78 80 80 81 81 82 83 88 93 94 94 94 94 107 111 113 118

Issue 2 January 2008

Contents

Administering trunk-group parameters . . . Administering signaling-group parameters . Administering dial-pattern parameters . . . . Administering incoming-routing parameters Summary of SLS configuration commands .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

120 127 128 129 131

Chapter 5: Configuring logging . . . . . . . . . . . . . . . . . . . . . .


Configuring a Syslog server . . . . . . . . . . . . Defining Syslog servers . . . . . . . . . . . Disabling Syslog servers . . . . . . . . . . Deleting Syslog servers . . . . . . . . . . . Displaying the status of the Syslog server. Syslog sink default settings. . . . . . . . . Syslog message format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

139
140 140 141 141 142 142 142 143 143 143 144 144 145 145 145 146 146 147 147 148 148 149 150 151 152 152

Configuring a log file . . . . . . . . . . . . . . . . . . . . . . . Disabling logging system messages to a log file . . . . Deleting current log file and opening an empty log file . Displaying log file messages . . . . . . . . . . . . . . . Displaying conditions defined for the file output sink . Log file message format. . . . . . . . . . . . . . . . . . . . Configuring a session log. . . . . . . . . . . . . . . . . . Discontinuing the display of system messages . . Displaying how the session logging is configured Session logging message format. . . . . . . . . . . . Configuring logging filters . . . . . Setting the logging filters . . Severity levels . . . . . . . . Sinks default severity levels Applications to be filtered . . Syslog server example . . . Log file example . . . . . . . Session log example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Summary of Logging configuration CLI commands . . . . . . . . . . . . . . . .

Chapter 6: Configuring VoIP QoS . . . . . . . . . . . . . . . . . . . . .


Configuring RTP and RTCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring QoS parameters . . . . . . . . . . . . . . . . . . . . . . . Configuring RTCP QoS parameters . . . . . . . . . . . . . . . . . RSVP parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of QoS, RSVP, and RTCP configuration CLI commands . . . . . . . . . . . . . . . . . . . . . . . .

155
155 155 156 156 157

6 IG550 Integrated Gateway Administration and CLI Reference

Contents

Chapter 7: Configuring Emergency Transfer Relay (ETR) . . . . . . . .


Setting ETR state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing ETR state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of ETR commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

159
159 160 160

Chapter 8: Configuring SNMP . . . . . . . . . . . . . . . . . . . . . . .


Agent and manager communication . . . . . . . . . . . . . . . . . . . . . . . . . SNMP versions. . . . . . . . . . . . SNMPv1. . . . . . . . . . . . . . SNMPv2c . . . . . . . . . . . . . SNMPv3. . . . . . . . . . . . . . Users . . . . . . . . . . . . . . . SNMP security levels . . . . SNMP-server user command Groups . . . . . . . . . . . . . . Creating an SNMPv3 group . Views . . . . . . . . . . . . . . . Creating an SNMPv3 view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

161
161 162 163 163 163 164 164 164 165 166 166 166 167 168 169 169 170 171 172 173

Configuring SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notification types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of SNMP trap configuration commands . . . . . . . . . . . . . . . Configuring SNMP access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of SNMP access configuration commands . . . . . . . . . . . . . . Configuring dynamic trap manager . . . . . . . . . . . . . . . . . . . . . . . . . Summary of dynamic trap manager configuration commands . . . . . . . . . SNMP configuration examples . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 9: Transferring and managing announcement files . . . . . . .


Announcement file operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of announcement files commands . . . . . . . . . . . . . . . . . . . .

175
175 177

Chapter 10: Configuring monitoring applications. . . . . . . . . . . . .


Configuring and analyzing RTP statistics . . . . . . . . . . . Configuring the RTP statistics application . . . . . . . . Viewing RTP statistics thresholds . . . . . . . . . . . Configuring RTP statistics thresholds . . . . . . . . . Enabling and resetting the RTP statistics application Viewing application configuration . . . . . . . . . . . Configuring QoS traps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

179
179 180 180 183 184 184 187

Issue 2 January 2008

Contents

Configuring QoS fault and clear traps . . . . . . . . . . . . . . . Configuring the trap rate limiter . . . . . . . . . . . . . . . . . . Analyzing RTP statistics output . . . . . . . . . . . . . . . . . . . . Viewing RTP statistics summary reports . . . . . . . . . . . . . Viewing RTP session statistics . . . . . . . . . . . . . . . . . . . Viewing QoS traps, QoS fault traps, and QoS clear traps. . . . . Analyzing QoS trap output . . . . . . . . . . . . . . . . . . . . . Analyzing QoS fault and clear trap output . . . . . . . . . . . . . Viewing automatic traceroute results . . . . . . . . . . . . . . . RTP statistics examples. . . . . . . . . . . . . . . . . . . . . . . . . Configuring the RTP statistics application for a sample network A call over the WAN from an analog phone to an IP phone. . . . A local call between an IP and an analog phone . . . . . . . . . A remote call over the WAN from an IP phone to an IP phone . . A conference call . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of RTP statistics commands . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

188 189 189 189 190 197 198 201 203 204 204 208 210 212 215 217 219 219 220 220 220 221 222 223 225 225

Reporting on interface status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of interface status commands. . . . . . . . . . . . . . . . . . . . . Configuring and monitoring CNA test plugs. . . . . . . . . . . . . . . . . . . . . CNA test plug functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . Test plug actions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CNA tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the TGM550 Telephony Gateway Module test plug for registration CNA test plug configuration example . . . . . . . . . . . . . . . . . . . . . . Resetting the CNA test plug counters . . . . . . . . . . . . . . . . . . . . . . Summary of CNA test plug commands . . . . . . . . . . . . . . . . . . . . .

Chapter 11: Setting synchronization . . . . . . . . . . . . . . . . . . . .


Synchronization status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying synchronization status . . . . . . . . . . . . . . . . . . . . . . . . Summary of synchronization commands . . . . . . . . . . . . . . . . . . . .

227
228 229 229

Chapter 12: User Levels and Contexts . . . . . . . . . . . . . . . . . . .


User levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contexts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command line prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Available contexts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

231
231 232 232 233

Chapter 13: CLI Commands . . . . . . . . . . . . . . . . . . . . . . . .


About the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

235
235

8 IG550 Integrated Gateway Administration and CLI Reference

Contents

Logging in to the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the CLI. . . . . . . . . Using Help . . . . . . . . Using auto-complete . . Abbreviating commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

235 236 236 236 236 237 237 238 239 240 241 241 242 243 244 246 246 246 247 248 249 250 251 252 252 253 254 254 255 256 257 258 258 259 259 259 260 261 262 262

Announcement files . . . . . . . . . . . . . . . copy announcement-file ftp . . . . . . . . . copy announcement-file scp . . . . . . . . copy ftp announcement-file . . . . . . . . . copy scp announcement-file . . . . . . . . erase announcement-file . . . . . . . . . . rename announcement-file . . . . . . . . . show announcements files . . . . . . . . . show download announcement-file status show upload announcement-file status . . ASG authentication . . . . . . . . . . . . . . copy auth-file ftp . . . . . . . . . . . . . . copy auth-file scp . . . . . . . . . . . . . copy auth-file tftp . . . . . . . . . . . . . copy ftp auth-file . . . . . . . . . . . . . . copy scp auth-file . . . . . . . . . . . . . copy tftp auth-file . . . . . . . . . . . . . login authentication lockout . . . . . . . login authentication local-craft-password login authentication response-time . . . login authentication services-login. . . . show auth-file info . . . . . . . . . . . . . show download auth-file status . . . . . show login authentication. . . . . . . . . show upload auth-file status . . . . . . . username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Backing up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show backup status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CDR file . . . . . . . . . . . . . . copy cdr-file ftp . . . . . . . copy cdr-file scp . . . . . . . copy cdr-file tftp . . . . . . . show upload cdr-file status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

CLI sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2 January 2008

Contents

reset . . . . retstatus . . set logout. . show logout tech . . . . . tree . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

262 263 264 265 265 266 267 267 267 268 269 269 270 271 272 272 273 276 276 277 278 279 279 280 281 282 283 284 284 285 285 286 287 287 288 289 290 290 291 291

CNA test plugs . . . . . . . . . . . . cna testplug . . . . . . . . . . . clear counters (CNA test plugs) control-port. . . . . . . . . . . . rtp-echo-port . . . . . . . . . . . rtp-test-port . . . . . . . . . . . scheduler . . . . . . . . . . . . . shutdown (CNA test plugs) . . . test-rate-limit . . . . . . . . . . . cna-testplug-service . . . . . . . show cna testplug . . . . . . . .

Configuration files . . . . . . . . . . . . copy ftp startup-config . . . . . . . copy running-config ftp . . . . . . . copy running-config scp . . . . . . copy running-config startup-config copy running-config tftp . . . . . . copy scp startup-config . . . . . . . copy startup-config ftp . . . . . . . copy startup-config scp . . . . . . . copy startup-config tftp . . . . . . . copy tftp startup-config . . . . . . . erase startup-config . . . . . . . . . nvram initialize . . . . . . . . . . . . show copy status . . . . . . . . . . show download status . . . . . . . show erase status . . . . . . . . . . show running-config . . . . . . . . show startup-config . . . . . . . . . show upload status . . . . . . . . .

Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Counters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . clear counters (interface) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

10 IG550 Integrated Gateway Administration and CLI Reference

Contents

clear ip traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show ip traffic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CSU loopbacks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show csu loopbacks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show csu status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Device status. . . . . . . clear utilization cpu . set utilization cpu . . show download . . . show faults . . . . . . show mg list_config . show mgc . . . . . . show mm . . . . . . . show module . . . . . show recovery . . . . show restart-log . . . show system . . . . . show timeout. . . . . show upload . . . . . show utilization . . . test led . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

292 292 294 294 295 296 296 297 298 299 299 300 301 302 303 303 304 305 305 306 307 307 307 308 308 309 310 311 311 312 312 313 313 315 315 315 315 316 318 318

Display . . . . . . . . . . . . banner login . . . . . . . banner post-login . . . . clear screen . . . . . . . hostname . . . . . . . . . line . . . . . . . . . . . . show banner login . . . . show banner post-login . terminal length . . . . . . terminal width . . . . . .

DNS resolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dynamic CAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show dynamic-cac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dynamic trap manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . clear dynamic-trap-manager . . . . . . . . . . . . . . . . . . . . . . . . . . . snmp-server dynamic-trap-manager . . . . . . . . . . . . . . . . . . . . . . . E1/T1 interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . clock source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2 January 2008

11

Contents

ETR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . set etr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show etr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Firmware management . . . . . . . copy ftp SW_imageA . . . . . . copy ftp SW_imageB . . . . . . copy tftp SW_imageA . . . . . . copy tftp SW_imageB . . . . . . dir . . . . . . . . . . . . . . . . . set boot bank. . . . . . . . . . . show boot bank . . . . . . . . . show download software status show image version . . . . . . . Fragmentation . . . . clear fragment . . fragment chain . . fragment size. . . fragment timeout. show fragment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

319 319 320 321 321 322 322 323 324 325 326 326 327 328 328 328 329 330 331 332 332 334 337 337 337 338 338 338 340 341 341 342 343 344 345 346 346 347 348 349

Frame relay encapsulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ICMP errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ip icmp-errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show ip icmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IP interface configuration . interface console . . . show ip interface. . . . show ip interface brief. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

IP phone upgrades. . . . . . . . clear ip tftp-server statistics copy ftp phone-image . . . . copy ftp phone-script . . . . copy phone-script ftp . . . . copy phone-script scp. . . . copy phone-script tftp . . . . copy scp phone-script. . . . copy tftp phone-image . . . copy tftp phone-script . . . . erase phone-image . . . . .

12 IG550 Integrated Gateway Administration and CLI Reference

Contents

erase phone-script. . . . . . . . . . . . . ip tftp-server file-system size . . . . . . . show application-memory. . . . . . . . . show download phone-image-file status. show download phone-script-file status . show ip tftp-server files . . . . . . . . . . show ip tftp-server statistics . . . . . . . show upload phone-script-file status . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

349 350 351 351 352 353 354 355 356 356 357 357 358 358 359 359 360 360 361 362 363 364 365 366 367 368 368 369 370 371 372 372 373 373 374 375 376 376 377 378

License file of CM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ip license-server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Link status . . . . . . . . . . show isdn bri link . . . . show isdn link summary show isdn pri link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Logging. . . . . . . . . . . . . . . . . . clear logging cdr file content . . . . clear logging file . . . . . . . . . . . clear logging server . . . . . . . . . set logging file . . . . . . . . . . . . set logging server . . . . . . . . . . set logging server access-level . . set logging server condition . . . . set logging server enable | disable . set logging server facility . . . . . . set logging session . . . . . . . . . show dev log file . . . . . . . . . . . show logging file condition . . . . . show logging file content . . . . . . show logging server condition . . . show logging session condition . .

Master key configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . key config-key password-encryption. . . . . . . . . . . . . . . . . . . . . . . MGC (Media Gateway Controller) configuration . clear mgc list . . . . . . . . . . . . . . . . . . session . . . . . . . . . . . . . . . . . . . . . set mediaserver . . . . . . . . . . . . . . . . set mgc list . . . . . . . . . . . . . . . . . . . set reset-times . . . . . . . . . . . . . . . . . show mediaserver . . . . . . . . . . . . . . . show mgc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2 January 2008

13

Contents

show mgc list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modem configuration Console port . . . . . . . . . . . . . . . . . . . . . . . . interface console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MSS notifications . . icmp in-echo-limit icmp. . . . . . . . icmp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

379 380 381 381 382 382 382 384 385 385 386 386 387 390 390 391 392 392 393 394 394 395 396 397 397 398 399 399 400 400 401 401 402 402 404 404 405 406 406

Policy - QoS lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . icmp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Port classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show port classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . QoS . . . . . . . . . . . . . set qos bearer . . . . . set qos control . . . . . set qos signal . . . . . show qos-rtcp . . . . . show voip-parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

RADIUS authentication . . . . . . . . . . . clear radius authentication server . . . set radius authentication . . . . . . . . set radius authentication retry-number set radius authentication retry-time . . set radius authentication secret . . . . set radius authentication server . . . . set radius authentication udp-port . . . show radius authentication . . . . . . .

Recovery password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . set terminal recovery password . . . . . . . . . . . . . . . . . . . . . . . . . Restoring gateway configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . show restore status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Routing table configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . set qos rtcp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show qos-rtcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTP statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . rtp-stat clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

14 IG550 Integrated Gateway Administration and CLI Reference

Contents

rtp-stat event-threshold . . rtp-stat fault . . . . . . . . rtp-stat min-stat-win . . . . rtp-stat qos-trap . . . . . . rtp-stat qos-trap-rate-limit . rtp-stat-service . . . . . . . rtp-stat threshold . . . . . show rtp-stat config . . . . show rtp-stat detailed . . . show rtp-stat sessions . . show rtp-stat summary . . show rtp-stat thresholds . show rtp-stat traceroute. .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

. . . . . . . . . . . . .

407 408 409 410 411 412 412 415 416 417 420 421 422 424 424 424 424 425 426 427 428 429 431 432 432 433 434 435 436 437 438 439 440 440 442 443 443 444 445 445

SAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sat. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SLS survivability . . . . . . . . sls . . . . . . . . . . . . . . set sls. . . . . . . . . . . . show sls . . . . . . . . . . bri . . . . . . . . . . . . . . set bearer-capability . . . . set country-protocol . . . . set directory-number-a . . set directory-number-b . . set endpoint-init . . . . . . set interface . . . . . . . . set interface-companding . set layer1-stable . . . . . . set name . . . . . . . . . . set side . . . . . . . . . . . set spid-a . . . . . . . . . . set spid-b . . . . . . . . . . set tei-assignment . . . . . show (bri). . . . . . . . . . clear attendant . . . . . . . clear bri . . . . . . . . . . . clear dial-pattern . . . . . . clear ds1 . . . . . . . . . . clear extension. . . . . . . clear fac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2 January 2008

15

Contents

clear incoming-routing . . . . . . . clear sig-group . . . . . . . . . . . . clear slot-config . . . . . . . . . . . clear station . . . . . . . . . . . . . clear survivable-config . . . . . . . clear trunk-group . . . . . . . . . . dial-pattern . . . . . . . . . . . . . . set delete-digits . . . . . . . . . . . set deny . . . . . . . . . . . . . . . set insert-digits (dial-pattern) . . . . set max-length . . . . . . . . . . . . set min-length . . . . . . . . . . . . set tgnum. . . . . . . . . . . . . . . set type (dial-pattern) . . . . . . . . show (dial-pattern). . . . . . . . . . ds1 . . . . . . . . . . . . . . . . . . set bearer-capability . . . . . . . . . set bit-rate . . . . . . . . . . . . . . set channel-numbering . . . . . . . set connect . . . . . . . . . . . . . . set country-protocol . . . . . . . . . set interface . . . . . . . . . . . . . set interface-companding . . . . . . set long-timer . . . . . . . . . . . . set name . . . . . . . . . . . . . . . set protocol-version . . . . . . . . . set side . . . . . . . . . . . . . . . . set signaling-mode . . . . . . . . . show (ds1) . . . . . . . . . . . . . . incoming-routing . . . . . . . . . . set delete-digits . . . . . . . . . . . set insert-digits (incoming-routing) set length . . . . . . . . . . . . . . . set match-pattern . . . . . . . . . . show (incoming-routing) . . . . . . set attendant . . . . . . . . . . . . . set date-format . . . . . . . . . . . . set fac. . . . . . . . . . . . . . . . . set ip-codec-set . . . . . . . . . . . set max-ip-registrations . . . . . . . set pim-lockout . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

446 447 448 449 450 450 451 452 453 453 454 455 456 457 459 460 462 463 464 464 465 467 468 469 469 470 472 473 474 476 478 479 480 481 481 482 483 484 485 485 486

16 IG550 Integrated Gateway Administration and CLI Reference

Contents

set slot-config . . . . . . . . show attendant. . . . . . . . show bri . . . . . . . . . . . show date-format . . . . . . show dial-pattern . . . . . . show ds1 . . . . . . . . . . . show extension . . . . . . . show fac . . . . . . . . . . . show incoming-routing . . . show ip-codec-set . . . . . . show last-pim-update . . . . show max-ip-registrations . show pim-lockout . . . . . . show sig-group . . . . . . . show slot-config . . . . . . . show station . . . . . . . . . show trunk-group . . . . . . sig-group . . . . . . . . . . . add nfas-interface . . . . . . remove nfas-interface . . . . set associated-signaling . . set primary-dchannel . . . . set trunk-group-chan-select show (sig-group). . . . . . . station . . . . . . . . . . . . set cor . . . . . . . . . . . . set expansion-module . . . . set name . . . . . . . . . . . set password . . . . . . . . . set port . . . . . . . . . . . . set swhook-flash. . . . . . . set trunk-destination . . . . set type (station) . . . . . . . show (station) . . . . . . . . trunk-group. . . . . . . . . . add port . . . . . . . . . . . Analog trunks . . . . . . Digital trunks . . . . . . . clear tac . . . . . . . . . . . remove port . . . . . . . . . set cbc . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

487 489 489 490 491 492 493 495 495 496 497 498 498 499 500 500 502 504 505 506 507 508 509 510 511 512 515 515 516 517 518 519 520 521 523 527 527 528 529 530 531

Issue 2 January 2008

17

Contents

set cbc-parameter . . . . set cbc-service-feature . set channel-preference . set codeset-display . . . set codeset-national . . . set dial . . . . . . . . . . set digit-handling . . . . set digits . . . . . . . . . set digit-treatment . . . . set incoming-destination set incoming-dialtone . . set japan-disconnect . . set name . . . . . . . . . set numbering-format . . set send-name . . . . . . set send-number . . . . . set supervision. . . . . . set tac. . . . . . . . . . . set trunk-hunt . . . . . . show (trunk-group) . . . SNMP access configuration. ip snmp . . . . . . . . . . set snmp community . . show snmp . . . . . . . . show snmp engineID . . show snmp group . . . . show snmp user . . . . . show snmp usertogroup show snmp view . . . . . snmp-server community snmp-server engineID . . snmp-server group . . . snmp-server remote-user snmp-server user . . . . snmp-server view . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

532 533 534 534 535 536 537 538 539 540 540 541 542 543 544 545 546 547 548 549 551 551 552 552 553 554 555 556 557 557 558 559 561 562 564 565 565 565 566 567

SNMP trap configuration . . . . . . . . set snmp trap enable | disable auth show snmp . . . . . . . . . . . . . . snmp-server enable notifications. . snmp-server host . . . . . . . . . .

18 IG550 Integrated Gateway Administration and CLI Reference

Contents

snmp-server informs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SSH protocol . . . . . . . . . . . clear ssh-client known-hosts disconnect ssh. . . . . . . . hostname . . . . . . . . . . . ip ssh . . . . . . . . . . . . . show ip ssh . . . . . . . . . Synchronization . . . . clear sync interface set sync interface . set sync source . . set sync switching . show sync timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

570 571 571 571 572 573 574 575 575 576 576 577 578 579 579 579 581 582 582 582 583 584 585 585 586 586 587 587 588 589 589 590 590 591 591 592 593 593 594

SYN-cookies . . . . . . . . . . . . . clear tcp syn-cookies counters . show tcp syn-cookies . . . . . . tcp syn-cookies . . . . . . . . . Syslog files . . . . . . . . . . . . . copy syslog-file ftp . . . . . . copy syslog-file scp . . . . . . copy syslog-file tftp . . . . . . show upload syslog-file status System identification . set system contact. set system location set system name . . Telnet access. . . ip telnet . . . . ip telnet-client show ip telnet telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

TFTP server . . . . . . . . . . . . clear ip tftp-server statistics . ip tftp-server . . . . . . . . . . ip tftp-server file-system size . show application-memory. . .

Traffic shaping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show restore status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2 January 2008

19

Contents

Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VoIP . . . . . . . . . . . . . . . campon-busyout voip-dsp reset voip-dsp . . . . . . . show voip-dsp . . . . . . . show voip-parameters. . . VoIP testing . . . . . . . . busyout voip-dsp . . . release voip-dsp . . . . show voip-parameters. test voip-dsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

595 595 596 597 597 598 599 600 601 601 602 603 603 605 605

WAN configuration, verifying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Appendix A: Traps and MIBs . . . . . . . . . . . . . . . . . . . . . . . .


TGM550 Telephony Gateway Module traps . . . . . . . . . . . . . . . . . . . . . TGM550 Telephony Gateway Module MIB files . . . . . . . . MIB files in the Load.MIB file . . . . . . . . . . . . . . . . MIB files in the ENTITY-MIB.my file. . . . . . . . . . . . . MIB files in the UTILIZATION-MANAGEMENT-MIB.my file MIB files in the ENTITY-SENSOR-MIB.my file . . . . . . . MIB files in the RFC1213-MIB.my file . . . . . . . . . . . . MIB files in the AVAYA-ENTITY-MIB.my file . . . . . . . . MIB files in the IF-MIB.my file . . . . . . . . . . . . . . . . MIB files in the CONFIG-MIB.my file . . . . . . . . . . . . MIB files in the G700-MG-MIB.my file. . . . . . . . . . . . MIB files in the SNMPv2-MIB.my file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

609
609 619 620 621 622 623 624 627 627 628 629 634

Appendix B: Configuring the routers modem interface for remote dial-in and dial backup . . . . . . . . . . . . . . . . . . .
USB Modem Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Connecting the USB Modem to the Services Router's USB Port. Configuring the USB Modems with a Configuration Editor . . Configuring an USB Modem Interface . . . . . . . . . . . Configuring a Dialer Interface. . . . . . . . . . . . . . . . Configuring Dial Backup . . . . . . . . . . . . . . . . . . Configuring a Primary Interface for Backup Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

635
635 636 637 637 637 640 642 644

20 IG550 Integrated Gateway Administration and CLI Reference

Contents

Configuring a Dialer Filter for Dial-on-Demand Routing Backup . . . . Configuring the Dialer Filter. . . . . . . . . . . . . . . . . . . . . . Applying the Dial-on-Demand Dialer Filter to the Dialer Interface . Configuring a Firewall Filter for Dial-on-Demand Routing Backup. . . Configuring the Firewall Filter . . . . . . . . . . . . . . . . . . . . Applying the Dial-on-Demand Firewall Filter to the Dialer Interface Configuring Dialer Watch . . . . . . . . . . . . . . . . . . . . . . . . . Adding a Dialer Watch Interface on the Services Router . . . . . . Configuring the USB Modem Interface for Dialer Watch . . . . . . Configuring Dial-In. . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring CHAP on Dialer Interfaces (Optional) . . . . . . . . . Configuring and Administering USB Modems . . . . . . . . . . . . . . Configuring the USB Modem Initialization String . . . . . . . . . . Resetting USB Modems . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . .

. . . . . . . . . . . . . .

. . . . . . . . . . . . . .

. . . . . . . . . . . . . .

645 645 646 647 648 650 651 651 652 654 656 657 657 659 660

Configuring a personal computer for remote dial access through the routers modem. . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Index

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

669

Issue 2 January 2008

21

Contents

22 IG550 Integrated Gateway Administration and CLI Reference

Chapter 1: Configuration overview


Services personnel should have already administered the following administration access points of a TGM550 Telephony Gateway Module:

TGM550 external IP interface (for access from the J2320/J2350/J4350/J6350 Services Router or through the TGM550 Console port) JJ2320/J2350/J4350/J6350 Services Router IP interface J2320/J2350/J4350/J6350 Services Router USB PPP modem interface

For information on configuring these access points, see Installing and Configuring the IG550 Integrated Gateway.

Configuration of J-series Services Router


The J2320, J2350, J4350 and J6350 J-series Services routers may be configured using either the CLI or the J-Web interface. Administer the J-series Services Router for the initial addressing for both the router and the TGM550, the media gateway controller list of the TGM550, and any or all of the following LAN/WAN features:

SSH protocol support SCP protocol support E1, T1, E3, and T3 connections DSL ADSL PPPoe ISDN DLS Firewall Filters MPLS CNLS VPN IP sec COS Policy

Issue 2 January 2008

23

Configuration overview

Multicast Transmission Alarms SNMP for Network Management DHCP Packet capture RPM configuration Ports LLDP Routing: - Static routes - RIP network - IS-IS protocol - BGP protocol - Graceful restart - Logical routers - OSPF

For more information, see J-series Services Router Administration.

Configuration using CLI


You can use the TGM550 Telephony Gateway Module CLI to manage the TGM550 Telephony Gateway Module. The CLI is a command prompt interface that enables you to type commands and view responses. For instructions on how to access the TGM550 Telephony Gateway Module CLI, see Accessing the TGM550 CLI on page 28. This guide contains information and examples about how to use CLI commands to configure the TGM550 Telephony Gateway Module. For more information about the TGM550 Telephony Gateway Module CLI and a complete description of each CLI command, see Chapter 13: CLI Commands on page 235.

24 IG550 Integrated Gateway Administration and CLI Reference

PIM for configuration of TGM550 and some J-series Service Router functions

PIM for configuration of TGM550 and some J-series Service Router functions
The Avaya Provisioning and Installation Manager (PIM) is an application that allows the user to perform initial installation and provisioning of multiple gateways. It provides integrated network system views that ease centralized configuration tasks, especially provisioning and installing large numbers of gateways simultaneously. One of the primary functions of PIM is to provision and configure Standard Local Survivability (SLS). For instructions on configuring SLS, see Configuring Standard Local Survivability (SLS) on page 69.

Saving configuration changes


When you make changes to the configuration of the TGM550 Telephony Gateway Module, you must save your changes to make them permanent. The TGM550 Telephony Gateway Module has two sets of configuration information:

Running configuration Startup configuration

The TGM550 Telephony Gateway Module operates according to the running configuration. When the TGM550 Telephony Gateway Module is reset, the TGM550 Telephony Gateway Module erases the running configuration and loads the startup configuration as the new running configuration. When you change the configuration of the TGM550 Telephony Gateway Module, your changes affect only the running configuration. Your changes are lost when the TGM550 Telephony Gateway Module resets if you do not save your changes. Enter copy running-config startup-config to save changes to the configuration of the TGM550 Telephony Gateway Module. A copy of the running configuration becomes the new startup configuration. You can back up either the running configuration or the startup configuration to an FTP or TFTP server on your network. You can restore a backup copy of the configuration from the FTP or TFTP server. When you restore the backup copy of the configuration, the backup copy becomes the new running configuration on the TGM550 Telephony Gateway Module. For more information, see Backing up and restoring configuration files on page 65.

Issue 2 January 2008

25

Configuration overview

Summary of configuration changes CLI commands


Table 1: Configuration changes CLI commands Command copy running-config startup-config Description Commit the current configuration, including Standard Local Survivability (SLS) data, to NVRAM

Firmware version control


Firmware is the software that runs the TGM550 Telephony Gateway Module. The TGM550 Telephony Gateway Module has two firmware banks:

Bank A Bank B

Each firmware bank contains a version of the TGM550 Telephony Gateway Module firmware. These may be different versions. The purpose of this feature is to provide redundancy of firmware. You can save an old version of the firmware in case you need to use it later. If it becomes necessary to use the older version, you can enter set boot bank bank-x and then reset the TGM550 Telephony Gateway Module to use the older version. This is particularly important when uploading new versions. For more information on firmware version control, see Software and firmware upgrades on page 61.

26 IG550 Integrated Gateway Administration and CLI Reference

Chapter 2: Accessing the TGM550 Telephony Gateway Module and the J-Series Router
You can access the TGM550 Telephony Gateway Module using the CLI, the PIM, and the Avaya Communication Manager. When you access the TGM550 remotely through a modem dialup connection, you must first log in to the J-series router. You can also log in to the J-series router over an Ethernet connection, and then log in to the TGM550 from the router. You can manage login permissions by using and configuring usernames and passwords, and by configuring the TGM550 Telephony Gateway Module to use SSH, SCP, and RADIUS authentication. There are special security features that enable and disable the recovery password, establish incoming and outgoing telnet connections, and configure SYN cookies for preventing SYN attacks.

Accessing the CLI of the Juniper J-Series Services Router


This section explains how to access the CLI and includes the following topics: To start the CLI: 1. Establish a connection with the Services Router:

To access the router remotely from an Ethernet connection, enter the command you typically use to establish a remote connection (such as telnet or SSH) using the router hostname or IP address. To access the router through a management device attached to the Console port, connect your PC to the Console port of the Services Router and start your preferred terminal application such as HyperTerminal. To access the router through a modem connection, open a network connection and dial the modem phone number of the Juniper Services Router. See Configuring Dial-In on page 654 or Installing and Configuring the Avaya IG550 Integrated Gateway, 03-601883, for information on setting up a J-series modem for remote dial-in. See Configuring a personal computer for remote dial access through the routers modem on page 660 on setting up your personal computer for remotely accessing the router.

2. Log in using your username and password. After you log in, you enter a UNIX shell.

Issue 2 January 2008

27

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

3. At the UNIX prompt, enter cli. The CLI prompt appears, with the format user@host>. The presence of the angle bracket (>) prompt indicates the CLI has started. By default, the prompt is preceded by a string that contains your username and the hostname of the Services Router. 4. To exit the CLI and return to the UNIX shell, enter the quit command. Note: You cannot log in as root using telnet. Also, you can use the J-Web Interface, instead of the CLI, on the Juniper Services Router to perform many tasks.

Note:

Accessing the TGM550 CLI


The CLI is a textual command prompt interface that you can use to configure the TGM550 Telephony Gateway Module and media modules. You can access the CLI with any of the following:

A Telnet connection over the LAN/WAN Note: You can alternatively use an SSH connection through the network to the Juniper J-series Services Router, then a Telnet connection to the TGM550

Note:

A TGM550 Console port connection A dialup connection through a USB modem to the Juniper J-series Services Router, then a Telnet connection to the TGM550

If the TGM550 Telephony Gateway Module is under service contract with Avaya Services, remote service providers can connect remotely to service the TGM550 Telephony Gateway Module with telnet and SSH sessions. You can configure the TGM550 Telephony Gateway Module to authenticate remote service logins using Access Security Gateway (ASG) authentication instead of password authentication, for higher security.

Logging into the CLI


Log in to the CLI with a username and password that your system administrator provides. Use RADIUS authentication if your network has a RADIUS server. For more information, see Managing login permissions on page 32. Note: Disconnect a telnet session by typing <Ctrl>+]. This is particularly useful if the normal telnet logout does not work.

Note:

28 IG550 Integrated Gateway Administration and CLI Reference

Accessing the TGM550 CLI

CLI help
You can display a list of commands for the context you are in by typing help or ?. The help command displays a list of all CLI commands that you can use within the current context, with a short explanation of each command. If you type help or ? before or after the first word or words of a command, the CLI displays a list of all commands in the current context that begin with this word or words. For example, to display a list of IP commands available in general context, enter help ip, ip help, ? ip, or ip ?. If you type help or ? before or after a full command, the CLI displays the commands syntax and parameters, and an example of the command. You must be in the commands context in order to use the help command to display information about the command. In the following example, the user enters the vlan 1 interface context and displays help for the bandwidth command.

Accessing the TGM550 CLI via local network


Access the CLI from a computer on the same local network as the TGM550 Telephony Gateway Module by using SSH or, if telnet is active, any standard telnet program. Use the IP address of the TGM550 interface.

Accessing CLI with a console device


To access the TGM550 CLI with a console device, use a laptop with a serial cable and terminal emulator software. Connect the console device to the CONSOLE on the front panel of the TGM550 Telephony Gateway Module. Use only an approved Avaya serial cable. For more information about approved Avaya serial cables, see Overview for the Avaya IG550 Integrated Gateway. To access the TGM550 CLI with a console device, use a laptop with a serial cable and terminal emulator software.

Issue 2 January 2008

29

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

Accessing the CLI via modem


You can use any standard telnet program to access the CLI from a remote location. This is done by using a dialup PPP network connection from a modem at the remote location. You can use a USB modem connected to the USB port on the front panel of the TGM550 Telephony Gateway Module. Note: You can disconnect a telnet session by typing <Ctrl>+]. This is particularly useful if the normal telnet logout does not work.

Note:

Accessing the TGM550 CLI via a USB modem


To access the TGM550 CLI with telnet through dialup from a remote location using a USB modem: 1. Log in to the Juniper Services Router (see Accessing the CLI of the Juniper J-Series Services Router on page 27). 2. At the Unix command line, enter ssh ip_address, where ip_address is the ip address of the TGM550. Note: Telnet is disabled by default on both the TGM550 and the router. However, you can enable telnet on both the TGM550 and the router. Then, you can use telnet instead of SSH for access to the TGM550. Note: After a user login is established on the TGM550, you can use an alternate command for accessing the TGM550 from the router. See Accessing the TGM550 CLI from the router interface on page 31. 3. At the login prompt, type the username and press Enter. 4. At the password prompt, type the password and press Enter. You are now logged-in. Note: You can disconnect a telnet session by typing <Ctrl>+]. This is particularly useful if the normal telnet logout does not work. 5. If your network has a RADIUS server, you can use RADIUS authentication for the PPP connection. For more information, see Managing login permissions on page 32.

Note:

Note:

Note:

30 IG550 Integrated Gateway Administration and CLI Reference

Accessing PIM

Accessing the TGM550 CLI from the router interface


You can access the TGM550 directly from the router interface. Use of this command requires that the login and password have already been administered on the TGM550. 1. Access the CLI command prompt on the router. 2. Type request tgm login fpc <slot> user <tgm-user>, where slot is the slot number of the TGM550 and tgm-user is the login of the user. 3. At the password prompt, type the password for the login. The command line of the TGM550 appears.

Accessing PIM
The Provisioning and Installation Manager (PIM) enables you to remotely configure devices, primarily Avaya media gateways, on a network-wide basis. PIM provides integrated network system views that ease centralized configuration tasks, especially provisioning and installing large numbers of gateways simultaneously. One of PIMs primary functions is to provision and configure Standard Local Survivability (SLS) on the TGM550. See Configuring Standard Local Survivability (SLS) on page 69. PIM is launched from the Avaya Network Management Console. The Avaya Network Management Console is the central infrastructure application that discovers and monitors enabled network devices and runs Avaya Integrated Management applications. PIM must be installed on the same Windows server as Avaya Network Management Console with System View and Avaya Secure Access Administration. For detailed information about installing and launching PIM, see Avaya Integrated Management Enterprise Network Management Installation and Upgrade, 14-300444.

Accessing Avaya Communication Manager


Use Avaya Communication Manager software to control telephone services that the TGM550 Telephony Gateway Module provides. Run the Avaya Communication Manager software on a server. There might be several servers on your network that can control the TGM550 Telephony Gateway Module. Access Avaya Communication Manager on any server that is a Media Gateway Controller (MGC) for the TGM550 Telephony Gateway Module. For more information, see Configuring the Server on page 51.

Issue 2 January 2008

31

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

Access Avaya Communication Manager with any of the following:

Avaya Site Administration (ASA). ASA provides wizards and other tools that help you to use Avaya Communication Manager effectively. For more information, see Administrator Guide for Avaya Communication Manager, 03-300509. SSH to port 5023 on the MGC. For more information, see Administrator Guide for Avaya Communication Manager, 03-300509. TGM550 Telephony Gateway Module CLI. See Accessing the registered MGC on page 56.

Managing login permissions


You can manage login permissions to enable different privilege levels for each user and to operate the security mechanism.

Security overview
The TGM550 Telephony Gateway Module includes a security mechanism through which the system administrator defines users and assigns each user a username and password. Each user is assigned a privilege level. The users privilege level determines which commands the user can perform. In addition to its basic security mechanism, the TGM550 Telephony Gateway Module supports secure data transfer via SSH and SCP. The TGM550 Telephony Gateway Module can be configured to work with an external RADIUS server to provide user authentication. When RADIUS authentication is enabled on the TGM550 Telephony Gateway Module, the RADIUS server operates in conjunction with the TGM550 Telephony Gateway Module security mechanism. When the user enters a username, the TGM550 Telephony Gateway Module first establishes a connection with the RADIUS server, and the RADIUS server provides the necessary authentication services, if available. If the TGM550 does not find the username from the RADIUS server, the TGM550 searches its own database for the username. For Avaya remote services, remote access is protected with the Access Security Gateway capability of the TGM550. An authentication file, which is loaded by default on the TGM550, provides the challenge/response key used by the Avaya remote services.

32 IG550 Integrated Gateway Administration and CLI Reference

Managing login permissions

Managing users and passwords


You must provide a username and password when you perform any of the following actions:

When you access the CLI. For more information, see Accessing the TGM550 CLI on page 28. When you connect a modem with dialup PPP. For more information, see Accessing the CLI via modem on page 30.

When you use the CLI, your username determines your privilege level. The commands that are available to you during the session depend on your privilege level. If your network has a RADIUS server, you can use RADIUS authentication instead of a username and password. A RADIUS server provides centralized authentication service for many devices on a network.

Privilege level
When you start to use the CLI, you must enter a username. The username that you enter sets your privilege level. The commands that are available to you during the session depend on your privilege level. If you use RADIUS authentication, the RADIUS server sets your privilege level. The TGM550 Telephony Gateway Module provides the following three privilege levels:

Read-only. You can use Read-only privilege level to view configuration parameters. Read-write.You can use Read-write privilege level to view and change all configuration parameters except those related to security. For example, you cannot change a password with Read-write privilege level. Admin.You can use Admin privilege level to view and change all configuration parameters, including parameters related to security. Use Admin privilege level only when you need to change configuration that is related to security, such as adding new user accounts and setting the device policy manager source.

The default username has Admin privilege level. For security reasons, the network administrator usually changes the password of the default username. For more information about privilege levels, see Chapter 13: CLI Commands on page 235.

Configuring usernames
To create a username, use the username command. To remove a username, use the no username command. To change the password or the privilege level for a username, remove the username and add it again. You need an Admin privilege level to use the username and no username commands.

Issue 2 January 2008

33

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

Note:

Note: When ASG authentication is enabled on the gateway, all password user accounts with usernames similar to the reserved Avaya Services logins are deactivated. The logins are "rasaccess", sroot, init, inads, and craft. The login "dadmin" is reserved for an Avaya business partner remote services account, which can be defined for ASG authentication. For information about ASG authentication, refer to Authenticating TGM550 service logins with Access Security Gateway (ASG) authentication on page 34.

When you create a new user, you must define the users password and privilege level. The following example creates a user named John with the password johnny69 and a Read-write privilege level:
TGM550-001(super)# username john password johnny69 access-type read-write

Authenticating TGM550 service logins with Access Security Gateway (ASG) authentication
The TGM550 supports ASG authentication for remote service logins. Direct remote connection of services to the gateway is needed for gateways that are under service contract. ASG is a more secure authentication method than password authentication and does not require a static password. ASG uses one-time tokens for authentication, in which a unique secret key is associated with each login. ASG authentication is a challenge-response system, in which the remote user receives a challenge from the gateway and returns an ASG authenticated response, which the gateway verifies before permitting access. A new challenge is used for each access attempt. ASG authentication is supported for remote services connecting to the gateway using telnet or SSH protocols via any of the following:

Direct connection to the front panel Console port using the "craft" login Logging in from the J-series router

When ASG authentication is enabled on the TGM550, the TGM550 recognizes any login attempts using Avaya Services reserved usernames as service logins, and requests ASG authentication from the user, instead of a static user password. The following usernames are reserved for Avaya Services usage: rasaccess, sroot, init, inads, and craft. When ASG authentication is enabled on the TGM550, all password user accounts with usernames similar to the reserved service logins are deactivated.

34 IG550 Integrated Gateway Administration and CLI Reference

Managing login permissions

Enabling ASG authentication


ASG authentication can be enabled and disabled on the gateway and requires an ASG authentication file. The ASG authentication file contains Avaya Services accounts for authenticating users at login as members of Avaya Services. The TGM550 is shipped with an ASG authentication file. For information about replacing the authentication file, refer to Replacing the ASG authentication file on page 35.

Replacing the ASG authentication file


In case of any problems with the ASG authentication file, you can download a newer authentication file from the Authentication File System (AFS). You cannot install an authentication file with a different authentication file ID to that of the authentication file currently installed in the gateway. Note: If there is a need to install an authentication file with a different ID, you must first delete the current authentication file using the command erase auth-file. This command requires Supervisor level access and can only be used when directly connecting to the Console or Services port. If you do delete the authentication file and replace it with an authentication file with a new ID, the authentication file label on the gateway chassis must also be replaced. 1. Optionally display the current ASG authentication file version, using the show auth-file info command. For example:
TGM550-001(super)# show auth-file info Authentication File (AF) information: AF-ID :7000012345 Date/time : 15:02:27 27-SEP-2005 Major release : 4

Note:

2. Use Windows File Explorer or another file management program to create a directory on an FTP, SCP or TFTP server for storing authentication files (for example, C:\licenses). 3. Access the Internet and go to rfa.avaya.com. 4. Login using your SSO login and password. The AFS and RFA information home page appears. 5. Start the AFS application from the RFA information page. Follow the instructions outlined in the Authentication File System (AFS) Guide, 03-601703 to create and download the authentication file. 6. Download the authentication file from an FTP, SCP or TFTP server or USB mass storage device to the TGM550. To install the authentication file, use one of the following commands:

To download an authentication file from a remote FTP server: copy ftp auth-file filename ip, where filename is the name of the authentication file, including the

Issue 2 January 2008

35

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

full path and ip is the IP address of the host. The TGM550 prompts you for a username and password after you enter the command.

To download an authentication file from a remote SCP server:copy scp auth-file filename ip, where filename is the name of the authentication file, including the full path and ip is the IP address of the host. The TGM550 prompts you for a username and password after you enter the command. To download an authentication file from a remote TFTP server: copy tftp auth-file filename ip, where filename is the name of the authentication file, including the full path and ip is the IP address of the host. The TGM550 prompts you for a username and password after you enter the command. To download an authentication file from a USB mass storage device:copy usb auth-file source-usb-device source-filename, where source-usb-device is the source USB mass storage device and source-filename is the full name and path of the authentication file.

The authentication file is downloaded. You can view the download status using show download auth-file status. Note: You can also upload the authentication file from the gateway for troubleshooting. To upload the authentication file, use copy auth-file ftp to upload it to an FTP server, copy auth-file scp to upload it to an SCP server, copy auth-file tftp to upload it to a TFTP server, or copy auth-file USB to upload it to a USB mass storage device. To display the upload status, use show upload auth-file status.

Note:

Configuring ASG authentication


You can perform the following ASG configurations:

Block Avaya Services login access, using no login authentication services-logins. This deactivates all Avaya Services logins, including local craft password-based authenticated login. To reactivate, use login authentication services-logins.

36 IG550 Integrated Gateway Administration and CLI Reference

Managing login permissions

Set the time the gateway waits for user response to authentication requests before timing out a connection, using login authentication response-time time, where time is the time, in seconds, after which the gateway aborts the connection if no response is received. For example, to timeout connections if no response arrives within 180 seconds after an authentication request:
TGM550-001(super)# login authentication response-time 180

Use no login authentication response-time to return the response time value to the factory default of 120 seconds. The time value you enter is used for both:

The response time interval between the username prompt and the username entry The response time interval between the challenge prompt and the challenge response

Deactivate password authentication and activate ASG authentication of Avaya Services local connections to the Console port. To do this, use no login authentication local-craft-password. To enable password authentication of Avaya Services local connections to the Console port, use login authentication local-craft-password (default). Set a policy for locking out access to the gateway after successive failed login attempts. To do this, use login authentication lockout time attempt count, where time is the interval of time for which lockout is enforced and count is a number of failed attempts after which lockout is enforced. Use no login authentication lockout to return the lockout time and lockout attempt threshold to their default values (180 and 3). For example, to lockout Avaya Services access to the device for 360 seconds following five failed login attempts:
TGM550-001(super)# login authentication lockout 360 attempt 5

This lockout affects all users locally stored in the gateway, including locally defined user accounts and Avaya Services logins defined in the ASG authentication file. Remote users maintained centrally in a Radius server are not subject to the lockout sanction.

Switch between modem operation modes, including rasaccess and ppp modes, using ppp authentication {pap|chap|none|ras}. ASG authentication is enabled when ras is selected. For example:
TGM550-001(super)# ppp authentication ras

Issue 2 January 2008

37

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

Displaying ASG authentication information

Display login authentication settings and information, using show login authentication. For example:
TGM550-001(super)# show login authentication Services logins: On Local craft: On Lockout time: 180 seconds Lockout attempt threshold: 3 Authentication response time: 120 seconds CLI logout timeout: Off

Display ASG authentication file information, using show auth-file info. For example:
TGM550-001(super)# show auth-file info Authentication File (AF) information: AF-ID :7000012345 Date/time : 15:02:27 27-SEP-2005 Major release : 4

Display all locally defined user accounts, including services accounts and account type information such as authentication method, using show username. For example:
TGM550-001(super)# show username User account Access level Account type ----------- -------------------sroot dev Services init dev Services inads tech Services craft admin Services dadmin admin local rasaccess read-only Services root admin local

Active Authent. method -----------------yes challenge yes challenge yes challenge yes challenge yes challenge yes challenge yes password

Summary of ASG authentication CLI Commands


Table 2: ASG authentication CLI command Command copy auth-file ftp Description Upload the authentication file from the gateway to an FTP server Upload the authentication file from the gateway to an SCP server 1 of 2

copy auth-file scp

38 IG550 Integrated Gateway Administration and CLI Reference

Managing login permissions

Table 2: ASG authentication CLI command (continued) Command copy auth-file tftp Description Upload the authentication file from the gateway to a TFTP server Download an ASG authentication file from a remote FTP server Download an ASG authentication file from a remote SCP server Download an ASG authentication file from a remote TFTP server Erase the gateways ASG authentication file Enable password authentication of Avaya Services local connections to the Console port with the "craft" login. Use the no form to disable password authentication for Avaya Services local connections to the Console port. When password authentication is disabled, ASG authentication is activated. Set the time the gateway waits for user response to authentication requests before timing out a connection Set a policy for locking out access to the gateway after successive failed login attempts Activate all Avaya Services logins, including local login to Console port with "craft" login. Use the no form to deactivate all Avaya Services logins. Display ASG authentication file information Display download status of ASG authentication file, after using copy ftp|scp|tftp|usb auth-file to download an authentication file to the gateway Display login authentication settings and information Display upload status of ASG authentication file, after using copy auth-file ftp|scp|tftp to upload an authentication file from the gateway 2 of 2

copy ftp auth-file

copy scp auth-file copy tftp auth-file erase auth-file login authentication local-craft-password

login authentication response-time login authentication lockout login authentication services-logins show auth-file info show download auth-file status show login authentication show upload auth-file status

Issue 2 January 2008

39

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

SSH protocol support


Secure Shell (SSH) protocol is a security protocol that enables you to establish a remote session over a secured tunnel, also called a remote shell. SSH accomplishes this by creating a transparent, encrypted channel between the local and remote devices. In addition to the remote shell, SSH provides secure file transfer between the local and remote devices. SSH is used for telnet file transfers. The TGM550 Telephony Gateway Module supports two concurrent SSH users. Establishing an SSH session can be done by RSA authentication, or password authentication. To determine which of these ways is used on your TGM550 Telephony Gateway Module, enter show ip ssh.

SSH configuration

To enable SSH on the TGM550 Telephony Gateway Module: a. To execute the SSH protocol, the TGM550 Telephony Gateway Module must first be assigned hostname identification. Use the hostname command to assign hostname identification. b. To enable SSH to be used, you must also configure the server host key. Use the crypto key generate dsa command to generate an SSH host key pair. c. Enter ip ssh to enable SSH authentication. Note that SSH is enabled by default.

To disable SSH on the TGM550 Telephony Gateway Module: - Use the disconnect ssh command to disconnect an existing SSH session. - Enter no ip ssh to disable the SSH server which disconnects all active SSH sessions.

Enter show ip ssh to display SSH configuration information and information about any active SSH sessions.

Summary of SSH configuration commands


For information about these commands, see SSH protocol on page 571. Table 3: SSH configuration commands Command disconnect ssh hostname Description Disconnect an existing SSH session Assign hostname identification to the TGM550 Telephony Gateway Module 1 of 2

40 IG550 Integrated Gateway Administration and CLI Reference

Managing login permissions

Table 3: SSH configuration commands (continued) Command ip ssh show ip ssh Description Enable or disable the Secure Shell (SSH) service Display general SSH information and information about the currently active connections that are using SSH 2 of 2

SCP protocol support


In addition to data transfer via an SSH session, the SSH protocol is used to support SCP for secure file transfer. When using SCP, the TGM550 Telephony Gateway Module is the client, and an SCP server must be installed on the management station. After users are defined on the SCP server, the TGM550 Telephony Gateway Module acts as an SCP client. The process of establishing an SCP session is the same process as described in SSH protocol support on page 40, except that the roles of the TGM550 Telephony Gateway Module and the client computer are reversed. To perform file transfers secured by SCP, the TGM550 Telephony Gateway Module launches a local SSH client via the CLI. This establishes a secured channel to the secured file server. The TGM550 Telephony Gateway Module authenticates itself to the server by providing a username and password. With a Windows-based SSH server (WinSSHD), the username provided must be a defined user on the Windows machine with read/write privileges. The files transferred via SCP are saved in the C:\Documents and Settings\username directory. The network element performs file transfer in unattended mode.

SCP configuration
Enter clear ssh-client known-hosts to clear the clients list of SCP server fingerprints. Each SCP client maintains a list of server fingerprints. If a key changes, the clients verification of the servers fingerprint will fail, thereby preventing the clients access to the SCP server. If this happens, you can enter clear ssh-client known-hosts to erase the clients server fingerprint list. This enables the client to access the server and begin to recreate its list of fingerprints with the SCP servers new fingerprint.

Issue 2 January 2008

41

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

Summary of SCP configuration commands


For information about these commands, see SSH protocol on page 571. Table 4: SCP configuration commands Command clear ssh-client known-hosts Description Clear the SSH known-host file content

RADIUS authentication
If your network has a RADIUS server, you can configure the TGM550 Telephony Gateway Module to use RADIUS authentication. A RADIUS server provides centralized authentication service for many devices on a network. When you use RADIUS authentication, you do not need to configure usernames and passwords on the TGM550 Telephony Gateway Module. When the user enters a username, the TGM550 Telephony Gateway Module first establishes a connection with the RADIUS server, and the RADIUS server provides the necessary authentication services, if available. If the TGM550 does not does not find the username from the RADIUS server, the TGM550 searches its own database for the username. For additional information on RADIUS configuration and authentication, go to the Avaya website at http://www.avaya.com/support, and perform a search for the document Avaya G700/G350 RADIUS Configuration Overview, 104207.

Using RADIUS authentication


1. Configure your RADIUS server with the usernames, passwords, and privilege levels that you want to use on the TGM550 Telephony Gateway Module. 2. Configure RADIUS authentication on the TGM550 Telephony Gateway Module.

Configuring RADIUS authentication


1. Enter set radius authentication enable to enable RADIUS authentication. 2. Use the set radius authentication secret command to set the shared secret for the authentication. This command must be followed by a text string. For example:
set radius authentication secret hush

3. Use the set radius authentication server command to set the IP address of the primary or secondary RADIUS Authentication server.

42 IG550 Integrated Gateway Administration and CLI Reference

Managing login permissions

For more information about these commands, see Chapter 13: CLI Commands on page 235.

Changing RADIUS parameters


The following commands are optional:

Use the set radius authentication retry-number command to set the number of times to resend an access request when there is no response. Use the set radius authentication retry-time command to set the time to wait before resending an access request. Use the set radius authentication udp-port command to set the RFC 2138 approved UDP port number. Normally, the UDP port number should be set to its default value of 1812. Some early implementations of the RADIUS server used port number 1645.

Disabling RADIUS authentication


Enter set radius authentication disable to disable RADIUS authentication on the TGM550 Telephony Gateway Module.

Displaying RADIUS parameters


Enter show radius authentication. Shared secrets are not displayed.

Issue 2 January 2008

43

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

Summary of RADIUS authentication configuration commands


For information about these commands, see RADIUS authentication on page 394. Table 5: RADIUS authentication configuration command Command clear radius authentication server set radius authentication set radius authentication retry-number set radius authentication retry-time set radius authentication secret set radius authentication server set radius authentication udp-port show radius authentication Description Clear the primary or secondary RADIUS server IP address Enable or disable RADIUS authentication Set the number of times to resend an access request when there is no response Set the time to wait before resending an access request

Set the shared secret for RADIUS authentication Set the IP address of the primary or secondary RADIUS authentication server Set the RFC 2138 approved UDP port number

Display all RADIUS authentication configurations (shared secrets are not displayed)

Special security features


Special security features allow you to enable and disable the recovery password, establish incoming and outgoing telnet connections, copy gateway configurations while keeping configuration secrets, and configure SYN cookies for preventing SYN attacks.

44 IG550 Integrated Gateway Administration and CLI Reference

Special security features

Enabling and disabling recovery password


The TGM550 Telephony Gateway Module includes a special recovery password. The purpose of the recovery password is to enable the system administrator to access the TGM550 Telephony Gateway Module in the event that the regular password is forgotten. You can only use the recovery password when accessing the TGM550 Telephony Gateway Module via a direct connection to the Console port or Services port. Use the set terminal recovery password command to enable or disable the recovery password. Use this command only when accessing the TGM550 Telephony Gateway Module via a direct connection to the Console port or Services port. Table 6: Master Configuration Key configuration commands Command set terminal recovery password Description Enable or disable the recovery password

Enabling and disabling telnet access


You can enable and disable the TGM550 Telephony Gateway Modules ability to establish incoming and outgoing telnet connections, using the following commands. You can only use these commands when accessing the TGM550 Telephony Gateway Module via a direct connection to the Console port.

Use the ip telnet command to enable the TGM550 Telephony Gateway Module to establish an incoming telnet connection. Use the no form of this command to disable the TGM550 Telephony Gateway Modules ability to establish an incoming telnet connection. Enter ip telnet-client to enable the TGM550 Telephony Gateway Module to establish an outgoing telnet connection. Use the no form of this command to disable the TGM550 Telephony Gateway Modules ability to establish an outgoing telnet connection. Note: These commands are secured commands and are not displayed together with the running configuration (using the show running-config command). To see the status of these commands, use the show protocol command.

Note:

Use the show ip telnet command to display the status of the Telnet server and the current Telnet connections.

Issue 2 January 2008

45

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

For information about these commands, see Telnet access on page 587. Table 7: Telnet access configuration commands Command ip telnet Description Enable the TGM550 Telephony Gateway Module to establish an incoming telnet connection, or disable its ability to establish an incoming telnet connection Enable the TGM550 Telephony Gateway Module to establish an outgoing telnet connection, or disable its ability to establish an outgoing telnet connection Display the status of the Telnet server and the current Telnet connections Display the status of the telnet or telnet-client protocol Initiate a login session via telnet to a network host

ip telnet-client

show ip telnet show protocol telnet

Managing gateway secrets


The TGM550 Telephony Gateway Module provides a mechanism for storage, backup, and restore of sensitive materials (passwords and keys) maintained in the Media Gateways. All sensitive materials are encrypted using a Master Configuration Key (MCK), derived from a passphrase entered by an administrator. The secrets are then stored in the configuration file in an encrypted format. This enables copying configurations, including secrets, from one device to another. The only requirement is that the administrator must generate an identical MCK (by using the same passphrase) in the target device before executing the copy operation. Note: All gateways have the same default MCK. For security reasons, it is recommended to configure a new MCK immediately upon gateway installation.

Note:

Configuring the Master Configuration Key


1. Enter key config-key password-encryption followed by a phrase of 13-64 printable ASCII characters. 2. Copy the running configuration to the start-up configuration using the copy running-config startup-config command. The new MCK is now in effect.

46 IG550 Integrated Gateway Administration and CLI Reference

Special security features

Summary of Master Configuration Key configuration commands


For information about these commands, see RADIUS authentication on page 394. Table 8: Master Configuration Key configuration commands Command key config-key password-encryption Description Set the default Master Configuration Key of the gateway

Enabling SYN cookies


The TGM550 Telephony Gateway Module provides various TCP/IP services and is therefore exposed to a myriad of TCP/IP based DoS attacks. DoS (Denial of Service) attacks refers to a wide range of malicious attacks that can cause a denial of one or more services provided by a targeted host. Specifically, a SYN attack is a well-known TCP/IP attack in which a malicious attacker targets a vulnerable device and effectively denies it from establishing new TCP connections. SYN cookies refers to a well-known method of protection against a SYN attack.

SYN attack (SYN flood attack)


The SYN (TCP connection request) attack is a common DoS attack characterized by the following pattern: Using a spoofed IP address, an attacker sends multiple SYN packets to a listening TCP port on the target machine (the victim). For each SYN packet received, the target machine allocates resources and sends an acknowledgement (SYN-ACK) to the source IP address. The TCP connection is called a half-open connection at this point since the initiating side did not yet send back an acknowledgment (termed the 3rd ACK). Because the target machine does not receive a response from the attacking machine, it attempts to resend the SYN-ACK, typically five times, at 3-, 6-, 12-, 24-, and 48-second intervals, before de-allocating the resources, 96 seconds after attempting the last resend. Altogether, the target machine typically allocates resources for over three minutes to respond to a single SYN attack. When an attacker uses this technique repeatedly, the target machine eventually runs out of memory resources since it holds numerous half-open connections. It is unable to handle any more connections, thereby denying service to legitimate users. Moreover, flooding the victim with TCP SYN at a high rate can cause the internal queues to fill up, also causing a denial of service.

Issue 2 January 2008

47

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

SYN cookies
SYN cookies protect against SYN attacks by employing the following strategies:

Not maintaining any state for half-open inbound TCP sessions, thus preventing the SYN attack from depleting memory resources. SYN cookies are able to maintain no state for half-open connections by responding to SYN requests with a SYN-ACK that contains a specially crafted initial sequence number (ISN), called a cookie. The value of the cookie is not a pseudo-random number generated by the system, but the result of a hash function. The hash result is generated from the source IP, source port, destination IP, destination port, and some secret values. The cookie can be verified when receiving a valid 3rd ACK that establishes the connection. The verification ensures that the connection is a legitimate connection and that the source IP address was not spoofed.

Employing the SYN cookies method at a lower point in the network stack then regular TCP handling, closer to the start point of packet handling. This reduces the chances that a SYN attack will fill up the internal queues. Performing SYN attack fingerprinting and alerting an administrator about a SYN attack as it occurs. This is implemented by keeping track of the rate at which half-open TCP connections are created, and sending an alert when the rate exceeds a certain threshold.

In addition, when the SYN cookies mechanism is active, a hostile port scan might be misled into concluding that all TCP ports are open.

Configuring SYN cookies


1. Enter tcp syn-cookies. 2. Copy the running configuration to the start-up configuration using the copy running-config startup-config command. 3. Reset the device using the reset command. SYN cookies are now enabled on the device.

SYN attack notification


When the SYN cookies feature is enabled, the TGM550 Telephony Gateway Module alerts the administrator to a suspected SYN attack as it occurs by sending the following syslog message: SYN attack suspected! Number of unanswered SYN requests is greater than 20 in last 10 seconds.

48 IG550 Integrated Gateway Administration and CLI Reference

Special security features

Maintaining SYN cookies


Use the following commands to show and clear SYN cookies statistics:

Enter show tcp syn-cookies to show SYN cookies statistics. Note: For an example and explanation of SYN cookies statistics, see SYN-cookies on page 579.

Note:

Enter clear tcp syn-cookies counters to clear the SYN cookies counters.

Summary of SYN cookies configuration commands


For information about these commands, see SYN-cookies on page 579. Table 9: Master Configuration Key configuration commands Command clear tcp syn-cookies counters show tcp syn-cookies tcp syn-cookies Description Clear the SYN cookies counters Show SYN cookies statistics for inbound TCP connections Enable or disable the TCP SYN cookies defense mechanism against SYN attacks

Issue 2 January 2008

49

Accessing the TGM550 Telephony Gateway Module and the J-Series Router

50 IG550 Integrated Gateway Administration and CLI Reference

Chapter 3: Basic device configuration


Basic device configuration lets you:

Configure an MGC to work with the TGM550 Telephony Gateway Module Configure DNS resolver for resolving hostnames to IP addresses View the status of the TGM550 Telephony Gateway Module Manage and upgrade software, firmware, configuration, and other files on the TGM550 Telephony Gateway Module Backup and restore the TGM550 Telephony Gateway Module

Configuring the Server


You can use a server with Avaya Communication Manager software as an MGC. When the TGM550 Telephony Gateway Module uses an ECC, it can use a local S8300 as a backup controller for Enhanced Local Survivability (ELS). The S8300 functions in Local Survivable Processor (LSP) mode. If the ECC stops serving the TGM550 Telephony Gateway Module, the S8300 takes over the service. To register the TGM550 Telephony Gateway Module with a server, you need the TGM550 Telephony Gateway Modules serial number. You can find this serial number in either of the following ways:

Use the show system command Look for a 12-character string located on a label on the back panel of the TGM550 Telephony Gateway Module Table 10: Servers supported by the TGM550 Server Avaya S8300 Server Avaya S8400 Server Avaya S8500 Server Avaya S8700 Server* Avaya S8710 Server

Issue 2 January 2008

51

Basic device configuration

Table 10: Servers supported by the TGM550 (continued) Server Avaya S8720 Server Avaya S8730 Server
*. The S8700 cannot be upgraded to CM5.0

Survivability and migration options


Several options exist to minimize network disruption in the event that connectivity between the TGM550 Telephony Gateway Module and the server or media gateway controller (MGC) is lost.

MGC list. You must register the TGM550 Telephony Gateway Module with at least one, and up to four, MGCs. The first MGC on the list is the primary MGC. If the TGM550 Telephony Gateway Module cannot connect with, or loses its connection with, the primary MGC, it attempts to connect with the other MGCs on the list. See Configuring the MGC list on page 53. Note: When Standard Local Survivability (SLS) is enabled, the MGC list includes the SLS module as a fifth entry in the MGC list. For details about SLS, see Configuring Standard Local Survivability (SLS) on page 69.

Note:

Standard Local Survivability (SLS). SLS consists of a module built into the TGM550 Telephony Gateway Module to provide partial backup MGC functionality in the event that the connection with the primary MGC is lost. This feature allows a local TGM550 Telephony Gateway Module to provide a degree of MGC functionality when no link is available to an external MGC. It is configured on a system-wide basis using the Provisioning and Installation Manager (PIM) (see Accessing PIM on page 31). Alternatively, it can be configured on an individual TGM550 Telephony Gateway Module using the CLI. For more information and instructions on configuring SLS, see Configuring Standard Local Survivability (SLS) on page 69. Enhanced Local Survivability (ELS). ELS is available for the TGM550 using a local S8300 or S8500 functioning in LSP mode. If the primary MGC stops serving the TGM550 Telephony Gateway Module, the S8300 takes over the service. Auto fallback to primary MGC. This feature provides a means by which a TGM550 Telephony Gateway Module being serviced by its LSP can return to its primary MGC automatically when the connection is restored between the TGM550 Telephony Gateway Module and the MGC. By migrating the TGM550 Telephony Gateway Module to the MGC automatically, a fragmented network can be made whole faster, without the need for human intervention. Auto fallback is configured via the Avaya Communication Manager. For details, see the Administrator Guide for Avaya Communication Manager, 03-300509.

52 IG550 Integrated Gateway Administration and CLI Reference

Configuring the Server

Note:

Note: Auto fallback does not include survivability. Therefore, there is a short period during registration with the MGC during which calls are dropped and service is not available. This problem can be minimized using the connection preservation feature described below.

Connection preservation. This feature enables the TGM550 Telephony Gateway Module to preserve the bearer paths of stable calls in the event that the TGM550 Telephony Gateway Module migrates to another MGC (including an LSP), including migration back from an LSP to the primary MGC. A call for which the talk path between parties in the call has been established is considered stable. A call consisting of a user listening to announcements or music is not considered stable and is not preserved. Any change of state in the call prevents the call from being preserved. For example, putting a call on hold during MGC migration will cause the call to be dropped. Special features, such as conference and transfer, are not available on preserved calls. Connection preservation preserves all types of bearer connections except BRI. PRI trunk connections are also preserved. Connection preservation is configured via the Avaya Communication Manager. For details, see the Administrator Guide for Avaya Communication Manager, 03-300509.

Configuring the MGC list


The TGM550 Telephony Gateway Module must be registered with an MGC in order to provide telephone service. You can set the TGM550 Telephony Gateway Modules MGC, and show the current MGC list used to determine the results.

Setting the TGM550 Telephony Gateway Modules MGC


Use the set mgc list command to set the TGM550 Telephony Gateway Modules MGC. You can enter the IP addresses of up to four MGCs with the set mgc list command. The first MGC on the list is the primary MGC. The TGM550 Telephony Gateway Module searches for the primary MGC first. If it cannot connect to the primary MGC, it searches for the next MGC on the list, and so on. When SLS is enabled, the MGC list includes the SLS module as a fifth entry on the MGC list. For details about SLS, see Configuring Standard Local Survivability (SLS) on page 69.

Issue 2 January 2008

53

Basic device configuration

Note:

Note: If the MGC is an S8700-series server, the first server on the list will normally be the primary C-LAN board connected to the server. If the MGC is an S8400 or S8500, the first server on the list will be either the primary C-LAN board connected to the server, or an Ethernet port on the server that has been enabled for processor Ethernet connections. If the MGC is an S8300, the first server on the list will be the IP address of the S8300. The remaining servers will be either alternate C-LAN boards connected to the S8400, S8500, or S8700-series servers, or an S8300 configured as an LSP, or the port enabled as the Ethernet processor port on an S8500 configured as an LSP.

In the following example of the set mgc list command, if the MGC with the IP address 132.236.73.2 is available, that MGC becomes the TGM550 Telephony Gateway Modules MGC. If that server is not available, the TGM550 Telephony Gateway Module searches for the next MGC on the list, and so on.
TGM550-001(super)# set mgc list 132.236.73.2, 132.236.73.3, 132.236.73.4, 132.236.73.5 Done!

Determining results
To determine the result of the set mgc list command, use the show mgc command. This command has the following output:

Registered. Indicates whether or not the TGM550 Telephony Gateway Module is registered with an MGC (YES or NO) Active Controller. Displays the IP address of the active MGC. If there is no active MGC (that is, if the set mgc list command failed to configure an MGC), this field displays 255.255.255.255. H248 Link Status. Indicates whether the communication link between the TGM550 Telephony Gateway Module and the MGC is up or down H248 Link Error Code. If there is a communication failure between the TGM550 Telephony Gateway Module and the MGC, this field displays the error code

Showing the current MGC list


To show the current MGC list, use the show mgc list command. This command shows the IP addresses of the MGCs on the MGC list. It also shows whether or not SLS is enabled.

54 IG550 Integrated Gateway Administration and CLI Reference

Configuring the Server

Removing one or more MGCs


To remove one or more MGCs from the MGC list, use the clear mgc list command. Type the IP address of the MGC you want to remove as an argument to remove that MGC. You can remove more than one MGC with one command by typing the IP addresses of all the MGCs you want to remove, separated by commas. To remove all the MGCs on the list, enter clear mgc list with no arguments.

Changing the MGC list


1. Enter clear mgc list with no arguments to clear the MGC list. 2. Enter set mgc list with a different set of IP addresses. Note: If you use the set mgc list command without first clearing the MGC list, the TGM550 Telephony Gateway Module simply adds the new MGCs to the end of the MGC list.

Note:

Setting reset times


If the connection between the TGM550 Telephony Gateway Module and its registered MGC is lost, the TGM550 Telephony Gateway Module attempts to recover the connection. Use the set reset-times primary-search command and the set reset-times total-search command to set the timeout for the TGM550 Telephony Gateway Modules search for the primary MGC and the other MGCs on its MGC list, respectively. Use the set reset-times transition-point command to configure the point at which the primary MGCs in the list end and the LSPs begin. For example, if there are three IP addresses in the MGC list and the third address is the LSP, the transition point should be 2. The default time for the primary search is one minute. The default time for the total search is 30 minutes. The default transition point is 1. For example:
TGM550-001(super)# set reset-times primary-search 20 Done! TGM550-001(super)# set reset-times total-search 40 Done! TGM550-001(super)# set reset-times transition-point 1 Done!

In this example, in the event of a connection loss with the registered MGC, the TGM550 Telephony Gateway Module searches for the primary MGC on its MGC list for 20 minutes. If the TGM550 Telephony Gateway Module does not establish a connection with the primary MGC within this time, it searches for the other MGCs on the list for a total of 40 minutes.

Issue 2 January 2008

55

Basic device configuration

Use the show recovery command to display the reset times.

Accessing the registered MGC


Access the MGC according to the following: To access the TGM550s registered MGC directly from the TGM550 command line, perform the following steps: 1. Enter session mgc. The login prompt of the MGC appears. 2. Enter the login and password to the MGC. The MGC servers Linux prompt appears. 3. Enter sat to access the SAT interface. The login prompt of the SAT appears. 4. Enter the password for the SAT.

Summary of MGC list configuration commands


For information about these commands, see MGC (Media Gateway Controller) configuration on page 373. Table 11: MGC list configuration commands Command clear mgc list session set mediaserver set mgc list set reset-times Description Remove one or more MGCs from the MGC list Open a telnet connection to the MGC Set the MGC management address and ports Create a list of valid Media Gateway Controller(s) Set the timeout for the TGM550 Telephony Gateway Modules search for the primary MGC, or search for the other MGCs on the MGC list, or configure the point at which the primary MGCs in the list end and the LSPs begin Display MGC configuration information 1 of 2

show mediaserver

56 IG550 Integrated Gateway Administration and CLI Reference

Viewing the status of the device

Table 11: MGC list configuration commands (continued) Command show mgc show mgc list show recovery Description Display the state and setup parameters of the currently active MGC Display the IP addresses of the MGCs on the MGC list Show the media gateway connection recovery setup 2 of 2

Viewing the status of the device


To view the status of the TGM550 Telephony Gateway Module, use the following commands:

Enter show faults to view information about currently active faults. Use the show image version command to display the software version of the image on both memory banks of the device. Enter show mgc to view information about the Media Gateway Controller with which the TGM550 Telephony Gateway Module is registered. For more information, see Configuring the Server on page 51. Use the show mm command to view information about TIMs that are installed on the TGM550 Telephony Gateway Module. To view information about a specific TIM, include the slot number of the TIM as an argument. For example, to view information about the TIM in slot 2, enter show mm v2. The output of the command shows the following information: - Slot number - Uptime - Type of TIM - Description - Serial number and other hardware identification numbers - Firmware version - Number of ports - Fault messages

Issue 2 January 2008

57

Basic device configuration

Use the show module command or enter show mg list_config to view brief information about media modules that are installed in the TGM550 Telephony Gateway Module. To view brief information about a specific media module, include the slot number of the media module as an argument. For example, to view information about the media module in slot 2, enter show module v2. The output of the command shows the following information: - Slot number - Firmware version - Type of TIM - TIM code Enter show system to display the serial number of the TGM550 Telephony Gateway Module, the TGM550 Telephony Gateway Modules uptime, the firmware version number, MAC addresses, and other system information. Enter show restart-log to view information about the last time the TGM550 Telephony Gateway Module was reset. Use the show timeout command to display the amount of time in minutes the terminal remains idle before timing out. Use the show utilization command to display information about CPU and memory usage on the TGM550 Telephony Gateway Module. Note: Before using this command, you must first use the set utilization cpu command to enable CPU utilization measurements.

Note:

Enter test led to test the system ALM LED on the front panel of the TGM550 Telephony Gateway Module. The LED blinks for five seconds.

Summary of device status commands


For more information about these commands, see Device status on page 296. Table 12: Device status commands Command set utilization cpu show faults Description Enable CPU utilization measurements Display information about currently active faults 1 of 2

58 IG550 Integrated Gateway Administration and CLI Reference

Viewing the status of the device

Table 12: Device status commands (continued) Command show image version show mg list_config show mgc show mm show module show restart-log show system show temp show timeout show utilization show voltages test led Description Display the software version of the image on both memory banks of the device Display the current hardware and firmware configurations for the installed media gateway equipment Display information about the Media Gateway Controller with which the TGM550 Telephony Gateway Module is registered Display information about TIMs that are installed on the TGM550 Telephony Gateway Module Display brief information about the media modules installed in the TGM550 Telephony Gateway Module Display information about the last time the TGM550 Telephony Gateway Module was reset Display information about the TGM550 Telephony Gateway Module Display the device temperature Display the amount of time in minutes the terminal remains idle before timing out Display information about CPU and memory usage on the TGM550 Telephony Gateway Module Display power supply voltages Test the system ALM LED on the front panel of the TGM550 Telephony Gateway Module 2 of 2

Viewing voice channel availability and TIM status from the J-series router interface
To check the number of voice channels available on the TGM550 from the interface of the J-series router, use the command show tgm fpc <slot> dsp-capacity, where slot is the slot number of the TGM550. For example:
sidewinder> show tgm fpc 1 dsp-capacity DSP Capacity: 40 voice channels

Issue 2 January 2008

59

Basic device configuration

To show the status of the TIMs installed in the router, use the command show tgm telephony-interface-module status. For example:
sidewinder> show tgm telephony-interface-module status Slot State Offline Reason 1 Offline Busy out 2 Online 5 Online 6 Online

Software and firmware management

You can manage TGM550 Telephony Gateway Module software and firmware remotely, using an FTP, TFTP, or SCP server

File transfer
The TGM550 Telephony Gateway Module can be a client for the FTP and TFTP protocols. Use either a USB device or the FTP or TFTP protocols to transfer files between the TGM550 Telephony Gateway Module and other devices. You can use file transfer to:

Install software and firmware upgrades on the TGM550 Telephony Gateway Module Back up and restore configuration settings

To use FTP/TFTP file transfer, you need to have an FTP server or TFTP server on your network. Note: If you use an FTP server, the TGM550 Telephony Gateway Module prompts you for a username and password when you enter a command to transfer a file. Also, when opening an FTP connection to the S8300, all anonymous FTP file transfers are restricted to the /pub directory. Permission for anonymous FTP users to create files in other directories is denied.

Note:

60 IG550 Integrated Gateway Administration and CLI Reference

Software and firmware management

Software and firmware upgrades


You can upgrade software on the TGM550 Telephony Gateway Module. Software used to control the TGM550 Telephony Gateway Module itself and media modules installed on the TGM550 Telephony Gateway Module is called firmware. Use a USB device or the FTP or TFTP protocol to download a new version of software or firmware. You can upgrade the following types of software and firmware:

Firmware for the TGM550 Telephony Gateway Module Note: You can also use the TGM550 Telephony Gateway Module to upgrade the firmware and configuration files for IP phones. For details, see Installing and Configuring the Avaya IG550 Integrated Gateway.

Note:

Managing the firmware banks


The TGM550 Telephony Gateway Module has two firmware banks:

Bank A Bank B

Each firmware bank contains a version of the TGM550 Telephony Gateway Module firmware. These may be different versions. The purpose of this feature is to provide software redundancy. If one of the versions becomes corrupted, you can reset the TGM550 Telephony Gateway Module using the other version. This is particularly important when downloading new versions.

Displaying firmware versions in the banks


Use the show image version command to display the firmware version of the image on both memory banks of the device.

Changing the default bank


By default, when you turn on or reset the TGM550 Telephony Gateway Module, the TGM550 Telephony Gateway Module loads firmware from Bank B. To change the default bank from which firmware is loaded during startup, use the set boot bank command. For example, to configure the TGM550 Telephony Gateway Module to load firmware from Bank A on startup, enter set boot bank bank-A. Now, when you reset the TGM550 Telephony Gateway Module, it will load firmware from Bank A. To display the bank from which the TGM550 Telephony Gateway Module is currently set to load its firmware upon startup or reset, use the show boot bank command.

Issue 2 January 2008

61

Basic device configuration

Loading firmware from the non-default bank


You can use the ASB button on the TGM550 Telephony Gateway Module front panel to load firmware from a bank other than the default bank during startup: 1. Press and hold the reset button. 2. Press and hold the ASB button. 3. Release the reset button. 4. Release the ASB button. For example, if the TGM550 Telephony Gateway Module is configured to load firmware from Bank B, use the steps listed above to reset the TGM550 Telephony Gateway Module to load the firmware from Bank A instead.

Upgrading software and firmware using FTP/TFTP


To upgrade software or firmware, you must obtain an upgrade file from Avaya. Place the file on your FTP or TFTP server. Then, use one of the following commands to upload the file to the TGM550 Telephony Gateway Module. For each of these commands, include the full path of the file and the IP address of the FTP or TFTP host as parameters. When you enter the command, the CLI prompts you for a username and password.

Use the copy ftp module command, followed by the module number of the module you want to upgrade, to upgrade the firmware on a media module from an FTP server. Use the copy ftp SW_imageA command to upgrade the TGM550 Telephony Gateway Module firmware into Bank A from an FTP server. Use the copy ftp SW_imageB command to upgrade the TGM550 Telephony Gateway Module firmware into Bank B from an FTP server. Use the copy tftp SW_imageA command to upgrade the TGM550 Telephony Gateway Module firmware into Bank A from a TFTP server. Use the copy tftp SW_imageB command to upgrade the TGM550 Telephony Gateway Module firmware into Bank B from a TFTP server. Note: When downloading firmware from the S8300, use only the file name, without the directory path, in the command line. Otherwise, the procedure will fail. For instance, in the example above, you must use the following command:
copy tftp

Note:

tgm550.net 192.1.1.10 2

When downloading firmware from the S8300 using TFTP, you may need to enable the TFTP service in the Set LAN Security parameters of your web server.

62 IG550 Integrated Gateway Administration and CLI Reference

Software and firmware management

The following example downloads a firmware version with the path and file name C:\tgm550.net from an FTP server with the IP address 149.49.134.153 to Bank A of the TGM550:
copy ftp SW_imageA C:\tgm550.net 149.49.134.153

Uploading software and firmware from the gateway


Copying files to an FTP/SCP/TFTP server

Use the copy file ftp command to upload a specific file from the gateway to an FTP server, where file can be any of the following:

SW_imageA | SW_imageB. Software image files announcement-file. Announcements files auth-file. Authentication file sys-log-file. The system log file cdr-file. A Call Detail Recording (CDR) file

Use the copy file scp command to upload a specific file from the gateway to an SCP server, where file can be any of the following:

SW_imageA | SW_imageB. Software image files announcement-file. Announcements files auth-file. Authentication file sys-log-file. The system log file cdr-file. A Call Detail Recording (CDR) file

Use the copy file tftp command to upload a specific file from the gateway to a TFTP server, where file can be any of the following:

SW_imageA | SW_imageB. Software image files auth-file. Authentication file sys-log-file. The system log file cdr-file. A Call Detail Recording (CDR) file

Issue 2 January 2008

63

Basic device configuration

Summary of software and firmware management commands


For more information about these commands, see Device status on page 296. Table 13: Software and firmware management CLI commands Command copy file ftp copy file scp copy file tftp copy ftp module copy ftp SW_imageA copy ftp SW_imageB copy tftp SW_imageA copy tftp SW_imageB set boot bank show boot bank Description Upload a specific file from the gateway to an FTP server Upload a specific file from the gateway to an SCP server Upload a specific file from the gateway to a TFTP server Upgrade the firmware on a media module from an FTP server Upgrade the TGM550 Telephony Gateway Module firmware into Bank A from an FTP server Upgrade the TGM550 Telephony Gateway Module firmware into Bank B from an FTP server Upgrade the TGM550 Telephony Gateway Module firmware into Bank A from a TFTP server Upgrade the TGM550 Telephony Gateway Module firmware into Bank B from a TFTP server Set the default bank from which firmware is loaded during startup Display the bank from which the TGM550 Telephony Gateway Module is currently set to load its firmware upon startup or reset Display the status of the firmware download process Display the firmware version of the image on both memory banks of the device

show download software status show image version

64 IG550 Integrated Gateway Administration and CLI Reference

Software and firmware management

Backing up and restoring configuration files


A configuration file is a data file that contains a complete set of configuration settings for the TGM550 Telephony Gateway Module. You can use configuration files to back up and restore the configuration of the TGM550 Telephony Gateway Module. You can back up either the running configuration or the startup configuration to the server as a configuration file. When you restore a configuration file from a server, it becomes the startup configuration on the TGM550 Telephony Gateway Module. For more information about running configuration and startup configuration, see Saving configuration changes on page 25. Note: The startup configuration file stores gateway secrets (passwords, etc.) in an encrypted format. Thus, secrets do not have to be re-entered if you are copying a configuration file from one TGM550 Telephony Gateway Module to another. For more information, see Managing gateway secrets on page 46.

Note:

Use the FTP/TFTP/SCP protocol to transfer a configuration file between the TGM550 Telephony Gateway Module and a server on the network.

Backing up/restoring a configuration file using FTP/TFTP/SCP

Use the copy ftp startup-config command to restore a configuration file from an FTP server. The configuration file becomes the startup configuration on the TGM550 Telephony Gateway Module. Use the copy tftp startup-config command to restore a configuration file from a TFTP server. The configuration file becomes the startup configuration on the TGM550 Telephony Gateway Module. Use the copy scp startup-config command to restore a configuration file from an SCP server. The configuration file becomes the startup configuration on the TGM550 Telephony Gateway Module. Note: You can use the show download status command to display the status of the current configuration file download process, as the file is being loaded into the device.

Note:

Use the copy running-config ftp command to back up the running configuration on the TGM550 Telephony Gateway Module to an FTP server. Use the copy running-config tftp command to back up the running configuration on the TGM550 Telephony Gateway Module to a TFTP server. Use the copy running-config scp command to back up the running configuration on the TGM550 Telephony Gateway Module to a SCP server. Use the copy startup-config ftp command to back up the startup configuration on the TGM550 Telephony Gateway Module to an FTP server.

Issue 2 January 2008

65

Basic device configuration

Use the copy startup-config tftp command to back up the startup configuration on the TGM550 Telephony Gateway Module to a TFTP server. Use the copy startup-config scp command to back up the startup configuration on the TGM550 Telephony Gateway Module to a SCP server.

Summary of configuration file backup and restore commands


For more information about these commands, see Backing up on page 258 and Restoring gateway configuration on page 401. Table 14: Configuration file backup and restore CLI commands Command copy ftp startup-config copy scp startup-config copy tftpstartup-config copy running-config ftp copy running-config scp copy running-config tftp copy startup-config ftp copy startup-config scp copy startup-config tftp show download status Description Download a TGM550 Telephony Gateway Module configuration file from an FTP server to the Startup Configuration NVRAM Download a TGM550 Telephony Gateway Module configuration from an SCP server to the Startup Configuration NVRAM Download a TGM550 Telephony Gateway Module configuration file from a TFTP server to the Startup Configuration NVRAM Upload the current TGM550 Telephony Gateway Module running configuration to a file on an FTP server Upload the current TGM550 Telephony Gateway Module running configuration to a file on an SCP server Upload the current TGM550 Telephony Gateway Module running configuration to a file on a TFTP server Upload the current TGM550 Telephony Gateway Module startup configuration to a file on an FTP server Upload the current TGM550 Telephony Gateway Module startup configuration to a file on a SCP server Upload the current TGM550 Telephony Gateway Module startup configuration to a file on a TFTP server Display the status of the current TGM550 Telephony Gateway Module configuration file download process, as the file is being loaded into the device

66 IG550 Integrated Gateway Administration and CLI Reference

Software and firmware management

Listing the files on the TGM550 Telephony Gateway Module


Use the dir command to list all TGM550 Telephony Gateway Module files. When you list the files, you can see the version numbers of the software components. The dir command also shows the booter file, which cannot be changed.

Summary of file listing commands


Table 15: File listing CLI commands Command dir Description List all TGM550 Telephony Gateway Module files

Issue 2 January 2008

67

Basic device configuration

68 IG550 Integrated Gateway Administration and CLI Reference

Chapter 4: Configuring Standard Local Survivability (SLS)


Standard Local Survivability (SLS) provides a local TGM550 Telephony Gateway Module with a limited subset of MGC functionality when there is no IP-routed WAN link available to an MGC, or no MGC is available. SLS is not a replacement for LSP survivability, which offers full call-feature functionality and full translations in the survivable mode. Instead, SLS is a cost-effective survivability alternative offering limited call processing in survivable mode. In contrast to the server-based survivability features, SLS operates entirely from the media gateway and requires a data set comprised of Avaya Communication Manager translations (survivable ARS analysis and configuration data). This data set is compiled and distributed to a group of devices using the Provisioning and Installation Manager (PIM). In the absence of the PIM, the data set can be configured manually from individual media gateways using CLI commands. For instructions on configuring SLS, see Configuring SLS on page 82.

SLS service

Call capability for analog and IP phones ISDN BRI/PRI trunk interfaces Non-ISDN digital DS1 trunk interfaces Outbound dialing through the local PSTN (local trunk gateway) from analog and IP phones Inbound calls from each trunk to pre-configured local analog or IP phones that have registered Direct inward dialing Multiple call appearances Hold and call transfer functions Local call progress tones (dial tone, busy, etc.) Emergency Transfer Relay (ETR) in cases of power loss Auto fallback to primary MGC IP station registration

Issue 2 January 2008

69

Configuring Standard Local Survivability (SLS)

Avaya phones supported in SLS


Table 16: Avaya phones supported in SLS Analog 2500 IP 4601 4602 4602sw 4610sw 4612 4620 4620sw 4621 4622 4624 4625 The new Avaya 96xx IP phone family is not directly referenced in the TGM550 Telephony Gateway Module CLI. When you administer these phones via the CLI, use the following mapping: Table 17: Mapping Avaya 96xx IP phones for CLI administration Module name 9610 9620 9630 9640 9650 CLI interface name 4606 4610 4620 4620 4620

70 IG550 Integrated Gateway Administration and CLI Reference

Call processing in SLS mode


In survivable mode, SLS provides only a limited subset of Avaya Communication Manager call processing functionality:

Limited call routing through a Survivable ARS Analysis Table (in the PIM application or through the CLI) and COR calling permissions Inbound calls are directed in one of three ways: - Using the Incoming-Routing form - Using the Set Incoming-Destination on the Trunk group form, which enables mapping to a given station - Inbound calls are directed to a previously-administered pool of available stations (the Survivable Trunk Dest? field is y on the Station form). The search algorithm is circular so that the incoming calls are fairly distributed.

!
Important:

Important: SLS permits 911 calls, but the specific location information is not transmitted to the Public Service Answering Point (PSAP). Only the general trunk-identifying information is transmitted. Emergency personnel will have a general location associated with the trunk (for example, a building address), but nothing more specific (for example, a room or office number). Also, if a 911 call disconnects for any reason, emergency personnel cannot reliably call the originator back. A small business offices address is sufficient from the perspective of emergency routing.

Communication Manager Feature Access Codes for ARS and Hold Acts as an H.323 Gatekeeper that enables IP endpoints to register simultaneously Direct Inward Dialing Multiple call appearances Hold and Call Transfer functions Call Detail Recording (CDR, see SLS logging activities on page 81) Trunk Access Code (TAC) dialing Non-ISDN DS1 trunks (with in-band signaling) ISDN PRI/BRI trunks: - T1 robbed-bit. All 24 channels serve as trunks without full 64 kbps transmission - E1 CAS. All 31 channels serve as trunks with full 64 kbps transmission

Issue 2 January 2008

71

Configuring Standard Local Survivability (SLS)

Call processing not supported by SLS

Many small business customers employ custom calling features such as call waiting, from the BOC/LEC, attempting a more PBX-like capability. These features are not supported by SLS. Non-ISDN signaling: - DMI BOS signaling for T1 and E1 - R2-MFC signaling for E1 Calling party name/number information to digital station displays Caller ID on outgoing analog station calls Caller ID on incoming analog loop-start trunk calls Three party conferences Last Number Redial Call Forwarding-Busy/Dont Answer No Music On Hold source or announcement playback Call Center features, including ASAI Connection Preserving Failover/Failback for H.248 Gateways

Provisioning data
SLS requires that the TGM550 Telephony Gateway Module has connected to an MGC at least once and has received provisioning information, including:

Avaya Communication Manager port information sent through the H.248 control channel: - Tone sources, including a distinctly different dial tone to inform users that the system is operating in survivable mode - Loss plan Avaya Communication Manager provisioning information for the options in the station and trunk media modules is sent through the CCMS channel Provisioning and Installation Manager (PIM) queries Avaya Communication Manager for station/trunk configuration and dial plan routing administration data through SNMP. Alternatively, the provisioning may be entered manually via an SNMP MIB browser or via the local gateways CLI interface.

These data sources and communication links are illustrated in Figure 1.

72 IG550 Integrated Gateway Administration and CLI Reference

Figure 1: Standard Local Survivability data sources and communication paths


H.248 Control Link

Communication Manager

1 2 3 IP

H.248 Control Channel CCMS Channel MGM Channel

Gateway CLI

6 4 Provisioning and Installation Manager (PIM) 7 5

Communication Manager Translations

cydscomm LAO 071106

Figure notes: 1. H.248 call signaling and configuration data 2. CCMS messages through Clear Channel 3. Media Gateway Maintenance Channel 4. PIM extracts Communication Manager translation subset through OSSI NOTE: The SLS data must be configured manually in the gateway if the PIM is not available. 5. PIM data set and SLS MIB delivered to the gateway through SNMP 6. Security codes (passwords) sent over SSH connection to CLI 7. Provisioning and Installation Manager (PIM) for remotely provisioning gateways, network-wide. PIM is installed on an enterprise management server, not on the primary Communication Manager server.

The required Communication Manager translations for SLS include fields on the Station and Media Gateway forms. See Configuring Communication Manager for SLS on page 83 for more information about the information types and how to administer Communication Manager for SLS.

PIM configuration data


SLS also requires PIM configuration data, some of which the TGM550 Telephony Gateway Module extracts from the Avaya Communication Manager translations. PIM aggregates the required data and copies the provisioning data over a secure communication path to non-volatile RAM (NVRAM) on the TGM550 Telephony Gateway Module. After the initial data collection, PIM retains a copy of the data set for each TGM550 Telephony Gateway Module. This set is compared with subsequent data sets to determine if anything has changed:

If the data set changes, the newer data set is pushed down to the media gateway If the data set does not change, the data set in NVRAM remains unchanged

Issue 2 January 2008

73

Configuring Standard Local Survivability (SLS)

Users can schedule when to collect and push data, perform scheduled and manual backups, and enable and disable SLS, as well as display (but not change) the data to ensure correct information. See Using PIM to manage SLS administration on the gateway on page 88. If PIM is unavailable, the SLS data set can be manually configured in the TGM550 Telephony Gateway Module CLI. For information on configuring SLS, both manually and via PIM, see Configuring SLS on page 82.

Entering SLS mode


When SLS is enabled, the MGC list displays a fifth element called SLS. This element is always past the Transition Point. After the Link Recovery search concludes for the primary MGC list (entries above the Transition Point), it searches the alternate MGC list (entries below the Transition Point), ending with SLS, the last choice for the TGM550 Telephony Gateway Module. When the Link Recovery search settles on the SLS entry in the MGC list, the TGM550 Telephony Gateway Module registers with SLS (resident on the TGM550 Telephony Gateway Module) for its call control. SLS transitions between four possible SLS states: Unregistered, Setup, Registered, and Teardown.

Unregistered state
This is the normal state in which SLS waits for an H.248 registration request from the TGM550 Telephony Gateway Module. When SLS receives the request, it registers the TGM550 Telephony Gateway Module and transitions to the Setup state.

Setup state
In this transitional state, SLS performs the following activities: 1. Checks for proper provisioning data. If there is insufficient provisioning, the registration request is denied, and SLS returns to the Unregistered state. 2. Initializes SLS components, such as gatekeeper data (for example, IP endpoints E.164 addresses and passwords), dial plan, and ARS routing. 3. Registers with the media gateway. 4. Creates the H.323 Gatekeeper socket after successful registration. When Setup is complete, SLS transitions to the Registered state.

74 IG550 Integrated Gateway Administration and CLI Reference

Registered state
SLS can only process calls while it is in the Registered state in which it performs the following: 1. Constructs endpoint objects based on board insertion and IP registration. 2. Tears down endpoint objects based on board removal and IP unregistration. 3. Handles registration requests from H.323 endpoints that properly authenticate by using their extension number as a 'terminal alias', and the password as the registration encryption key. 4. Handles stimuli from all interfaces to establish and remove calls. SLS remains in the Registered state as long as the socket to SLS is open.

Teardown
SLS transitions to the Teardown state whenever the following occur:

The TGM550 Telephony Gateway Module administrator uses the set sls disable command from the CLI or manual MIB browser using the SNMP read/write attribute avSurvAdminState. The TGM550 Telephony Gateway Module closes the SLS socket after maintenance determines that it has completed an H.248 registration with the primary MGC. SLS determines that it needs to unregister with the TGM550 Telephony Gateway Module due to internal error conditions.

Teardown state activities


1. Tears down endpoint objects. 2. Sends unregistration requests to IP endpoints that are not on active calls. IP endpoints lose registration with SLS and display the discovered IP address during re-registration with an MGC. 3. Closes the H.323 Gatekeeper socket. After Teardown is complete, SLS transitions to the Unregistered state and starts searching at the top of the MGC list for a controller.

SLS interaction with specific TGM550 Telephony Gateway Module features


SLS interacts differently with the various TGM550 Telephony Gateway Module features.

Issue 2 January 2008

75

Configuring Standard Local Survivability (SLS)

Direct Inward Dialing in SLS mode


Direct Inward Dial (DID) is a service offered by telephone companies that enables callers to dial directly into an extension on a PBX without the assistance of an operator or automated call attendant. Note: DID is a method of routing calls that applies to both analog and digital (T1/E1) lines. However, while the method is typically referred to as DID in the analog world, it is usually called Dialed Number Identification Service (DNIS) in the digital world. Despite the difference in names, the concept is the same.

Note:

The gateways support DID central office trunk interfaces, and the digit transmission from the central office is configurable when ordering the service:

Immediate. The DID signaling starts immediately after the central office seizes the analog DID trunk by closing the loop (across tip and ring). In addition, analog DID trunk lines only support inbound calls. For this reason, Customer Premise Equipment (CPE) utilizing DID trunk lines for inbound routing may utilize loop-start lines for outbound transmission. Wink. The DID signaling starts after the gateways analog trunk interface reverses the battery polarity and sends a wink to the central office.

!
WARNING:

WARNING: An analog two-wire DID trunk line is different from a standard analog loop-start line. With analog DID trunk lines, the battery (power feed) to the line is supplied by the gateways analog trunk interface. With a standard loop-start line, the power is supplied by the central office, which is why damage can occur from connecting a loop-start PSTN trunk to the DID port.

The number of sent digits (3-4 typically) and signaling type (Pulse/DTMF) are also configurable at ordering time.

Multiple call appearances in SLS mode


When a gateway is in SLS mode, three call appearances, each with limitations, are supported:

The first two call appearances are for incoming or outgoing calls. The first call appearance is the default. The third call appearance is for outgoing calls only. Note: First", "second", and "third", refer to the order in which you use call appearances, not the order of the Call Appearance buttons on your phone.

Note:

For example, User A chooses the third call appearance to dial User B, and then User C calls User A, which is sent to the first call appearance. In this situation, a subsequent inbound call to User A will be denied (busy) because the first and third call appearances are in use, and the second call appearance is only available for outbound calls.

76 IG550 Integrated Gateway Administration and CLI Reference

Hold in SLS mode


Using the Hold feature differs by user and by phone type, and the same is true of the Hold feature in Standard Local Survivability (SLS) mode. Some users return to a call on Hold by pressing the Call Appearance button, however, Communication Manager has an administrable parameter that allows users to release a call on hold by pressing the Hold button a second time (if only one call is held). The Hold feature also works differently in IP phones and Analog phones in the survivable mode. The Hold feature in SLS does not support:

Music on Hold Local mute on analog phones Specialized treatment of E-911 calls Call Hold indicator tones

IP phones
When a media gateway is in the survivable mode, you can release calls on Hold on all IP phones by either:

Pressing the Hold button a second time (if only one call is held) Pressing the held Call Appearance button

Analog phones
Newer analog phones (for example, Avaya 62xx series) have buttons with specific functions for placing a call on Hold:

Hold button. A hold function that is local to the phone Pressing the Hold button causes the analog station to place a hold bridge in both directions at the telephone set. No signaling notification is sent to the SLS call-engine and, therefore, there is no ability to notify the other party that they have been placed on hold. Pressing the Hold button a second time causes the analog phone to remove the hold bridge and the call path is restored. In essence, this hold operation is equivalent to using the Mute button on station sets.

Flash button. A function that sends a switchhook signal to the server Switchhook (receiver on/off hook). A function that sends a disconnect signal to the server

Using the Flash button 1. Press the Flash button on the analog phone. You hear a dial tone; the other party hears nothing. You can leave the call on Hold or transfer the call. Press the Flash button twice to return to the call. 2. Dial the Feature Access Code (FAC) for Hold. At this point you can leave the call on Hold or transfer the call.

Issue 2 January 2008

77

Configuring Standard Local Survivability (SLS)

3. To return to the call, press the Flash button again. The call is re-established. Note: Either party can put the call on Hold or return to the call.

Note:

Using the switchhook button 1. Press the switchhook once. You hear a dial tone. 2. Dial the FAC for Hold. This places the call on Hard Hold which prevents you from transferring the call. To return to the call, dial the FAC for Hold. 3. Do one of the following:

Return to the call by dialing the FAC for Hold. The call is re-established.

Dial a third party by dialing the number and flashing the switchhook once (you will hear a stutter dial tone). Dial the FAC for Hold (the second call is now on Hold and the first call is re-established). If you want to toggle between the first and second calls, press the switchhook and dial the FAC for Hold once each time you want to change calls. Hang up. Your phone will ring to notify you that you have a call on Hold. When you lift the receiver you will hear a dial tone and can perform any of the activities listed in Step 3.

Call Transfer in SLS mode


Using the Call Transfer feature differs by user and by phone type. The same is true of the Hold feature in Standard Local Survivability (SLS) mode. Call Transfer also works differently in IP phones and analog phones in the survivable mode. Some limitations of the Call Transfer feature are:

The established call must be initiated from a local station (administered on this gateway) or from an incoming trunk. You can make only point-to-point call transfers to a phone that is local to the same gateway. Does not support E-911 calls Does not support the Conference button on any phone Does not support trunk-to-trunk transfer (for example, for voice messaging)

78 IG550 Integrated Gateway Administration and CLI Reference

Transferring a call on IP phones


1. While talking on a call or while you have a call on Hold, press the Transfer button on your phone. You hear a dial tone; the other party hears nothing. 2. Dial the third partys number on your phone. 3. You can either:

Wait for the third party to answer and announce the call, then either press the Transfer button again or hang up. Transfer the call before the third party answers by pressing the Transfer button again.

The person you were talking to is transferred to the third party. A message appears on your phone display to indicate that the call transfer is complete. Note: If you do not completely dial the string or if you hear a fast-busy or re-order (French siren) tone, only a Hard Hold call connection (if present) remains at the station. If the third party does not answer, the call does not ring back to the originating party. If a transfer does not complete, the event is logged.

Note:

Transferring an established call from an analog phone


Newer analog phones (for example, Avaya 62xx series) have buttons with specific functions for transferring a call. The switchhook (receiver on/off hook) sends a disconnect signal to the server, and the Transfer/Flash button sends a transfer message to the server. 1. While on a call, press the switchhook once or press the Transfer/Flash button. You hear a dial tone; the other party will hear nothing. 2. Dial the third partys number on your phone. 3. You can either:

Wait for the third party to answer and announce the call, then hang up. Transfer the call before the third party answers by hanging up.

The person you were talking to is transferred to the third party. A message appears on your phone display to indicate that the call transfer is complete. If the necessary call processing resources are not available, the transfer does not complete and the event is logged. Note: Displays are not supported on analog phones unless they are supported locally by an analog phone.

Note:

Issue 2 January 2008

79

Configuring Standard Local Survivability (SLS)

IP Softphone shared administrative identity in SLS mode


The SLS mode supports shared administrative identity with the Avaya Softphone application, but requires specific station administration. 1. Access the CM administrative SAT interface. For instructions on accessing the Avaya Communication Manager through the TGM550 Telephony Gateway Module, see Accessing the registered MGC on page 56. 2. At the SAT interface, enter change station extension to display the Station form. 3. Set the Terminal Type field to a 46xx IP phone. 4. Save the changes.

Emergency Transfer in SLS mode


Emergency Transfer Relay (ETR) on the gateway connects or "latches" an analog loop-start CO trunk port to an analog station port, allowing the user to access the PSTN for emergency calls in these conditions:

Power outage Loss of controller, including SLS, dropping calls on either the trunk port or the station port. Once the gateway registers with SLS, ETR unlatches. set etr CLI command can set ETR to: - auto, meaning that the ETR ports are connected if no controller is active. - on, meaning that the connection is always present. - off, meaning that the connection is never made. However, if there was a connection and ETR is set to off, the call stays up until it is disconnected, normally making the ETR ports available.

The Emergency Transfer closes the tip/ring contacts for the ports listed in Table 18. Table 18: Emergency Transfer trunk-to-port latching Model J2320/J2350/ J4350/J6350 Analog loop start trunks TGM550, port 2 Analog station ports TGM550, port 3

80 IG550 Integrated Gateway Administration and CLI Reference

If SLS is disabled, then the ETR remains latched unless the media gateway registers with a Communication Manager server or the state is changed through a CLI command or through the SNMP interface with a manual MIB browser. There can only be one ETR call, so upon registering with a server, the gateway ports are polled to determine if an ETR call is active. If there are none, the ETR disengages, and the ports are returned to normal service. Otherwise, the gateway remains in Emergency Transfer mode until the ports are idle. If the gateway is still in ETR mode after the gateway registers with a new server, Communication Manager maintenance must busy out the ports until it receives notification that the ports are idle and available for use.

SLS logging activities


SLS exports call-recording data in survivability mode. The Call Detail Record (CDR) log contains detailed information about each outgoing call that uses a trunk. This information can be stored in flash NVRAM or directed to an external server for later processing. It includes data for:

Merged outgoing Trunk Access Codes (TACs), indicating successfully completed dialing Successfully completed ARS calls, as shown in Figure 2

Example of CDR log entries and format


Figure 2: CDR log example
TGM550-SLS(super)# show logging cdr file content 02/18/2005,10:46:35:CDR-Informational: 10:46 00:00 A 700 50029555 52001 v301 02/18/2005,10:45:46:CDR-Informational: 10:45 00:00 A 700 50029 52001 v301 02/18/2005,10:45:14:CDR-Informational: 10:45 00:00 A 700 52 52001 v301 02/18/2005,10:44:35:CDR-Informational: 10:44 00:00 A 700 445200 52001 v301 02/10/2005,13:20:23:CDR-Informational: 13:20 00:00 A 700 50029 52001 v301 02/10/2005,13:20:15:CDR-Informational: 13:20 00:00 A 700 50029 52000 v301 02/10/2005,13:20:05:CDR-Informational: 13:20 00:00 A 700 44 52000 v301 02/10/2005,13:19:59:CDR-Informational: 13:19 00:00 A 700 44500 52000 v301

An interpretation of the first entry in Figure 2 is:


02/18/2005 is the date of the log entry 10:46:35 is the time of the log entry

Issue 2 January 2008

81

Configuring Standard Local Survivability (SLS)

CDR-Informational is the category (to aid sorting) 10:46 is the time the call was placed 00:00 is the duration of the call in hours and minutes or 99:99 if the duration is greater than 99 hours A is the condition code. Possible values are: - 7. Outgoing call - 9. Incoming call - A. Outgoing TAC call or emergency call 700 is the FAC or TAC number 50029555 is the dialed number 52001 is the extension that originated the call v301 indicates the port through which the call was routed

Configuring SLS
SLS is included as part of the resident gateway firmware package that is installed as part of the TGM550 Telephony Gateway Module gateway firmware upgrade. However, for SLS to function correctly, the following conditions must be met:

Avaya Communication Manager must be configured for SLS and Auto Fallback. For instructions on configuring SLS in Avaya Communication Manager, see Configuring Communication Manager for SLS on page 83. Provisioning data from the PIM tool must be gathered from Avaya Communication Manager and delivered to the TGM550 Telephony Gateway Module using PIM. For instructions on gathering and delivering the provisioning data, see Using PIM to manage SLS administration on the gateway on page 88. If PIM is not available, the TGM550 Telephony Gateway Module can be manually configured for SLS and Auto Fallback via the CLI. See Using the CLI to manually configure SLS administration on the gateway on page 94. SLS must be enabled on the TGM550 Telephony Gateway Module. See Enabling and disabling SLS on page 93. To activate any saved changes within SLS, the disable and enable SLS commands must be used together. See Activating changes in SLS on page 94.

82 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Note:

Note: Exercise caution when using a CLI session and an SNMP manual browser session concurrently. Specifically, if the administrator has entered as SLS second level context for trunk-group to view command settings, then performs an SNMP write operation to change a give attribute, this will get overwritten back with the present CLI values in the process of exiting the second level CLI command area for trunk-group. It is recommended that a single admin interface be used for a given administration parameter update session.

Configuring Communication Manager for SLS


You must configure the Avaya Communication Manager for SLS whether you will be using PIM provisioning or manual CLI entry of SLS administration. Perform the configuration during the initial administration of the host CM server. 1. Access the CM administrative SAT interface. For instructions on accessing the Avaya Communication Manager through the TGM550 Telephony Gateway Module, see Accessing the registered MGC on page 56. 2. At the SAT, enter change node-names ip to display the IP Node Names form. For example:
change node-names ip Page 1 of 1 IP NODE NAMES Name IP Address Name IP Address Denver Gateway1 192.168.1 .200 . . . procr 192.168.1 .201 . . . (X of X administered node-names were displayed ) Use 'list node-names' command to see all the administered node-names Use 'change node-names ip xxx' to change a node-name 'xxx' or add a node-name

3. In the Name field, type the gateway name; that is, the name of the survivable gatekeeper node that corresponds to the IP address in Step 4. Note: Set the name of the media gateway consistently with the Name field on the Media Gateway Administration form in Communication Manager (add media-gateway). 4. Type the IP address of the gateway in the IP Address field. 5. Submit the form.

Note:

Issue 2 January 2008

83

Configuring Standard Local Survivability (SLS)

6. At the SAT, enter change system-parameters mg-recovery-rule 1 to display the System Parameters Media Gateway Automatic Recovery Rule form. For example:
change system-parameters mg-recovery-rule 1 Page 1 of 1 SYSTEM PARAMETERS MEDIA GATEWAY AUTOMATIC RECOVERY RULE Recovery Rule Number: 1 Rule Name: _____________ Migrate H.248 MG to primary: immediately Minimum time of network stability: 3 WARNING: The MG shall be migrated at the first possible opportunity. The MG may be migrated with a number of active calls. These calls shall have their talk paths preserved, but no additional processing of features shall be honored. The user must hang up in order to regain access to all features.

NOTE: set 'Migrate H.248 MG to primary' to Blank to disable rule.

7. Type a description of the rule in the Rule Name field. 8. Set the Migrate H.248 MG to primary field to immediately. Note: The immediately field value is only one of the four possible choices. See the Administrator Guide for Avaya Communication Manager, 03-300509 for more information on the values for this field. 9. Submit the form.

Note:

84 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

10. At the SAT, enter change media-gateway 1 to display the Media Gateway form. For example:
change media-gateway 1 MEDIA GATEWAY Number: Type: Name: Serial No: Encrypt Link? Network Region: Location: Recovery Rule: Slot V1: V2: V3: V4: V5: V6: 1 j4350 Swainsons 012X06230551 y 1 1 1 Registered: y FW Version/HW Vintage: 21.13.0 /0 MGP IP Address: 135.9.41.150 Controller IP Address: 135.9.41.146 MAC Address: Site Data: DSP Type FW/HW Version DAR1 1 0 Page 1 of 1

Module Type TGM550 TIM514 TIM510 TIM521

Name ANA MM ANA MM DS1 MM BRI MM

Max Survivable IP Ext: 8 V9:

11. Verify the following fields:

Name field (20 characters maximum) must match the administered name of the gateway (see Step 2 of Configuring the SLS data through the CLI on page 107). Max Survivable IP Ext field only appears when the Type field is J2320, J2350, J4350 or J6350. The current maximum product limit enforced by the SLS gateways firmware module is 100.

These limits are enforced due to resource considerations in the given gateway.

!
Important:

Important: Since the VoIP resources on the gateway are limited, the Max Survivable IP Ext field should not exceed these values.

Issue 2 January 2008

85

Configuring Standard Local Survivability (SLS)

12. At the SAT, enter change station extension to display the Station form. For example:
change station 8003 STATION Extension: 8003 Type: 4620 Port: IP Name: Lock Messages? n Security Code: Coverage Path 1: Coverage Path 2: Hunt-to Station: BCC: TN: COR: COS: 1 1 1 1 Page 1 of 4

STATION OPTIONS Loss Group: 19 Speakerphone: 2-way Display Language? English Survivable GK Node Name: Survivable COR: internal Survivable Trunk Dest? y

Personalized Ringing Pattern: Message Lamp Ext: Mute button enabled? Expansion Module?

1 8003 y n

Media Complex Ext: IP SoftPhone? N

13. Verify the following fields:

Survivable GK Node Name. Names the gatekeeper to register with when the gateway unregisters (loses call control) with the main server. The media gateway delivers the gatekeeper list to IP endpoints, allowing them to register and subsequently originate/receive calls from other endpoints in this survivable calling zone. This field must be set equal to the IP Node Name of the media gateway that will support this station in survivable mode. Survivable COR. Places a restriction level for stations to limit certain users to only certain types of calls: - Emergency. This station can only be used to place emergency calls which are defined - Internal. This station can only make intra-switch calls (default) - Local. This station can only make calls that are defined as locl, op, svc, or hnpa on the Survivable ARS Analysis Table - Toll. This station can place any national toll call which are defined as fnpa or natl on the Survivable ARS Analysis Table - Unrestricted. This station can place a call to any number defined in the Survivable ARS Analysis Table. Those strings administered as deny are also denied to these users as well.

86 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Figure 3 shows the hierarchical relationship among the calling-restriction categories. Figure 3: Inherited Class of Restriction (COR) permissions

2 1 4 3 5 Emergency Internal Local Toll Unrestricted


cydsetru LAO 031405

Figure notes:

1. Unrestricted: Users can dial any valid routable number, except an ARS pattern specifically administered as deny (see Figure 4). ETR functionality and calls through the CO are permitted in this class. 2. Toll: Users can only dial these call types: - fnpa (10-digit NANP call) - natl (non-NANP call)

3. Local: Users can only dial these call types: - locl (public-network local number call) - op (operator) - svc (service) - hnpa (7-digit NANP call) 4. Internal: Users can only dial other stations within the media gateway and the emergency external number (default) 5. Emergency: Users can only dial the emergency external number

Survivable Trunk Dest? Enables stations to receive/not receive incoming trunk calls in survivable mode (default is receive). PIM extracts the Communication Manager information, pushes it to the media gateway, and stores it in NVRAM. This feature is an alternative technique for answering central office trunks (analog and digital non-ISDN) by routing directly to a station upon the action of inward trunk seizure. This operates equivalently to analog DID or ISDN trunk calls that have the ability to forward digit information regarding the called party.

14. Submit the form.

Issue 2 January 2008

87

Configuring Standard Local Survivability (SLS)

Using PIM to manage SLS administration on the gateway


Before enabling SLS, you must gather provisioning data from PIM and deliver it to the TGM550 Telephony Gateway Module. Run PIMs Device Profile Wizard to perform this task. The Device Profile Wizard gathers a subset of the Communication Manager translations (dial plan analysis and destination routing instructions) and delivers them to the TGM550 Telephony Gateway Module. If PIM is not available, this translation subset (the SLS data set) can be created manually, using the procedure described in Using the CLI to manually configure SLS administration on the gateway on page 94. PIM must be installed on and launched from the Avaya Network Management Console. For information about PIM, see Accessing PIM on page 31. 1. Ensure that the Network Management Console (NMC) has discovered the media gateway. 2. Before PIMs automatic scheduled SLS updates will work as expected, set the device parameters for both the server and the gateway in the NMC:

Server. Communication Manager login and password

Note:

Note: The server must be the first listing in NMCs discovery output. If an ESS node is discovered and listed prior to the main server, the main servers login/password will not permit access to the ESS node.

Gateway. SNMPv1/v3 access parameters Gateway. NMC has discovered the gateways IP address

3. Make sure the Communication Manager has been configured for SLS as described in Configuring Communication Manager for SLS on page 83. 4. Click the Device Profiles icon/link in the top-level toolbar of the main PIM window. Alternatively, select PIM Objects > Device Profiles from the left panel. 5. Click the New icon on the Device Profile list page that appears in the right panel of the main PIM window. If this is not a new profile, open the existing profile from the left panel or from the Device Profile list page. 6. Proceed through the Device Profile Wizard to the Details page. Set the CM version field to 4.0. 7. Proceed through the Device Profile Wizard to the SLS / ARS page (Figure 4) and perform the following: a. Select the Enable the SLS feature on this device? checkbox to enable SLS on the TGM550 Telephony Gateway Module. A cleared checkbox means that SLS is disabled. b. Select the Perform scheduled SLS updates on this device? checkbox to send the SLS administration data set to the gateway according to the settings on the SLS Update Schedule form (Figure 6).

88 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Figure 4: SLS / ARS page

8. Optionally click the following buttons:


View Extract displays the current SLS administration data set for this gateway. Perform Extract extracts the SLS information from the controlling Communication Manager server for this Media Gateway. Actions enables you to edit or delete a previously-administered entry: - The paper/pencil icon is the edit icon, which opens the ARS Entry page (Figure 5). - The trash can icon is the delete icon, which removes the ARS Entry from the table. The Add ARS Entry option may be used to create/edit a maximum of 30 ARS dial pattern entries.

9. If this gateway has not been previously provisioned, click Add ARS Entry to open the ARS Entry page (Figure 5).

Issue 2 January 2008

89

Configuring Standard Local Survivability (SLS)

Figure 5: SLS ARS Entry page

10. Use the SLS ARS Entry page (Figure 5) to administer an Automatic Route Selection in SLS. Refer to Table 19. Table 19: SLS ARS Entry page field options Field Dialed String Description The maximum length of the dialed string is 18 characters. The allowed characters include 0-9, '*' and 'X' or 'x' as a pre-string or mid-string replacement. 'X' cannot be at the end of a dialed string. The minimum length of the user-dialed number that the SLS call engine collects to match to the dialed-string. The default is the length of the specified dialed-string element. The maximum length of the user-dialed number that the SLS call engine collects to match to the dialed-string. The default is the length of the specified dialed-string element. The number of dialed digits to be deleted from the beginning of the dialed string. Default: 0. The digit string to be inserted at the beginning of the dialed string. Default: blank. 1 of 2

Min Length

Max Length

Number of Deleted Digits Inserted Digits

90 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 19: SLS ARS Entry page field options (continued) Field Call Type Description Can be one of the following: emer (emergency call)* fnpa (10-digit NANP call) hnpa (7-digit NANP call) intl (public-network international number call) iop (international operator call) locl (public-network local number call) natl (non-NANP call) op (operator) svc (service) Trunk-group number (1-2000), which you can select from the drop-down choices of trunk groups found in the SLS extract from the controlling Communication Manager server Indicates whether the call should be permitted or denied 2 of 2
* Any active, in-service station can dial the emergency access number while in survivable mode. Define the emergency access number on the SLS / ARS page (Figure 4).

Trunk Group

Permit / Deny

!
Important:

Important: SLS permits 911 calls, but the specific location information is not transmitted to the Public Service Answering Point (PSAP). Only the general trunk-identifying information is transmitted. Emergency personnel will have a general location associated with the trunk (for example, a building address), but nothing more specific (for example, a room or office number). Also, if a 911 call disconnects for any reason, emergency personnel cannot reliably call the originator back.

Issue 2 January 2008

91

Configuring Standard Local Survivability (SLS)

11. Use the SLS Update Schedule page (Figure 6) to administer up to six SLS updates per day. Figure 6: SLS Update Schedule page

a. Check the Enable SLS Updates box. b. Set as many as six Daily Updates. Note: The Daily Updates must be at least four hours apart. c. Click Submit. 12. Use the Backup/Restore page (Figure 7) to backup the PIM database backup schedule.

Note:

92 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Figure 7: Backup/Restore page

Note:

Note: Step 12 backs up the PIM database. Avaya encourages users to set a PIM backup schedule/policy independent of the SLS implementation. Note: If you require the use of the Incoming Call Handling Treatment option for adding/deleting the incoming dial pattern on incoming trunk calls, this route pattern must be modified using the CLI. There are NO equivalent commands in the PIM wizard screens.

Note:

Enabling and disabling SLS


To enable SLS on the TGM550 Telephony Gateway Module, enter set sls enable. The TGM550 Telephony Gateway Module responds with the message Survivable Call Engine is enabled. To disable SLS on the TGM550 Telephony Gateway Module, enter set sls disable. The TGM550 Telephony Gateway Module responds with the message Survivable Call Engine is disabled. Note: If you enable SLS and then performed additional administration, you must first disable SLS and then re-enable it. This will cause the SLS application to resynchronize its administrative database with the gateway's global CLI command database.

Note:

Issue 2 January 2008

93

Configuring Standard Local Survivability (SLS)

Activating changes in SLS


To activate changes you make in SLS, you must use the disable and enable SLS commands together. Thus, to activate changes in SLS, perform the following steps: 1. Make any changes to SLS administration desired. 2. While still in SLS mode, enter set sls disable. The TGM550 Telephony Gateway Module responds with the message Survivable Call Engine is disabled. 3. Enter set sls enable. The TGM550 Telephony Gateway Module responds with the message Survivable Call Engine is enabled.

Using the CLI to manually configure SLS administration on the gateway


It is recommended to use PIM to configure the SLS data. However, if PIM is unavailable, you can also configure the SLS data from the TGM550 Telephony Gateway Module itself.

Prerequisites

The Communication Manager Release 3.0 or later4.1 is running on the host server PIM or configuration of the TGM550 Telephony Gateway Module through its CLI The TGM550 Telephony Gateway Module is registered with Avaya Communication Manager The SLS is enabled on the TGM550 Telephony Gateway Module through its CLI S8300 is not serving as an LSP TGM550 Telephony Gateway Module is not subtending to another external server (including ESS or another LSP in another gateway)

Planning and preparing the SLS data set


It is recommended to plan the SLS coverage and gather information from Avaya Communication Manager before creating the SLS administration data set at the gateway command line. Strategic selection of the stations and trunks that participate in SLS can ensure that vital communications are spared interruptions caused by network outages.

94 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

!
Important:

Important: Since you can administer your system for SLS either from the SAT or from the gateway CLI, the two administration tasks must be synchronized with common data and port usage as well as system-defined capacities. For example, if a physical station port number 10 is not administered on the Communication Manager server, even though the gateways SLS engine has that port administered, the port is unusable during SLS operation on the gateway. This is because the hardware port configuration on the media modules is initially configured by CM in subtending gateway mode, by using the H.248 control channel to push information down to the gateway.

SLS capacities
The following table lists the SLS capacities: Table 20: SLS capacities Gateway model J2320 J2350 J4350/J6350 * IP stations 100 100 100 Analog stations 34 66 92 DCP stations Analog trunks BRI trunks DS1 trunks

Maximum 120 trunks Maximum 120 trunks Maximum 120 trunks

* The maximum number of legacy stations/trunks that may be supported is dependent upon the slot-module configuration of what is installed. In any case, the maximum number of combined stations ports and trunk channels may not exceed 120.

You can collect the Communication Manager data using the CM administrative SAT interface. For instructions on accessing the Avaya Communication Manager through the TGM550 Telephony Gateway Module, see Accessing the registered MGC on page 56.

Collecting analog stations data


1. At the SAT, enter list media-gateway to display a list of administered gateways.

Issue 2 January 2008

95

Configuring Standard Local Survivability (SLS)

2. Look for TGM550 supported gateways in the Type field. 3. Once you know the media gateway of interest, match the gateway model with the analog station ports: Table 21: Matching the gateway with the analog station ports Gateway model J2320/J2350/ J4350/J6350 Media module (if applicable) TGM550 TIM508 TIM514 TIM516 TIM518 Slot configuration for all media modules v1, v2, v3 (J2320) v1, v2, v3, v4, v5 (J2350) v1, v2, v3, v4, v5, v6 (J4350, J6350)

4. At the SAT, enter display port port-number, where port-number is the analog station port on the gateway. The system displays the extension number assigned to the port. 5. Once you know the extension, enter display station extension to display the Station form for this extension. 6. Gather the necessary information from Table 22. Table 22: Analog station form data to assemble for SLS Page* 1 1 Field Name Extension Port The port address correlates the analog stations that belong to a particular media gateway. If the port ID includes the media gateway number, then it is accepted. A new station slot/port entry must include the "V", as in "V305". Only 2500 is the accepted Type Class of Restriction while in SLS mode Trunk destination while in SLS mode This field appears when Type is 2500 This is the users name Notes

1 1 1 2 1

Type Survivable COR Survivable Trunk Dest Switchhook Flash Name

* Page numbers might vary for your system.

96 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Collecting IP stations data


1. At the SAT, enter list media-gateway to display a list of administered gateways. 2. Look for supported gateways in the Type field. 3. Enter display media-gateway. 4. Read the reported IP address for this gateway. 5. Enter list node-name and compare the IP address of the media gateway in the list with the IP address of the gateway that you are administering for SLS. When you find a match in the node-name form, read the assigned node-name. This will be used to do a pattern match with a field on the IP Station form in Step 6. 6. Enter list station type type, where type is one of the supported IP stations. The report lists all IP phones that could have the Survivable GK Node-Name administered to the target media gateway. The Survivable GK Node-Name uniquely associates an IP phone with a particular media gateway. 7. Once a match is made between the station form's Survivable GK Node-Name and the target gateway's Node-Name, gather the values for the given IP station per Table 23. Table 23: IP station form data to assemble for SLS Page* 1 1 Field Name Extension Security Code (IP only) This value is the shared secret between Communication Manager and the media gateway used for the registration of the IP endpoint 4601 4602 4602SW 4606 4610SW 4612 4620 4620SW 4621 4622 4624 4625 Class of Restriction while in SLS mode Trunk destination while in SLS mode 1 of 2 Notes

Type

1 1

Survivable COR Survivable Trunk Dest

Issue 2 January 2008

97

Configuring Standard Local Survivability (SLS)

Table 23: IP station form data to assemble for SLS (continued) Page* 1 1 Field Name Expansion Module Name Notes Determines if optional CA module is connected to this phone model This is the users name 2 of 2
* Page numbers might vary for your system.

Collecting trunk groups data


1. At the SAT, enter list media-gateway to display a list of administered gateways. 2. Look for supported gateways in the Type field. 3. At the SAT, enter display media gateway to view the media modules that are assigned to the various slots. Use Table 38 as a reference to identify how the particular media module has been configured for serving as a trunk port, and then use the various list commands on CM to look for physical port matches in the various trunk SAT forms in order to discover what translation information is needed. 4. Identify the analog trunk ports. Refer to Table 38. 5. Identify the BRI trunk ports. Refer to Table 39. 6. Identify the digital DS1 trunk ports. Refer to Table 39. 7. Identify the modules and check for provisioned trunk ports. 8. At the SAT, enter display port portid, where portid is the trunks port on the target gateway. The system reports the Trunk Group Number/Member Number for this particular port. 9. Once you know the Trunk Group Number, gather trunk-group information according to Table 24. Table 24: Trunk group data to assemble for SLS Page* 1 1 Field Name Group Type Outgoing Dial Type Notes This field specifies the type of trunks associated with this trunk group The only acceptable values are tone and rotary. If the field is set to automatic or mf, then the value of tone is used instead. Note that this does not apply to DS1 PRI links. 1 of 3

98 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 24: Trunk group data to assemble for SLS (continued) Page* 1 1 Field Name Trunk Group Number TAC Notes This value is used in the routing table This value is only necessary if the Dial Access? field is set to y. If that field is set to n, the TAC value is not pushed down to the media gateway. There may be more than one port within a trunk group definition that pertains to a given media gateway This only applies for DID analog trunks or for DS1 tie trunks. Note that this does not apply to DS1 PRI tie trunks. This field contains a value only when the Digit Treatment field is set to insert1, insert2, insert3, or insert4 Depends on trunk signaling type: Analog trunks: - Loop-start - Ground-start - DID In-Band DS1 trunks with CO Group-Type: - Loop-start - Ground-start In-Band DS1 trunks with Tie Group-Type: - Wink/wink - Wink/immediate - Wink/auto - Immediate/Immediate - Auto/auto - Auto/wink Customer identification of trunk group Describes which Q.931 code-sets are allowed to send Display IEs Describes which Q.931 code-sets are allowed to send National supported IEs 2 of 3

4 1

Port Digit Treatment

1 1

Digits Trunk Type

1 1 1

Group Name Codeset to Send Display Codeset to Send National IEs

Issue 2 January 2008

99

Configuring Standard Local Survivability (SLS)

Table 24: Trunk group data to assemble for SLS (continued) Page* 2 Field Name Outgoing Channel ID Encoding Digit Handling (in/out) Network (Japan) Needs Connect Before Disconnect Send Name Send Calling Number Incoming Calling Number - Format Incoming Destination Trunk Hunt Notes Used for encoding Channel ID IE

1 2

Defines overlap receiving and transmitting rules Sends a CONNECT message before sending a DISCONNECT message, if enabled

2 2

Specifies whether the Group Name is to be specified with the message sent while connecting to the network Specifies whether the Trunk Group Number is to be specified with the message sent while connecting to the network Specifies how to fill the Calling Party Number and Called Party Number IEs Sets a destination station for routing incoming trunk group calls Determines the method in which the survivable-call-engine selects an available trunk from the trunk group pool Specifies the Signaling Group Number that is the manager of this ISDN trunk member 3 of 3

1 1

Sig Grp

* Page numbers might vary for your system.

Collecting DS1 trunks data


1. At the SAT, enter display ds1 location to display the DS1 administration for a particular circuit pack location.

100 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

2. Gather DS1 information according to Table 25 for each DS1 facility. Table 25: DS1 circuit pack data to assemble for SLS Page* 1 1 1 1 Field Name Name Bit-Rate Signaling Mode Channel Numbering Notes Descriptive name often of the Service Provider or destination of the DS1 facility Selects the maximum transmission rate of the DS1 facility Selects the signaling method deployed on the given DS1 facility E1 interface for ETSI and QSIG require sequential encoding from 1 to 30 This field appears when Signaling Mode = isdn-pri Bit Rate = 2.048 Connect = pbx Specifies what is connected at the far-end of the DS1 facility Determines glare handling Specifies QSIG glare handling when the Interface field is set to peerslave Specifies the Layer 3 signaling protocol used by the country-specific service provider Used in countries whose public networks allow multiple Layer 3 signaling protocols for ISDN PRI service Sets the Information Transfer capability in the Bearer Capability IE of the SETUP message Specifies the companding mode used by the far-end switch Specifies whether the duration of Q.931 timers (T302 and T302) is to be extended. This is only required for Russian telecom applications or if Signaling Mode = isdn-pri.

1 1 1 1 1 1 1 1

Connect Interface Side Country Protocol Protocol Version DCP/Analog Bearer Capability Interface Companding ITN-C7 Long Timers

* Page numbers might vary for your system.

3. Repeat the display ds1 location command and press Enter for each circuit pack that you want to included in the SLS data set.

Issue 2 January 2008

101

Configuring Standard Local Survivability (SLS)

Collecting signaling groups data


Collect the information from the Communication Manager Signaling Group form (Table 26) for ISDN-PRI administration only. Table 26: ISDN-PRI administration data to assemble for SLS Page* 1 1 Field Name Trunk Group for Channel Selection Associated Signaling Notes Trunk group reference number association with trunk group table Specifies whether the D-channel is physically associated in the DS1 facility. The enabled setting is when there is a D-channel present. Specifies the gateway port ID where the D-channel is located. For the gateways, the first component is the three digit gateway number, followed by a v, the slot number, and 24 (T1) or 16 (E1). This is needed only if the Associated Signaling is set to no. Specifies the gateway port ID where the D-channel is located. For the gateways, the first component is the three digit gateway number, followed by a v, and one numeric character for the slot number. This is needed only if the Associated Signaling is set to no. Specifies the channel of the DS1 circuit that carries the D-channel for ISDN signaling. This is an integer from 0 through 31.

Primary D-channel

Trunk Board

Interface Id

* Page numbers might vary for your system.

Collecting administered ISDN-BRI trunks data


1. At the SAT, enter display bri-trunk-board location to display the DS1 administration for a particular circuit pack location. 2. Gather ISDN-BRI administration information in Table 27 for each location. Table 27: ISDN-BRI administration data to assemble for SLS Page* 1 1 Field Name Name Interface Notes Descriptive name often of the Service Provider or destination of BRI facility Determines glare handling 1 of 2

102 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 27: ISDN-BRI administration data to assemble for SLS (continued) Page* 1 1 1 2 1 2 2 2 2 2 1 Field Name Side Country Protocol DCP/Analog Bearer Capability Companding Mode TEI Directory Number A Directory Number B SPID-A SPID-B Endpt Init Layer 1 Stable Notes QSIG glare handling, when the interface field is peerSlave Specifies the Layer 3 signaling protocol used by the country-specific service provider Sets the Information Transfer capability in the Bearer Capability IE of the SETUP message Specifies the companding mode used by the far end switch LAPD address assignment for the TEI field Channel B1s directory number Channel B2s directory number Service Profile Identifier required for Country Code (USA) Service Profile Identifier required for Country Code (USA) Determines whether the far end supports endpoint initialization Determines whether to expect the network to drop BRI Layer 1 when no calls are active 2 of 2
* Page numbers might vary for your system.

Collecting Feature Access Codes data


1. At the SAT, enter display system-parameters customer-options to display the Customer Options form. 2. Scroll to page 5 and determine how the Multinational Locations or Multiple Locations fields are set:

If either of these fields is set to y (enabled), then proceed to Step 3. If these fields are set to n (disabled), at the SAT, enter display feature-access-codes and gather the FAC information listed in Table 28.

3. Look up the location of the gateway, as follows: a. At the SAT, enter list media-gateway to get the gateways number. b. At the SAT, enter display media gateway number, where number is the gateway number you obtained in Step a. This provides you with the location field value.

Issue 2 January 2008

103

Configuring Standard Local Survivability (SLS)

If the gateway has an administered location, at the SAT, enter display locations number, where number is the administered location number. If there is an ARS entry for the given location, you must use this value exclusively in the SLS data set. If there is no administered location, at the SAT, enter display feature-access-codes and gather the FAC information listed in Table 28.

Table 28: Feature Access Codes to assemble for SLS Page 1 1 1-16 Field Name Auto Route Selection (ARS) Access Code1 Auto Route Selection (ARS) Access Code2 ARS FAC Notes Specifies the first access code for ARS table routing Specifies the second access code for ARS table routing This is used instead of the Features form ARS FAC entry if the Loc No. that correlates to the gateway has an entry in this form, which overrides the general ARS FAC(s) Specifies the dial access code to provision a hold bridge on the call involving this station user. Successive access to this dial code causes the feature to toggle between the Hold and the Unhold states

CAS Remote Hold/ Answer Hold-Unhold Access Code

Collecting System parameters data


1. At the SAT, enter list media-gateway to display a list of administered gateways. 2. Look for supported gateways in the Type field. 3. Once you have determined the media gateway of interest, note its IP-Network-Region. 4. At the SAT, enter display ip-network-region n, where n is the gateways administered IP-Network-Region. Read the Codec-set field value from the IP Network Region form. 5. At the SAT, enter display ip-codec-set n, where n is the Codec-set field value from the IP Network Region form. The report lists the supported codes in the Audio Codec field (summarized in Table 29). Note: SLS only supports G.711 mu/A-law. 6. At the SAT, enter display system-parameters features to display the Feature Related System Parameters form. 7. Scroll to page 10 and read the value of the Date Format on Terminals field (summarized in Table 29).

Note:

104 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

8. At the SAT, enter display media-gateway n, where n is the administered number of the media gateway of interest, to display the Media Gateway form. 9. Read the Max Survivable IP Ext field value (summarized in Table 29). Table 29: General system parameters data to assemble for SLS CM Form Ip-codec-set Page All Field Name All fields Notes There can be up to 7 distinct codec-sets in use in the system. However, only one codec set is active for the network region in which the gateway is located. SLS only supports two codecs: G.711 A-law G.711 U-law Applies to 46xx IP terminals Maximum IP phone registrations allowed

System-parameter features Media Gateway

10 1

Date Format on Terminals Max Survivable IP Ext

Collecting ARS dial patterns data


To gather the route patterns and ARS analysis in Communication Manager, you must first know which trunk groups are assigned to the gateway of interest. After verifying this information, perform the following steps: 1. At the SAT, enter list route-pattern trunk-group n, where n is an administered trunk group, to display the administered route pattern(s). 2. For the first preference for this route-pattern entry, read the values of the following fields (described in Table 30):

No Deleted Digits Inserted Digits

3. At the SAT, enter list ars analysis to search the ARS Analysis table for row entries whose Route Pattern field matches the route-pattern value(s) that were obtained in Step 1. Once you discover a match with Route Pattern, use the entries from this row in the ARS Analysis table to complete the following three entries for the SLS Dial-Pattern table (see Table 30):

Min Max

Issue 2 January 2008

105

Configuring Standard Local Survivability (SLS)

Dialed String

Table 30: ARS Dial Patterns for SLS CM Form Route-Pattern Page 1 Field Name No. Del Digits Notes Specifies the number of dialed digits to be deleted from the beginning of the dialed string. The default is 0. Specifies the digit string to be inserted at the beginning of the dialed string. The default is blank. Dial string entry that is used to match a pattern within the user-dialed number Minimum length of the user-dialed number that the SLS call engine collects to match to the dialed-string. The default is the length of the specified dialed-string element. Maximum length of the user-dialed number that the SLS call engine collects to match to the dialed-string. The default is the length of the dialed-string element.

Route-Pattern

Inserted Digits

ARS Analysis ARS Analysis

1 1

Dialed String Min

ARS Analysis

Max

Collecting Incoming Call Handling data


To gather the Incoming Call Handling Treatment and ARS Digit Conversion information in Communication Manager, you must first know which trunk groups are assigned to the gateway of interest. After verifying this information, perform the following steps: 1. At the SAT, enter display inc-call-handling-trmt trunk-group n, where n is an administered trunk group. 2. For each entry, read the values of the following fields (see Table 31):

Called Number Called Length Del Insert

106 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 31: Incoming call handling data to gather for SLS CM Form Incoming Call Handling Treatment Incoming Call Handling Treatment Page 1 Field Name Called Number Notes Dial string entry that is used to match a pattern on inbound trunk calls Maximum length of the user-dialed number that the SLS call engine collects to match to the dialed string. The default is that the minimum length is defined to be equal to the length of the dialed string. Specifies the number of dialed digits to be deleted from the beginning of the string. The default is 0. Specifies the digit string to be inserted at the beginning of the dialed string. The default is blank. Defines the overlap receiving rules. Needed to set the mode field in the IncomingRouting table. The default is enbloc.

Called Len

Incoming Call Handling Treatment

Del

Incoming Call Handling Treatment

Insert

Trunk Group

Digit Handling (In/Out)

Configuring the SLS data through the CLI


The command line interface (CLI) has a root-level context of sls for administering the SLS data set. After you enter sls at the CLI prompt, the prompt changes to indicate that you are in the sls context. Once in this context, seven additional sub-contexts provide for station and trunk administration, minimizing the need to type in a long command string:

station context that is invoked by entering station extension class to enter a second-level sub-context for administering stations trunk-group context that is invoked by entering trunk-group tgnum group-type to enter the second-level sub-context for administering trunk groups ds1 context that is invoked by entering ds1 port-address to enter the second-level sub-context for administering DS1 trunks sig-group context that is invoked by entering sig-group sgnum to enter the second-level sub-context for administering signaling groups

Issue 2 January 2008

107

Configuring Standard Local Survivability (SLS)

bri context that is invoked by entering bri port-address to enter the second-level sub-context for administering ISDN BRI links dial-pattern context that is invoked by entering dial-pattern dialed-string to enter the second-level sub-context for administering dial pattern strings incoming-routing context that is invoked by entering incoming-routing tgnum mode pattern length to enter the second-level sub-context for administering incoming routing

Enter exit to leave the second-level sub-contexts and return to the (super-sls)# context. See Table 40 for a complete hierarchical listing of all SLS CLI commands. Note: Review Table 40 in its entirety before proceeding with SLS administration. This summary of SLS commands guides you in understanding the various sub-commands of each sub-context.

Note:

Creating the SLS administration data set on the media gateway


1. Log on to the gateway. 2. To administer the name, enter set system name name, where name is typed inside quotation marks(""). To remove the administered name, enter set system name, and then rename the gateway using the set system name command. Note: The gateways administered name must match the name in the Communication Manager administration. 3. At the gateway command prompt, enter sls to begin entering SLS data. The command line prompt changes to (super-sls)# to indicate that you are in SLS data entry mode. Entering exit ends the SLS data entry mode session, and the command line prompt returns to its original state. 4. Enter set pim-lockout yes to prevent Provisioning and Installation Manager (PIM) updates while you are working on SLS administration of the gateway. 5. If you want to change the maximum allowable IP registrations from the default, enter set max-ip-registrations n, where n is from 1 to 100. 6. Use the set date-format command to set a date format for the SLS data set. 7. Use the set ip-codec-set command to select the country-specific G.711 codec set within the SLS data set: g.711mu or g.711a.

Note:

108 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

8. Administer the slot configuration information by entering set slot-config slot-number board-type, where slot-number is the slot where the Media Module is located and board-type is the Media Module type (see Table 32 for a list of Media Modules supporting SLS). Table 32: Media Modules supporting SLS Media Module TGM550 Description Central processing and resources, plus two analog trunk ports and two analog station ports 8 analog telephone/DID trunk ports Permitted Slots v1 (recommended), v2, v3, v4, v5, v6 v1, v2, v3 (J2320) v1,v2, v3, v4, v5 (J2350) v1, v2, v3, v4, v5, v6 (J4350, J6350) v1, v2, v3 (J2320) v1,v2, v3, v4, v5 (J2350) v1, v2, v3, v4, v5, v6 (J4350, J6350) v1, v2, v3 (J2320) v1,v2, v3, v4, v5 (J2350) v1, v2, v3, v4, v5, v6 (J4350, J6350) v1, v2, v3 (J2320) v1,v2, v3, v4, v5 (J2350) v1, v2, v3, v4, v5, v6 (J4350, J6350) v1, v2, v3 (J2320) v1,v2, v3, v4, v5 (J2350) v1, v2, v3, v4, v5, v6 (J4350, J6350) v1, v2, v3 (J2320) v1,v2, v3, v4, v5 (J2350) v1, v2, v3, v4, v5, v6 (J4350, J6350)

TIM508

TIM510

One T1/E1 trunk port

TIM514

Four analog trunk ports and four analog station/DID ports

TIM516

16 analog line station ports

TIM518

Eight analog trunk ports and eight analog station/DID ports

TIM521

Four BRI trunk ports

9. Administer the station information. Refer to Administering Station parameters on page 111. 10. Administer DS1 trunks as required. Refer to Administering DS1 parameters on page 113. 11. Administer BRI links as required. Refer to Administering BRI parameters on page 118.

Issue 2 January 2008

109

Configuring Standard Local Survivability (SLS)

12. Administer the trunk groups. Refer to Administering trunk-group parameters on page 120. Note that you can add members to the trunk group only after you administer the signaling group information. 13. Administer the signaling groups. Refer to Administering signaling-group parameters on page 127. 14. Administer ARS dial patterns for outgoing calls. Refer to Administering dial-pattern parameters on page 128. 15. Administer digit treatment for incoming routed calls. Refer to Administering incoming-routing parameters on page 129. 16. Optionally administer the attendant feature for the purpose of call routing by entering set attendant access-code extension, where access-code specifies the dial access code for the attendant feature, and extension specifies the station which serves as the branch office attendant position. Incoming trunk calls that have dialed strings that cannot be completely routed, will now be routed by SLS to this attendant position. In addition, stations in the branch office may directly dial the attendant using the access-code. 17. Administer the Feature Access Codes (FACs) by entering set fac feature fac, where feature is one of the following:

ars1 ars2 hold

and fac is a 1-4 digit string that includes the digits 0 through 9 (excluding * and # for analog rotary phones). The fac string must be unique and must not conflict with station extension numbers and Trunk Access Codes (TACs). Examples

set fac ars2 *9

Note:

Note: The "*" and "#" characters are not available on rotary-dial, analog phones. 18. Enter set pim-lockout no to allow Provisioning and Installation Manager (PIM) updates, since you finished SLS administration of the gateway. 19. At the gateway command prompt, enter exit to leave the sls context. The gateway command prompt reverts to that of the original login. 20. After all of the SLS features are administered, at the gateway command prompt enter set sls enable to enable SLS on the gateway. Note: If you enabled SLS and then entered additional administration, you must first disable SLS by entering set sls disable, and then re-enable it by entering set sls enable. This will cause the SLS application to resynchronize its administrative database with the gateway's CLI command database.

Note:

110 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

21. At the gateway command prompt, enter copy running-config startup-config to save the changes.

Administering Station parameters


1. At the gateway command prompt, enter station extension class to enter a second-level sub-context to administer each phone that you want covered by SLS. In this command, extension is a 1-13 digit numeric string that may begin with 0, and class is analog or ip. The command line prompt changes to sls-station <extension> to indicate that you are in the station context for SLS administration. Entering exit ends the station configuration mode, and the command line prompt returns to its original state. If you want to remove the station from the SLS administration, enter clear extension extension at the command line interface. Enter exit to leave the second-level station context to return to the (super-sls)# context. Example

station 1234567 ip administers an IP phone with the extension "1234567".

2. Depending on the class (analog, or ip, set in Step 1), enter set type model, where model is a value from Table 33. Table 33: Class values in SLS station context analog analog2500* ip ip4601 ip4602 ip4602sw ip4610sw ip4612 ip4620 ip4620sw ip4621 ip4622 ip4624 ip4625
* Since there is just one entry, the model is optional; analog2500 is the default value.

Issue 2 January 2008

111

Configuring Standard Local Survivability (SLS)

Example

set type ip4620 sets the previously-administered extension "1234567" as an Avaya 4620 IP phone.

3. For analog classes only (set in Step 1), enter set port module-port for this station, where module-port is a value in Table 34. Note: This command is only required for stations that support physical media module ports. If the class is ip (set in Step 1), you cannot run this command. Table 34: Module-port values in SLS station configuration mode Gateway J2320 J2350 J4350 J6350 Media module TGM550 TIM508 TIM514 TIM516 TIM518 Analog station ports* 3, 4 1 through 8 5, 6, 7, 8 1 through 16 1 through 8 DCP

Note:

* You cannot select these modules/ports if they are already assigned as DID trunks.

set port v302 sets the previously-administered analog station "1234567" to the first physical analog station port on the TGM550 gateways media module.

4. Enter set cor cor to set the class of restriction (COR) for this extension, where cor is one of the following:

emergency internal (default) local toll unrestricted

There exists a hierarchical relationship among the calling-restriction categories. As you move from the most restricted COR (emergency) to the least restricted (unrestricted), each level increases the range of dialing abilities. For example, toll includes the dialing privileges of local, internal, and emergency. See Figure 3 for the hierarchical relationship among the COR permissions.

112 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Example

set cor unrestricted gives a station unrestricted dialing.

5. If this station is administered to be included into a pool of stations that are allowed to receive incoming analog loop-start trunk calls, enter set trunk-destination yes. 6. If this is an IP phone (set in Step 1), enter set password password, where password is from four to eight digits in length, to administer a password. The phone will automatically register to the gateway upon failure if the password and the extension number are the same as those administered in the CM. Note: Passwords are not required for analog phones. Example

Note:

set password 53136 establishes the password "53136" on a previously-administered IP phone.

7. To enable IP phones (set in Step 1) to have an expansion module, enter set expansion-module yes. 8. For analog phones (set in Step 1) that you want SLS to recognize the switchhook flash signal (which offers subsequent transfer features), enter set swhook-flash yes. 9. Enter set name name to identify the user name for the station. Use the 1-27 character name as specified on the Communication Manager form. Type the name string inside double quotes. 10. Enter show to check the station administration of the station being programmed. The report lists the station parameters. For example:

Extension --------49139

Type Port Cor ----------ip4620 IPaddr local ip station registered

Trunk-Des Exp-Mod Flash --------------------y n at address aaa.bbb.ccc.ddd

Password -------********

Note:

Note: For currently-registered IP phones or IP Softphones, the IP address is displayed. 11. Enter exit to leave the station context in SLS.

Administering DS1 parameters


1. Enter ds1 slot-address, where slot-address is any permitted port. The command line prompt changes to super-sls/ds1-<port-address>. If you want to remove the ds1 trunk from the SLS administration, enter exit to leave the second-level ds1 context and return to the (super-sls)# context, and then enter clear ds1 slot-address.

Issue 2 January 2008

113

Configuring Standard Local Survivability (SLS)

Note:

Note: If configuration changes affecting trunk provisioning (such as, signaling and bit-rate) are made to a DS1 trunk where the trunk and its associated signaling group have already been provisioned, an error message instructs you that the "Administrative change is in violation with existing trunk member provisioning", and the configuration change is rejected. 2. Enter set name name to identify the user name for the DS1 trunk. Use the 1-27 character name as specified on the Communication Manager form (add trunk-group n). Type the name string inside double quotes. 3. Enter set bit-rate rate to set the maximum transmission rate in Mbps for the DS1 facility. The rate can be either 1544 (T1) or 2048 (E1). 4. Enter set signaling-mode mode-type to set the signaling mode for the DS1 facility, where mode-type is one of the following values:

cas. Out-of-band signaling for E1 service, yielding thirty 64 kbps B-channels for voice transmission robbed bit. In-band signaling for T1 service, yielding twenty-four 56 kbps B-channels for voice transmission isdnpri. T1 or E1 ISDN Primary Rate service (supports both FAS and NFAS) isdnext. NFAS T1 or E1 ISDN service for:

T1 facility, in which all 24 channels are for bearer transport E1 facility, in which all 31 channels are for bearer transport

5. Enter set channel-numbering method to select the channel-numbering method for B-channels on an E1 interface, where method is one of the following values:

seq. Sequential codes of B-channels 1-30 in the ISDN Channel Identification IE tslot. Timeslot method

6. Enter set connect far-end to specify the equipment at the far-end of the DS1 link, where far-end is one of the following values:

host. Data application (computer or server) lineside. Terminal equipment (video multiplexer) network. Central office pbx. Private communication system (another pbx)

7. If the far-end equipment is specified as pbx (set in Step 6), enter set interface glare-mode to specify the glare-handling convention, where glare-mode can be one of the following values:

For non-QSIG calls: - network. If the gateway is connected to a host computer and encounters glare, it overrides the far-end

114 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

- user. If the gateway is connected to a public network and encounters glare, it releases the circuit

For QSIG calls: - peerMaster. SLS overrides the other end when glare occurs - peerSlave. SLS releases the circuit when glare occurs

8. If the DS1 link is employed with ISDN, and the glare-handling convention is specified as peerMaster or peerSlave for the ISDN link (set in Step 7), enter set side side to specify the glare mode: either a or b. 9. If the DS1 link is employed with ISDN, enter set country-protocol country-code to specify the ISDN Layer 3 country protocol type, where country-code is one of the values in Table 35: Table 35: ISDN Layer 3 country codes Country Code 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 Country United States (AT&T mode, also known as 5ESS) Australia (Australia National PRI) Japan Italy Netherlands Singapore Mexico Belgium Saudi Arabia United Kingdom (ETSI) Spain France (ETSI) Germany (ETSI) Czech Republic Russia Argentina 1 of 2

Issue 2 January 2008

115

Configuring Standard Local Survivability (SLS)

Table 35: ISDN Layer 3 country codes (continued) Country Code 17 18 19 20 21 22 23 24 25 etsi qsig Country Greece China Hong Kong Thailand Macedonia Poland Brazil Nordic countries South Africa ETSI (no use of RESTART message) QSIG 2 of 2 10. For countries whose public networks allow for multiple ISDN Layer 3 country protocols for ISDN Primary Rate service, enter set protocol-version option to specify the mode (see Table 36). Verify that the protocol version matches the country specified in set country-protocol (set in Step 9). Table 36: ISDN Layer 3 country protocols for ISDN Primary Rate service Country code Country 1 (United States) Description AT&T mode (also known as 5ESS) National ISDN-1 Nortel mode (also known as DMS) Telecordia (NI-2) Australia National PRI ETSI invalid invalid Possible Values a b c d a b c d 1 of 2

Country 2 (Australia)

116 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 36: ISDN Layer 3 country protocols for ISDN Primary Rate service (continued) Country code Country 10 (United Kingdom) Description DASS ETSI invalid invalid French National PRI ETSI invalid invalid German National PRI ETSI invalid invalid Full message set, including RESTART No RESTART message invalid invalid Possible Values a b c d a b c d a b c d a b c d 2 of 2 11. If the DS1 link is employed with ISDN, enter set bearer-capability bearer to set the Information Transfer Rate field of the Bearer Capability IE, where bearer is one of the following values:

Country 12 (France)

Country 13 (Germany)

ETSI

3khz. 3.1 kHz audio encoding speech. Speech encoding

12. Enter set interface-companding type to set the interface to agree with the companding method used by the far-end of the DS1 circuit for SLS mode, where type is one of the following values:

alaw. A-law companding ulaw. U-law companding

13. Enter set long-timer yes | no to increase the duration of the T303 (call establishment) timer, where:

yes. The T303 timer is extended from 4 seconds to 13 seconds no. The T303 timer remains at 4 seconds

Issue 2 January 2008

117

Configuring Standard Local Survivability (SLS)

14. Enter show to check the DS1 administration. The report lists the DS1 parameters. For example:
Name = Willow Steet 2 DS1 Rate Signaling Channel Connect Interface Side Protocol Ver Bearer Cmpd Ltm ---- ---- --------- ------- ------- --------- ---- -------- --- ------ ---- --v4 1544 isdnpri seq network user a country1 a speech ulaw no

15. Enter exit to leave the ds1 context in SLS.

Administering BRI parameters


1. Enter bri slot-address, where slot-address is any permitted port. The command line prompt changes to sls-bri <slot-address>. If you want to remove the BRI link from the SLS administration, enter exit to leave the second-level bri context and return to the (super-sls)# context, and then enter clear bri slot-address. 2. Enter set name name to identify the user name for the DS1 trunk. Use the 1-27 character name, as specified on the Communication Manager form (add trunk-group n). Type the name string inside double quotes. 3. Enter set interface glare-mode to specify the glare-handling convention. glare-mode can be one of the following values:

For non-QSIG calls: - network. If the gateway is connected to a host computer and encounters glare, it overrides the far-end - user. If the gateway is connected to a public network and encounters glare, it releases the circuit

For QSIG calls: - peerMaster. SLS overrides the other end when glare occurs - peerSlave. SLS releases the circuit when glare occurs

4. If the BRI link is employed with ISDN, and the glare-handling convention is specified as peerMaster or peerSlave for the ISDN link (set in Step 3), enter set side side to specify the glare mode: either a or b. 5. If the BRI link is employed with ISDN, enter set country-protocol country-code to specify the ISDN Layer 3 country protocol type, where country-code is any the values listed in Table 35. 6. If the BRI link is employed with ISDN, enter set bearer-capability bearer to set the Information Transfer Rate field of the Bearer Capability IE, where bearer is one of the following values:

3khz. 3.1 kHz audio encoding

118 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

speech. Speech encoding

7. Enter set interface-companding type to set the far-end companding method, where type is one of the following values:

alaw. A-law companding ulaw. U-law companding

8. If the BRI link is employed with ISDN, enter set tei-assignment tei to select the method by which the Layer 2 (LAPD) protocol obtains its Terminal Endpoint Identification (TEI) address. tei is one of the following values:

auto. TEI is assigned by the network provider zero. TEI is fixed administratively

9. Enter set directory-number-a number to assign a directory number to the B1 channel of the BRI link. number is the provisioned number received from the network provider. The number value must be identical to the number the network provider has assigned to the circuit. 10. Enter set directory-number-b number to assign a directory number to the B2 channel of the BRI link. number is the provisioned number received from the network provider. The number value must be identical to the number the network provider has assigned to the circuit. 11. Enter set spid-a number to assign an SPID to the B1 channel of the BRI link. 12. Enter set spid-b number to assign an SPID to the B2 channel of the BRI link. Note: All BRI links must have SPIDs properly configured for the link to function. SPIDs are received from the network service provider. 13. If the BRI link is employed with ISDN, enter set-endpoint-init {yes | no} to determine whether or not the far-end supports endpoint initialization. 14. If the BRI link is employed with ISDN, enter set layer1-stable {yes | no} to determine whether or not to keep the physical layer active (stable) between calls. Some European countries require that the physical layer is deactivated when there is no active call. 15. Enter show to check the BRI administration. The report lists the BRI parameters. For example:
Name = BRI-SLS1 BRI Interface ----------v401 user

Note:

Side ---a

Country -------country1

Bearer -----speech

Compand ------ulaw

Endpt-Init ---------yes

Layer1-Stable ------------yes

Dir-NumberA Dir-NumberB Spid-A Spid-B ----------- ----------- -------------- -------------3033234567 3033234568 30332345671111 30332345681111

Issue 2 January 2008

119

Configuring Standard Local Survivability (SLS)

16. Enter exit to leave the bri context in SLS.

Administering trunk-group parameters


1. Enter trunk-group tgnum group-type, where tgnum is any number from 1 to 2000 and group-type can be one of the following:

loop-start (analog) did (analog) ground-start (analog) bri (ISDN basic rate) t1-isdn (ISDN primary rate on 1.544 Mbps facility) e1-isdn (ISDN primary rate on 2.048 Mbps facility) t1-inband (non-ISDN rate on 1.544 Mbps facility) e1-inband (non-ISDN rate on 2.048 Mbps facility)

The command line prompt changes to super-sls/trunk-group-<tgnum>. If you want to remove the trunk group from the SLS administration, enter exit to leave the second-level trunk-group context and return to the (super-sls)# context, and then enter clear trunk-group tgnum. You can create a trunk group that does not have any assigned members. Once a valid port is assigned as a trunk group member, this trunk group then becomes active and may be employed by SLS call processing for incoming/outgoing trunk operation. The slot-configuration table is used, together with the port capacity for the given module, to determine the validity of a port assignment at administration time. As a result, there may not be more active trunk groups than there are physical trunk members within a given gateway. In addition, a combo-port may only be used for one active assignment. For example, the analog station/DID trunk ports may be either allocated to serve as an analog station or as an analog DID trunk, but not both. The maximum limits for a given trunk type are defined by the J2320/J2350/J4350/J6350 media gateway models. The maximum number of ports allowed per interface module is defined in Table 37. Table 37: J2320, J2350, J4350 and J6350 SLS group type assignments Group type loop-start ground-start did Media module TGM550 TGM550 Number of ports/channels 2 2 Description 1, 2 3, 4 1 of 2

120 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 37: J2320, J2350, J4350 and J6350 SLS group type assignments (continued) Group type loop-start ground-start did Media module TIM514 TIM518 TIM508 TIM514 TIM518 bri t1-isdn t1-isdn TIM521 TIM510 TIM510 Number of ports/channels 4 8 8 4 8 8 23 24 D-channel is associated with this facility (FAS) D-channel is not associated with this facility (NFAS), and the DS1s signaling-mode is set to isdnext D-channel is associated with this facility (FAS) D-channel is not associated with this facility (NFAS), and the DS1s signaling-mode is set to isdnext Description 1, 2, 3, 4 9 through 16 1 through 8 5, 6, 7, 8 1 through 8

t1-isdn e1-isdn

TIM510 TIM510

30 31

t1-inband e1-inband

TIM510 TIM510

24 30 2 of 2

Example

trunk-group 1 loop-start establishes an analog loop-start trunk group number 1.

2. Enter set dial dial-type, where dial-type is either rotary or dtmf. Example

set dial dtmf establishes that the trunk group uses DTMF signaling.

3. Enter set tac tac, where tac is a 1-4 digit numeric value (plus initial # and * on all but rotary dial phones) for this trunks access code (TAC). The TAC value must be unique among all trunk groups, extension numbers, and ARS Feature Access Code (FAC) strings. Example

set tac 88 establishes access to this trunk group by dialing "88".

Issue 2 January 2008

121

Configuring Standard Local Survivability (SLS)

4. Enter add port module port sig-group to specify the media module port that is compatible with the device and/or media module (see Table 38 for J2320/J2350/J4350/J6350 analog trunks and Table 39 for J2320/J2350/J4350/J6350 digital trunks). The sig-group argument is necessary for a digital ISDN-PRI trunk. It is an integer number from 1 to 650 that specifies the signaling group associated with the management of this trunk member. Note: You must administer the signaling group and DS1 information before you can add any ports to the trunk group. Note: You can assign the following maximum number of members to a trunk group: - TGM550 analog trunks = 4 members - TGM550 digital trunks = 30 members Table 38: Media Module-port values in SLS trunk-group context for the TGM550 (Analog Trunks) Group Type loop-start Media Module TGM550 TIM514 TIM518 ground-start TGM550 TIM514 TIM518 did TGM550 TIM508 TIM514 TIM518 Number of Ports/Channels 2 4 8 2 4 8 2 8 4 8 Description 1,2 1,2,3,4 9 through 16 1,2 1,2,3,4 9 through 16 3,4 1 through 8 5,6,7,8 1 through 8

Note:

Note:

122 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 39: Trunk port values in SLS trunk-group context for the TGM550 (Digital Trunks) Group Type bri t1-isdn e1-isdn t1-inband e1-inband Media Module TIM521 TIM510 TIM510 TIM510 TIM510 Number of Ports/Channels 8 23(FAS) 24(NFAS) 30(FAS) 31(NFAS) 24 30

Note:

Note: You cannot mix BRI and PRI trunks within the same trunk group. If you attempt to assign more than the maximum number of trunks to a trunk group, an error message instructs you to delete a trunk member before adding a new trunk. A physical trunk can be a member of only one trunk group. 5. For an analog DID trunk group, enter set supervision sup-type to set the incoming signaling supervision mode. sup-type can be either immediate or wink. Example

set supervision wink assigns wink-start incoming signaling supervision to a DID trunk group

6. For a non-ISDN digital trunk (t1-inband or e1-inband), enter set supervision sup-type to set the incoming signaling supervision mode, where sup-type can be one of the following:

loop-start ground-start wink-wink wink-immediate wink-auto immediate-immediate auto-auto auto-wink

7. For an analog DID trunk group or DS1 non-ISDN tie trunk group, enter set digit-treatment digit-treat, where digit-treat can be one of the following values:

Issue 2 January 2008

123

Configuring Standard Local Survivability (SLS)

blank (use this value to prevent any absorb or insert digit treatment from being applied) absorb1 absorb2 absorb3 absorb4 absorb5 insert1 insert2 insert3 insert4

Examples

set digit-treatment absorb1 removes the first digit from the incoming DID trunk set digit-treatment blank removes any digit treatment from the trunk group

8. For analog DID trunk groups or DS1 tie trunk groups, enter set digits digits to define the inserted digit string, where digits is the number of digits. Note: The number of digits must comply with the digit-treat parameter in the set digit-treatment command. If the digit-treat parameter is insert3, then the digits parameter for this command must be three digits in length. 9. Enter set name name to identify the user name for the trunk group. Use the 1-27 character name as specified on the Communication Manager form (add trunk-group n). Type the name string inside double quotes. 10. For ISDN trunks, enter set codeset-display codeset to identify which Q.931 codesets are allowed to send display information to the user phone: codeset0, codeset6, or codeset7. 11. For ISDN trunks, enter set codeset-national codeset to identify which Q.931 codesets are allowed to send National Information Elements (IEs, or display information) to the user phone: codeset6 or codeset7. 12. For ISDN trunks, enter set channel-preference type to define how the Channel Identification IE field is encoded, where type can be one of the following:

Note:

exclusive. The central office must have the ability to grant a call on this channel or reject the call attempt preferred. The central office might offer the call request on another available channel

124 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

13. For ISDN trunks, enter set digit-handling method to define the order of reception/transmission to be considered with the flow of inbound/outbound:

enbloc-enbloc enbloc-overlap overlap-enbloc overlap-overlap

Enbloc requires sending the entire collected digit string in one block. Overlap sends the digits one at a time as they are collected. 14. For ISDN trunks, enter set japan-disconnect yes | no to specify whether to perform a disconnect sequence (CONNECT message followed by a DISCONNECT message). 15. For ISDN trunks, enter set send-name method to define whether or not the calling, connected, called, or busy partys administered name is sent to the network on outgoing or incoming calls. method can be one of the following:

no. The name is not sent to the network for incoming or outgoing calls yes. The name is sent to the network for incoming or outgoing calls restricted. The name is sent to the network as Presentation restricted

Note:

Note: For this release, specify method as no, since sending a Calling Party Name is a future feature. 16. For ISDN trunks, enter set send-number method to define whether or not the calling, connected, called, or busy partys administered number is sent to the network on outgoing or incoming calls. method can be one of the following:

no. The number is not sent to the network for incoming or outgoing calls yes. The number is sent to the network for incoming or outgoing calls restricted. The number is sent to the network as Presentation restricted

Note:

Note: For this release, specify method as no, since sending a Calling Party Number is a future feature. 17. For ISDN trunks, enter set numbering-format type to specify the numbering plan for this trunk in Standard Local Survivability (SLS). The numbering plan encodes the Numbering Plan Indicator and Type of Number fields in the Calling/Connected Party Number IE in the ISDN protocol. type can be one of the following:

unknown. Both the Numbering Plan Indicator and Type of Number are unknown public. The Numbering Plan Indicator meets the E.164 standard and the Type of Number is national

Issue 2 January 2008

125

Configuring Standard Local Survivability (SLS)

Note:

Note: The SLS application is intended to operate into PSTN trunk interfaces. For this reason, the only two choices for network numbering plans identification are public (E.464) and unknown (no particular plan). For this release, specify type as unknown since SLS does not currently support an administrative table to calculate the Calling Party Number that is consistent with the numbering plan of the PSTN service provider. 18. For non-ISDN digital trunks, analog loop-start and analog ground-start trunks, enter set incoming-destination extension to identify an extension to directly receive an incoming trunk call, for example, an attendant or a voice response/recording system. 19. For non-ISDN digital trunks, enter set incoming-dialtone yes | no to specify whether to provide a dial tone in response to far-end trunk group seizures. 20. For a DS1 circuit, enter set trunk-hunt type to specify the trunk-hunting search within a facility in an ISDN trunk group or through a non-ISDN digital trunk group, where type is one of the following:

ascend. A linear search from the lowest to the highest numbered available channels circular. A circular search beginning with the point at which the search previously ended. When the search has reached the top of the channel list, it resumes at the bottom of the list in wrap-around fashion descend. A linear search from the highest to the lowest numbered available channels

21. Enter show to check the trunk-group administration. The report lists the trunk-group parameters.

The following example shows four BRI trunks assigned to one trunk-group:
Supervision Treat Insert ------------------- ------- ------

Group Type Dial Tac ----- ---------- ------ ---1 bri - *99 Name = Willow Street 2 Ports = v401,v402,v417,v418 Codeset Codeset Channel Display National Preference -------- -------- ---------codeset6 codeset6 exclusive

Digit Handling --------------enbloc-enbloc

Japan Discon -----no

Send Name ---yes

Send Number -----yes

Number Format -----public

Trunk Hunt -------ascend

126 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

The following example shows twelve ports assigned as T1inband signalling:

Group Type Dial Tac Supervision Treat Insert ----- ---------- ------ ---- ------------------- ------- -----1 t1inband dtmf *96 wink/immediate Name = Willow Street 2 Ports = v401,v402,v403,v404,v405,v406,v407,v408,v409,v410,v411,v412 Incoming-Dest Incoming-Dial Trunk-Hunt ------------- ------------- ---------no ascend

22. Enter exit to leave the trunk-group context in SLS.

Administering signaling-group parameters


1. Enter sig-group sgnum, where sgnum is any number from 1 to 650. The command line prompt changes to sls-sig-group <sgnum>. If you want to remove the signaling group from the SLS administration, enter exit to leave the second-level sig-group context and return to the (super-sls)# context, and then enter clear sig-group sgnum. 2. Enter set trunk-group-chan-select tgnum to specify the trunk-group number that accepts incoming calls where the Information Channel Selection field does not specify a preferred channel for bearer transport. This is useful if the signaling group controls more than one trunk group (in cases where you wish to manage a DS1 facility with more than one trunk group). 3. Enter set primary-dchannel circuit-number, where circuit-number is an identifier for a gateway, slot, or T1/E1 circuit, to select the primary D-channel number. For the value of circuit-number, you can use a 3-digit gateway identifier (for example, 005), a 2-character slot identifier (for example, v4), or a 2-digit circuit number (24 for T1-ISDN, 16 for E1-ISDN). 4. If your trunk is provisioned without a D-channel for signaling, enter set associated-signaling no to use Non-Facility Associated Signaling (NFAS). Note: NFAS is primarily a feature for ISDN-T1 connections offered by service providers in North America and Hong Kong. However, it can also be used on private-network connections, and in that context it is possible to set up NFAS using ISDN-E1 interfaces. If you are using NFAS, enter add nfas-interface gateway module interface-id, where gateway is the 3-digit gateway identifier, module is the 2-character slot identifier, and interface-id is the DS1 circuit number associated with the NFAS group. The value of interface-id is received from the network service provider.

Note:

Issue 2 January 2008

127

Configuring Standard Local Survivability (SLS)

Note:

Note: The North American Public Network Service Providers do not allow any part of a T1 to be shared outside of this NFAS-trunk group. In other words, they do not allow one of the T1 interfaces (of this NFAS group) to be fractionalized into two or more uses. It must be dedicated to this given customer. Therefore, the following usage rules apply: - All members of an NFAS DS1 (that are administered) must belong to the same trunk-group - All members of this trunk-group must belong to a single signaling group 5. Enter show to check the signaling groups administration. The report lists the signaling groups parameters. For example:
Sig-group Tg-Select Assoc-Sig Prime-Dchan Nfas-Modules/Nfas-Id --------- --------- --------- ----------- ------------------------------------10 98 yes 005v424 -

6. Enter exit to leave the sig-group context in SLS.

Administering dial-pattern parameters


1. Enter dial-pattern dialed-string, where dialed-string is a dial pattern to be used on outgoing calls. The command line prompt changes to super-sls/dial-pattern <dialed-string>. If you want to remove the incoming routing treatment from the SLS administration, enter exit to leave the second-level dial-pattern context and return to the (super-sls)# context, and then enter clear dial-pattern dialed-string. 2. Enter set type dial-type, where dial-type specifies the type of outbound call and the dialing privileges available for outbound calls. The following call types are available:

emer. Emergency calls only fnpa. 10-digit North American Numbering Plan calls hnpa. 7-digit North American Numbering Plan calls intl. Public-network international number calls iop. International operator calls locl. Public-network local number calls natl. Non-North American Numbering Plan calls op. Operator calls svc. Service calls

128 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Note:

Note: Each level of call includes the previous levels dialing privileges. For example, locl has the calling privileges of iop, intl, etc. See Figure 3 for an illustration of the relationship between the various dial types and the COR permissions. 3. Enter set max-length length to define the maximum length of the dialed string. This must be set prior to the minimum length if the minimum length is larger than the default value. 4. Enter set min-length length to define the minimum length of the dialed string. 5. Enter set tgnum tgnum to designate a trunk-group for which this dialed string is assigned. 6. Enter set deny no to permit stations to originate outgoing trunk calls. 7. At the command-line enter set insert-digits digits to define the digits to insert into a dialed string, if required. 8. Enter set delete-digits digits to define the number of digits to be deleted from a dialed string, if required. Note: You may either insert or delete digits, but not both. 9. Enter show to check the outbound dial-pattern string administration. The report lists the dial-pattern parameters. For example:

Note:

Dialed-String/Deny -----------------5381000/n 5385000/n

Min/Max Length -----9/9 9/9

Type ---locl locl

Trunk Group ----2 3

Delete/Insert Digits ---------------------1/303 1/720

10. Enter exit to leave the dial-pattern context in SLS.

Administering incoming-routing parameters


The incoming-routing parameters are useful for mapping DNIS numbers directly into the station extension numbers when the Service Provider's DNIS plan does not directly reflect the station extension number length used in the gateways dial plan. Note: Since the PIM application does not automatically extract this information from the CM's SAT screen for Incoming-Digit-Treatment-Handling, you must enter this SLS information via the gateway CLI interface.

Note:

Issue 2 January 2008

129

Configuring Standard Local Survivability (SLS)

1. Enter incoming-routing tgnum mode, where tgnum is an existing ISDN trunk group number and mode is the protocol used for receiving incoming digits. mode can be either enbloc or overlap. The command line prompt changes to sls-incoming-routing <tgnum>. If you want to remove the incoming routing treatment from the SLS administration, enter exit to leave the second-level incoming-routing context and return to the (super-sls)# context, and then enter clear internal-routing tgnum mode. 2. Enter set match-pattern pattern to define the beginning digit pattern of an incoming alphanumeric dial string to be matched against. 3. Enter set length length to define the length of the dialed string. 4. If the mode is set to enbloc (in Step 1), you must:

Enter set delete-digits digits to define the number of digits to be deleted from a dialed string. Enter set insert-digits digits to define the number of digits to be inserted at the beginning of a dialed string.

5. (Optional) If the mode is set to overlap (in Step 1), you may configure only one of the following options:

Enter set delete-digits digits to define the number of digits to be deleted from a dialed string. Or

Enter set insert-digits digits to define the number of digits to be inserted at the beginning of a dialed string.

Note that this action takes place after the deletion task has been completed for the enbloc-receiving mode. 6. Enter exit to leave the incoming-routing context in SLS. 7. Enter show to check the incoming-routing administration. The report lists the incoming-routing parameters for all dial patterns that have been administered. For example:

Match_pattern ------------234 235

Length -----7 7

Del --3 3

Insert-digits ------------5381000 5381001

Mode -----enbloc enbloc

tgnum ----98 99

130 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Summary of SLS configuration commands


For more information about these commands, see SLS survivability on page 424. Table 40: SLS CLI command hierarchy
Root Level Commands
set sls show sls sls bri set bearer-capability

First Level Context Commands

Second Level Context Commands

Description

Enable or disable SLS Display SLS status: enabled or disabled Enter the sls context Administer an ISDN Basic Rate Interface (BRI) port for SLS Set the Information Transfer Rate field of the Bearer Capability IE in SLS Specify the ISDN Layer 3 country protocol type in SLS Assign a directory number to the B1 channel of the BRI interface in SLS Assign a directory number to the B2 channel of the BRI interface in SLS Determine whether or not the far-end supports endpoint initialization in SLS Specify the glare-handling convention for a BRI link in SLS Set the interface to agree with the companding method used by the far-end of the DS1 circuit for SLS mode Determine whether or not to keep the physical layer active (stable) between calls in SLS Identify the user name for an ISDN facility in SLS Specify the glare-handling conditions when the set interface command has been administered as peerMaster or peerSlave for the ISDN link in SLS Assign a Service Profile Identifier (SPID) to the B1 channel of the BRI link in SLS

set country-protocol set directory-number-a set directory-number-b set endpoint-init

set interface set interface-companding

set layer1-stable

set name set side

set spid-a

1 of 8

Issue 2 January 2008

131

Configuring Standard Local Survivability (SLS)

Table 40: SLS CLI command hierarchy (continued)


Root Level Commands First Level Context Commands Second Level Context Commands
set spid-b Description

Assign a Service Profile Identifier (SPID) to the B2 channel of the BRI link in SLS Select the method by which the Layer 2 (LAPD) protocol obtains its Terminal Endpoint Identification (TEI) address in SLS List all BRI SLS parameters for this BRI port Delete the administered attendant provisioning in SLS Delete the administration for a given BRI channel in SLS Delete a single dialed string pattern entry in the SLS data set Delete the administration for a specific DS1 channel in SLS Delete a particular extension number in the SLS data set. Note: It is preferable to use the clear station command. Delete an administered Feature Access Code for SLS Delete an entry for a particular incoming routed string that is associated with a given trunk group in SLS Delete the administration for a given ISDN signaling group in SLS Delete the slot and the board administration in the TGM550 Telephony Gateway Module for SLS Set the SLS parameters to their default values Delete a particular extension number in the SLS data set Delete a trunk group entry from the SLS data set Administer ARS dial patterns for SLS

set tei-assignment

show clear attendant clear bri clear dial-pattern clear ds1 clear extension

clear fac clear incoming-routing

clear sig-group clear slot-config

clear survivable-config clear station clear trunk-group dial-pattern

2 of 8

132 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 40: SLS CLI command hierarchy (continued)


Root Level Commands First Level Context Commands Second Level Context Commands
set delete-digits Description

Specify the number of digits to be deleted from the beginning of the dialed string for an outbound call in SLS Permit or deny access to an outbound trunk in SLS Specify the number of digits to be inserted at the beginning of the dialed string for an outbound call in SLS Establish the maximum length of the dialed string in SLS Establish the minimum length of the dialed string in SLS Designate the trunk-group number in SLS Administer the type of outbound call in SLS List all dial-pattern SLS parameters Administer DS1 trunks for SLS

set deny set insert-digits

set max-length set min-length set tgnum set type show ds1 set bearer-capability

Set the Information Transfer Rate field of the Bearer Capability IE in SLS Set the maximum transmission rate for the DS1 facility in SLS Select the channel-numbering method for B-channels on an E1 interface in SLS Specify the equipment at the far-end of the DS1 link in SLS Specify the ISDN Layer 3 country protocol type in SLS Specify the glare-handling convention for a DS1 link in SLS Set the interface to agree with the companding method used by the far-end of the DS1 circuit for SLS mode Increase the duration of the T303 (call establishment) timer in SLS

set bit-rate set channel-numbering

set connect set country-protocol set interface set interface-companding

set long-timer

3 of 8

Issue 2 January 2008

133

Configuring Standard Local Survivability (SLS)

Table 40: SLS CLI command hierarchy (continued)


Root Level Commands First Level Context Commands Second Level Context Commands
set name set protocol-version Description

Identify the user name for a DS1 facility in SLS Specify country protocol for countries whose public networks allow for multiple ISDN Layer 3 country protocols for ISDN Primary Rate service in SLS Specify the glare-handling conditions when the set interface command has been administered as peerMaster or peerSlave for the ISDN link in SLS Set the signaling mode for the DS1 facility in SLS List all SLS parameters for this DS1 interface Administer digit-treatment for incoming routed calls in SLS

set side

set signaling-mode show Incoming-routing set delete-digits

Specify number of digits to be deleted from the beginning of the dialed string for an inbound trunk call in SLS Specify number of digits to be inserted at the beginning of the dialed string for an inbound trunk call in SLS Specify the length of the dialed string in SLS Specify the beginning digit pattern of the incoming alphanumeric dial string to be matched against in SLS List all incoming-routing SLS parameters Specify the dial access code for the attendant feature, and specify the station which serves as the branch office attendant position Set a date format for the SLS data set Administer the Feature Access Code for SLS Configure an IP codec set within the SLS data set

set insert-digits

set length set match-pattern

show set attendant

set date-format set fac set ip-codec-set

4 of 8

134 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 40: SLS CLI command hierarchy (continued)


Root Level Commands First Level Context Commands
set max-ip-registrations

Second Level Context Commands

Description

Configure the maximum number of IP registrations allowed in the SLS data set Prevent or enable PIM updates while working on SLS administration of the TGM550 Telephony Gateway Module Define the slot and the board type in the TGM550 Telephony Gateway Module for SLS Display the administered attendant provisioning List the administered BRI parameters for SLS Display the current date format for the SLS data set List all dial-pattern strings in the SLS data set List the administered DS1 parameters for SLS Display extension-specific SLS data parameters. Note: It is preferable to use the show station command List the administered Feature Access Codes for SLS Show all of the administered dial patterns in SLS for trunk groups List the codec set entries for SLS Display when the last PIM update of SLS data occurred Display the maximum IP registration administration in the SLS data set Display the current status of the setting for the PIM lockout feature List all administered signaling groups in SLS Define the slot and the board administration in the TGM550 Telephony Gateway Module for SLS

set pim-lockout

set slot-config

show attendant show bri show date-format show dial-pattern show ds1 show extension

show fac show incoming-routing show ip-codec-set show last-pim-update show max-ip-registrations show pim-lockout show sig-group show slot-config

5 of 8

Issue 2 January 2008

135

Configuring Standard Local Survivability (SLS)

Table 40: SLS CLI command hierarchy (continued)


Root Level Commands First Level Context Commands
show station show trunk-group sig-group add nfas-interface

Second Level Context Commands

Description

Display extension-specific SLS data parameters Display trunk group administration in SLS Administer signaling groups for SLS Identify a list of DS1 modules that are controlled by the primary D-channel in SLS Remove a member from a NFAS-managed DS1 group in SLS Specify whether the D-channel is physically present in the DS1 interface in SLS Identify the D-channel number in SLS Specify the trunk-group number that can accept incoming calls in cases where the Information Channel Selection field does not specify a preferred channel for bearer transport in SLS List all SLS parameters for this signaling-group Administer stations for SLS set cor Administer the class-of-restriction values for each station that uses SLS Administer a DCP or IP station for an expansion module in SLS Identify the user name for a station in SLS Administer a station password in SLS for DCP and IP station sets Administer the port on a station for SLS Enable SLS to recognize the switchhook flash signal from a particular analog station and to provide a subsequent transfer service

remove nfas-interface set associated-signaling

set primary-dchannel set trunk-group-chan-select

show station

set expansion-module set name set password set port set swhook-flash

6 of 8

136 IG550 Integrated Gateway Administration and CLI Reference

Configuring SLS

Table 40: SLS CLI command hierarchy (continued)


Root Level Commands First Level Context Commands Second Level Context Commands
set trunk-destination Description

Administer a station extension to be included in a pool of stations that can receive incoming analog loop-start trunk calls in circular queuing in SLS Administer specific phone models for SLS List all Station SLS parameters for this station Administer trunks for SLS

set type show trunk-group add port clear tac

Administer the port appropriate for SLS Remove a trunk access code (TAC) assignment from a trunk group in SLS Remove the port assignment from a trunk group in SLS Specify whether the ISDN trunk group will operate by declaring the service type explicitly on a call-by-call basis Specify the type of service or feature being declared in the Network Services Facility information element Define what class of service is being specified, as part of the scocs service declared in the Network Services Facility information element Define how the Channel Identification IE field is encoded in SLS Specify which Q.931 codesets are allowed to send display information to the user phone in SLS Specify which Q.931 codesets are allowed to send National Information Elements to the user phone in SLS Define the method for sending outbound digits in SLS Define how the inbound/outbound calls handle the transmission/reception of the dialed pattern in SLS

remove port set cbc

set cbc-parameter

set cbc-service-feature

set channel-preference

set codeset-display

set codeset-national

set dial set digit-handling

7 of 8

Issue 2 January 2008

137

Configuring Standard Local Survivability (SLS)

Table 40: SLS CLI command hierarchy (continued)


Root Level Commands First Level Context Commands Second Level Context Commands
set digits Description

Define the inserted dial string that is added to the beginning of the received DID incoming dial string for analog DID trunks or for DS1 TIE trunks using in-band signaling in SLS Define the incoming digit treatment for analog DID trunks or for DS1 TIE trunks using in-band signaling in SLS Identify an extension to directly receive an incoming trunk call in SLS Provide a dial tone in response to far-end trunk group seizures in SLS Perform a disconnect sequence (CONNECT message followed by a DISCONNECT message) in SLS Identify the user name for a trunk group in SLS Specify the numbering plan for this trunk in SLS Define whether or not the calling, connected, called, or busy partys administered name is sent to the network on outgoing or incoming calls in SLS Define whether or not the calling, connected, called, or busy partys administered number is sent to the network on outgoing or incoming calls in SLS Define the incoming signaling supervision mode for analog DID trunks or DS1 tie trunks only in SLS Administer the trunk-access codes for SLS Specify the trunk-hunting search within a facility in an ISDN trunk group or through a non-ISDN digital trunk group in SLS List all trunk-group SLS parameters for this trunk-group

set digit-treatment

set incoming-destination set incoming-dialtone set japan-disconnect

set name set numbering-format set send-name

set send-number

set supervision

set tac set trunk-hunt

show

8 of 8

138 IG550 Integrated Gateway Administration and CLI Reference

Chapter 5: Configuring logging


System logging is a method of collecting system messages generated by system events. The TGM550 Telephony Gateway Module includes a logging package that collects system messages in several output types. Each of these types is called a sink. When the system generates a logging message, the message can be sent to each sink that you have enabled. Table 41: Logging sinks Sink Syslog Description Logging messages are sent to up to three configured servers, using Syslog protocol as defined in RFC 3164. Messages sent to the Syslog server are sent as UDP messages. Logging data is saved in the flash memory. These compressed, cyclic files serve as the system logging database. Logging messages are sent to the terminal screen as follows: For a local connection, messages appear online on the local terminal. For a remote Telnet/SSH connection, messages appear online on the remote terminal. This sink is deleted whenever a session ends.

Log file Session

System messages do not always indicate problems. Some messages are informational, while others may help to diagnose problems with communications lines, internal hardware, and system software. By default, all sinks are disabled. When enabled, log file and Syslog sink settings can be saved by entering copy running-config startup-config to save the running configuration to the startup configuration. However, the Session sink and its settings are deleted when the session is terminated. You can define filters for each sink to limit the types of messages the sink receives (see Configuring logging filters on page 147). The logging facility logs configuration commands entered through the CLI or via SNMP, as well as system traps and informative messages concerning the behavior of various processes. However, a user enabling the log will only see entered commands with a user-level no higher than the users privileges. For example, a user with read-only privileges will not see entered commands having a read-write user level. In addition, the log does not display entered information of a confidential nature, such as, passwords and VPN pre-shared-keys.

Issue 2 January 2008

139

Configuring logging

Configuring a Syslog server


A Syslog server is a remote server that receives logging messages using the Syslog protocol. This enables storage of large log files, which you can use to generate reports.

Defining Syslog servers


You can define up to three Syslog servers. 1. Define the Syslog server by entering set logging server followed by the IP address of the server. For example:
TGM550-001(super)# set logging server 147.2.3.66 Done!

2. Enable the Syslog server by entering set logging server enable followed by the IP address of the Syslog server. When you define a new Syslog server, it is defined as disabled, so you must use this command in order to enable the server. For example:
TGM550-001(super)# set logging server enable 147.2.3.66 Done!

3. Optionally, define an output facility for the Syslog server by typing the set logging server facility command, followed by the name of the output facility and the IP address of the Syslog server. If you do not define an output facility, the default local7 facility is used. For example:
TGM550-001(super)# set logging server facility auth 147.2.3.66 Done!

The following is a list of possible facilities:


auth. Authorization daemon. Background system process clkd. Clock daemon clkd2. Clock daemon mail. Electronic mail local0 local7. For local use ftpd. FTP daemon kern. kernel alert. Log alert audi. Log audit

140 IG550 Integrated Gateway Administration and CLI Reference

Configuring a Syslog server

ntp. NTP subsystem lpr. Printing sec. Security syslog. System logging uucp. Unix-to-Unix copy program news. Usenet news user. User process

4. Optionally, limit access to the Syslog server output by typing the set logging server access-level command, followed by an access level (read-only, read-write, or admin) and the IP address of the Syslog server. If you do not define an access level, the default read-write level is used. For example:
TGM550-001(super)# set logging server access-level read-only 147.2.3.66 Done!

Only messages with the appropriate access level are sent to the Syslog output. 5. Optionally, define filters to limit the types of messages received (see Configuring logging filters on page 147).

Disabling Syslog servers


Enter set logging server disable followed by the IP address of the Syslog server. For example:
TGM550-001(super)# set logging server disable 147.2.3.66 Done!

Deleting Syslog servers


You can delete a Syslog server from the Syslog server table. Enter clear logging server followed by the IP address of the Syslog server you want to delete. For example:
TGM550-001(super)# clear logging server 147.2.3.66 Done!

Issue 2 January 2008

141

Configuring logging

Displaying the status of the Syslog server


Enter show logging server condition followed by the IP address of the Syslog server. If you do not specify an IP address, the command displays the status of all Syslog servers defined for the TGM550 Telephony Gateway Module. As the following example illustrates, the command displays whether the server is enabled or disabled, and lists all filters defined on the server:
TGM550-001(super)# show logging server condition 147.2.3.66

****************************************************** *** Message logging configuration of SYSLOG sink *** Sink Is Enabled Sink default severity: Warning Server name: 147.2.3.66 Server facility: auth Server access level: read-only

Syslog sink default settings


Severity. Warning Facility. Local 7 Access level. Read-write

Syslog message format


Syslog messages are arranged chronologically and have the following format:
<34> Oct 11 22:14:15 host LINKDOWN SWICHFABRIC-Notification:Port 10/3 Link

The message provides the following information:

A priority (<34> in this example), which is calculated based on the syslog facility and the severity level. A header (Oct 11 22:14:15 host LINKDOWN in this example), providing the date and time, the hostname, and a message mnemonic. A message (SWICHFABRIC-Notification: Port 10/3 Link in this example), detailing the application being logged, the severity level, and the message text.

142 IG550 Integrated Gateway Administration and CLI Reference

Configuring a log file

Configuring a log file


A log file is a file of data concerning a system event, saved in the flash memory. The log files serve as the system logging database, keeping an internal record of system events. 1. Enter set logging file enable.
TGM550-001(super)# set logging file enable Done!

2. Optionally, define filters to limit the types of messages received (see Configuring logging filters on page 147).

Disabling logging system messages to a log file


Enter set logging file disable.
TGM550-001(super)# set logging file disable Done!

Deleting current log file and opening an empty log file


Enter clear logging file.
TGM550-001(super)# clear logging file Done!

Issue 2 January 2008

143

Configuring logging

Displaying log file messages


Use the show logging file content command. Note that the user enabling the log will only see entered commands with a user-level no higher than the users privileges. A user with read-only privileges will not see entered commands having a read-write user level. For example:
TGM550-001(super)# show logging file content 11/21/2004,15:45:43:CLI-Notification: root: nvram initialize 11/21/2004,15:43:08:CLI-Notification: root: exit 11/21/2004,15:42:20:ROUTER-Warning: Duplicate IP address: 3.3.3.1 from 00:00:021 11/18/2004,16:48:21:CLI-Notification: root: no track 20 11/18/2004,16:48:18:SAA-Debug: Response for ipIcmpEcho timed-out on rtr 6, echo. 11/18/2004,16:48:18:CLI-Notification: root: no rtr-schedule 6 11/18/2004,16:48:18:SAA-Informational: rtr 6 state changed to pending. 11/18/2004,16:48:18:TRACKER-Informational: track 6 state changed to pending.

Displaying conditions defined for the file output sink


Enter show logging file condition. For example:
TGM550-001(super)# show logging file condition

****************************************************** *** Message logging configuration of FILE sink ***

Sink Is Enabled Sink default severity: Informational

144 IG550 Integrated Gateway Administration and CLI Reference

Configuring a session log

Log file message format


Log file messages appear in first-in, last-out order. They have the following format:
01/18/2005,10:55:09:CLI-Notification: root: set port disable 10/6

01/18/2005,10:49:03:SWITCHFABRIC-Notification: Port Connection Lost on Module 10 port 5

Each message provides the following information:


The date and time (if available) The logging application The severity level The message text

Configuring a session log


A session log is the display of system messages on the terminal screen. It is automatically deleted when a session ends. 1. Enter set logging session enable.
TGM550-001(super)# set logging session enable Done!

Note:

Note: If the device is connected to several terminals, a separate session log is established for each terminal. 2. Optionally, define filters to limit the types of messages received (see Configuring logging filters on page 147).

Discontinuing the display of system messages


To discontinue the display of system messages to the terminal screen, enter set logging session disable.
TGM550-001(super)# set logging session disable Done!

Issue 2 January 2008

145

Configuring logging

Displaying how the session logging is configured


Enter show logging session condition. This command displays whether session logging is enabled or disabled, and lists all filters defined for session logging. For example:
TGM550-001(super)# show logging session condition

****************************************************** *** Message logging configuration of SESSION sink *** Sink Is Enabled Sink default severity: Warning Session source ip: 172.16.1.231

Session logging message format


Session logging messages are arranged chronologically and have the format shown in the following example:
01/18/2005,10:49:03:SWITCHFABRIC-Notification: Port Connection Lost on Module 10 port 5 was cleared 01/18/2005,10:55:09:CLI-Notification: root: set port disable 10/6

Each message provides the following information:


The date and time (if available) The logging application The severity level The message text

Note:

Note: The user enabling the log will only see entered commands with a user-level no higher than the users own privileges. For example, a user with read-write privileges will not see entered commands having an admin user level.

146 IG550 Integrated Gateway Administration and CLI Reference

Configuring logging filters

Configuring logging filters


You can use filters to reduce the number of collected and transmitted messages. The filtering options are based on message classification by severity for each application. For a specified sink, you can define the threshold severity level for message output for each application. Messages pertaining to the specified applications, that have a severity level stronger than or equal to the defined threshold, are sent to the specified sink. Messages with a severity level weaker than the defined threshold are not sent.

Setting the logging filters


For each sink, you can set logging filters by specifying a severity level per application, as follows:

To create a filter for messages sent to a specified Syslog server, enter set logging server condition application severity ip address. To create a filter for messages sent to a log file, enter set logging file condition application severity. To create a filter for messages sent to a session log on a terminal screen, enter set logging session condition application severity. where:

application is the application for which to view messages (use all to specify all applications). For the list of applications see Applications to be filtered on page 149. severity is the minimum severity to log for the specified application (use none to disable logging messages for the specified application). For a list of the severity levels and the default severity settings, see Severity levels on page 148. ip address is the IP address of the Syslog server.

For example:
TGM550-001(super)# set logging server condition dialer critical 147.2.3.66 Done! TGM550-001(super)# set logging file condition dhcps warning Done! TGM550-001(super)# set logging session condition ISAKMP Information Done!

You can also filter the show logging file content command by severity for each application, using the same variables as in the set logging file condition command. In addition, you can limit the number of messages to display.

Issue 2 January 2008

147

Configuring logging

For example, to display the 50 most recent messages from the QoS application with a severity level of critical or higher, enter the following command:
TGM550-001(super)# show logging file content critical qos 50

Severity levels
Table 42: Severity levels Severity level emergency alert critical error warning notification informational debugging Code 0 1 2 3 4 5 6 7 Description System is unusable Immediate action required Critical condition Error condition Warning condition Normal but significant condition Informational message only Message that only appears during debugging

Sinks default severity levels


Syslog. Warning Log file. Informational Session - Session from terminal. Informational - Session from telnet/ssh. Warning

148 IG550 Integrated Gateway Administration and CLI Reference

Configuring logging filters

Applications to be filtered
Filters can be defined for any application listed in Table 43. Table 43: Logging applications Application boot cascade cdr cli aan config console dhcpc dhcps dialer dnsc fan filesys ids ipsec isakmp lag policy ppp pppoe qos router Description System startup failures Stack CASCADE mechanism Call Detail Recording. Registers the active calls in SLS mode. CLI Application Assurance Networking. CNA test plugs report to AAN. Configuration changes Serial modem messages DHCP client package DHCP server package Dialer interface messages DNS client package Cooling system File system problem (flash) IDS events, specifically a SYN attack heuristic employed by the SYN cookies feature VPN IPSEC package VPN IKE package Link Aggregation package Policy package PPP protocol PPP over Ethernet QoS messages Core routing system failures 1 of 2

Issue 2 January 2008

149

Configuring logging

Table 43: Logging applications (continued) Application rtp-stat saa security snmp stp supply switchfabric system tftp threshold tracker usb-modem vlan voice wan Description RTP MIB statistics RTR-probes messages Secure logging (authentication failure) SNMP agent Spanning tree package Power supply system Switch fabric failures Operating system failures Internal TFTP server RMON alarms Object tracker messages USB modem messages VLAN package Voice failures WAN plugged-in expansion 2 of 2

Syslog server example


The following example defines a Syslog server with the following properties:

IP address 147.2.3.66 Logging of messages enabled Output to the Kernel facility Only messages that can be viewed by read-write level users are received

150 IG550 Integrated Gateway Administration and CLI Reference

Configuring logging filters

Filter restricts receipt of messages from all applications to those less severe than error
set logging server 147.2.3.66 set logging server enable 147.2.3.66 set logging server facility kern 147.2.3.66 set logging server access-level read-write 147.2.3.66 set logging server condition all error 147.2.3.66

TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# Done!

Log file example


The following example enables the logging of system messages to a log file in the flash memory and creates a filter to restrict the receipt of messages from the boot application to those with severity level of informational or more severe, and messages from the cascade application to those with severity level of alert or more severe.
TGM550-001(super)# set logging file enable Done! TGM550-001(super)# set logging file condition boot informational Done! TGM550-001(super)# set logging file condition cascade alert Done!

Issue 2 January 2008

151

Configuring logging

Session log example


The following example enables a session log for a user wishing to debug the ISAKMP application, while only receiving messages of severity level error or stronger for all other applications. Therefore, the user sets the default severity level for all applications to error, and then sets the severity of the ISAKMP application to informational. Finally, the user displays the filter settings.
TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# set logging session enable set logging session condition all Error set logging session condition ISAKMP Informational show logging session condition

****************************************************** *** Message logging configuration of CLI sink *** Sink Is Enabled Sink default severity: Error Application ! Severity Override ------------------------------------------ISAKMP ! Informational

Summary of Logging configuration CLI commands


For more information about these commands, see Logging on page 359. Table 44: Logging configuration CLI commands Command clear logging file Description Delete the message log file being stored in non-volatile memory (NVRAM), including the history log, and open a new, empty log file Delete the specified Syslog message server from the Syslog server table Manage the logging of system messages to non-volatile memory (NVRAM) 1 of 2

clear logging server set logging file

152 IG550 Integrated Gateway Administration and CLI Reference

Summary of Logging configuration CLI commands

Table 44: Logging configuration CLI commands (continued) Command set logging server set logging server access-level set logging server condition set logging server enable | disable set logging server facility set logging session show logging file condition show logging file content show logging server condition show logging session condition Description Define a new Syslog output server for remote logging of system messages Set the access level associated with a Syslog server sink Set a filter for messages sent to the specified Syslog server. Messages can be filtered by source system, severity, or both. Enable or disable a specific Syslog server Define an output facility for the specified Syslog server Manage message logging for the current console session Display all conditions that have been defined for the file output sink Output the messages in the log file to the CLI console Display the filter conditions defined for the Syslog output sink Display the filter conditions defined for message logging to the current console session 2 of 2

Issue 2 January 2008

153

Configuring logging

154 IG550 Integrated Gateway Administration and CLI Reference

Chapter 6: Configuring VoIP QoS


The TGM550 Telephony Gateway Module provides voice services over IP data networks using VoIP. VoIP is a group of protocols for transmitting and receiving various types of voice data over an IP network. VoIP includes protocols for transmitting and receiving the following types of information:

Digitally encoded voice data Call signalling information Call routing information QoS information

VoIP uses the RTP and RTCP protocols to transmit and receive digitally encoded voice data. For more information about configuring RTP and RTCP on the TGM550 Telephony Gateway Module, see Configuring RTP and RTCP on page 155. You can use many types of telephones and trunks that do not directly support VoIP. The TGM550 Telephony Gateway Module translates voice and signalling data between VoIP and the system used by the telephones and trunks.

Configuring RTP and RTCP


VoIP uses the RTP and RTCP protocols to transmit and receive digitally encoded voice data. RTP and RTCP are the basis of common VoIP traffic. RTP and RTCP run over UDP and incur a 12-byte header on top of other (IP, UDP) headers. Running on PPP or frame relay, these protocols can be compressed.

Configuring QoS parameters


The TGM550 Telephony Gateway Module uses MGCP (H.248) protocol for call signalling and call routing information. Use the following commands to configure QoS for signalling and VoIP traffic.

Issue 2 January 2008

155

Configuring VoIP QoS

Use the set qos control command to define the source for QoS control parameters. The source can be either local, in which case the user configures the values locally on the TGM550 Telephony Gateway Module, or remote, in which case the values are obtained from the TGM550 Telephony Gateway Modules registered MGC. Use the set qos signal command to provide the means to set up QoS parameters for MGCP (H.248) communication with the MGC. Use the show qos-rtcp command to display the local and downloaded QoS parameters. Use the set qos bearer command to provide the means to set up QoS parameters for the VoIP bearer. The parameters you define using the set qos bearer command may conflict with the default QoS list (400). In particular, the signal 802.1 priority and the bearer 802.1 priority are not applicable for the TGM550.

For more information about these commands, including parameters and default settings, see Chapter 13: CLI Commands on page 235.

Configuring RTCP QoS parameters


Use the following commands to set the RTCP QoS parameters.

Use the set qos rtcp command to permit the setup of RTCP parameters. The parameters that can be set are enabling or disabling RTCP reporting capability, setting the IP address of the monitor, setting the reporting period (the default is five seconds), and defining the listening port number. Use the show qos-rtcp command to display QoS, RSVP, and RTCP parameters.

RSVP parameters
VoIP can use the RSVP protocol to reserve network resources for voice data while communicating with other media gateways and other VoIP entities, such as, IP phones and Softphones.

Use the set qos rsvp command to set the current values for the RSVP parameters of the VoIP engines. The parameters that can be set are enabled/disabled, refresh rate (seconds), failure retry (y or n), and service profile (Guaranteed or Controlled). Use the show qos-rtcp command to display QoS, RSVP, and RTCP parameters.

156 IG550 Integrated Gateway Administration and CLI Reference

Configuring QoS parameters

Summary of QoS, RSVP, and RTCP configuration CLI commands


For more information about these commands, see QoS on page 390. Table 45: QoS, RSVP and RTCP configuration CLI commands Command set qos bearer set qos control set qos rsvp set qos rtcp set qos signal show qos-rtcp Description Permit the setting of VoIP QoS-bearer related parameters for the Media Gateway Processor and VoIP engines Define the source for QoS control parameters: local or remote Set values for the RSVP parameters of the VoIP engines Set values for RTCP parameters Set QoS signaling parameters (DSCP or 802.1Q) for the Media Gateway Processor Display QoS, RSVP, and RTCP parameters

Issue 2 January 2008

157

Configuring VoIP QoS

158 IG550 Integrated Gateway Administration and CLI Reference

Chapter 7: Configuring Emergency Transfer Relay (ETR)


The ETR feature provides basic telephone services in the event of system failure, such as a power outage or a failed connection to the MGC. ETR is activated automatically. When ETR is activated, the TGM550 Telephony Gateway Module connects the fixed analog trunk port to the first fixed analog line port. An outside telephone exchange can be connected to the trunk port and an analog telephone can be connected to the line port. All calls are then directed by the analog relay between the outside line and the analog telephone. A current-loop detection circuit prevents ongoing calls from being disconnected when normal functioning resumes. If a call is in progress on LINE 1 when the problem ends, the call continues. The fixed trunk port and analog line ports do not start to operate until the active call ends. The ETR closes the tip/ring contacts between TGM550 trunk port 2 and TGM550 line port 3.

! CAUTION:
CAUTION:

Some ports should not be administered as DID ports to avoid having the ETR loop-start trunk connected directly to the tip and ring circuit of the DID trunk, thus creating two battery feed circuits driving one another. J2320/J2350/J4350/J6350 models do not use the indicated Integrated ports for DID.

When ETR is active and the TGM550 Telephony Gateway Module has power, the ETR front panel LED is lit.

Setting ETR state


By default, ETR is set to go into effect automatically in the event of power outage or a failed connection to the MGC. You can activate ETR manually via the CLI.

To activate ETR manually in the TGM550, use the following command:

set etr 7 manual-on

Generally, you should only use this command for testing.

To deactivate ETR manually in the TGM550, use the following command:

set etr 7 manual-off

ETR does not become active in the event of link failure.

Issue 2 January 2008

159

Configuring Emergency Transfer Relay (ETR)

To restore ETR to automatic activation in the TGM550, use the following command:

set etr 7 auto

If the system fails, the trunk and port are automatically latched. Note: A call in progress will be terminated when ETR is activated either automatically or manually. The relay call will be terminated only when ETR is deactivated manually.

Note:

Viewing ETR state


You can enter show etr to display ETR information. This information includes the following:

Admin state (auto, manual-off, or manual-on) Module status (in service, out of service, or out of service waiting for off-hook) Trunk number of the trunk connected to ETR Line number of the line connected to ETR Line status (off hook or on hook)

Summary of ETR commands


For more information about these commands, see ETR on page 319. Table 46: ETR configuration CLI commands Command set etr show etr Description Enable or disable Emergency Transfer Relay (ETR) mode, or allow the gateway to control ETR mode automatically Display the status of Emergency Transfer Relay (ETR) mode

160 IG550 Integrated Gateway Administration and CLI Reference

Chapter 8: Configuring SNMP


SNMP uses software entities called managers and agents to manage network devices. The manager monitors and controls all other SNMP-managed devices or network nodes on the network. There must be at least one SNMP Manager in a managed network. The manager is installed on a workstation located on the network. An agent resides in a managed device or network node. The agent receives instructions from the SNMP Manager, generates reports in response to requests from the SNMP Manager, and sends management information back to the SNMP Manager as events occur. The agent can reside on:

Routers Bridges Hubs Workstations Printers Other network devices

There are many SNMP management applications, but all these applications perform the same basic task. They allow SNMP managers to communicate with agents to configure, get statistics and information, and receive alerts from network devices. You can use any SNMP-compatible network management system to monitor and control a TGM550 Telephony Gateway Module.

Agent and manager communication


There are several ways that the SNMP manager and the agent communicate. The manager can:

Retrieve a value (get). The SNMP manager requests information from the agent, such as the number of users logged on to the agent device or the status of a critical process on that device. The agent gets the value of the requested Management Information Base (MIB) variable and sends the value back to the manager. Retrieve the value immediately after the variable you name (get-next). The SNMP manager retrieves different instances of MIB variables. The SNMP manager takes the variable you name and then uses a sequential search to find the desired variable. Retrieve a number of values (get-bulk). The SNMP manager retrieves the specified number of instances of the requested MIB variable. This minimizes the number of protocol exchanges required to retrieve a large amount of data.

Issue 2 January 2008

161

Configuring SNMP

Note:

Note: Get-bulk is not supported in SNMPv1.

Change a configuration on the agent (set). The SNMP manager requests the agent to change the value of the MIB variable. For example, you can run a script or an application on a remote device with a set action. Receive an unsolicited message (notification). The SNMP manager receives an unsolicited message from an agent at any time if a significant, predetermined event takes place on that agent. When a notification condition occurs, the SNMP agent sends an SNMP notification to the device specified as the trap receiver or trap host. The SNMP Administrator configures the trap host, usually the SNMP management station, to perform the action needed when a trap is detected. Note: For a list of traps and MIBS, see Traps and MIBs on page 609.

Note:

SNMP versions
There are currently three versions of SNMP:

SNMPv1 SNMPv2c SNMPv3

The TGM550 Telephony Gateway Module supports all three versions. The implementation of SNMPv3 on the TGM550 Telephony Gateway Module is backwards compatible. That is, an agent that supports SNMPv3 will also support SNMPv1 and SNMPv2c.

162 IG550 Integrated Gateway Administration and CLI Reference

SNMP versions

SNMPv1
SNMPv1 uses community strings to limit access rights. Each SNMP device is assigned to a read community and a write community. To communicate with a device, you must send an SNMP packet with the relevant community name. By default, if you communicate with a device using only the read community, you are assigned the security name ReadCommN. This security name is mapped to the ReadCommG group by default. This allows you to view the agents MIB tree, but you cannot change any of the values in the MIB tree. If you communicate with a device using the write community, you are assigned the security name WriteCommN. This security name is mapped to the WriteCommG group by default. This allows you to view the agents MIB tree and change any of the values in the MIB tree. Note: If you delete the ReadCommN or WriteCommN users, the ReadCommG or WriteCommG groups, or the snmpv1WriteView or snmpv1View, you may not be able to access the device using SNMPv1 or SNMPv2c.

Note:

In addition, traps are sent to designated trap receivers. Packets with trap information also contain a trap community string.

SNMPv2c
SNMPv2c is very similar to SNMPv1. However, SNMPv2c adds support for the get-bulk action and supports a different trap format.

SNMPv3
SNMPv3 enables the following features over SNMPv1 or v2c:

User authentication with a username and password Communication encryption between the Network Management Station (NMS) and the SNMP agent at the application level Access control definition for specific MIB items available on the SNMP agent Notification of specified network events directed toward specified users Definition of roles using access control, each with unique access permissions and authentication and encryption requirements

The basic components in SNMPv3 access control are users, groups, and views. In addition, SNMPv3 uses an SNMP engine ID to identify SNMP identity. An SNMP engine ID is assigned to each MAC address of each device in the network. Each SNMP engine ID should be unique in the network.

Issue 2 January 2008

163

Configuring SNMP

Users
SNMPv3 uses the User-based Security Model (USM) for security, and the View-based Access Control Model (VACM) for access control. USM uses the HMAC-MD5-96 and HMAC-SHA-96 protocols for user authentication, and the CBC-DES56 protocol for encryption or privacy. An unlimited number of users can access SNMPv3 at the same time.

SNMP security levels

NoAuthNoPriv. This is the lowest level of SNMPv3 security. No MAC is provided with the message, and no encryption is performed. This method maintains the same security level as SNMPv1, but provides a method for limiting the access rights of the user. AuthNoPriv. User authentication is performed based on MD5 or SHA algorithms. The message is sent with an HMAC that is calculated with the user key. The data part is sent unencrypted. AuthPriv. User authentication is performed based on MD5 or SHA algorithms. The message is sent in encrypted MAC that is calculated with the user key, and the data part is sent with DES56 encryption using the user key.

SNMP-server user command


Use the snmp-server user command to create a user or to change the parameters of an existing user. This command includes the following parameters:

A user name for the user The name of the SNMP group with which to associate the user The SNMP version functionality that the user is authorized to use. Possible values are: v1 (SNMPv1), v2c (SNMPv2c), and v3 (SNMPv3). For an SNMPv3 user, which authentication protocol to use, if any. Possible values are: md5 (HMAC MD5), and sha (HMAC SHA-1). If you specify an authentication protocol, you must also configure an authentication password for the user. The authentication password is transformed using the authentication protocol and the SNMP engine ID to create an authentication key. For an SNMPv3 user, whether or not to use the DES privacy protocol, and the users privacy password if you enable DES privacy

Use the no form of the snmp-server user command to remove a user and its mapping to a specified group. If you do not specify a group, the no form of the snmp-server user command removes the user from all groups.

164 IG550 Integrated Gateway Administration and CLI Reference

SNMP versions

Groups
In SNMPv3, each user is mapped to a group. The group maps its users to defined views. These views define sets of access rights, including read, write, and trap or inform notifications the users can receive. The group maps its users to views based on the security model and level with which the user is communicating with the TGM550 Telephony Gateway Module. Within a group, the following combinations of security model and level can be mapped to views:

SNMPv1 security model and NoAuthNoPriv security level SNMPv2c security model and NoAuthNoPriv security level SNMPv3 security model and NoAuthNoPriv security level SNMPv3 security model and AuthNoPriv security level SNMPv3 security model and AuthPriv security level

If views are not defined for all security models and levels, a user can access the highest level view below the users security level. For example, if the SNMPv1 and SNMPv2c views are undefined for a group, anyone logging in using SNMPv1 and SNMPv2c cannot access the device. If the NoAuthNoPriv view is not defined for a group, SNMPv3 users with a NoAuthNoPriv security level can access the SNMPv2c view. The TGM550 Telephony Gateway Module includes the following pre-configured groups: Table 47: Pre-configured SNMP groups Group name initial ReadCommG ReadCommG WriteCommG WriteCommG v3ReadOnlyG v3AdminViewG v3ReadWriteG Security model v3 (USM) v1 v2c v1 v2c v3 (USM) v3 (USM) v3 (USM) Security level NoAuthNoPriv NoAuthNoPriv NoAuthNoPriv NoAuthNoPriv NoAuthNoPriv AuthNoPriv AuthPriv AuthNoPriv Read view name restricted snmpv1View snmpv1View snmpv1 WriteView snmpv1 WriteView v3configView iso v3configView iso v3configView snmpv1 WriteView snmpv1 WriteView Write view name restricted Notify view name restricted snmpv1View snmpv1View snmpv1 WriteView snmpv1 WriteView v3configView iso v3configView

Issue 2 January 2008

165

Configuring SNMP

Creating an SNMPv3 group

Use the snmp-server group command to create an SNMPv3 group. Use the no form of the command to remove the specified group. You can define the following parameters with this command: - The name of the group - The SNMP security model - The security level, for a group with the SNMPv3 security model - The name of a read view to which the group maps users - The name of a write view to which the group maps users - The name of a notify view to which the group maps users

Views
There are three types of views:

Read Views. Allow read-only access to a specified list of Object IDs (OIDs) in the MIB tree Write Views. Allow read-write access to a specified list of OIDs in the MIB tree Notify Views. Allow SNMP notifications from a specified list of OIDs to be sent

Each view consists of a list of OIDs in the MIB tree. This list can be created using multiple snmp-server view commands to either add OIDs to the list or exclude OIDs from a list of all of the OIDs in the TGM550 Telephony Gateway Modules MIB tree. You can use wildcards to include or exclude an entire branch of OIDs in the MIB tree, using an asterisk instead of the specific node. For a list of MIBs and their OIDs, see TGM550 Telephony Gateway Module MIB files on page 619.

Creating an SNMPv3 view


To create an SNMPv3 view, the following information must be provided:

ViewName. A string of up to 32 characters representing the name of the view ViewType. Indicates whether the specified OID is included or excluded from the view OIDs. A list of the OIDs accessible using the view

166 IG550 Integrated Gateway Administration and CLI Reference

Configuring SNMP traps

Configuring SNMP traps


When SNMP traps are enabled on the device, SNMP traps are sent to all IP addresses listed in the trap receivers table. You can add and remove addresses from the trap receivers table. In addition, you can limit the traps sent to specified receivers. You can also enable and disable link up/down traps on specified TGM550 Telephony Gateway Module interfaces. Use the following commands to configure the trap receivers table: Note: You need an Admin privilege level to use the SNMP commands.

Note:

Enter snmp-server enable notifications to enable SNMP traps and notifications. Use the no form of this command to disable SNMP traps and notifications. Use the set snmp trap enable/disable auth command to enable or disable authentication failure traps for all managers. Enter set snmp trap enable/disable frame-relay to enable or disable frame relay traps for all managers. Enter show snmp to display SNMP information. Use the snmp-server informs command to configure the SNMPv3 timeout and retries for notifications. Use the snmp-server host command to define an SNMP notification host. Use the no form of this command to remove an SNMP notification host and to remove notification filter groups from a specific host. You can define the following parameters with this command: - The IP address of the recipient. - Whether to send traps or informs to the recipient. - The SNMP security model (v1, v2c, v3). For SNMPv1 and SNMPv2c, you must also specify the community name. For SNMPv3, you must specify the level of authentication and a username to use in notifications. Authentication levels are:

auth. Authentication without encryption noauth. No authentication priv. authentication with encryption

Issue 2 January 2008

167

Configuring SNMP

- The UDP port of the target host to use as the destination UDP port when sending a notification to this manager. Optional. The default is 162. - Notification filter groups, to modify the types of traps that are sent to the recipient. Optional. If not specified, all notification groups are sent. For a list of possible notification types, see Notification types on page 168.

Notification types
Various types of SNMP traps can be sent. You can modify the type of trap by setting the notification-list parameter of the snmp-server host command to one of the following:

all. All traps. This is the default. generic. Generic traps hardware. Hardware faults rmon. RMON rising/falling alarm dhcp server. DHCP server error, such as a DHCP IP conflict detection or notification of no IP address left for specific network dhcp-clients. DHCP client error, such as a DHCP client conflict detection rtp-stat-faults. RTP statistics: QoS fault/clear traps rtp-stat-qos. RTP statistics: end-of-call QoS traps wan. WAN router traps media-gateway. Media gateway traps (equivalent to G700 MGP traps) security. Security traps, such as unAuthAccess, macSecurity, unknownHostCopy, and accountLockout config. Configuration change notifications eth-port-faults. Ethernet port fault notifications sw-redundancy. Software redundancy notifications temperature. Temperature warning notifications cam-change. Changes in CAM notifications 13-events. Duplicate IP, VLAN violations policy. Policy change notifications link-faults. ITC proprietary link down notifications supply. Main and backup power supply notifications

168 IG550 Integrated Gateway Administration and CLI Reference

Configuring SNMP access

Summary of SNMP trap configuration commands


For more information about these commands, see SNMP trap configuration on page 565. Table 48: SNMP trap configuration CLI commands Root level command set snmp trap enable | disable auth set snmp trap enable | disable frame-relay show snmp snmp-server enable notifications snmp-server host Command Description Enable or disable authentication failure traps for all managers Enable or disable frame relay traps for all managers Display SNMP configuration information Enable or disable the sending of all traps and notifications from the TGM550 Identify an SNMP management server, and specify the kind of messages it receives. Use the no form of the command to remove the specified server, or to disable a particular set of notification types. Configure the SNMPv3 timeout and retries for notifications

snmp-server informs

Configuring SNMP access

Use the ip snmp command to enable SNMP access to the TGM550 Telephony Gateway Module. Use the no form of this command to disable SNMP access to the TGM550 Telephony Gateway Module. Enter snmp-server community to enable SNMPv1 access to the TGM550 Telephony Gateway Module. Use the no form of this command to disable SNMPv1 access to the TGM550 Telephony Gateway Module. Use the snmp-server user command to create an SNMPv3 user. Use the no form of this command to remove an SNMPv3 user.

Issue 2 January 2008

169

Configuring SNMP

Use the snmp-server group command to create an SNMPv3 group. Use the no form of this command to remove an SNMPv3 group. Use the snmp-server remote-user command to create an SNMPv3 remote user for SNMP notifications. Use the no form of this command to remove an SNMPv3 remote user for SNMP notifications. Use the set snmp community command to create or modify an SNMPv1 community. Use the snmp-server engineID command to configure the SNMPv3 engine ID. Use the no form of this command to configure the engine ID to its default value. The SNMP engine ID is set automatically by a calculation based on the MAC address of the host device, but you can change the engine ID using this command. If the SNMP engine ID changes, all users other than the default user are invalid and must be redefined. Use the snmp-server view command to add or exclude OIDs from a view and to create the view if it does not exist. Use the no form of this command to delete an SNMPv3 view. Enter show snmp view to display a list of SNMPv3 views or to display information about a specific SNMPv3 view. Use the show snmp userToGroup command to display a table of SNMPv3 users and the groups to which they are mapped. Enter show snmp engineID to display the SNMPv3 engine ID. Enter show snmp group to display a list of SNMPv3 groups. Use the show snmp user command to display configuration information for all SNMP users or for a specific SNMP user. Enter show snmp to display a list of SNMP notification receivers. Note: You need an Admin privilege level to use the SNMP commands.

Note:

Summary of SNMP access configuration commands


For more information about these commands, see SNMP access configuration on page 551. Table 49: SNMP access configuration CLI commands Command ip snmp set snmp community Description Enable or disable the SNMP agent for the TGM550 Create or modify an SNMPv1 community 1 of 2

170 IG550 Integrated Gateway Administration and CLI Reference

Configuring dynamic trap manager

Table 49: SNMP access configuration CLI commands (continued) Command show snmp show snmp engineID show snmp group show snmp user show snmp usertogroup show snmp view snmp-server community snmp-server engineID snmp-server group snmp-server remote-user snmp-server user snmp-server view Description Display SNMP configuration information, including a list of SNMP notification receivers Display the SNMPv3 engine ID for the TGM550 Display a list of SNMPv3 groups Display configuration information for a specified SNMP user Display a table of SNMPv3 users and the groups to which they are mapped Display configuration information for all SNMP views Enable or disable SNMP access to the TGM550 Telephony Gateway Module Specify the SNMP Engine ID for the TGM550 Telephony Gateway Module Define a new SNMPv3 group, or configure settings for the group Configure settings for a remote SNMPv3 user. If the user does not exist, it is created. Configure settings for an SNMPv3 user. If the user does not exist, it is created. Configure settings for an SNMP MIB view. If the view does not exist, it is created. 2 of 2

Configuring dynamic trap manager


Dynamic trap manager is a special feature that ensures that the TGM550 Telephony Gateway Module sends traps directly to the currently active MGC. If the MGC fails, dynamic trap manager ensures that traps are sent to the backup MGC. Note: The dynamic trap manager is created by default and cannot be removed.

Note:

Issue 2 January 2008

171

Configuring SNMP

Use the snmp-server dynamic-trap-manager command to specify the parameters of the dynamic trap manager feature. You can configure the following parameters:

Whether to send traps or informs to the recipient The SNMP security model (v1 or v2c) The SNMP community name The UDP port of the target host to use as the destination UDP port when sending a notification to this manager. Optional. The types of traps to be sent. Optional. The default is to send all types of traps. For a list of possible notification types, see Notification types on page 168. The following example configures dynamic trap manager to send all traps:

TGM550-001(super)# snmp-server dynamic-trap-manager traps v1 public udp-port 162 all

Use the clear dynamic-trap-manager command to remove administration of the dynamic trap manager.

Summary of dynamic trap manager configuration commands


For more information about these commands, see QoS on page 390. Table 50: Dynamic trap manager configuration CLI commands Command clear dynamic-trap-manager snmp-server dynamic-trap-manager Description Remove administration of the dynamic trap manager Specify the parameters of the dynamic trap manager feature

172 IG550 Integrated Gateway Administration and CLI Reference

SNMP configuration examples

SNMP configuration examples


The following example displays SNMP information:
TGM550-001(super)# show snmp Authentication trap disabled Community-Access ---------------read-only read-write Community-String ---------------***** *****

SNMPv3 Notification Status ---------------------------Traps: Enabled Informs: Enabled Retries: 3 SNMP-Rec-Address Model ---------------- ----149.49.70.137 v1 UDP port: 162 DM

Timeout: 3 seconds Trap/Inform ----------trap User name ---------ReadCommN

Level Notification ----------------noauth all

The following example creates a read-only user:


TGM550-001# snmp-server user joseph ReadOnlyG v3 auth md5 katmandu priv des56 ktamatan

The following example creates a read-write user:


TGM550-001# snmp-server user johnny ReadWriteG v3 auth md5 katmandu priv des56 ktamatan

The following example creates an admin user:


TGM550-001# snmp-server user johnny v3AdminG v3 auth md5 katmandu priv des56 ktamatan

The following example sets the SNMPv1 read-only community:


TGM550-001(super)# set snmp community read-only read SNMP read-only community string set.

The following example sets the SNMPv1 read-write community:


TGM550-001(super)# set snmp community read-write write SNMP read-write community string set.

Issue 2 January 2008

173

Configuring SNMP

174 IG550 Integrated Gateway Administration and CLI Reference

Chapter 9: Transferring and managing announcement files


The TGM550 stores announcement files in an internal announcement directory. The TGM550 supports up to 256 announcement files, totalling up to 20 minutes of audio for announcements and music on hold. A total of 16 announcements can be played simultaneously, and one port may be used at a time for recording. Recording, storing, and playing announcement files is controlled by Avaya CM. Avaya Voice Announcement Manager (VAM) can be used to centrally manage announcement files for multiple voice systems, including TGM550 media gateways. VAM is designed to be installed on a customer-provided platform at a remote location. For information about VAM, see Avaya Voice Announcement Manager Reference, 14-300613. The TGM550 supports:

Secure transfer of announcement files to and from VAM using SCP Simple management operations for the announcement files stored in the announcement directory

Announcement file operations

Upload an announcement file to a remote SCP server, using the copy announcement-file scp command. Specify the file name of the announcement file in the TGM550 announcement directory, followed by the IP address of the remote SCP server, and, optionally, a destination file name, including the full path. For example:
TGM550-001(super)# copy announcement-file scp local_announcement2.wav 192.168.49.10 remote_announcement2.wav

Download an announcement file from a remote SCP server to the TGM550 announcement directory, using the copy scp announcement-file command. Specify the file name of the announcement file on the remote SCP server, followed by the IP address of the remote SCP server, and, optionally, a destination file name, including the full path. For example:
TGM550-001(super)# copy scp announcement-file announcement_file1.wav 192.168.49.10

Issue 2 January 2008

175

Transferring and managing announcement files

Upload an announcement file to a remote FTP server, using the copy announcement-file ftp command. Specify the file name of the announcement file in the TGM550 announcement directory, followed by the IP address of the remote FTP server, and, optionally, a destination file name, including the full path. For example:
TGM550-001(super)# copy announcement-file ftp local_announcement2.wav 192.168.49.10 remote_announcement2.wav

Download an announcement file from an FTP server to the TGM550 announcement directory, using the copy ftp announcement-file command. Specify the file name of the announcement file on the FTP server, followed by the IP address of the FTP server, and, optionally, a destination file name, including the full path. For example:
TGM550-001(super)# copy ftp announcement-file announcement_file1.wav 192.168.49.10

Erase an announcement file from the TGM550 announcement directory, using the erase announcement-file command. Specify the name of the file. For example:
TGM550-001# erase announcement-file local_announcement1.wav

Rename an announcement file in the TGM550 announcement directory, using the rename announcement-file command. Specify the current name of the file followed by the new name. For example:
TGM550-001# rename announcement-file from_local_announcement1.wav to_local_announcement1.wav

Display the announcements files stored in the TGM550 announcement directory, using the show announcements-files command. Optionally add the keyword brief to display less detail. For example:
TGM550-001(super)# show announcements files Mode: FTP-SERVER/SCP-CLIENT ID File Description Size (Bytes) Date ---- ---------------- ------------- ------------ ----------------5 46xxupgrade.scr Announcement1 4000 09:54:55 04 APR 2005 8 4601dbte1_82.bin Announcement2 8000 09:55:55 04 APR 2005 9 4602dbte1_82.bin Announcement3 16000 09:56:55 04 APR 2005 Nv-Ram: Total bytes used: 28000 Total bytes free: 7344800 Total bytes capacity(fixed) 7372800

176 IG550 Integrated Gateway Administration and CLI Reference

Summary of announcement files commands

Display the status of a download process of announcement files from the remote SCP server, using the show download announcement-file status command. For example:
TGM550-001(super)# Module #9 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Bytes Downloaded =========== show download announcement-file status

9 hellosource.wav hellodestination.wav 135.64.102.64 Idle (null) No-warning : 7825

Display the status of an upload process of announcement files to the remote SCP server, using the show upload announcement-file status command. For example:
TGM550-001(super)# Module #9 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : =========== show upload announcement-file status

9 hellosource.wav d:\hellodestination.wav 135.64.102.64 Idle (null) No-warning

Summary of announcement files commands


For more information about these commands, see QoS on page 390. Table 51: Announcement file CLI commands Command copy announcement-file ftp copy announcement-file scp Description Upload an announcement file to a remote FTP server Upload an announcement file to a remote SCP server 1 of 2

Issue 2 January 2008

177

Transferring and managing announcement files

Table 51: Announcement file CLI commands (continued) Command copy ftp announcement-file copy scp announcement-file Description Download an announcement file from an FTP server to the TGM550 announcement directory Download an announcement file from a remote SCP server to the TGM550 announcement directory Erase an announcement file from the TGM550 announcement directory Rename an announcement file in the TGM550 announcement directory Display the announcements files stored in the TGM550 announcement directory Display the status of a download process of announcement files from the remote SCP server Display the status of an upload process of announcement files to the remote SCP server 2 of 2

erase announcement-file rename announcement-file show announcements files show download announcement-file status show upload announcement-file status

178 IG550 Integrated Gateway Administration and CLI Reference

Chapter 10: Configuring monitoring applications


The TGM550 Telephony Gateway Module provides several software tools for monitoring and diagnosing your network. Use these tools to monitor the status of your network operations, and to analyze the flow of information.

Configuring and analyzing RTP statistics


The RTP statistics application collects data and statistics for RTP sessions (streams) from the gateway VoIP engine. You can view the data and configure SNMP traps to be generated when the QoS level falls below a configured level. Note: An alternative tool available from Avaya for debugging QoS problems is VMON. VMON is an RTCP QoS reports collector. VMON support, available in all Avaya devices, is the capability of a VoIP device to send a copy of an RTCP message to the IP address of a VMON server. VMON can collect RTCP reports, store them on its host hard disk, and analyze and generate graphic reports. However, VMON requires a dedicated Windows server. The RTP statistics application runs on the TGM550 Telephony Gateway Modules firmware, and does not require any dedicated hardware. For information about configuring VMON in Avaya Communication Manager, see Administrator Guide for Avaya Communication Manager, 03-300509. Note: The gateway performs traceroutes whenever RTP statistics is enabled.

Note:

Note:

The RTP statistics application provides the following functionality:

Collects QoS data from the gateway VoIP engine(s), including Real-Time Control Protocol (RTCP) data, traceroute reports, and information from the DSP regarding jitter buffer, internal delays, and so on Note: RTCP is a standard QoS report companion protocol to RTP. RTP endpoints periodically send RTCP report packets to their remote peer (or peers in multicast). RTCP reports include QoS data such as delay, jitter, and loss.

Note:

Collects call data from the gateway, such as duration, start-time, and end-time

Issue 2 January 2008

179

Configuring monitoring applications

Displays the RTP statistics in CLI and MIB formats Displays summary reports for the VoIP engine(s) Assesses QoS status based on configurable thresholds on an extensive set of QoS metrics Generates QoS traps. QoS traps are notifications sent via SNMP upon termination of an RTP stream that suffers from bad QoS. These notifications include extensive data about the session that enables offline troubleshooting of QoS problems.The trap rate is controlled by a configurable trap rate limiter. Note: QoS trap generation is an especially convenient troubleshooting tool for large installations, since all devices that support the RTP statistics application can be configured to send traps to a single SNMP trap manager.

Note:

Generates QoS fault and clear traps. QoS fault traps are notifications that are sent when more than a configurable number of active sessions have QoS indicators over the configured thresholds. A QoS clear trap is a notification that is sent after a QoS fault trap when the number of active RTP sessions with QoS indicators over the configured thresholds reduces to a specified number.

Configuring the RTP statistics application


To configure the RTP statistics application, work through the following sections, in order:

Viewing RTP statistics thresholds Configuring RTP statistics thresholds Enabling and resetting the RTP statistics application Viewing application configuration Configuring QoS traps Configuring QoS fault and clear traps Configuring the trap rate limiter

Viewing RTP statistics thresholds


The RTP statistics application uses a system of thresholds to evaluate levels of QoS during RTP sessions. The thresholds are configured on several QoS metrics. Your configuration of the thresholds determines when the application evaluates a session as having bad QoS conditions. This section describes the thresholds that you can configure, how you can view the thresholds that are currently configured, and the metrics on which you can configure them.

180 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

The RTP statistics application samples the VoIP engine every RTCP interval, which is configured in Avaya Communication Manager, where it is called RTCP Report Period. The RTCP interval is typically 5 to 8 seconds. For information about configuring the RTCP interval (RTCP report period), see Administrator Guide for Avaya Communication Manager, 03-300509.

Thresholds types

A threshold on a metric. For example, you can configure a threshold on the metric packet loss. The application samples the metric every RTP interval and increments a counter (event counter) if the sampled value is over the threshold. Hence, the 'event-counter' represents the number of times the metric was sampled over its threshold. An event threshold. An event threshold is a threshold on an event counter. If QoS traps are configured, the application generates a QoS trap when, at the end of a session, one or more event counters are over their event thresholds. For example, if the event threshold for packet loss is 2, the application generates a QoS trap if packet loss is sampled over its threshold two or more times. Thresholds on metric averages. The application calculates averages of some of the metrics. When an RTP session terminates, the application evaluates the average metrics and generates a QoS trap (if QoS traps are configured) if one of them is over its corresponding threshold. Note: All CLI commands described in this section are available in the general context of the CLI.

Note:

Viewing the configured thresholds


1. Enter show rtp-stat thresholds. For example:
TGM550-001(super)# show rtp-stat thresholds Item -------------------Codec Loss Average Codec Loss Codec RTT Echo Return Loss Loss Average Loss Remote Loss Average Remote Loss RTT Local Jitter Remote Jitter SSRC Changes Threshold ------------6.0% 3.0% 700mS 0dB 6.0% 3.0% 6.0% 3.0% 500mS 50mS 50mS N/A Event Threshold ----------------1 N/A 2 1 2 N/A 2 N/A 2 2 2 2

Issue 2 January 2008

181

Configuring monitoring applications

Table 52 describes the QoS metrics on which thresholds are configured, and the time at which each metric is evaluated. Table 52: QoS metrics Metric Codec Loss Description The percentage of time the codec plays fill frames due to lack of valid RTP frames. Possible causes include jitter and packet loss. The average codec loss measurement since the beginning of the RTP stream An estimation of the overall Round Trip Time (RTT) on the voice-channel, including the network delay and internal delays. RTT is the time taken for a message to get to the remote peer and back to the local receiver. The echo cancellation loss on the TDM bus The estimated network RTP packet loss. The VoIP engine evaluates the current received packet loss every RTCP interval usually 5 to 8 seconds. The VoIP engine postpones loss estimation until the next interval if the number of packets received is less than the minimum statistic window. The minimum statistic window is configured with the CLI command rtp-stat min-stat-win. The average packet loss evaluation since the beginning of the RTP stream The network loss according to the remote RTP receiver. The device learns of the remote packet loss from received RTCP messages. The average remote network loss measurement since the beginning of the RTP stream The network RTT. This metric does not include internal delay. The device learns of the RTT from RTCP messages. Variation in delay of packet delivery to the local peer Evaluation time Every RTCP interval

Average Codec Loss Codec RTT

At the end of the session Each time an RTCP packet is received

Echo Return Loss Loss

Every RTCP interval Every RTCP interval

Average Loss Remote Loss

At the end of the session Each time an RTCP packet is received At the end of the session Each time an RTCP packet is received Every RTCP interval 1 of 2

Average Remote Loss RTT

Local Jitter

182 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Table 52: QoS metrics (continued) Metric Remote Jitter Description Variation in delay of packet delivery to the remote peer. The device learns of the remote jitter from RTCP messages. The number of times the RTP SSRC field in received RTP packets has changed Evaluation time Each time an RTCP packet is received Every RTCP interval 2 of 2

SSRC Changes

Configuring RTP statistics thresholds


RTP statistics thresholds should be configured so that incrementation of QoS event counters coincides with real detectable bad QoS in your network. Optimal values are different for each network. Configure any thresholds that are not already configured as you require them. See Viewing RTP statistics thresholds on page 180. For a description of each metric, see Table 52. The Codec metrics, Codec loss and Codec RTT are useful for evaluating the actual user experience. The other metrics are useful for identifying network problems that contribute to QoS problems experienced by the user. For example, the Codec RTT metric indicates the overall delay experienced by the user. If you configure a meaningful threshold on the Codec RTT metric, metrics such as Local Jitter, Remote Jitter, and rtt metrics may help you identify causes when Codec RTT exceeds its threshold.

Configuring RTP statistics thresholds


1. Use the rtp-stat thresholds command to set thresholds on QoS indicators. For example:
TGM550-001(super)# rtp-stat thresholds echo-return-loss 5

Done!

With this example configuration, if echo-return-loss is sampled higher than 5 dB during an RTP session, the echo-return-loss event counter increments. 2. Use the rtp-stat event-threshold command to set thresholds on QoS events. For example:
TGM550-001(super)# rtp-stat event-threshold echo-return-loss 2 Done!

With this example configuration, if echo-return-loss is sampled over its threshold more than twice during an RTP session, the application considers the session to have QoS faults.

Issue 2 January 2008

183

Configuring monitoring applications

Enabling and resetting the RTP statistics application


When you enable the RTP statistics application on the gateway, the application starts to collect QoS data from the VoIP engine(s) and stores the data in the gateway RAM, which holds a limited history of RTP session entries. The VoIP engine also starts to perform and report UDP traceroutes. Session data and automatic session traceroute results can be viewed using the CLI.

Enabling the RTP statistics application


1. Enter rtp-stat-service. For example:
TGM550-001# rtp-stat-service The RTP statistics service is enabled (default: disabled)

Note:

Note: Admin level access is required in order to use the rtp-stat-service command.

Resetting the RTP statistics application


1. Enter rtp-stat clear. All counters are reset and the RTP statistics history is erased.

Viewing application configuration


Viewing the application configuration helps you see if the application is enabled, which types of traps are enabled, and how the trap rate limiter and minimum statistics window are configured. The minimum statistics window is the minimum number of observed RTP sequence increments for which the application evaluates packet loss.

184 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Enter show rtp-stat config. For example:


TGM550-001(super)# show rtp-stat config RTP Statistic: Enabled QoS Trap: Enabled QoS Fault Trap: Enabled Fault: 2 Clear: 0 QoS Trap Rate Limiter: Token Interval: 10.00 seconds Bucket Size: 5 Session Table: Size: 128 Reserved: 64 Min Stat Win: 50

Table 53 describes the output of the show rtp-stat config command. Table 53: RTP statistics application configuration Name RTP Statistic Description Status of the RTP statistics application. Possible values: Enabled. The application is enabled. Disabled. The application is disabled. QoS trap status. Possible values: Enabled. The RTP statistics application is configured to generate QoS traps. Disabled. The RTP statistics application is not configured to generate QoS traps. QoS fault trap status. Possible values: Enabled. The RTP statistics application is configured to generate QoS fault and clear traps. Disabled. The RTP statistics application is not configured to generate QoS fault and clear traps. The QoS fault trap boundary. That is, the minimum number of active sessions with QoS faults that triggers a QoS fault trap. The QoS clear trap boundary. That is, the reduced number of active sessions with QoS faults that triggers a QoS clear trap to be sent after a QoS fault trap was sent.

QoS Trap

QoS Fault Trap

Fault Clear

QoS Trap Rate Limiter: 1 of 2

Issue 2 January 2008

185

Configuring monitoring applications

Table 53: RTP statistics application configuration (continued) Name Token Interval Description The displayed token interval is in seconds. The maximum long term trap rate, expressed as an interval in seconds. In the example shown, the maximum long term trap rate is one trap every 10 seconds. The maximum number of tokens stored in the token bucket of the trap rate limiter. This item limits the size of a QoS trap burst.

Bucket Size Session Table: Size Reserved

The maximum number of RTP session entries held in the session table in the gateway RAM The number of rows in the session table that are reserved for sessions with QoS problems. In the example shown, the table size is 128 and the reserved number is 64. If, from 1000 sessions only 300 had QoS problems, the session table will hold at least the last 64 sessions that had QoS problems. Note that if the last 128 sessions all had QoS problems, all rows in the session table will be filled with sessions that had QoS problems. The minimum statistic window configured for the RTP statistics application. That is, the minimum number of observed RTP sequence increments for which the application evaluates packet loss. 2 of 2

Min Stat Win

186 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Configuring QoS traps


You can configure the application to automatically generate QoS traps via SNMP at the termination of RTP sessions that have QoS problems. SNMP traps are automatically sent to the SNMP trap manager on the active Media Gateway Controller (MGC). You can also configure SNMP traps to be sent to an external trap manager. The application generates a QoS trap when, at the end of an RTP session, one or more event counters are over their event thresholds. For example, if the event threshold for packet loss is 2, the application generates a trap at the termination of any session in which packet-loss was sampled over its threshold twice or more during the session.

! CAUTION:
CAUTION:

If the thresholds for trap generation are set too low, a significant amount of trap traffic will be generated and negatively impact network performance.

Enabling QoS traps


1. View the RTP statistic thresholds and modify their configurations as necessary. See Viewing RTP statistics thresholds on page 180 and Configuring RTP statistics thresholds on page 183. 2. If you need to modify the minimum statistic window, use the rtp-stat min-stat-win command. For example:
TGM550-001(super)# rtp-stat min-stat-win 50 Done!

The minimum statistic window is the minimum number of observed RTP sequence increments for which the application evaluates packet loss. The VoIP engine evaluates the current received packet loss every RTCP interval. The VoIP engine postpones loss estimation to the next interval if the number of received packets is less than the minimum statistic window. By modifying the minimum statistic window, you can prevent the application from generating loss-events based on too few packets and safely configure a low packet loss threshold. 3. To configure an additional trap destination, such as an external trap manager, use the command snmp-server host. For example:
TGM550-001(super)# snmp-server host 136.9.71.47 traps v1 public

Issue 2 January 2008

187

Configuring monitoring applications

Note:

Note: When using the snmp-server host command, you can specify only to send certain types of traps to the specified trap manager. For example, snmp-server host 1.1.1.1 traps v1 public rtp-stat-qos rtp-stats-faults configures only QoS traps and QoS fault and clear traps to be sent to host 1.1.1.1. To check your current SNMP configurations, enter show snmp. Traps are automatically sent to the active MGC by the dynamic trap manager feature. To configure the dynamic trap manager, use the command snmp-server dynamic-trap-manager. For more information about the dynamic trap manager, see Configuring dynamic trap manager on page 171. 4. Enter rtp-stat qos-trap to enable the traps, if not already enabled. For example:
TGM550-001# rtp-stat qos-trap The RTP statistics QoS trap is enabled

QoS traps are now enabled.

Configuring QoS fault and clear traps


You can configure the RTP statistics application to send QoS fault and clear traps. A QoS fault trap is sent when a specified number of active RTP sessions have QoS indicators over the configured thresholds. A QoS clear trap is sent after a QoS fault trap when the number of active RTP sessions with QoS indicators over the configured thresholds reduces to a specified number. Since some RTP sessions can be very long, and QoS traps are sent only after the termination of the stream, QoS fault and clear traps are important for providing timely information about QoS problems. Note: QoS fault traps appear in the Network Management Console Event Log Browser, indicating to the user that there are QoS problems in a specific network device. See the Avaya Network Management Console User Guide, 14-300169.

Note:

Use the rtp-stat fault command. For example:


TGM550-001(super)# rtp-stat fault 1 0

The fault trap boundary was set to 1 (default: 3) The clear trap boundary was set to 0

With this example configuration, a QoS fault trap is sent if and when one active RTP session has QoS problems. A QoS clear trap is then sent if and when the number of active RTP sessions with QoS problems reaches 0.

188 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Configuring the trap rate limiter


The application features a trap rate limiter. The trap rate limiter limits the rate at which QoS traps are sent. The rate limiter protects against overloading the trap manager with bursts of traps when a single event causes multiple RTP sessions to terminate simultaneously. The trap rate limiter uses a token bucket scheme, in which traps are sent only if there are tokens in a virtual bucket. Tokens are added to the bucket every 'token interval,' which sets the maximum long term trap rate. Each time a trap is sent, the number of tokens in the bucket decrements. The 'bucket size' is the maximum number of tokens that the bucket can hold. The bucket size limits the trap burst size.

Use the rtp-stat qos-trap-rate-limit command. For example:


TGM550-001# rtp-stat qos-trap-rate-limit 2000 10

In this example configuration, the token-interval is 2000 and the bucket-size is 10. This means that a token is added to the bucket every 2000 hundredths of a second (20 seconds) and the bucket is limited to a maximum size of 10 tokens.

Analyzing RTP statistics output


This section describes the reports, statistics, and traps you can view, how to view them, and how to understand the output.

Viewing RTP statistics summary reports


RTP statistics summary reports display QoS trap statistics for the VoIP engine(s).

Enter show rtp-stat summary. For example:


TGM550-001(super)# show rtp-stat summary Total QoS traps: 23 QoS traps Drop : 0 Qos Fault Engine ID Description --- -------------000 internal

Uptime ----------04,18:15:15

Active Session ------2/1

Total Session ------35/24

Mean Duration -------01:04:44

Tx TTL ---64

Issue 2 January 2008

189

Configuring monitoring applications

Table 54 describes the fields in the summary report. Table 54: RTP statistics summary reports output Field Total QoS traps Description The total number of QoS traps sent since the RTP statistics application was enabled or since the last use of the rtp-stat clear command The number of QoS traps dropped by the rate limiter since the RTP statistics application was enabled or since the last use of the rtp-stat clear command General QoS state: QoS Fault means that the number of active RTP sessions with QoS faults is currently higher than the QoS fault boundary. QoS Clear means that the number of active RTP sessions with QoS faults is currently less than or equal to the QoS clear boundary. You can configure the QoS fault and clear boundaries using the rtp-stat fault command. See Configuring QoS fault and clear traps on page 188. The ID of the VoIP engine. Since the TGM550 has one VoIP engine, one line appears in the table. Description of the VoIP engine The uptime of the RTP statistics application. This is the time since the RTP statistics application was enabled or since the last use of the rtp-stat clear command. The number of active sessions / number of active sessions with QoS problems The total number of sessions / number of sessions that had QoS problems The mean RTP session duration (calculated only for terminated calls) The IP Time To Live (TTL) field for transmitted RTP packets

QoS traps Drop

Qos Fault/QoS Clear

Engine ID Description Uptime

Active Session Total Session Mean Duration Tx TTL

Viewing RTP session statistics


Using the CLI, you can view a summary of active and terminated sessions and you can view RTP statistics for a given RTP session.

190 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

The show rtp-stat sessions command displays a summary of the active and/or terminated RTP sessions in the session table. For example:
TGM550-001(super)# show rtp-stat sessions last 5 ID QoS Start date and time End Time Type Destination ----- --- ------------------- -------- ------- --------------00031 2004-10-20,10:51:36 10:59:07 G729 135.8.76.64 00032 * 2004-10-20,10:53:42 10:57:36 G723 135.8.76.107 00033 * 2004-10-20,10:58:21 10:59:06 G723 135.8.76.107 00034 2004-10-20,11:08:40 - G729 135.8.76.64 00035 * 2004-10-20,11:09:07 - G723 135.8.76.107

An asterisk (*) in the QoS column indicates that the session had QoS problems. The show rtp-stat detailed command displays detailed information about a specified active or terminated RTP session, including the QoS metrics reported by the RTP statistics application. For example:
TGM550-001(super)# show rtp-stat detailed 35 Session-ID: 351 Status: Terminated2, QOS: Faulted3, EngineId: 04 Start-Time: 2004-10-205,11:09:076, End-Time: 2004-10-20,11:13:407 Duration: 00:04:338 CName: gwp@135.8.118.2529 Phone: 69:201110 Local-Address: 135.8.118.252:206111 SSRC 15461121212 Remote-Address: 135.8.76.107:206113 SSRC 2989801899 (0)14 Samples: 5415 (5 sec)16 Codec: G72317 62B18 30mS19 Off20, Silence-suppression(Tx/Rx) Disabled21/Not-Supported22, Play-Time 272.610sec23, Loss 0.0%24 #125, Avg-Loss 0.1%26, RTT 741mS27 #3828, Avg-RTT 570mS29, JBuf-under/overruns 0.1%30/0.0%31, Jbuf-Delay 22mS32, Max-Jbuf-Delay 60mS33 Received-RTP: Packets 923634, Loss 0.0%35 #036, Avg-Loss 0.0%37, RTT 604mS38 #3839, Avg-RTT 376mS40, Jitter 0mS41 #042, Avg-Jitter 0mS43, TTL(last/min/max) 63/63/6344, Duplicates 045, Seq-Fall 046, DSCP 4647, L2Pri 1248, RTCP 5449 Transmitted-RTP: VLAN 150, DSCP 18451, L2Pri 652, RTCP 6253 Remote-Statistics: Loss 0.0%54 #055, Avg-Loss 0.0%56, Jitter 0mS57 #058, Avg-Jitter 0mS59 Echo-Cancellation: Loss 45dB60 #161, Len 32mS62 RSVP: Status Disabled63, Failures 064

Issue 2 January 2008

191

Configuring monitoring applications

Table 55 describes the fields in the show rtp-stat detailed command output according to the numbered labels in the example. Table 55: Detailed CLI output per RTP session Field Session-ID Status Label
1

Description An arbitrary index number for the session in the session table The status of the session. Possible values: Active. The session is still open. Terminated. The session is finished. The QoS status of the session. Possible values: OK. There are no QoS problems in the session. Faulted. There are QoS problems in the session. The ID of the VoIP engine. The TGM550 has one VoIP engine. The date of the RTP session The start time of the RTP session The end time of the RTP session The duration of the RTP session format: gwt@<MGP-address>

From the CLI example


Session-ID: 35

Status: Terminated

QOS

QOS: Faulted

EngineId Start-Time

EngineId: 0

5 6

2004-10-20 Start-Time: 2004-10-20,11:09:07 End-Time: 2004-10-20,11:13:40 Duration: 00:04:33 CName: gwp@135.8.118.252

End-Time Duration CName

7 8 9

1 of 6

192 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Table 55: Detailed CLI output per RTP session (continued) Field Phone Label
10

Description The local extension number and conference ID in format <conference ID>:<extension number>. Conference calls can involve more than one entry in the session table. Multiple sessions belonging to the same conference call can usually be identified by a common conference ID. Notes: Phone data is received from Avaya Communication Manager only if VMON is configured. If you are not running VMON, you can cause Avaya Communication Manager to send the phone data by configuring a dummy RTCP-server for the region, with a 'localhost' IP address (127.x.x.x). The PMI. The number after the colon is the UDP port number. The remote VoIP engine, gateway PMI, or IP phone address. The number after the colon is the UDP port number. SSRC ID. The number in parentheses is the number of observed SSRC changes during the session. The number of times the application has sampled the VoIP engine (RTP receiver) statistics. The sampling interval The codec used for the session The RTP packet size, in bytes The RTP packet interval, in ms The encryption method

From the CLI example


Phone: 69:2011

Local-Address Remote-Address

11

Local-Address: 135.8.118.252:2061 Remote-Address: 135.8.76.107:2061

13

12, 14

SSRC 2989801899 (0)

Samples

15

Samples: 5415 (5 sec)

16

Samples: 54 (5 sec)16 G723 62B 30mS Off

Codec:

17 18 19 20

2 of 6

Issue 2 January 2008

193

Configuring monitoring applications

Table 55: Detailed CLI output per RTP session (continued) Field Silence suppression (Tx/Rx) Label
21

Description The received silence suppression method The transmitted silence suppression method The overall time the codec played valid received frames The last value of codec loss sampled. Codec loss is the percentage of time the codec played fill frames due to lack of valid RTP frames. Possible causes include jitter and packet loss. The codec loss event counter The average of all codec loss values sampled during the session The last sampling of codec round trip time (RTT), in ms. Codec RTT is the round-trip delay experienced by the user, including internal delay. This value is not entirely accurate since remote internal delays are not always known. The codec RTT event counter The average of all codec RTT values sampled during the session The estimated percentage contribution of jitter-buffer underruns to the average codec loss The estimated percentage contribution of jitter-buffer overruns to the average codec loss The last jitter buffer delay The maximum jitter buffer delay during the session

From the CLI example


Silence-suppression (Tx/Rx) Disabled21/Not-Supp orted Silence-suppression (Tx/Rx) Disabled/Not-Suppor ted22 Play-Time 272.610sec Loss 0.0%24 #1

22

Play-Time Codec Loss codec-loss%

23

24

#codec-loss-events Avg-Loss RTT rtt ms

25 26

Loss 0.0% #125 Avg-Loss 0.1% RTT 741mS27 #38

27

#rtt-events Avg-RTT Jbuf-under/ overruns

28 29

RTT 741mS #3828 Avg-RTT 570mS

30

JBuf-under/overruns 0.1%30/0.0%

31

JBuf-under/overruns 0.1%/0.0%31

Jbuf-delay Max-Jbuf-Delay

32 33

Jbuf-Delay 22mS Max-Jbuf-Delay 60mS

3 of 6

194 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Table 55: Detailed CLI output per RTP session (continued) Field Received RTP: Packets Loss loss% #loss-events Avg-loss RTT rtt ms #rtt-events Avg-RTT Jitter jitter ms #jitter-event Avg-Jitter TTL (last/min/max)
34 35

Label

Description

From the CLI example

The total number of received packets The last sampled value of network RTP packet loss The network RTP packet loss event counter The average of all network RTP packet loss values during the session The network RTT. The RTT is calculated upon RTCP packet reception. The network RTT event counter The average of all network RTT values during the session The network jitter at the RTP receiver. Combined with long RTT, a large jitter value may indicate WAN congestion. The RTP receiver network jitter event counter The average of all network jitter values during the session The last value of TTL, minimum value of TTL, and maximum value of TTL sampled during the session. TTL changes during a session may indicate route flaps in the IP network. This counter increments each time two consecutive RTP packets with the sample RTP sequence number are received. A large number of duplicates may indicate problems in the Layer 2/Ethernet topology (for example, loops).

Packets 9236 Loss 0.0%35 #0

36

Loss 0.0% #036

37

Avg-Loss 0.0% RTT 604mS38 #38

38

39 40

RTT 604mS #3839 Avg-RTT 376mS Jitter 0mS41 #0

41

42

Jitter 0mS #042

43

Avg-Jitter 0mS

44

TTL(last/min/max) 63/63/63

Duplicates

45

Duplicates 0

4 of 6

Issue 2 January 2008

195

Configuring monitoring applications

Table 55: Detailed CLI output per RTP session (continued) Field Seq-Fall Label
46

Description This counter increments each time an RTP packet with a sequence number less than the last known sequence is received. Packet resequencing may be caused by switching to a backup WAN interface or route flaps. The last received DSCP value of the RTP packets The last received Layer 2 priority value of an RTP packet (usually IEEE802.1p) The total number of received RTCP packets

From the CLI example


Seq-Fall 0

DSCP L2Pri RTCP Transmitted-RTP: VLAN DSCP L2Pri RTCP

47

DSCP 46

48

L2Pri 12

49

RTCP 54

50

The VLAN-ID on which the RTP packets are transmitted The DSCP of RTP packets The Layer 2 priority of transmitted RTP packets (usually 802.1p) The total number of transmitted RTCP packets

VLAN 1

51 52

DSCP 184 L2Pri 6

53

RTCP 62

Remote-Statistics: (Remote-Statistics items are calculated and evaluated upon reception of RTCP messages) Loss rem-loss%
54

The network loss experienced by the remote RTP receiver. The local RTP receiver learns about its remote peer statistics from RTCP packets. The number of samples that were over the rem-loss threshold The average network loss experienced by the remote RTP receiver The network jitter experienced by the remote RTP receiver The number of samples that were over the remote jitter threshold

Loss 0.0%54 #0

#rem-loss-ev Avg-Loss Jitter rem-jitter #rem-jitter-ev

55

Loss 0.0% #055

56

Avg-Loss 0.0% Jitter 0mS57 #0

57

58

Jitter 0mS #058

5 of 6

196 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Table 55: Detailed CLI output per RTP session (continued) Field Avg-jitter Echo Cancellation: Loss loss dbm
60

Label
59

Description The average remote jitter

From the CLI example


Avg-Jitter 0mS

The echo cancellation loss on the TDM bus. A high value (that is, a low absolute value) may indicate impairment of DCP terminals. A counter that increments each time the echo-cancellation loss is sampled below its threshold The last echo-cancellation tail length used for this session

Loss 45dB60 #1

#loss-ev

61

Loss 45dB #161

Len RSVP: Status Failures

62

Len 32mS

63

The current (last) RSVP reservation state at the end of the session The total number of reservation failures during the session

Status Disabled

64

Failures 0

6 of 6

Viewing QoS traps, QoS fault traps, and QoS clear traps
QoS traps, QoS fault traps, and QoS clear traps sent to the active MGC by the dynamic trap manager are converted to syslog messages by the SNMP Trap manager on the MGC. The syslog messages are stored in the messages file on the MGC hard disk. You can view the syslog messages through the Avaya Maintenance Web Interface to debug the QoS problems. 1. In the Avaya Maintenance Web Interface, enter the Setup log viewing screen. 2. In the Select Log Types list, select Linux syslog. 3. Under Select Event Range, select the date range over which you want to view traps. 4. In the Match Pattern field, enter the string avrtp. 5. In the Number of Lines field, enter the maximum number of traps you want to view. 6. Click View Log. The View System Logs screen appears (Figure 8). Each line contains one message.

Issue 2 January 2008

197

Configuring monitoring applications

Figure 8: Viewing syslog messages

Analyzing QoS trap output


The following is an example of the syslog message for the QoS trap sent upon termination of RTP session 35 (see the session ID in bold), which terminated at 11:13:40 on Oct. 20:
Oct 201 11:13:402 LZ-SIT-SR1 snmptrapd[9407]: 135.8.118.2523 [135.8.118.252]: Trap sysUpTime.0 = Timeticks: (43147723) 4 days, 23:51:17.234, snmpTrapOID.0 = OID: av RtpQoSTrap5, avRtpSessionLocAddrV4.0 = IpAddress: 135.8.118.2526, avRtpSessionRemAddrV4.0 = IpAddress: 135.8.76.1077, avRtpSessionDuration.0 = INTEGER: 2738, avRtpSessionCname.0 = STRING: gwp@135.8.118.2529, avRtpSessionPhone.0 = STRING: 69:201110, avRtpSessionSeverity.0 = INTEGER: warning(4), avRtpSessionDebugStr.0 = STRING: Id{35}11; Traps{2412/013};Stats{S 5414 RTCP 5415 RX 923616};Codec{g72317 62B18 encryptionOff19 SSup disabled20/disabled21 Loss 0.1%22 #123 RTT 570mS24 #3825 Jbuf 0.1%26/0.0%27};Net{Loss 0.0%28 #029 RTT 376mS30 #3831 Jtr #032 TTL 63-6333 Dup 034 Fall 035};Rem{Loss 0.0%36 #037 Jtr #038} EC{Loss 45dB39}

Table 56 describes the fields in the QoS trap according to the numbered labels in the example. Table 56: QoS Trap output fields Label
1 2 3

Description The date on which the trap was received The time at which the trap was received The IP address of the local MGP

From the trap example


Oct 20 11:13:40 135.8.118.252

1 of 4

198 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Table 56: QoS Trap output fields (continued) Label


4

Description The gateway up time The trap name, which indicates that this is a QoS trap The local gateway PMI The remote VoIP engine, gateway PMI, or IP phone address The duration of the RTP session Format: gwt@<MGP-address> The local extension number and conference ID in format <conference ID>:<extension number>. Conference calls can involve more than one entry in the session table. Multiple sessions belonging to the same conference call can usually be identified by a common conference ID. Notes: The phone string data is received from Avaya Communication Manager if VMON is configured. If you are not running VMON, you can cause Avaya Communication Manager to send the phone string data by configuring a dummy RTCP-server for the region, with a 'localhost' IP address (127.x.x.x). An arbitrary index number for the session in the session table The total number of sent traps since the application was enabled The number of traps that were dropped by the trap rate limiter since the application was enabled. This item can be used, when analyzing received traps logs, to identify missing traps (due to network conditions or the rate limiter). This is also displayed by the show rtp-stat summary command. The number of times the application sampled the VoIP engine (RTP receiver) statistics

From the trap example


sysUpTime.0 = Timeticks: (43147723) 4 days, 23:51:17.23 snmpTrapOID.0 = OID: av RtpQoSTrap avRtpSessionLocAddrV4.0 = IpAddress: 135.8.118.252 avRtpSessionRemAddrV4.0 = IpAddress: 135.8.76.107 Duration: 00:04:33 avRtpSessionCname.0 = STRING: gwp@135.8.118.252 avRtpSessionPhone.0 = STRING: 69:2011

6 7

8 9 10

11

avRtpSessionDebugStr.0 = STRING: Id{35} Traps{2411/0} Traps{24/012}

12

13

14

Stats{S 54}

2 of 4

Issue 2 January 2008

199

Configuring monitoring applications

Table 56: QoS Trap output fields (continued) Label


15 16 17 18 19 20 21 22

Description The total number of received RTCP packets The total number of received RTP packets The codec used for the session The codec packet size, in bytes The encryption method The received silence suppression method The transmitted silence suppression method The average of all codec loss values sampled during the session The codec loss event counter The average of all codec round trip time values sampled during the session The codec round trip time event counter The percentage contribution of jitter-buffer underruns to the average codec loss The percentage contribution of jitter-buffer overruns to the average codec loss The average of all network RTP packet loss values sampled during the session The network RTP packet loss event counter The average of all network RTT values during the session The network RTT event counter The network jitter at the RTP receiver The minimum and maximum TTL values sampled in the session A counter that increments each time two consecutive RTP packets with the sample RTP sequence number are received

From the trap example


Stats{S 54 RTCP 5414 RX 9236} Stats{S 54 RTCP 54 RX 923615} g723 62B encryptionOff SSup disabled19/disabled SSup disabled/disabled20 Loss 0.1%21 #1 Loss 0.1% #122 RTT 570mS23 #38 RTT 570mS #3824 Jbuf 0.1%25/0.0% Jbuf 0.1%/0.0%26 Loss 0.0%27 #0 Loss 0.0% #028 RTT 376mS29 #38 RTT 376mS #3830 Jtr #0 TTL 63-63

23 24

25 26

27

28

29 30

31 32 33

34

Dup 0

3 of 4

200 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Table 56: QoS Trap output fields (continued) Label


35

Description A counter that increments each time an RTP packet with a sequence number less than the last known sequence is received The average network loss experienced by the remote RTP receiver A counter that increments each time the remote loss is sampled over its threshold A counter that increments each time the network jitter experienced by the remote RTP receiver is sampled over its threshold The echo cancellation loss on the TDM bus. A high value (that is, a low absolute value) may indicate impairment of DCP terminals.

From the trap example


Fall 0

36

Rem{Loss 0.0%36 #0 Jtr #0} Rem{Loss 0.0% #037 Jtr #0} Rem{Loss 0.0% #0 Jtr #038}

37

38

39

EC{Loss 45dB}

4 of 4

Analyzing QoS fault and clear trap output


The following is an example of the syslog message for the QoS fault and clear traps sent during RTP session 35, which terminated at 11:13:40 on October 20:
Oct 201 11:10:542 LZ-SIT-SR1 snmptrapd[9407]: 135.8.118.252 [135.8.118.252]: TrapsysUpTime.0 = Timeticks: (43131114) 4 days, 23:48:31.143, snmpTrapOID.0 = OID: avRtpQoSFault4, avRtpQoSFaultTh.0 = INTEGER: 15, avRtpQoSClearTh.0 = INTEGER: 06 Oct 201 11:13:402 LZ-SIT-SR1 snmptrapd[9407]: 135.8.118.252 [135.8.118.252]: TrapsysUpTime.0 = Timeticks: (43147723) 4 days, 23:51:17.233, snmpTrapOID.0 = OID: avRtpQoSClear4, avRtpQoSFaultTh.0 = INTEGER: 15, avRtpQoSClearTh.0 = INTEGER: 06

Issue 2 January 2008

201

Configuring monitoring applications

Table 57 describes the fields in the QoS fault and clear traps according to the numbered labels on the example above. Table 57: QoS fault and clear trap output fields Label
1

Description The date on which the trap was received The time at which the trap was received The gateway uptime The trap name. Indicates that this is a QoS fault trap or a QoS clear trap. The QoS fault trap boundary. That is, the number of active sessions with QoS faults that causes a QoS fault trap to be sent. The QoS clear trap boundary. That is, the reduced number of active sessions with QoS faults that causes a QoS clear trap to be sent after a QoS fault trap was sent.

From the QoS fault trap example


Oct 20

From the QoS clear trap example


Oct 20

11:10:54

11:13:40

sysUpTime.0 = Timeticks: (43131114) 4 days, 23:48:31.14 snmpTrapOID.0 = OID: avRtpQoSFault

sysUpTime.0 = Timeticks: (43147723) 4 days, 23:51:17.23 snmpTrapOID.0 = OID: avRtpQoSClear

avRtpQoSFaultTh.0 = INTEGER: 1

avRtpQoSFaultTh.0 = INTEGER: 1

avRtpQoSClearTh.0 = INTEGER: 0

avRtpQoSClearTh.0 = INTEGER: 0

202 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Viewing automatic traceroute results


The VoIP engine automatically performs UDP traceroutes whenever the RTP statistics application is enabled. A traceroute is performed per RTP session, 10 seconds after the session begins. A traceroute is not performed if there is another active session to the same destination for which a traceroute was already performed within the last five seconds.

Use the show rtp-stat traceroute command. You can filter the results according to subnet address by adding destination-ip and specifying the remote subnet address and subnet mask, or by specifying the rtp-statistics session index. For example:
TGM550-001(super)# show rtp-stat traceroute destination-ip 10.2.5.0 255.255.255.0 Session ID: 1234 From: 123.21.11.5, To: 10.2.4.15, At: 2004-12-26,12:21:55 TTL HOP ADDRESS DELAY --- --------------- -------1 123.21.11.1 2ms 2 212.201.233.102 65ms 3 213.21.51.12 110ms 4 10.2.4.15 175ms Session ID: 1234 From: 123.21.11.5, To: 10.2.4.5, At: 2004-12-26,13:30:15

Note:

Note: The traceroute results are displayed in reverse order (most recent first). Table 58: RTP traceroute results output Field Session ID From To At TTL HOP ADDRESS DELAY Description The RTP statistics index for the RTP session The IP address of the TGM550 The IP address of the session destination (in this case, a destination within the specified subnet) The time the traceroute is performed The hop count and TTL field value of probe packets The hop IP address The round trip time per probe packet. Three probe packets are sent per hop address, and the displayed value is the average of the three round-trip times. An asterisk (*) indicates that the probe packet timed out.

Issue 2 January 2008

203

Configuring monitoring applications

RTP statistics examples


This section includes an example of configuring the RTP statistics application for a sample network. In addition, there are some example calls between various types of phones.

Configuring the RTP statistics application for a sample network


Figure 9 shows the locations of four telephone extensions in an example network. Telephones with extensions 2004 and 2111 are connected to the local gateway IG550-001. Extensions 2002 and 2101 are connected to the remote gateway IG550-002. Figure 9: Four telephones in a sample network

204 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

At the site of the local gateway, the administrator enabled and configured the RTP-MIB application as follows:
//to enable the RTP statistics application: TGM550-001(super)# rtp-stat-service //to view the configuration of the application: TGM550-001(super)# show rtp-stat config RTP Statistic: Enabled QoS Trap: Disabled QoS Fault Trap: Disabled Fault: 0 Clear: 0 QoS Trap Rate Limiter: Token Interval: 10.00 seconds Bucket Size: 5 Session Table: Size: 128 Reserved: 64 Min Stat Win: 1 //to view the thresholds: TGM550-001(super)# show rtp-stat thresholds Item -------------------Codec Loss Average Codec Loss Codec RTT Echo Return Loss Loss Average Loss Remote Loss Average Remote Loss RTT Local Jitter Remote Jitter SSRC Changes Threshold ------------0.0% 1.0% 5 mS 1 dB 1.0% 1.0% 1.0% 1.0% 13mS 1mS 1mS N/A Event Threshold ----------------1 N/A 1 1 1 N/A 1 N/A 1 1 1 1

Issue 2 January 2008

205

Configuring monitoring applications

//to change the thresholds appropriately for the network: TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# TGM550-001(super)# rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat rtp-stat thresholds codec-loss 6.0 thresholds average-codec-loss 0.0 thresholds codec-rtt 700 thresholds echo-return-loss 5 thresholds loss 6.0 thresholds remote-loss 6.0 thresholds average-loss 0.0 thresholds average-remote-loss 0.0 thresholds jitter 70 thresholds remote-jitter 70 thresholds rtt 500 event-threshold echo-return-loss 0 event-threshold loss 1 event-threshold remote-loss 0 event-threshold jitter 0 event-threshold remote-jitter 0 event-threshold rtt 0 event-threshold ssrc-change 0

//to review the threshold configuration again: TGM550-001(super)# show rtp-stat thresholds Item -------------------Codec Loss Average Codec Loss Codec RTT Echo Return Loss Loss Average Loss Remote Loss Average Remote Loss RTT Local Jitter Remote Jitter SSRC Changes Threshold ------------6.0% 0.0% 700mS 5dB 6.0% 0.0% 6.0% 0.0% 500mS 70mS 70mS N/A Event Threshold ----------------1 N/A 1 0 0 N/A 0 N/A 0 0 0 0

//to configure the minimum statistics window for evaluating packet loss: TGM550-001(super)# rtp-stat min-stat-win 50 //to configure an external trap manager as a trap destination in addition to the active MGC: TGM550-001(super)# snmp-server host 136.9.71.47 traps v1 public

206 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

//to check SNMP configuration TGM550-001(super)# show snmp Authentication trap enabled Community-Access Community-String ---------------- ---------------read-only ***** read-write ***** SNMPv3 Notifications Status ----------------------------Traps: Enabled Informs: Enabled Retries: 3 Timeout: 3 seconds SNMP-Rec-Address Model Level Notification Trap/Inform User name ---------------- ----- ------- --------------- ----------- ------------------135.9.77.47 v1 noauth all trap ReadCommN UDP port: 162 DM 136.9.71.47 v1 noauth all trap WriteCommN UDP port: 162 //to enable the sending of QoS traps: TGM550-001(super)# rtp-stat qos-trap //to enable and configure the sending of fault and clear traps: TGM550-001(super)# rtp-stat fault 2 0 //to view RTP statistics configuration again: TGM550-001(super)# show rtp-stat config RTP Statistic: Enabled QoS Trap: Enabled QoS Fault Trap: Enabled Fault: 2 Clear: 0 QoS Trap Rate Limiter: Token Interval: 10.00 seconds Bucket Size: 5 Session Table: Size: 128 Reserved: 64 Min Stat Win: 50

Issue 2 January 2008

207

Configuring monitoring applications

A call over the WAN from an analog phone to an IP phone


At 00:39 on December 7, 2004, a call is placed from analog extension 2111 to IP phone extension 2002 (see Figure 10) in the network described in Configuring the RTP statistics application for a sample network on page 204. Figure 10: Remote call from analog to IP phone

208 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

The RTP statistics application is configured as described in Configuring the RTP statistics application for a sample network on page 204. The callers complain after the call that there were QoS problems during the call. The administrator investigates as follows:
//to see if the RTP statistics application registered QoS problems for the call: TGM550-001(super)# show rtp sessions ID QoS Start date and time End Time Type Destination ----- --- ------------------- -------- ---------- --------------20.20.20.2 00001 *1 2004-12-07,00:39:26 00:41:01 G711U //to display more details on the session: TGM550-001(super)# show rtp-stat detailed 1 Session-ID: 1 Status: Terminated, QOS: Faulted2, EngineId: 0 Start-Time: 2004-12-07,00:39:26, End-Time: 2004-12-07,00:41:01 Duration: 00:01:35 CName: gwp@30.30.30.1 Phone: 199:2111 Local-Address: 30.30.30.1:2329 SSRC 2764463979 Remote-Address: 20.20.20.2:2329 SSRC 1260226 (0) Samples: 19 (5 sec) Codec: G711U 200B 20mS Off, Silence-suppression(Tx/Rx) Disabled/Disabled, Play-Time 63. 916sec, Loss 11.0% #153, Avg-Loss 8.6%, RTT 201mS #0, Avg-RTT 210mS, JBuf-under/o verruns 9.4%/0.0%, Jbuf-Delay 2mS, Max-Jbuf-Delay 35mS Received-RTP: Packets 3225, Loss 0.0% #94, Avg-Loss 8.4%, RTT 124mS #0, Avg-RTT 96mS, Jitter 11 mS #0, Avg-Jitter 9mS, TTL(last/min/max) 63/63/63, Duplicates 0, Seq-Fall 0, DSC P 46, L2Pri 12, RTCP 9 Transmitted-RTP: VLAN 1, DSCP 46, L2Pri 6, RTCP 17 Remote-Statistics: Loss 11.6% #145, Avg-Loss 8.9%, Jitter 33mS #0, Avg-Jitter 26mS Echo-Cancellation: Loss 49dB #0, Len 32mS RSVP: Status Disabled, Failures 0

Issue 2 January 2008

209

Configuring monitoring applications

A few points to note:

The asterisk in the show rtp sessions output indicates that session 1 has QoS faults [1] The QoS is described as Faulted because there were QoS faults [2] QoS faults that can be seen in the output are: - The codec loss event counter indicates that codec loss went over its threshold 15 times [3] - The received-RTP packet loss event counter indicates that packet loss went over its threshold nine times [4] - The remote packet loss event counter indicates that remote packet loss went over its threshold 14 times [5]

A local call between an IP and an analog phone


A local call is placed at 00:57 between IP phone extension 2004 and analog phone extension 2111 (see Figure 11) in the network described in Configuring the RTP statistics application for a sample network on page 204. The call is finished at 00:59:19. Figure 11: Local call from analog to IP phone

210 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

After the call is ended, the administrator uses the CLI to view the QoS statistics:
//to see if there were QoS problems registered during the session TGM550-001(super)# show rtp sessions last 1 ID QoS1 Start date and time End Time Type ----- --- ------------------- -------- --------00001 2004-12-07,00:57:13 00:59:19 G711U //To display details of the session: TGM550-001(super)# show rtp-stat detailed 1 Session-ID: 1 Status: Terminated, QOS: Ok2, EngineId: 0 Start-Time: 2004-12-07,00:57:13, End-Time: 2004-12-07,00:59:19 Duration: 00:02:06 CName: gwp@30.30.30.1 Phone: 200:2111 Local-Address: 30.30.30.1:2165 SSRC 2533871380 Remote-Address: 30.30.30.2:2165 SSRC 93269 (0) ip phone or another medi proc Samples: 25 (5 sec) Codec: G711U 200B 20mS Off, Silence-suppression(Tx/Rx) Disabled/Disabled, Play-Time 130 .080sec, Loss 0.0% #03, Avg-Loss 0.0%4, RTT 83mS #05, Avg-RTT 108mS6, JBuf-under/overruns 0.0%/0.0%, Jbuf-Delay 5mS, Max-Jbuf-Delay 27mS Received-RTP: Packets 6503, Loss 0.0% #07, Avg-Loss 0.0%8, RTT 0mS #09, Avg-RTT 0mS10, Jitter 0mS #011, Avg-Jitter 0mS12, TTL(last/min/max) 64/64/64, Duplicates 0, Seq-Fall 0, DSCP 46, L2Pri 12, RTCP 26 Transmitted-RTP: VLAN 1, DSCP 46, L2Pri 6, RTCP 31 Remote-Statistics: Loss 0.0% #013, Avg-Loss 0.0%14, Jitter 10mS #015, Avg-Jitter 10mS16 Echo-Cancellation: Loss 49dB #017, Len 32mS RSVP: Status Disabled, Failures 0 Destination -----------30.30.30.2

A few points to note:

The QoS column in the show rtp sessions output has no asterisk (*), showing that no metrics went over their event thresholds or average thresholds during the session [1] The QoS is described as Ok because there were no QoS problems [2] All average metric values are below the average thresholds [4] [5] [6] [8] [10] [12] [14] [16] All event counters are zero [3] [5] [7] [9] [11] [13] [15] [17]

Issue 2 January 2008

211

Configuring monitoring applications

A remote call over the WAN from an IP phone to an IP phone


An unshuffled call is placed from IP phone extension 2004 to IP phone extension 2002 (Figure 12) in the network described in Configuring the RTP statistics application for a sample network on page 204. Figure 12: Remote call from IP phone to IP phone

After the call is ended, the following commands are run:


//to display the RTP sessions: TGM550-001(super)# show rtp sessions ID QoS Start date and time End Time Type Destination ----- --- ------------------- -------- ------------- -------------00011 2004-12-07,00:57:13 00:59:19 G711U 30.30.30.2 00012 * 2004-12-07,00:39:26 00:41:01 G711U 20.20.20.2 00013 * 2004-12-07,01:02:45 01:05:15 G711U 20.20.20.2 00014 2004-12-07,01:02:50 01:05:15 G711U 30.30.30.2

Sessions 13 and 14 both belong to the call, since two VoIP channels are used by an unshuffled call between two IP phones: one channel between each telephone and the TGM550 Telephony Gateway Module VoIP engine.

212 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Session 13 has QoS problems.


//to display details of session 13: TGM550-001(super)# show rtp-stat detailed 13 Session-ID: 13 Status: Terminated, QOS: Faulted, EngineId: 0 Start-Time: 2004-12-07,01:02:45, End-Time: 2004-12-07,01:05:15 Duration: 00:02:30 CName: gwp@30.30.30.1 Phone: 202:2004 Local-Address: 30.30.30.1:2329 SSRC 3510756141 Remote-Address: 20.20.20.2:2329 SSRC 1372162 (0) Samples: 30 (5 sec) Codec: G711U 200B 20mS Off, Silence-suppression(Tx/Rx) Disabled/Disabled, Play-Time 144 .540sec, Loss 0.0% #17, Avg-Loss 6.9%, RTT 99mS #0, Avg-RTT 208mS, JBuf-under/ov erruns 7.4%/0.0%, Jbuf-Delay 9mS, Max-Jbuf-Delay 73mS Received-RTP: Packets 7279, Loss 0.0% #17 , Avg-Loss 6.8%, RTT 8mS #0, Avg-RTT 68mS, Jitter 0mS #0, Avg-Jitter 6mS, TTL(last/min/max) 63/63/63, Duplicates 0, Seq-Fall 0, DSCP 46, L2Pri 12, RTCP 23 Transmitted-RTP: VLAN 1, DSCP 46, L2Pri 6, RTCP 27 Remote-Statistics: Loss 0.4% #17 , Avg-Loss 6.5%, Jitter 3mS #0, Avg-Jitter 22mS Echo-Cancellation: Loss 49dB #0, Len 32mS RSVP: Status Disabled, Failures 0

Issue 2 January 2008

213

Configuring monitoring applications

Session 14 is free of QoS problems:


//to display details of session 14: TGM550-001(super)# show rtp-stat detailed 14 Session-ID: 14 Status: Terminated, QOS: Ok, EngineId: 0 Start-Time: 2004-12-07,01:02:50, End-Time: 2004-12-07,01:05:15 Duration: 00:02:25 CName: gwp@30.30.30.1 Phone: 202:2002 Local-Address: 30.30.30.1:2165 SSRC 247950253 Remote-Address: 30.30.30.2:2165 SSRC 120077 (0) Samples: 29 (5 sec) Codec: G711U 200B 20mS Off, Silence-suppression(Tx/Rx) Disabled/Disabled, Play-Time 151 .140sec, Loss 0.0% #0, Avg-Loss 0.0%, RTT 95mS #0, Avg-RTT 106mS, JBuf-under/ove rruns 0.0%/0.0%, Jbuf-Delay 11mS, Max-Jbuf-Delay 27mS Received-RTP: Packets 7556, Loss 0.0% #0, Avg-Loss 0.0%, RTT 0mS #0, Avg-RTT 0mS, Jitter 0mS # 0, Avg-Jitter 0mS, TTL(last/min/max) 64/64/64, Duplicates 0, Seq-Fall 0, DSCP 46 , L2Pri 12, RTCP 31 Transmitted-RTP: VLAN 1, DSCP 46, L2Pri 6, RTCP 25 --type q to quit or space key to continue-Remote-Statistics: Loss 0.0% #0, Avg-Loss 0.0%, Jitter 7mS #0, Avg-Jitter 7mS Echo-Cancellation: Loss 49dB #0, Len 32mS RSVP: Status Disabled, Failures 0

214 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

A conference call
A conference call is placed between IP phone extension 1003, analog phone extension 80900, and IP phone extension 80886. The call is established by calling from extension 1003 to extension 80900, and then using the conference function on extension 1003 to add 80886 (see Figure 13). Figure 13: A conference call

During the call, the following commands are run:


//to display the RTP sessions: TGM550-001(super)# show rtp sessions ID QoS Start date and time End Time Type ----- --- ------------------- -------- --------------00001 2004-12-23,09:55:17 G729 00002 2004-12-23,09:55:20 G711U Destination --------------16.16.16.101 149.49.41.50

Issue 2 January 2008

215

Configuring monitoring applications

//to display details of session 1: GTGM550-001(super)# show rtp detailed 1 Session-ID: 1 Status: Active, QOS: Ok, EngineId: 0 Start-Time: 2004-12-23,09:55:17, End-Time: Duration: 00:00:48 CName: gwp@33.33.33.33 Phone: 1401:80900:1003 Local-Address: 33.33.33.33:61999 SSRC 3585271811 Remote-Address: 16.16.16.101:61999 SSRC 1369159108 (0) Samples: 9 (5 sec) Codec: G729 40B 0mS Off, Silence-suppression(Tx/Rx) No-RTP/No-RTP, Play-Time 4.760sec, Loss 0.0% #0, Avg-Loss 0.8%, RTT 137mS #0, Avg-RTT 141mS, JBuf-under/overruns 0. 8%/0.0%, Jbuf-Delay 20mS, Max-Jbuf-Delay 30mS Received-RTP: Packets 238, Loss 0.0% #0, Avg-Loss 0.0%, RTT 24mS #0, Avg-RTT 21mS, Jitter 0mS #0, Avg-Jitter 0mS, TTL(last/min/max) 0/61/61, Duplicates 0, Seq-Fall 0, DSCP 0, L2Pri 6, RTCP 26 Transmitted-RTP: VLAN 400, DSCP 46, L2Pri 6, RTCP 34 Remote-Statistics: Loss 0.0% #0, Avg-Loss 0.0%, Jitter 2mS #0, Avg-Jitter 1mS Echo-Cancellation: Loss 49dB #0, Len 0mS RSVP: Status Reserved, Failures 0 //to display details of session 2: TGM550-001(super)# show rtp detailed 2 Session-ID: 2 Status: Active, QOS: Ok, EngineId: 0 Start-Time: 2004-12-23,09:55:20, End-Time: Duration: 00:00:50 CName: gwp@33.33.33.33 Phone: 1402:80886:1003 Local-Address: 33.33.33.33:61175 SSRC 3702564610 Remote-Address: 149.49.41.50:61175 SSRC 15161893 (0) Samples: 10 (5 sec)

216 IG550 Integrated Gateway Administration and CLI Reference

Configuring and analyzing RTP statistics

Codec: G711U 40B 0mS Off, Silence-suppression(Tx/Rx) Disabled/Disabled, Play-Time 161.9 00sec, Loss 0.0% #0, Avg-Loss 0.0%, RTT 103mS #0, Avg-RTT 105mS, JBuf-under/over runs 0.0%/0.0%, Jbuf-Delay 11mS, Max-Jbuf-Delay 13mS Received-RTP: Packets 8094, Loss 0.0% #0, Avg-Loss 0.0%, RTT 8mS #0, Avg-RTT 9mS, Jitter 0mS # 0, Avg-Jitter 0mS, TTL(last/min/max) 0/64/64, Duplicates 0, Seq-Fall 0, DSCP 0, L2Pri 6, RTCP 30 Transmitted-RTP: VLAN 400, DSCP 46, L2Pri 6, RTCP 30 Remote-Statistics: Loss 0.0% #0, Avg-Loss 0.0%, Jitter 1mS #0, Avg-Jitter 0mS Echo-Cancellation: Loss 49dB #0, Len 0mS RSVP: Status Reserved, Failures 0

The conference ID that appears in the Phone string for session 1 and for session 2 is identical, which identifies the two sessions as belonging to the same conference call [1] [2].

Summary of RTP statistics commands


For more information about these commands, see RTP statistics on page 406. Table 59: RTP statistics application CLI commands Command rtp-stat clear rtp-stat event-threshold rtp-stat fault rtp-stat min-stat-win rtp-stat qos-trap Description Reset the RTP statistics application Set a QoS event-threshold for RTP streams Configure the RTP statistics application to send QoS fault and/or clear traps Set the RTP statistics minimum statistic window Configure the RTP statistics application to automatically send a QoS trap upon the termination of an RTP stream in which one or more QoS event counters exceeded their configured threshold 1 of 2

Issue 2 January 2008

217

Configuring monitoring applications

Table 59: RTP statistics application CLI commands (continued) Command rtp-stat qos-trap-rate-limit rtp-stat-service rtp-stat thresholds show rtp-stat config show rtp-stat detailed show rtp-stat sessions show rtp-stat summary show rtp-stat thresholds show rtp-stat traceroute Description Configure the QoS trap rate limiter Enable the RTP statistics application Set thresholds for the RTP statistics applications Display the RTP statistics application configuration Display a detailed QoS log for a specific RTP session Display RTP sessions QoS statistics Display a summary of the RTP statistics Display the configured RTP statistic thresholds Display the results of UDP traceroutes issued by the media gateway VoIP engine per active RTP session 2 of 2

218 IG550 Integrated Gateway Administration and CLI Reference

Reporting on interface status

Reporting on interface status


You report on the status of an interface using the show interfaces command. The command reports on the operational status of the interface. For example:
Console asynchronous mode is terminal Cable type: terminal Terminal baud rate is 9600 Voip is up, line protocol is up Internet address is 135.9.77.187, mask is 255.255.255.255 Primary management interface MTU 1500 bytes, Bandwidth 10000 kbit Link status trap disabled Last input 00:00:00, Last output 00:00:00 Last clearing of 'show interface' counters never 5 minute input rate 795 bits/sec, 2 packets/sec 5 minute output rate 998 bits/sec, 2 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 341507 packets input, 27428491 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 429220 packets output, 35968580 bytes 0 output errors, 0 collisions

For detailed specifications of CLI commands, refer to CLI Commands on page 235.

Summary of interface status commands


For more information about these commands, see IP interface configuration on page 338. Table 60: Interface status CLI commands Command show interfaces Description Display interface information

Issue 2 January 2008

219

Configuring monitoring applications

Configuring and monitoring CNA test plugs


The Converged Network Analyzer (CNA) is a distributed system for real-time monitoring of IP networks, using active measurements. The CNA supports various network tests including connectivity tests with pings, topology tests with traceroute, and QoS tests with synthetic RTP streams. Within a CNA system, test plugs are the entities that execute the tests, according to instructions from CNA schedulers, and return the results. For more information about administrating the CNA system, see IM R3.0 Converged Network Analyzer (CNA) Configuration, 14-300284.

CNA test plug functionality


When activated, test plugs present themselves to the CNA system in a process called registration. During registration, a test plug publishes its IP address and active ports, and authenticates and exchanges encryption keys with CNA schedulers. The schedulers are software components running on single board computers called chatterboxes. Schedulers are responsible for initiating tests, coordinating tests, and collecting the test results. For redundancy and load sharing, CNA systems usually include multiple chatterboxes and, therefore, multiple schedulers. However, since the schedulers distribute test plug registration parameters among themselves, a test plug only has to register with a single scheduler. Test plug administrators typically configure multiple schedulers addresses, for redundancy. You can configure a list of up to five scheduler IP addresses. The test plug attempts to register with the first scheduler on the list first, and then moves down the list as necessary if the registration is unsuccessful. When the test plug registers with a scheduler, the test plug provides the scheduler with its IP address, and two UDP port numbers, called the control port and the RTP echo port. The test plug IP address is the IP address of the interface on which the PMI is configured.

Test plug actions


Once registered, the test plug listens for test requests on the control port. When the test plug receives an authenticated and validly formatted test request from the scheduler, the test plug performs the following:

Injects any one of the tests specified in the test request into the network Performs the specified test using the parameter values passed in the test request Upon successful completion of the test, sends the test results to the analyzer of the chatterbox whose IP address is designated in the test request

220 IG550 Integrated Gateway Administration and CLI Reference

Configuring and monitoring CNA test plugs

CNA tests
The TGM550 Telephony Gateway Module test plug supports all CNA tests, which are:

Traceroute. Measures per-hop round-trip delays to a target IP address by sending a sequence of hop-limited UDP messages, each with a Time To Live (TTL) value that is one greater than that of the preceding message. Real Time Protocol (RTP). Measures delay, packet loss, and jitter to another test plug by sending a simulated RTP stream that is echoed back. Ping. Sends an ICMP echo message to a target IP address, and reports whether or not a response was returned. Transmission Control Protocol (TCP) Connect. Attempts to establish a TCP connection to a specified port at a target IP address, and reports whether the attempt succeeded or failed and the time taken by the TCP packet to reach its destination. Merge. Chatter test that is used, transparently to the user, to identify a single device with multiple IP addresses and to merge its multiple appearances into one in the network topology map.

When the test plug receives a request to run an RTP test, the test plug uses a UDP port called the RTP test port to send an RTP stream to another test plug. The test plug listens on the RTP echo port for RTP streams sent by other test plugs running RTP tests. All the UDP ports have default values, which can be overridden using CLI commands. The defaults are: Table 61: Default UDP port values
UDP Port Default value

Control port RTP echo port RTP test port

8889 8888 8887

Any changes you make to the test plug configuration, such as changing scheduler addresses or port numbers, only take effect when you cause the test plug to disconnect from the scheduler and register again.

Issue 2 January 2008

221

Configuring monitoring applications

Configuring the TGM550 Telephony Gateway Module test plug for registration
From the TGM550 Telephony Gateway Module CLI, you can configure the TGM550 Telephony Gateway Module test plug to register with a CNA scheduler. 1. Use the cna-testplug command to enter the testplug context. For example:
TGM550-001# cna-testplug 1 TGM550-001(cna-testplug 1)#

2. Use the scheduler command to configure one or more CNA scheduler IP addresses. You can configure up to five scheduler addresses. The test plug attempts to register with a scheduler according to its place on the list. By default, no schedulers are configured. At least one scheduler must be configured for registration to be possible. 3. Perform the following configurations as necessary:

Use the control-port command to configure the control port. The default control port number is 8889. Use the rtp-echo-port command to configure the RTP echo port. The default RTP echo port number is 8888. Use the rtp-test-port command to configure the RTP test port. The default RTP test port number is 8887. Use the test-rate-limit command to configure the CNA test rate limiter. The default test rate is 60 tests every 10 seconds.

4. If necessary, use the no shutdown command to enable the test plug. By default, the test plug is enabled. 5. When the test plug configurations are complete, use the exit command to exit the testplug context. From the general context, you can enter show cna testplug to display the test plug configuration. 6. From the general context, enter cna-testplug-service to enable the test plug service. For example:
TGM550-001# cna-testplug-service The Converged Network Analyzer test plug is enabled.

Note:

Note: The cna-testplug-service command requires admin access level. The test plug attempts to register with the first scheduler on the scheduler list. You can use the show cna testplug command to see if the test plug is registered and to view test plug statistics counters.

222 IG550 Integrated Gateway Administration and CLI Reference

Configuring and monitoring CNA test plugs

CNA test plug configuration example


The following example includes displaying default test plug configuration, configuring the test plug, enabling the test plug service, and displaying test plug configuration and counters.
//to display default test plug configuration before performing any //configuration: TGM550-001(super)# show cna testplug CNA testplug 1 is administratively down, test-plug status is unregistered Address 149.49.75.178, bind to PMI, ID 00:04:0d:6d:30:48 Scheduler list: Ports: Control 8889, RTP-test 8888, RTP-echo 8887 Test rate limiter: Maximum 60 tests in 10 seconds Last Test: none Test ---------traceroute rtp ping tcpconnect merge Count -----0 0 0 0 0 Failed -----0 0 0 0 0 Cancelled --------0 0 0 0 0

//to enter the test plug context: TGM550-001(super)# cna testplug 1 //to configure entries 3 and 1 on the scheduler list: TGM550-001(super-cna testplug 1)# scheduler 3 135.64.102.76 Done! TGM550-001(super-cna testplug 1)# scheduler 1 1.1.1.1 Done! //to change the configuration of scheduler 1: TGM550-001(super-cna testplug 1)# scheduler 1 1.1.1.2 Done! //to exit the test plug context: TGM550-001(super-cna testplug 1)# exit //to display test plug configuration: TGM550-001(super)# show cna testplug CNA testplug 1 is administratively down, test-plug status is unregistered Address 149.49.75.178, bind to PMI, ID 00:04:0d:6d:30:48 Scheduler list: 1: 1.1.1.2:50002 3: 135.64.102.76:50002 Ports: Control 8889, RTP-test 8888, RTP-echo 8887 Test rate limiter: Maximum 60 tests in 10 seconds

Issue 2 January 2008

223

Configuring monitoring applications

Last Test: none Test Count Failed Cancelled ---------------------------traceroute 0 0 0 rtp 0 0 0 ping 0 0 0 tcpconnect 0 0 0 merge 0 0 0//to reenter the test plug context: TGM550-001(super)# cna testplug 1 //to delete scheduler 1: TGM550-001(super-cna testplug 1)# no scheduler 1 Done! //to exit the test plug context: TGM550-001(super-cna testplug 1)# exit //to show that scheduler 1 is no longer configured: TGM550-001(super)# show cna testplug CNA testplug 1 is administratively down, test-plug status is unregistered Address 149.49.75.178, bind to PMI, ID 00:04:0d:6d:30:48 Scheduler list: 3: 135.64.102.76:50002 Ports: Control 8889, RTP-test 8888, RTP-echo 8887 Test rate limiter: Maximum 60 tests in 10 seconds Last Test: none Test Count Failed Cancelled ---------------------------traceroute 0 0 0 rtp 0 0 0 ping 0 0 0 tcpconnect 0 0 0 merge 0 0 0 //to enable the test plug service: TGM550-001(super)# cna testplug-service Done! //to display test plug configuration and counters after some running time: TGM550-001(super)# show cna testplug CNA testplug 1 is up, test-plug status is running a test Address 149.49.75.178, bind to PMI, ID 00:04:0d:6d:30:48 Scheduler list: 3: 135.64.102.76:50002 Ports: Control 8889, RTP-test 8888, RTP-echo 8887 Test rate limiter: Maximum 60 tests in 10 seconds Last Test: traceroute to 135.64.103.107 Result: ip1=149.49.75.178 ip2=135.64.103.107 ttl_len = 4 Test ---------traceroute rtp ping tcpconnect merge Count -----4 3 2 4 0 Failed -----0 0 0 0 0 Cancelled --------0 0 0 0 0

224 IG550 Integrated Gateway Administration and CLI Reference

Configuring and monitoring CNA test plugs

Resetting the CNA test plug counters


1. In the CNA testplug context, enter clear counters.
TGM550-001(cna-testplug 1)# clear counters

All CNA test plug counters are cleared.

Summary of CNA test plug commands


For more information about these commands, see CNA test plugs on page 267. Table 62: CNA test plug CLI commands Root level command cna testplug clear counters control-port rtp-echo-port Command Description Enter the CNA testplug configuration context Clear the CNA test plug counters Set or reset the UDP port on which the CNA test plug listens for test requests from schedulers Set or reset the UDP port used by the CNA test plug to listen for RTP streams sent by other test plugs running RTP tests Set or reset the UDP port used by the CNA test plug to send an RTP stream to another test plug in an RTP test Add a schedulers IP address to the list of schedulers with which the test plug can attempt to register Disable the CNA test plug Configure the CNA test rate limiter Enable or disable the CNA test plug service on the gateway Display CNA test plug configuration and statistics

rtp-test-port

scheduler

shutdown test-rate-limit cna-testplug-service show cna testplug

Issue 2 January 2008

225

Configuring monitoring applications

226 IG550 Integrated Gateway Administration and CLI Reference

Chapter 11: Setting synchronization


If the TGM550 Telephony Gateway Module contains an TIM510 T1/E1 media module, it is advisable to define the TIM510 as the primary synchronization source for the TGM550. In so doing, clock synchronization signals from the Central Office (CO) are used by the TIM510 to synchronize all operations of the TGM550. If no TIM510 is present, it is not necessary to set synchronization. Enter set sync interface primary|secondary mmID [portID] to define a potential stratum clock source (T1/E1 Media Module, ISDN-BRI), where:

mmID is the Media Module ID of an TIM stratum clock source of the form vn, where n is the TIM slot number portID is the port number for an ISDN clock source candidate. The port ID consists of the slot number of the media module and the number of the port. You can set more than one port. For example, v2 1, 3, 5-8. Note: The port ID parameter only applies if the source is a BRI module.

Note:

By setting the clock source to primary, normal failover will occur. The identity of the current synchronization source is not stored in persistent storage. Persistent storage is used to preserve the parameters set by this command. Note: Setting the source to secondary overrides normal failover, generates a trap, and asserts a fault. Thus, it is only recommended to set the clock source to secondary for testing purposes.

Note:

To determine which reference source is the active source, use the set sync source primary|secondary command. If you choose secondary, the secondary source becomes active, and the primary source goes on standby. In addition, fallback to the primary source does not occur even when the primary source becomes available. If neither primary nor secondary sources are identified, the local clock becomes the active source. The following example sets the TIM510 media module located in slot 2 of the TGM550 chassis as the primary clock synchronization source for the TGM550 Telephony Gateway Module. set sync interface primary v2 set sync source primary

Issue 2 January 2008

227

Setting synchronization

If the TGM550 Telephony Gateway Module includes a second TIM510 media module, enter the following additional command: set sync interface secondary v3 set sync source secondary If, for any reason, the primary TIM510 media module cannot function as the clock synchronization source, the system uses the TIM510 media module located in slot 3 of the TGM550 Telephony Gateway Module chassis as the clock synchronization source. If neither TIM510 media module can function as the clock synchronization source, the system defaults to the local clock running on the S8300 Server. To disassociate an interface previously specified as the primary or secondary clock synchronization source, enter clear sync interface primary or clear sync interface secondary. To enable or disable automatic failover and failback between designated primary and secondary synchronization sources, enter set sync switching enable or set sync switching disable.

Synchronization status
The yellow ACT LED on the front of the TIM510 media module displays the synchronization status of that module.

If the yellow ACT LED is solidly on or off, it has not been defined as a synchronization source. If it is on, one or more channels is active. If it is an ISDN facility, the D-channel counts as an active channel and causes the yellow ACT LED to be on. When the TIM510 is operating as a clock synchronization source, the yellow ACT LED indicates that the TIM510 is the clock synchronization source by flashing at three second intervals, as follows:

The yellow ACT LED is on for 2.8 seconds and off for 200 milliseconds if the TIM510 media module has been specified as a clock synchronization source and is receiving a signal that meets the minimum requirements for the interface The yellow ACT LED is on for 200 milliseconds and off for 2.8 seconds if the TIM510 media module has been specified as a synchronization source and is not receiving a signal, or is receiving a signal that does not meet the minimum requirements for the interface

228 IG550 Integrated Gateway Administration and CLI Reference

Synchronization status

Displaying synchronization status


Enter show sync timing to display the status of the primary, secondary, and local clock sources. The status can be Active, Standby, or Not Configured. The status is Not Configured when a source has not been defined, for example, when there are no T1 cards installed.

Summary of synchronization commands


For more information about these commands, see Synchronization on page 575. Table 63: Synchronization CLI commands Command clear sync interface set sync interface set sync source Description Disassociate a previously specified interface as the primary or secondary clock synchronization source Define the specified module and port as a potential source for clock synchronization for the media gateway Specify which clock source is the active clock source. The identity of the current synchronization source is not stored in persistent storage. Toggle automatic sync source switching Display the status of the primary, secondary, and local clock sources

set sync switching show sync timing

Issue 2 January 2008

229

Setting synchronization

230 IG550 Integrated Gateway Administration and CLI Reference

Chapter 12: User Levels and Contexts


The TGM550 Command Line Interface (CLI) consists of commands that are divided into logical contexts. These contexts enable you to view and configure the TGM550 Telephony Gateway Module more efficiently. A context can be a particular interface of the media gateway, or it can be a specific function with all its related commands. The contexts you can enter and the commands you can access, depend on the user level from which you log in to the CLI. For example, you can use all show commands in User mode. To configure the TGM550 Telephony Gateway Module, you must be in Supervisor or Privileged mode. After logging in, type tree to see a list of all the commands that are accessible at your user level. Type help to see the list of commands available in the current context.

User levels
The following are the user levels that control access to the various parts of the CLI: Level User Access read-only Description User level is a general access level used to display system parameter values. This level complies with the Read Only restrictions level. Privileged level is used to access configuration options. This level complies with the Read and Write restrictions level. Supervisor level is used for highly secured operations, such as adding a new user account, and showing the PPP chap secret. Services includes the craft and dadmin logins and other remote services logins. Except for the dadmin login, these accounts are protected with the use of an installed authentication file and the use of a challenge/response algorithm for generating the appropriate password.

Privileged

read-write

Supervisor

admin

Services

admin

Issue 2 January 2008

231

User Levels and Contexts

Contexts
The CLI is divided into various contexts from which sets of related commands can be entered. Contexts are nested in a hierarchy, with each context accessible from another context, called the parent context. The top level of the CLI tree is called the root context. Commands that can be executed from any context in the system are listed as having the general context.

Command line prompts


The command line prompt is always prefixed with the hostname of the media gateway. If the media gateway is registered, then the prompt is hostname-media_gateway_number. Otherwise, the prompt is hostname-???. The root context prompt reflects the logged-in user level:

The Supervisor level prompt always ends with (super)# The Privileged level prompt ends with # The User level prompt ends with > Note: For the sake of consistency, this CLI Reference uses the prompt (super)# in examples. This does not mean that the command is only available at the Supervisor level.

Note:

As you change contexts, the command line prompt changes to reflect the context path. To enter a context from another context:

Enter the name of the context. The prompt changes to indicate the context entered.

To leave a context:

Enter exit. The user returns to the parent context.

232 IG550 Integrated Gateway Administration and CLI Reference

Contexts

Available contexts
The following table describes all the contexts in the CLI. The Context column provides the command to type in order to enter the context. The CLI prompt column is the prompt that you see once you have entered the context.

Table 64: List of CLI Contexts Context (Log in as User) (Log in as Privileged User) (Log in as Supervisor) Interface Console Banner login Description Root Read Only context Root Read Write context Root Admin context Configuring the Console interface For editing a text message that appears before users login For editing a text message that appears after users login Configure Standard Local Survivability (SLS) Configure SLS stations Configure SLS trunks Configure SLS DS1 parameters Configure SLS signaling-group parameters Configure SLS BRI parameters Configure SLS dial-pattern parameters Configure SLS incoming-routing parameters CLI prompt > # (super)# (if:Console)# (login)#

Banner post login

(post-login)#

sls sls/station sls/trunk-group sls/ds1 sls/sig-group sls/bri sls/dial-pattern sls/incoming-routing

(sls) (sls-station <extension>) (sls-trunk-group-<tgnum>) (sls-ds1-<port-address>) (sls-sig-group <sgnum>) (sls-bri <slot-address>) (sls-dial-pattern <dialed-string>) (sls-incoming-routing <tgnum>)

Issue 2 January 2008

233

User Levels and Contexts

234 IG550 Integrated Gateway Administration and CLI Reference

Chapter 13: CLI Commands

About the CLI


The TGM550 Telephony Gateway Module CLI is accessible directly via the serial console port, remotely via Secure Shell (SSH), or via the modem PPP interface. The CLI is command-line driven and does not have any menus. The CLI commands available, and the functions of those commands, depend on the context you are in when you issue the command. For a complete discussion of contexts, refer to Contexts on page 232. This chapter lists all the CLI commands for the TGM550 Telephony Gateway Module, arranged alphabetically within topics.

Logging in to the CLI


To login to the CLI, you need a username and an eight-digit password. Initially, there is only one user, named root (with password root), on the system. It is recommended to change the root user password to prevent unauthorized entry into the system. The root user has Administrative privileges. You can add more users with the username command. Note: At the first login using root, the TGM550 prompts for a change of the password.

Note:

When you open the CLI interface, you are prompted for a username. Enter the username and press Enter. Enter your password at the password prompt, and press Enter. Once you have logged in, you can execute all the CLI commands that are permitted at your user level. For a full discussion of user levels, refer to User levels on page 231.

Issue 2 January 2008

235

CLI Commands

Using the CLI

Using the CLI


To use a command, type the desired command at the prompt and press Enter.

Using Help
You can use the built-in Help feature to display the list of commands that are available to you. Type help to see the list of available commands in the present context. Type help followed by a word or part of a word to see a list of all commands starting with that word. For example, type help show to see a list of all commands using show. Type tree to see the full list of commands available at the current permission level.

Using auto-complete
If you are unsure of the spelling of a command, use the auto-complete feature. Type the first few letters of the command and then press the tab key. The system completes the command automatically. If more than one command begins with those letters, pressing the tab key twice displays a list of commands matching those letters. Pressing the tab key twice automatically populates the next part of the command when only one option is available.

Abbreviating commands
You can abbreviate commands or parts of commands in the CLI. As long as the abbreviation uniquely identifies a command, the system executes that command. If the abbreviation is ambiguous, the system displays a list of possible matches. For example, typing sh ban login is the same as typing show banner login. However, typing show m matches more than one command and is not executed. Instead the system displays a list such as:
Ambiguous Command. Possible commands are: map-class mediaserver mg mgc mm module

236 IG550 Integrated Gateway Administration and CLI Reference

Announcement files

Announcement files
copy announcement-file ftp
Use the copy announcement-file ftp command to upload an announcement file from the TGM550 Telephony Gateway Module announcement directory to a remote FTP server. The files can then be downloaded from the FTP server to Avaya Voice Announcements Manager (VAM).

Syntax
copy announcement-file ftp source-filename ip [destination-filename]

Parameters
Parameter source-filename Description The name of the announcement file in the TGM550 Telephony Gateway Module announcement directory. If the file name includes spaces, use quotes. The IP address of the remote FTP server The destination file name, including full path, if a name change is required. If the file name includes spaces, use quotes. up to 32 characters for the file name Possible Values Default Value

ip destination-filename

User Level
read-write

Context
general

Issue 2 January 2008

237

CLI Commands

Announcement files

Example
To upload local_announcement2.wav from the announcements directory to a remote FTP server with IP address 192.168.49.10, place it in the C drive, and name it remote_announcement2.wav:
TGM550-001(super)# copy announcement-file ftp local_announcement2.wav 192.168.49.10 c:\remote_announcement2.wav

copy announcement-file scp


Use the copy announcement-file scp command to upload an announcement file from the TGM550 announcement directory to a remote SCP server, using SCP. The files can then be downloaded from the SCP server to Avaya Voice Announcements Manager (VAM).

Syntax
copy announcement-file scp source-filename ip [destination-filename]

Parameters
Parameter source-filename Description The file name of the announcement file in the TGM550 announcement directory. If the file name includes spaces, use quotes. The IP address of the remote SCP server The destination file name, including full path, if a name change is required. If the file name includes spaces, use quotes. Up to 32 characters, not including the path Possible Values Default Value

ip destination-filename

User Level
read-write

Context
general

238 IG550 Integrated Gateway Administration and CLI Reference

Announcement files

Example
To upload the file local_announcement2.wav from the announcements directory to the location c:\ on a remote SCP server with IP address 192.168.49.10, and name the destination file remote_announcement2.wav:
TGM550-001(super)# copy announcement-file scp local_announcement2.wav 192.168.49.10 c:\remote_announcement2.wav

copy ftp announcement-file


Use the copy ftp announcement-file command to download a file from an FTP server to the gateways announcement directory. The FTP command prompts for the username and password after the command is entered.

Syntax
copy ftp announcement filename ip [destination-filename]

Parameters
Parameter filename ip destination -filename Description The file name on the FTP server The IP address of the FTP server The file name in the gateways announcement directory string of up to 32 characters Possible Values Default Value

User Level
read-write

Context
general

Example
To download announcement_file2.wav from the FTP server at IP address 192.168.49.10 and save it in the gateways announcement directory as local_announcement_file2, using login dan:
TGM550-001cp(super)# copy ftp announcement-file c:\temp\announcement_file2.wav 192.168.49.10 local_announcement_file2 Username: dan Password:

Issue 2 January 2008

239

CLI Commands

Announcement files

copy scp announcement-file


Use the copy scp announcement-file command to download an announcement file from the Voice Announcements Manager to the TGM550 announcement directory using SCP. A maximum of 256 announcement files can be stored in the announcement directory.

Syntax
copy scp announcement-file source-filename ip [destination-filename]

Parameters
Parameter source-filename Description The filename of the announcement file on the Voice Announcements Manager host with the full path. If the file name includes spaces, use quotes. The IP address of the Voice Announcements Manager host The destination filename, if a name change is required. If the file name includes spaces, use quotes. Possible Values Default Value

ip destination-filename

User Level
read-write

Context
general

Example
To download announcement_file1.wav from the Voice Announcements Manager on host 192.168.49.10, and change the name to local announcement file2:
TGM550-001(super)# copy scp announcement-file c:\temp\announcement_file2.wav 192.168.49.10 local announcement file2

240 IG550 Integrated Gateway Administration and CLI Reference

Announcement files

erase announcement-file
Use the erase announcement-file command to erase an announcement file in the TGM550 announcement directory.

Syntax
erase announcement-file source-filename

Parameters
Parameter source-filename Description The name of the announcement file to delete Possible Values Default Value

User Level
read-write

Context
general

Example
To erase the announcement file local_announcement1.wav from the TGM550 Telephony Gateway Module announcement directory:
TGM550-001# erase announcement-file local_announcement1.wav

rename announcement-file
Use the rename announcement-file command to rename an announcement file in the TGM550 announcement directory.

Syntax
rename announcement-file source-filename destination-filename

Issue 2 January 2008

241

CLI Commands

Announcement files

Parameters
Parameter source-filename destination-filename Description The name of the announcement file to be renamed The new name for the announcement file Possible Values Default Value

User Level
read-write

Context
general

Example
To change the name of the announcement file from from_local_announcement1.wav to to_local_announcement1.wav:
TGM550-001# rename announcement-file from_local_announcement1.wav to_local_announcement1.wav

show announcements files


Use the show announcements files command to display the announcements files stored in the TGM550 announcement directory.

Syntax
show announcements files [brief]

Parameters
Parameter brief Description Keyword indicating to display less detail Possible Values Default Value

User Level
read-only

242 IG550 Integrated Gateway Administration and CLI Reference

Announcement files

Context
general

Example
To display the announcements files in full detail:
TGM550-001(super)# show announcements files Mode: FTP-SERVER/SCP-CLIENT ID File Description Size (Bytes) Date ---- ---------------- ------------- ------------ ----------------5 46xxupgrade.scr Announcement1 4000 09:54:55 04 APR 2005 8 4601dbte1_82.bin Announcement2 8000 09:55:55 04 APR 2005 9 4602dbte1_82.bin Announcement3 16000 09:56:55 04 APR 2005 Nv-Ram: Total bytes used: 28000 Total bytes free: 7344800 Total bytes capacity(fixed) 7372800 TGM550-001(super)# show announcements files brief Mode: FTP-SERVER/SCP-CLIENT ID File ---- ---------------5 46xxupgrade.scr 8 4601dbte1_82.bin 9 4602dbte1_82.bin Nv-Ram: Total bytes used: 28000 Total bytes free: 7344800 Total bytes capacity(fixed) 7372800

show download announcement-file status


Use the show download announcement-file status command to display the status of the download process of announcement files from the Voice Announcements Manager to the TGM550 announcement directory.

Syntax
show download announcement-file status

User Level
read-only

Context
general

Issue 2 January 2008

243

CLI Commands

Announcement files

Example
To display the status of the download process of announcement files: (In this example, no download command has been issued.)
TGM550-001(super)# show download announcement-file status Module #9 =========== No dest file for download operation - no download operation was done.

(In this example, a download command has been issued.)


TGM550-001(super)# show download announcement-file status Module #9 =========== Module : 9 Source file : hellosource.wav Destination file : hellodestination.wav Host : 135.64.102.64 Running state : Idle Failure display : (null) Last warning : No-warning Bytes Downloaded : 7825 ===========

show upload announcement-file status


Use the show upload announcement-file status command to display the status of the upload process of announcement files from the TGM550 announcement directory to the Voice Announcements Manager.

Syntax
show upload announcement-file status

User Level
read-only

Context
general

244 IG550 Integrated Gateway Administration and CLI Reference

Announcement files

Example
To display the status of the upload process of announcement files: (In this example, an upload command has been issued and the upload succeeds.)
TGM550-001(super)# Module #9 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : =========== show upload announcement-file status

9 hellosource.wav d:\hellodestination.wav 135.64.102.64 Idle (null) No-warning

(In this example, an upload command has been issued, but the upload fails.)
TGM550-001(super)# Module #9 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : =========== show upload announcement-file status

9 hellosource.wav d:\hellodestination.wav 135.64.102.64 Idle SCP- Permission denied No-warning

(In this example, no upload command has been issued.)


TGM550-001(super)# show upload announcement-file status Module #9 =========== No source file for upload operation - no upload operation was done.

Issue 2 January 2008

245

CLI Commands

ASG authentication

ASG authentication
copy auth-file ftp
Use the copy auth-file ftp command to copy the authentication file to a remote server using FTP.

Syntax
copy auth-file ftp filename ip

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Example
To copy the authorization file auth-pass to the host with IP address 192.168.49.10:
TGM550-001(super)# copy auth-file ftp auth-pass 192.168.49.10

copy auth-file scp


Use the copy auth-file scp command to copy the authentication file to a remote server using SCP.

Syntax
copy auth-file scp filename ip

246 IG550 Integrated Gateway Administration and CLI Reference

ASG authentication

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Example
To copy the authorization file auth-pass to the host with IP address 192.168.49.10:
TGM550-001(super)# copy auth-file scp auth-pass 192.168.49.10

copy auth-file tftp


Use the copy auth-file tftp command to copy the authentication file to a remote server using TFTP.

Syntax
copy auth-file tftp filename ip

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Issue 2 January 2008

247

CLI Commands

ASG authentication

Example
To copy the authorization file auth-pass to the host with IP address 192.168.49.10:
TGM550-001(super)# copy auth-file tftp auth-pass 192.168.49.10

copy ftp auth-file


Use the copy ftp auth-file command to download an authentication file from a remote FTP server. The TGM550 prompts you for a username and password after you enter the command.

Syntax
copy ftp auth-file filename ip

Context
admin

Parameters
Parameter filename ip Description The name of the authentication file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Example
To download authentication file AF-7000003638-06712-211123.xml from the remote FTP server at IP address 195.123.49.54:
TGM550-001# copy ftp auth-file \firmware\AF-7000003638-060712-211123.xml 195.123.49.54 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning download operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time.

248 IG550 Integrated Gateway Administration and CLI Reference

ASG authentication

copy scp auth-file


Use the copy scp auth-file command to download an authentication file from a remote SCP server.

Syntax
copy scp auth-file filename ip

Context
general

Parameters
Parameter filename ip Description The name of the authentication file, including the full path The IP address of the host Possible Values Default Value

User Level
admin

Example
To download authentication file AF-7000003638-060712-211123.xml from the host at IP address 195.123.49.54:
TGM550-001# copy scp auth-file \firmware\AF-7000003638-060712-211123.xml 195.123.49.54 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning download operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time.

Issue 2 January 2008

249

CLI Commands

ASG authentication

copy tftp auth-file


Use the copy tftp auth-file command to download an authentication file from a remote TFTP server.

Syntax
copy tftp auth-file filename ip

Context
general

Parameters
Parameter filename ip Description The name of the authentication file, including the full path The IP address of the host Possible Values Default Value

User Level
admin

Example
To download authentication file AF-70000036368-060712-211123.xml from the host at IP address 195.123.49.54:
TGM550-001# copy tftp auth-file \firmware\AF-7000003638-060712-211123.xml 195.123.49.54 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning download operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time.

250 IG550 Integrated Gateway Administration and CLI Reference

ASG authentication

login authentication lockout


Use the login authentication lockout command to set a policy for locking out access to device administration service policy after successive failed login attempts. Use the no login authentication lockout command to return the lockout time and lockout attempt threshold to their default values. Note: As soon as you use the login authentication lockout command, the new lockout settings immediately override previous settings, for all user accounts.

Note:

Syntax
[no] login authentication lockout time attempt count

Parameters
Parameter time Description The lockout time, in seconds Possible Values 30-3600 0 disables the timeout function 1-10 0 disables the timeout function Default Value 180

count

The number of successive failed login attempts before account lockout is enforced

User Level
admin

Context
general

Example
To lockout Avaya Services access to the device for 360 seconds following 5 failed login attempts:
TGM550-001(super)# login authentication lockout 360 attempt 5

Issue 2 January 2008

251

CLI Commands

ASG authentication

login authentication local-craft-password


Use the login authentication local-craft-password command to enable Avaya Services login local craft authentication using a password (default). Use the no form of this command to disable Avaya Services login local craft authentication using a password.

Syntax
[no] login authentication local-craft-password

User Level
admin

Context
general

Example
To disable Avaya Services login local craft authentication using a password:
TGM550-001(super)# no login authentication local-craft-password

login authentication response-time


Use the login authentication response-time command to set the time the system waits for user response to authentication requests before timing out a connection. The system aborts the connection if no response is received within the defined response time period. Use the no form of the command to return the response time value to the factory default. The time value you enter is used for both:

The response time interval between the user name prompt and the user name entry The response time interval between the challenge prompt and the challenge response Note: The authentication response timeout is ignored by the gateway for the Console interface.

Note:

Syntax
[no] login authentication response-time time

252 IG550 Integrated Gateway Administration and CLI Reference

ASG authentication

Parameters
Parameter time Description The authentication response time period, in seconds, before timing out a connection Possible Values 30-3600 0 disables the timeout function Default Value 120

User Level
admin

Context
general

Example
To timeout a connection if no response arrives within 120 seconds after an authentication request:
TGM550-001(super)# login authentication response-time 120

login authentication services-login


Use the login authentication services-login command to enable Avaya Services login access. Use the no form of the command to disable all Avaya Services logins, including local craft password-based authentication. Note: By default, Avaya Services login access is enabled as soon as the Authentication File is downloaded to the gateway.

Note:

Syntax
[no] login authentication services-login

User Level
admin

Context
general

Issue 2 January 2008

253

CLI Commands

ASG authentication

Example
To enable Avaya Services login:
TGM550-001(super)# login authentication services-login

show auth-file info


Use the show auth-file info command to view information about the ASG authentication file.

Syntax
show auth-file info

User Level
admin

Context
general

Example
To view information about the ASG authentication file:
TGM550-001(super)# show auth-file info Authentication File (AF) information: AF-ID :7000012345 Date/time : 15:02:27 27-SEP-2005 Major release : 4

show download auth-file status


Use the show download auth-file status command to display the status of the download process of the authentication file to the device.

Syntax
show download auth-file status

User Level
read-only

254 IG550 Integrated Gateway Administration and CLI Reference

ASG authentication

Context
general

Example
To display the status of the download process of the authentication file to the device:
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Bytes Downloaded : show download auth-file status

10 AF-7000003277-060926-211040.xml auth-file 149.49.71.50 Idle (null) No-warning 1242

show login authentication


Use the show login authentication command to view the login authentication settings and information.

Syntax
show login authentication

User Level
admin

Context
general

Example
To view the login authentication settings and information:
TGM550-001(super)# show login authentication Services logins: On Local craft: On Lockout time: 180 seconds Lockout attempt threshold: 3 Authentication response time: 120 seconds CLI logout timeout: Off

Issue 2 January 2008

255

CLI Commands

ASG authentication

show upload auth-file status


Use the show upload auth-file status command to view the status of the upload operation of an authentication file.

Syntax
show upload auth-file status

User Level
read-only

Context
general

Example
To view the status of the upload operation of an authentication file: (In this example, an upload command has been issued and the upload succeeds.)
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Show upload auth-file status

10 auth-file 444 135.64.102.114 Idle (null) No-warning

(In this example, an upload command has been issued, but the upload fails.)
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Show upload auth-file status

10 auth-file. d:\zion\run.cfg 135.64.102.39 Idle SCP - Permission denied No-warning

(In this example, no upload command has been issued.)


TGM550-001(super)# show upload auth-file status Module #10 =========== No source file for upload operation - no upload operation was done.

256 IG550 Integrated Gateway Administration and CLI Reference

ASG authentication

username
Use the username command to add a local user account. Use the no form of the command to remove the user account from the system. By default there is only a single user account, named root, with password root, which accesses the administrator level. You cannot delete this basic user account, nor modify its access level. However, you can modify its basic password. Note: For security reasons, you should change the root password immediately.

Note:

Syntax
username name [password passwd | asg-secret secret] access-type access_type no username name

Parameters
Parameter name passwd secret access_type Description New user name or dadmin Users password ASG secret key of a dadmin user Access type definition Possible Values minimum four character string minimum eight character string 32 hexadecimal characters read-only, read-write, admin Note: A dadmin user and a root user must be assigned an admin access type. Default Value

User Level
admin

Context
general

Issue 2 January 2008

257

CLI Commands

Backing up

Example
To create a new user account with username john, password johnnysm, and a read-write access:
TGM550-001(super)# username john password johnnysm access-type read-write User account added.

To change the password of the root user:


TGM550-001(super)# username root password mysecret access-type admin User account modified.

Note:

Note: You cannot change the access type of the root user:

TGM550-001(super)# username root password verysecret access-type read-write ERROR: User account root has always an administrator access type.

Note:

Note: If you wish to define a username which includes spaces, you must enclose the entire name in quotation marks, for example new york.

Backing up
show backup status
Use the show backup status command to display status information regarding the backup of a configuration file.

Syntax
show backup status

User Level
read-only

Context
general

Example
To display backup status information for a current or recent backup:
TGM550-001(super)# show backup status

258 IG550 Integrated Gateway Administration and CLI Reference

CDR file

CDR file
copy cdr-file ftp
Use the copy cdr-file ftp command to copy a Call Detail Recording (CDR) file to a remote server using FTP.

Syntax
copy cdr-file ftp filename ip

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Example
To copy the authorization file cdr1 to the host with IP address 192.168.49.10:
TGM550-001(super)# copy cdr-file ftp cdr1 192.168.49.10

copy cdr-file scp


Use the copy cdr-file scp command to copy a Call Detail Recording (CDR) file to a remote server using SCP.

Syntax
copy cdr-file scp filename ip

Issue 2 January 2008

259

CLI Commands

CDR file

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Example
To copy the authorization file cdr1 to the host with IP address 192.168.49.10:
TGM550-001(super)# copy cdr-file scp cdr1 192.168.49.10

copy cdr-file tftp


Use the copy cdr-file tftp command to copy a Call Detail Recording (CDR) file to a remote server using TFTP.

Syntax
copy cdr-file tftp filename ip

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

260 IG550 Integrated Gateway Administration and CLI Reference

CDR file

Example
To copy the authorization file cdr1 to the host with IP address 192.168.49.10:
TGM550-001(super)# copy cdr-file tftp cdr1 192.168.49.10

show upload cdr-file status


Use the show upload cdr-file status command to view the status of the upload of a CDR file.

Syntax
show upload cdr-file status

User Level
read-only

Context
general

Example
To view the status of the upload of a CDR file: (In this example, an upload command has been issued and the upload succeeds.)
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Show upload cfr-file status

10 cdr file 444 135.64.102.114 Idle (null) No-warning

(In this example, an upload command has been issued, but the upload fails.)
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Show upload cdr-file status

10 cdr file. d:\zion\run.cfg 135.64.102.39 Idle SCP - Permission denied No-warning

Issue 2 January 2008

261

CLI Commands

CLI sessions

(In this example, no upload command has been issued.)


TGM550-001(super)# show upload cdr-file status Module #10 =========== No source file for upload operation - no upload operation was done.

CLI sessions
exit
Use the exit command to exit the current context. If you are in the root context, the exit command logs you out of the system.

Syntax
exit

User Level
read-only

Context
all

Example
To exit the survivable call engine context:
TGM550-001(super-sls)# exit TGM550-001(super)#

reset
Use the reset command to reset a specified system resource. The command performs a hard reset of the specified entity, returning any selectable parameters to their startup configuration values and setting all hardware and firmware to a known state. Note: If the Supervisor modules are in Active/Standby configuration, resetting the active supervisor causes the standby supervisor to take over and become active.

Note:

262 IG550 Integrated Gateway Administration and CLI Reference

CLI sessions

Note:

Note: The reset command does not work while the configuration is being saved. Note: If a reset command is issued while a backup or restore operation is in progress, a query displays, inquiring whether you wish to reset. If the gateway is reset while a backup or restore operation is in progress, the backup/restore operation fails.

Note:

Syntax
reset [module module_number | voip | chassis]

Parameters
Parameter module module_number voip chassis Description Keyword indicating to reset a module The module to reset Keyword indicating to reset the VoIP engine Keyword indicating to reset the TGM550 and all its media modules Possible Values Default Value

User Level
read-write

Context
general

Example
To reset the VoIP engine:
TGM550-001(super)# reset voip This command will perform a hard reset. Do you want to continue (Y/N)? y

retstatus
Use the retstatus command to show whether or not the last CLI command you performed was successful.

Syntax
retstatus

Issue 2 January 2008

263

CLI Commands

CLI sessions

User Level
read-only

Context
general

Example
To display the status of the most recently executed command:
TGM550-001(super)# retstatus Succeeded TGM550-001(super)# retstatus Failed

set logout
Use the set logout command to set the number of minutes until the system automatically disconnects an idle session.

Syntax
set logout [timeout]

Parameters
Parameter timeout Description Number of minutes until the system automatically disconnects an idle session. Setting the value to 0 disables the automatic disconnection of idle sessions. Possible Values 0-99 Default Value 15

User Level
read-write

Context
general

Example
To set the system to disconnect idle sessions automatically after 20 minutes:
TGM550-001(super)# set logout 20

264 IG550 Integrated Gateway Administration and CLI Reference

CLI sessions

To disable the automatic disconnection of idle sessions:


TGM550-001(super)# set logout 0

show logout
Use the show logout command to display the amount of time in minutes the terminal remains idle before timing out. If the logout value is 0, there is no timeout limit. The default logout value is 15 minutes.

Syntax
show logout

User Level
read-only

Context
general

Example
To display the timeout value:
TGM550-001(super)# show logout CLI timeout is 15 minutes

tech
Use the tech command to enter tech mode, where additional tech-related commands are available. Note: This command is reserved for service personnel use only.

Note:

Syntax
tech

User Level
tech

Context
general

Issue 2 January 2008

265

CLI Commands

CLI sessions

Example
To enter tech mode:
TGM550-001(super)# tech Password: TGM550-001(tech)#

tree
Use the tree command to display the commands that are available at your current location in the CLI hierarchy. All commands are listed alphabetically.

Syntax
tree depth

Parameters
Parameter depth Description The level of depth at which to display the list of CLI commands Possible Values Default Value

User Level
read-only

Context
general

Example
To display the list of available commands to two levels:
TGM550-001(super)# tree 2 > arp > arp timeout > banner login banner login > line > banner post-login banner post-login > line --type q to quit or space key to continue--

266 IG550 Integrated Gateway Administration and CLI Reference

CNA test plugs

CNA test plugs


cna testplug
The TGM550 features one CNA test plug, which has its own CNA configuration context. Use the cna testplug command to enter the CNA test plug configuration context.

Syntax
cna testplug 1

User Level
read-write

Context
general

Example
To enter the test plug context:
TGM550-001# cna testplug 1 TGM550-001(cna-testplug 1)#

clear counters (CNA test plugs)


Use the clear counters command to clear the CNA test plug counters.

Syntax
clear counters

User Level
read-write

Context
cna-testplug

Issue 2 January 2008

267

CLI Commands

CNA test plugs

Example
To clear CNA test plug counters on testplug 1:
TGM550-001(cna-testplug 1)# clear counters

control-port
Use the control-port command to set the UDP port on which the CNA test plug listens for test requests from schedulers. Use the no form of the command to return to the default control port.

Syntax
control-port port no control port

Parameters
Parameter port Description The UDP port number to be used as the control port Possible Values 1-65535 Default Value 8888

User Level
read-write

Context
cna-testplug

Example
To set the control port to port number 12843:
TGM550-001(cna-testplug 1)# control-port 12843

268 IG550 Integrated Gateway Administration and CLI Reference

CNA test plugs

rtp-echo-port
Use the rtp-echo-port command to set the UDP port used by the CNA test plug to listen for RTP streams send by other test plugs running RTP tests. Use the no form of the command to return the RTP echo port to its default.

Syntax
rtp-echo-port port

Parameters
Parameter port Description The UDP port number to be used as the RTP echo port number Possible Values 1-65535 Default Value 8888

User Level
read-write

Context
cna-testplug

Example
To set the RTP echo port to port 45230:
TGM550-001(cna-testplug 1)# rtp-echo-port 45230

rtp-test-port
Use the rtp-test-port command to set the UDP port used by the CNA test plug to send an RTP stream to another test plug in an RTP test. Use the no form of the command to return to the default UDP port for RTP tests.

Syntax
rtp-test-port port no rtp-test-port

Issue 2 January 2008

269

CLI Commands

CNA test plugs

Parameters
Parameter port Description The UDP port number to be used as the RTP test port Possible Values 1-65535 Default Value 8887

User Level
read-write

Context
cna-testplug

Example
To set the RTP test port to 65120:
TGM550-001(cna-testplug 1)# rtp-test-port 65120

scheduler
Use the scheduler command to add a schedulers IP address to the list of schedulers with which the test plug can attempt to register. You can list up to five schedulers. The test plug attempts to register with the scheduler highest on the list, and moves along the list if necessary until registration is successful. You can specify the TCP registration port, the port used by the test plug to request registration and send registration parameters to a scheduler. By default, the TCP registration port is 8888. Use the no form of the command to clear one of the scheduler addresses.

Syntax
scheduler index scheduler-address[:port] no scheduler index

270 IG550 Integrated Gateway Administration and CLI Reference

CNA test plugs

Parameters
Parameter index Description An index in the scheduler list. Scheduler 1 is the first scheduler attempted by the test plug for registration. The IP address of a scheduler The TCP registration port number 1-65535 8888 Possible Values 1-5 Default Value

scheduler-address port

User Level
read-write

Context
cna-testplug

Example
To add the scheduler whose IP address is 124.12.221.43 to the fourth place in the scheduler list:
TGM550-001(cna-testplug 1)# scheduler 4 124.12.221.43

shutdown (CNA test plugs)


Use the shutdown command to disable the CNA test plug. Use the no form of the command to enable the CNA test plug. By default, the test plug is enabled.

Syntax
[no] shutdown

User Level
read-write

Context
cna-testplug

Example
To enable the test plug:
TGM550-001(cna-testplug 1)# no shutdown

Issue 2 January 2008

271

CLI Commands

CNA test plugs

test-rate-limit
Use the test-rate-limit command to configure the CNA test rate limiter. The CNA test rate limiter sets the maximum rate of tests that can be run by the CNA test plug embedded in the TGM550. Use the no form of the command to return the CNA test rate limiter to its default configuration.

Syntax
test-rate-limit maxTests interval

Parameters
Parameter maxTests interval Description The maximum number of tests allowed in an interval. Zero means no limit. The rate limiter interval, in seconds Possible Values 0-10000 1-1000 Default Value 60 10

User Level
read-write

Context
cna-testplug

Example
To set the CNA test rate limit to 70 tests every 20 seconds:
TGM550-001(cna-testplug 1)# test-rate-limit 70 20

cna-testplug-service
Use the cna-testplug-service command to enable the CNA test plug service on the gateway. Use the no form of the command to disable CNA test plug service on the gateway. In order to enable the test plug, both the test plug and the test plug service must be enabled. Use the shutdown and no shutdown commands in the test plug context to disable/enable the test plug itself.

Syntax
cna-testplug-service

272 IG550 Integrated Gateway Administration and CLI Reference

CNA test plugs

User Level
admin

Context
general

Example
To enable the CNA test plug service:
TGM550-001# cna-testplug-service The Converged Network Analyzer test plug is enabled.

show cna testplug


Use the show cna testplug command to display CNA test plug configuration and statistics.

Syntax
show cna testplug

User Level
read-only

Context
cna-testplug

Example
To display the CNA test plug configuration and statistics:
TGM550-001(cna-testplug 1)# show cna testplug CNA testplug 1 is up, test-plug status is running a test Address 149.49.54.114, bind to PMI, ID 00:04:0d:6d:30:48 Scheduler list: 1: 135.64.102.76:50002 (current) 5: 135.64.105.3:50002 Ports: Control 8889, RTP-test 8888, RTP-echo 8887 Test rate limiter: Maximum 60 tests in 10 seconds Last Test: rtp to 149.49.54.114, scheduler: 135.64.102.76:50002 Result: RTP echo started Test Count Failed Cancelled ---------------------------traceroute 1 0 0 rtp 66 0 0 ping 0 0 0 tcpconnect 0 0 0 merge 0 0 0

Issue 2 January 2008

273

CLI Commands

CNA test plugs

Output fields
Name test plug 1 is... Description The status of the test plug service. Possible values are:

up. The test plug is up. down. The test plug is down due to lack of success registering or a configuration error. administratively down. The test plug is configured as down.

test-plug status

The registration status of the test plug. Possible values are:

test-plug is unregistered. The test plug is attempting to register and is currently unregistered. test-plug is unregistered (scheduler list exhausted). The test plug has exhausted its scheduler list at least once, and is now attempting to register. test-plug is idle. The test plug is registered but not currently running a test. test-plug is running a test. The test plug is running a test. test-plug is suspended. The test plug is suspended by its test rate limiter. test-plug configuration error (no IP address). No IP address is configured for the test plug interface. test-plug configuration error (bad IP address). The configured test plug address is not configured for the test plug interface. test-plug configuration error (scheduler list empty). The scheduler list is empty, and, therefore, the test plug is disabled. test-plug control port binding error. The test plug cannot bind the UDP control port. test-plug RTP port binding error. The test plug cannot bind the RTP test UDP port.

Address bind to PMI ID

The IP address of the test plug interface States that the PMI is the test plugs IP address The MAC address of the TGM550, used to identify the test plug 1 of 2

274 IG550 Integrated Gateway Administration and CLI Reference

CNA test plugs

Name Scheduler list Ports: Control RTP-test RTP-echo Test rate limiter Last Test

Description The list of up to five IP addresses of schedulers with which the test plug can attempt to register

The control port number. The UDP port on which the CNA test plug listens for test requests from the current scheduler. The UDP port from which the CNA test plug send RTP streams to another test plug when running an RTP test The RTP echo port number. The UDP port on which the CNA test plug listens for RTP streams sent by other test plugs running RTP tests. The configuration of the CNA test rate limiter The current or last test performed by the test plug. Possible values:

none. No test has been performed since the test plug was up. traceRoute. The current/last test performed is/was a traceroute test. rtp. The current/last test performed is/was an RTP test. ping. The current/last test performed is/was a ping test. tcpConnect. The current/last test performed is/was a TCPConnect test. merge. The current/last test performed is/was a merge test.

Result Test Count Failed Cancelled

The results of the last test run The types of tests The number of tests of each type that was run since the test plug was up The number of tests of each type that failed The number of tests of each type that was cancelled 2 of 2

Issue 2 January 2008

275

CLI Commands

Configuration files

Configuration files
copy ftp startup-config
Use the copy ftp startup-config command to download a configuration file from an FTP server. The command prompts for the username and password. Note: After you download the configuration file, the new configuration is not active until you reset the device.

Note:

Syntax
copy ftp startup-config filename ip

Parameters
Parameter filename ip Description The file name on the FTP server The IP address of the FTP server Possible Values Default Value

User Level
read-write

Context
general

Example
To download the configuration file TGM550.img from the FTP server at IP address 135.64.10.33 using login dan:
TGM550-001(super)# copy ftp startup-config TGM550.img 135.64.10.33 Username: dan Password: TGM550-001(super)# reset

276 IG550 Integrated Gateway Administration and CLI Reference

Configuration files

copy running-config ftp


Use the copy running-config ftp command to upload the current configuration to a file on an FTP server. The command prompts for the username and password. Uncommitted changes to the configuration are included. Note: After you change the configuration, run the copy running-config startup-config command to save the changes. If you do not save the changes, the device loses the changes when you reset it.

Note:

Syntax
copy running-config ftp filename ip

Parameters
Parameter filename ip Description File name to create on the FTP server IP address of the FTP server Possible Values Default Value

User Level
read-write

Context
general

Example
To upload the current configuration to TGM550.cfg on the ftp server at IP address 135.64.10.33 using login dan:
TGM550-001(super)# copy running-config ftp c:\config_files\router1.cfg 135.64.10.33 Username: dan Password:

Issue 2 January 2008

277

CLI Commands

Configuration files

copy running-config scp


Use the copy running-config scp command to upload the current configuration using the SCP secure protocol. The command prompts for the username and password. Uncommitted changes to the configuration are included. Note: After you change the configuration, run the copy running-config startup-config command to save the changes. If you do not save the changes, the device loses the changes when you reset it.

Note:

Syntax
copy running-config scp filename ip

Parameters
Parameter filename ip Description File name to create on the SCP server IP address of the SCP server Possible Values Default Value

User Level
read-write

Context
general

Example
To upload router.cfg to the SCP at IP address 192.168.49.10 using login dan:
TGM550-001(super)# copy running-config scp c:\config_files\router1.cfg 192.168.49.10 Username: dan Password:

278 IG550 Integrated Gateway Administration and CLI Reference

Configuration files

copy running-config startup-config


Use the copy running-config startup-config command to commit the current configuration, including Standard Local Survivability (SLS) data, to NVRAM. When a gateway powers up, SLS is disabled by default. However, if the gateway resets because of a CLI command, a software timeout, etc. and the copy running-config startup-config command has not been issued prior to the reset, any administrative changes made are lost. This command is equivalent to save translation in the Communication Manager. Note: Station passwords are stored in a special area of NVRAM to prevent them from being uploaded or downloaded through non-secure protocols.

Note:

Syntax
copy running-config startup-config

User Level
read-write

Context
general

Example
TGM550-001(super)# copy running-config startup-config

copy running-config tftp


Use the copy running-config tftp command to upload the current configuration to a file on a TFTP server. Uncommitted changes to the configuration are included. To use this command, you need to have an active TFTP server. If Avaya Network Manager is running, you do not require an additional TFTP server. Note: After you change the configuration, run the copy running-config startup-config command to save the changes. If you do not save the changes, the device loses the changes when you reset it.

Note:

Syntax
copy running-config tftp filename ip

Issue 2 January 2008

279

CLI Commands

Configuration files

Parameters
Parameter filename ip Description Name of file to create on TFTP server IP address of TFTP server Possible Values Default Value

User Level
read-write

Context
general

Example
To upload the current configuration to TGM550.cfg on the TFTP server at IP address 135.64.10.33:
TGM550-001(super)# copy running-config tftp TGM550.cfg 135.64.10.33

copy scp startup-config


Use the copy scp startup-config command to download a startup-config file using the SCP secure protocol. The command prompts for the username and password. Uncommitted changes to the configuration are not included. Note: After you change the configuration, run the copy running-config startup-config command to save the changes. If you do not save the changes, the device loses the changes when you reset it.

Note:

Syntax
copy scp startup-config filename ip

Parameters
Parameter filename ip Description Name of file to create on SCP server IP address of SCP server Possible Values Default Value

280 IG550 Integrated Gateway Administration and CLI Reference

Configuration files

User Level
read-write

Context
general

Example
To download router1.cfg from the SCP server at IP address 192.168.49.10:
TGM550-001(super)# copy scp startup-config c:\config_files\router1.cfg 192.168.49.10

copy startup-config ftp


Use the copy startup-config ftp command to upload the current configuration to a file on an FTP server. The command prompts for the username and password. Uncommitted changes to the configuration are not included. Note: After you change the configuration, run the copy running-config startup-config command to save the changes. If you do not save the changes, the device loses the changes when you reset it.

Note:

Syntax
copy startup-config ftp filename ip

Parameters
Parameter filename ip Description Name of file to create on the FTP server IP address of the FTP server Possible Values Default Value

User Level
read-write

Context
general

Issue 2 January 2008

281

CLI Commands

Configuration files

Example
To upload the current configuration to TGM550.cfg on the FTP server at IP address 135.64.10.33:
TGM550-001(super)# copy startup-config ftp TGM550.cfg 135.64.10.33

copy startup-config scp


Use the copy startup-config scp command to upload the current configuration to a file on an SCP server. The command prompts for the username and password. Uncommitted changes to the configuration are not included. Note: After you change the configuration, run the copy running-config startup-config command to save the changes. If you do not save the changes, the device loses the changes when you reset it.

Note:

Syntax
copy startup-config scp filename ip

Parameters
Parameter filename ip Description Name of file to create on the SCP server IP address of the SCP server Possible Values Default Value

User Level
read-write

Context
general

Example
To upload the current configuration to router1.cfg on the SCP server at IP address 192.168.49.10:
TGM550-001(super)# copy startup-config scp c:\config_files\router1.cfg 192.168.49.10

282 IG550 Integrated Gateway Administration and CLI Reference

Configuration files

copy startup-config tftp


Use the copy startup-config tftp command to upload the current configuration to a file on a TFTP server. Uncommitted changes to the configuration are not included. To use this command, you need to have an active TFTP server. If Avaya Network Manager is running, you do not require an additional TFTP server. Note: After you change the configuration, run the copy running-config startup-config command to save the changes. If you do not save the changes, the device loses the changes when you reset it.

Note:

Syntax
copy startup-config tftp filename ip

Parameters
Parameter filename ip Description Name of file to create on TFTP server IP address of TFTP server Possible Values Default Value

User Level
read-write

Context
general

Example
To upload the current configuration to TGM550.cfg on the TFTP server at IP address 135.64.10.33:
TGM550-001(super)# copy startup-config tftp TGM550.cfg 135.64.10.33

Issue 2 January 2008

283

CLI Commands

Configuration files

copy tftp startup-config


Use the copy tftp startup-config command to copy the media gateway configuration from the saved TFTP file to the Startup Configuration NVRAM. To use this command, you need to have an active TFTP server, and to create a file into which to download the data. If Avaya Network Manager is running, an additional TFTP server is not required.

Syntax
copy tftp startup-config filename ip

Parameters
Parameter filename ip Description The file name, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To copy the configuration file router1.cfg from the TFTP server 192.168.49.10 into the startup configuration:
TGM550-001(super)# copy tftp startup-config c:\TGM550\router1.cfg 192.168.49.10

erase startup-config
Use the erase startup-config command to reset the NVRAM parameters to the factory default values. This command is an alias for the command nvram initialize on page 285.

Syntax
erase startup-config

284 IG550 Integrated Gateway Administration and CLI Reference

Configuration files

User Level
read-write

Context
general

nvram initialize
Use the nvram initialize command to reset the NVRAM parameters to the factory default values. This command is an alias for erase startup-config (refer to erase startup-config on page 284).

! CAUTION:
CAUTION:

This command erases all announcement files in the TGM550 announcement directory.

Syntax
nvram initialize

User Level
read-write

Context
general

Example
To reset the configuration parameters for the device:
TGM550-001(super)# nvram initialize This command will restore factory defaults, and can disconnect your telnet session *** Reset *** - do you want to continue (Y/N)? Y Connection closed by foreign host.

show copy status


Use the show copy status command to display the status of the copy running-config startup-config operation.

Syntax
show copy status

Issue 2 January 2008

285

CLI Commands

Configuration files

User Level
read-write

Context
general

Example
To display the status of the current copy operation:
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : show copy status

10 startup-config running-config Idle (null) No-warning

show download status


Use the show download status command to display the status of the current configuration file download process, as the file is being loaded into the device.

Syntax
show download status [module_number]

Parameters
Parameter module_number Description The number of the module for which to display information Possible Values 1-10 Default Value

User Level
read-only

Context
general

286 IG550 Integrated Gateway Administration and CLI Reference

Configuration files

Example
To display the status of a configuration file download for module 10:
TGM550-001(super)# show download status 10

show erase status


Use the show erase status command to display the status of the erase startup-config operation.

Syntax
show erase status

User Level
read-write

Context
general

show running-config
Use the show running-config command to display the TGM550s current configuration.

Syntax
show running-config

User Level
read-only

Context
general

Issue 2 January 2008

287

CLI Commands

Configuration files

Example
To display the current configuration:
TGM550-001(super)# show running-config TGM550-001(super)# ! version 0.0.13 ! ! ! ds-mode t1 ! interface Vlan 1 icc-vlan ip address 172.16.1.139 255.255.255.240 pmi ! interface FastEthernet 10/2 ! interface Console ip address 10.3.0.1 255.255.255.0 !

show startup-config
Use the show startup-config command to show the NVRAM based configuration loaded automatically at startup.

Syntax
show startup-config

User Level
read-only

Context
general

Example
To display the startup configuration:
TGM550-001(super)# show startup-config TGM550-001(super)# ! version 26.21.0 Config info release 26.20.1 time "06:40:43 12 OCT 2006 " serial_number 06IS08707089 encrypted-username uncVTWjn/MLvdi9jfCicYw== password zR/

288 IG550 Integrated Gateway Administration and CLI Reference

Configuration files

5E5Hyp7UAnRSH7FJRXryRiM5i5Jhn0cE8+7ibrG4= access-type JvjDrGgDTiHv6qPqMV675A== set logging file enable set logging file condition all Error set logging file condition BOOT Debug no snmp-server community interface Console exit set mgc list 135.9.77.44 set mediaserver 135.9.77.44 135.9.77.44 23 telnet set mediaserver 135.9.77.44 135.9.77.44 5023 sat set TGM550-002(super)# qos bearer 802p 0 set qos signal 802p 0 rtp-stat qos-trap no rtp-stat fault !#

show upload status


Use the show upload status command to display status information regarding the upload of a capture file or a configuration file, for a specific module or for all modules.

Syntax
show upload status [module_number]

Parameters
Parameter module_number Description The module number for which to display upload information Possible Values 0-10 Default Value

User Level
read-only

Context
general

Issue 2 January 2008

289

CLI Commands

Connectivity

Example
To display upload status information for module 10:
TGM550-001(super)# show upload status 10 Module #10 =========== No source file for upload operation - no upload operation was done.

Connectivity
ping
Use the ping command to send ICMP packets to a target system. The ping command is useful for checking host reachability and network connectivity.

Syntax
ping host [interval [size[timeout[source_address]]]]

Parameters
Parameter host interval size timeout source_address Description The IP address of the target system The number of seconds between successive ICMP packets The size, in bytes, of the packet sent when pinging The timeout in seconds IP address from which to send the ICMP packets 1-256 22-65500 1-10 1 50 Possible Values Default Value

User Level
read-only

Context
general

290 IG550 Integrated Gateway Administration and CLI Reference

Counters

Example
To send test 50-byte packets to IP address 192.168.49.1 from IP address 192.168.49.4 every 3 seconds, timing out after 5 seconds:
TGM550-001(super)# ping 192.168.49.1 3 50 5 192.168.49.4

Counters
clear counters (interface)
Use the clear counters command to clear counters for the selected interface or the entire device.

Syntax
clear counters [interface_type interface_identifier]

Parameters
Parameter interface_ type interface_ identifier Description The type of interface The interface number. The format varies depending on the value of interface_type: For Serial: module/port:channel-group For LoopBack: Loopback number For Serial(USP): 2/1 For Serial (DS1): module/port: 2/1 channel-group: E1: 0-30 T1: 0-23 For Loopback: 1-99 Possible Values Default Value

User Level
read-write

Context
general

Issue 2 January 2008

291

CLI Commands

Counters

Example
To clear counters on DS1 module 3, channel group 20:
TGM550-001(super)# clear counters 3/20

clear ip traffic
Use the clear ip traffic command to clear the IP counters.

Syntax
clear ip traffic

User Level
read-only

Context
general

Example
To clear the IP counters:
TGM550-001(super)# clear ip traffic

show ip traffic
Use the show ip traffic command to display IP counters information for a given protocol. If no protocol is specified information for all protocols is displayed.

Syntax
show ip traffic [protocol_type]

Parameters
Parameter protocol_type Description The type of IP protocol for which to display information Possible Values arp, bootp-dhcp, icmp, ip, ospf Default Value

292 IG550 Integrated Gateway Administration and CLI Reference

Counters

User Level
read-only

Context
general

Example
To display traffic information for all protocols:
TGM550-001(super)# show ip traffic IP statistics: Received: 5644 total, 4012 local destination 0 bad hop count, 0 packet header errors 0 unknown protocol, 0 address errors 1632 discarded Fragments: 0 reassembled, 0 timeouts 0 couldn't reassemble, 0 fragmented Sent: 4014 generated, 0 forwarded 0 no route, 0 discarded ICMP statistics: Received: 0 total, 0 ICMP errors 0 unreachables, 0 time exceeded 0 parameter, 0 quench 0 echo, 0 echo reply 0 timestamps request, 0 timestamp reply 0 mask requests, 0 mask replies 0 redirects Sent: total, 0 ICMP errors unreachables, 0 time exceeded parameter, 0 quench echo, 0 echo reply timestamps request, 0 timestamp reply mask requests, 0 mask replies redirects

0 0 0 0 0 0 0

OSPF statistics: Received: 0 total, 0 checksum errors 0 hello, 0 database desc 0 link state req, 0 link state updates 0 link state acks

Issue 2 January 2008

293

CLI Commands

CSU loopbacks

Sent: 0 total ARP statistics: Received: 5394 requests, 2 replies Sent: 36 requests, 16 replies (0 proxy) DHCP statistics: Requests: 0 , Replies: 0 BOOTP statistics: Requests: 0 , Replies: 0

CSU loopbacks
show csu loopbacks
Use the show csu loopbacks command to view the state of the server SAT-controlled CSU loopbacks on a media module.

Syntax
show csu loopbacks mmID

Parameters
Parameter mmID Description The Media Module ID Possible Values Default Value

User Level
read-only

Context
general

Example
To view the state of loopbacks on module 2:
TGM550-001(super)#show csu loopbacks v2

294 IG550 Integrated Gateway Administration and CLI Reference

CSU loopbacks

CSU LOOPBACK STATUS ----------------------------------Towards DTE PortDigital Diagnostics: OFF Towards NetworkPayload: OFF Line : OFF

show csu status


Use the show csu status command to view the status of the CSU on a media module.

Syntax
show csu status mmID

Parameters
Parameter mmID Description The Media Module ID Possible Values Default Value

User Level
read-only

Context
general

Example
To display the status of the CSU on module 4:
TGM550-001(super)# show csu status v4 TI version of csu status: CSU NETWORK INTERFACE STATUS -----------------------------------------------------------------LOS:ON 00F: OFF EER:OFF L00PD: OFF AIS:OFF PDV: OFF LOF:OFF YEL: ON

Issue 2 January 2008

295

CLI Commands

Device status

E1 version of csu status: CSU NETWORK INTERFACE STATUS -----------------------------------------------------------------LOS:ON 00F:OFF EER:OFF L00PD:OFF AIS:OFF PDV:OFF LOF:OFF LMA:OFF RMA:OFF LCM:ON

Output fields
Name LOS OOF EER LOOPD AIS PDV LOF LMA YEL RMA LCM Description Loss of signal Out of frame Excessive error rate Looped Alarm indication signal Pulse density violation (same as BPV) Loss of frame Local multiframe alignment Yellow Remote multiframe alignment Loss of CRC multiframe

Device status
clear utilization cpu
Use the clear utilization cpu command to disable CPU utilization measurements.

Syntax
clear utilization cpu module

296 IG550 Integrated Gateway Administration and CLI Reference

Device status

Parameters
Parameter module Description The module for which to disable CPU utilization measurements Possible Values Default Value

User Level
read-write

Context
general

Example
To disable CPU utilization measurements for module 10:
TGM550-001(super)# clear utilization cpu 10

set utilization cpu


Use the set utilization cpu command to enable CPU utilization measurements.

Syntax
set utilization cpu module

Parameters
Parameter module Description Number of the module Possible Values Default Value

User Level
read-write

Context
general

Issue 2 January 2008

297

CLI Commands

Device status

Example
To enable CPU utilization measurements on module 10:
TGM550-001# set utilization cpu 10 CPU utilization is set on module 10

show download
Use the show download command to display the status of the current file copy process to the device.

Syntax
show download {software [mmID] | config} status

Parameters
Parameter software mmId config Description Keyword specifying that software download or upload information is displayed The Media Module ID number Keyword specifying that configuration download or upload information is displayed Possible Values Default Value

User Level
read-only

Context
general

Example
To display the status of software downloads for all media modules:
TGM550-001(super)# show download software status TFTP STATUS --------------------------------------------Module : MGP Source File : mg01_3.com Destination File: BANK B Host : 0.0.0.0 Running State : idle Last Failure : No Error

298 IG550 Integrated Gateway Administration and CLI Reference

Device status

Last Warning Progress

: (null) : [0/0] 0%

show faults
Use the show faults command to display the active faults for the media gateway.

Syntax
show faults

User Level
read-only

Context
general

Example
To display the current fault list:
TGM550-001(super)# show faults CURRENTLY ACTIVE FAULTS -------------------------------------------------------------------- MGP Faults -+ No controller found, 01/01-00:00:01.00

show mg list_config
Use the show mg list_config command to show the installed media gateway equipment. It displays the current hardware and firmware configurations of the media gateway. The show mg list_config command is an alias for show module on page 302.

Syntax
show mg list_config

User Level
read-only

Context
general

Issue 2 January 2008

299

CLI Commands

Device status

Example
To display the list of installed equipment:
TGM550-001(super)# show mg list_config SLOT ---v0 v1 v2 v3 v4 v5 v6 TYPE -----TGM550 -- Not -- Not -- Not -- Not -- Not -- Not SUFFIX -----A Installed -Installed -Installed -Installed -Installed -Installed -CODE -----HW VINTAGE ---------0 FW VINTAGE ----------26.21.0(A)

show mgc
Use the show mgc command to display the currently active media gateway controller state and setup parameters.

Syntax
show mgc

User Level
read-only

Context
general

Example
To display media gateway controller information:
TGM550-001(super)# show mgc CALL CONTROLLER STATUS ------------------------------------------Registered : NO Active Controller : 255.255.255.255 H248 Link Status : DOWN H248 Link Error Code: 0x0 CONFIGURED MGC HOST ---------------------- Not Available --

300 IG550 Integrated Gateway Administration and CLI Reference

Device status

-- Not Available --- Not Available --- Not Available --

show mm
Use the show mm command to show the media gateway media module information. It displays the types and serial numbers of media modules installed on the media gateway. If no media module ID is specified, information for all media modules is displayed.

Syntax
show mm [mmID]

Parameters
Parameter mmID Description The Media Module ID number Possible Values Default Value

User Level
read-only

Context
general

Example
To display information about media module 7:
TGM550-001(super)# show mm 7 MEDIA MODULE DESCRIPTION: v7 ------------------------------------------------Uptime(d,h:m:s): 0, 00:23:19 Type : Voice (Initializing) Description : N/A Serial Number : N/A HW Vintage : N/A HW Suffix : N/A FW Version : N/A No. of ports : 0 Faults : No Fault Messages

Issue 2 January 2008

301

CLI Commands

Device status

show module
Use the show module command to view information about a media module. If no media module is specified, information about all media modules is displayed.

Syntax
show module [mmID]

Parameters
Parameter mmID Description The Media Module ID Possible Values Default Value

User Level
read-only

Context
general

Example
To show information about media module 2:
TGM550-001(super)# show module v2 SLOT TYPE CODE SUFFIX ---- -------- ---------- -----v3 Analog (on-board) A HW VINTAGE ---------0 FW VINTAGE ----------N/A

To show information about all media modules:


TGM550-001(super)# show module SLOT TYPE CODE SUFFIX ---- -------- ---------- -----v0 TGM550 A v1 Analog TIM514 A v2 E1T1 TIM510 A v3 Analog (on-board) A v4 BRI TIM521 A v5 -- Not Installed -v6 -- Not Installed -HW VINTAGE ---------0 0 2 0 0 FW VINTAGE ----------26.21.0(A) 0 0 N/A 0

302 IG550 Integrated Gateway Administration and CLI Reference

Device status

show recovery
Use the show recovery command to show the media gateway monitoring and recovery setup.

Syntax
show recovery

User Level
read-only

Context
general

Example
To show recovery information:
TGM550-001(super)# show recovery RECOVERY TIMES -------------------------------Primary Search : 1 Total Search : 30 Transition Point: 1

show restart-log
Use the show restart-log command to retrieve restart data that is stored in a log in flash memory.

Syntax
show restart-log

User Level
read-only

Context
general

Issue 2 January 2008

303

CLI Commands

Device status

Example
To display restart information:
TGM550-001(super)# show restart-log RESET ID MM/DD-hh:mm:ss.hs STR ---------- ------------------- -----------------------------------0000000000 01/01-02:54:17.00 MgFw#:48.46.48 REBOOT 0000000000 01/01-02:54:12.00 MgFw#:48.46.48 WWD-STYCRINO-XXXXX REBOOT from RecoveryEngineUti EOF

show system
Use the show system command to display information about the device.

Syntax
show system

User Level
read-only

Context
general

Example
To display device information:
TGM550-001(super)# System Name System Location System Contact Uptime (d,h:m:s) MV Time MAC Address WAN MAC address Serial No Model No HW Vintage HW Suffix FW Vintage HW Ready for FIPS show system : : : : 0,7:36:43 : N/A : 00:04:0d:29:c5:11 : 00:04:0d:29:c5:10 : 03IS12345678 : TGM550 Chassis : 00 : B : 0.0.15 : Yes

304 IG550 Integrated Gateway Administration and CLI Reference

Device status

show timeout
Use the show timeout command to display the amount of time in minutes the terminal remains idle before timing out. If the timeout value is 0, there is no timeout limit. The default timeout value is 15 minutes.

Syntax
show timeout

User Level
read-only

Context
general

Example
To display the timeout value:
TGM550-001(super)# show timeout CLI timeout is 15 minutes

show upload
Use the show upload command to display the status of the current file copy process from the device.

Syntax
show upload {software [mmID] | config} status

Parameters
Parameter software mmId config Description Keyword specifying that software download or upload information is displayed The Media Module ID number Keyword specifying that configuration download or upload information is displayed Possible Values Default Value

Issue 2 January 2008

305

CLI Commands

Device status

User Level
read-only

Context
general

Example
To display the status of software downloads for all media modules:
TGM550-001(super)# show upload software status

show utilization
Use the show utilization command to display information about CPU usage. If no module is specified, information for all modules is displayed.

Syntax
show utilization [module]

Parameters
Parameter module Description Module to display Possible Values Default Value

User Level
read-write

Context
general

Example
To display utilization information for all modules:
TGM550-001(super)# show utilization Mod --10 CPU 5sec -----4% CPU 60sec ----4% RAM RAM used(%) Total(Kb) ------- ---------21% 105313 Kb

306 IG550 Integrated Gateway Administration and CLI Reference

Display

test led
Use the test led command to run a test of the devices LED operation.

Syntax
test led

User Level
read-only

Context
general

Example
To run a test of the devices LED operation:
TGM550-001(super)# test led

The Box level ALM, CPU and MDM LEDs should be BLINKING for 5 seconds each.

Display
banner login
Use the banner login command to enter the login banner configuration mode. Use the no form of this command to set the login banner to its default value. The login banner appears before the user is prompted for the login name. To enter text for the login banner, refer to the command line on page 310. Note: Before creating a new banner, delete the current banner using the no banner login command.

Note:

Syntax
[no] banner login

User Level
admin

Issue 2 January 2008

307

CLI Commands

Display

Context
general

Example
To enter login banner configuration mode:
TGM550-001(super)# banner login TGM550-001(super-login)#

banner post-login
Use the banner post-login command to enter the post-login banner configuration mode. The post-login banner appears after the user has logged in successfully. Use the no form of this command to set the post-login banner to its default value. To enter text for the post-login banner, refer to the command line on page 310. Note: Before creating a new banner, delete the current banner using the no banner post-login command.

Note:

Syntax
[no] banner post-login

User Level
admin

Context
general

Example
To enter the post-login banner configuration mode:
TGM550-001(super)# banner post-login TGM550-001(super-post-login)#

clear screen
Use the clear screen command to clear the current terminal display.

Syntax
clear screen

308 IG550 Integrated Gateway Administration and CLI Reference

Display

User Level
read-only

Context
general

hostname
Use the hostname command to change the Command Line Interface (CLI) prompt. The prompt is written as hostname-registration, where the hostname is the value entered with the hostname command, and registration is the media gateway registration information. If the device is registered, the current media gateway number appears. If the device is not registered, question marks are displayed. Use the hostname command with no parameters to display the current prompt value. Use the no form of this command to return the CLI prompt to the default.

Syntax
hostname [hostname_string] no hostname

Parameters
Parameter hostname_ string Description The hostname Possible Values A string of up to 20 characters Default Value TGM550

User Level
read-write

Context
general

Example
To set the CLI prompt to GTW-HQ:
TGM550-001(super)# hostname GTW-HQ GTW-HQ-001(super)# hostname Session hostname is 'GTW-HQ'

Issue 2 January 2008

309

CLI Commands

Display

To reset the CLI prompt to the default:


GTW-HQ-001(super)# no hostname TGM550-001(super)#

line
Use the line command to add a line to the current banner message.

Syntax
line number [string]

Parameters
Parameter number string Description The line number to add the specified text The text to display on the specified line Possible Values 1-24 Default Value

Note:

Note: To define a string that includes spaces, enclose the entire string in quotation marks (for example, New York).

User Level
admin

Context
banner login, banner post-login

Example
To specify text for the third line of the banner displayed after a successful login:
TGM550-001(super-banner-post-login)# line 3 Welcome to the TGM550 Media Gateway CLI Interface

310 IG550 Integrated Gateway Administration and CLI Reference

Display

show banner login


Use the show banner login command to display the banner that appears before the login prompt.

Syntax
show banner login

User Level
admin

Context
general

Example
To display the banner that appears before the login prompt:
TGM550-001(super)# show banner login Welcome to TGM550 Media Gateway FW version 0.11.0

show banner post-login


Use the show banner post-login command to display the banner that appears after a user logs in successfully.

Syntax
show banner post-login

User Level
admin

Context
general

Example
To display the banner that appears after a successful login:
TGM550-001(super)# show banner post-login *** Welcome to the TGM550 Media Gateway CLI Interface *** For questions, please refer to the CLI Reference Guide

Issue 2 January 2008

311

CLI Commands

Display

terminal length
Use the terminal length command to set the length of the terminal display in characters.

Syntax
terminal length [lines]

Parameters
Parameter lines Description The number of lines in the terminal display Possible Values none - Displays the current length. 3-200 - Sets the new screen length to the value. Default Value

User Level
read-only

Context
general

Example
To set the screen to display 24 lines:
TGM550-001(super)# terminal length 24

terminal width
Use the terminal width command to set the width of the terminal display in characters.

Syntax
terminal width [characters]

312 IG550 Integrated Gateway Administration and CLI Reference

DNS resolver

Parameters
Parameter characters Description The number of characters in the width of the terminal display Possible Values none - Displays the current width. 10-200 - Sets the new screen width to the value. Default Value

User Level
read-only

Context
general

Example
To limit the display to a width of 60 characters:
TGM550-001(super)# terminal width 60

DNS resolver
show protocol
Use the show protocol command to display the status of a specific management protocol, or all protocols.

Syntax
show protocol [ssh|telnet-client|ssh-client|snmp|telnet| scp|recovery-password|ftp-client|tftp]

Issue 2 January 2008

313

CLI Commands

DNS resolver

Parameters
Parameter ssh telnet-client ssh-client snmp telnet scp recovery-password ftp-client tftp Description Keyword indicating to display the status of the ssh protocol Keyword indicating to display the status of the telnet-client protocol Keyword indicating to display the status of the ssh-client protocol Keyword indicating to display the status of the SNMP protocol Keyword indicating to display the status of the telnet protocol Keyword indicating to display the status of the SCP protocol Keyword indicating to display the status of the recovery-password protocol Keyword indicating to display the status of the FTP-client protocol Keyword indicating to display the status of the TFTP protocol Possible Values Default Value

User Level
admin

Context
general

Example
To display information about all protocols:
TGM550-001(super)# show protocol Protocols -----------SSH-CLIENT TELNET-CLIENT SNMPv1 SNMPv3 TELNET RECOVERY-PASSWORD FTP-CLIENT TFTP Status -------ON OFF ON ON ON ON ON OFF

314 IG550 Integrated Gateway Administration and CLI Reference

Dynamic CAC

Dynamic CAC
show dynamic-cac
Use the show dynamic-cac command to display information about the most recent dynamic CAC event.

Syntax
show dynamic-cac

User Level
read-only

Context
general

Example
To display information about the most recent dynamic CAC event:
TGM550-001(super)# show dynamic-cac Current RBBL : 256 kbps event : 0 Days, 1:21:00 Last event BBL : 256 kbps

Dynamic trap manager


clear dynamic-trap-manager
Use the clear dynamic-trap-manager command to remove administration of the dynamic trap manager.

Syntax
clear dynamic-trap-manager

Issue 2 January 2008

315

CLI Commands

Dynamic trap manager

User Level
read-write

Context
snmp-server dynamic-trap-manager

Example
To remove administration of the dynamic trap manager:
TGM550-001(super-survivable-call-engine)# clear dynamic-trap-manager

snmp-server dynamic-trap-manager
Use the snmp-server dynamic-trap-manager command to modify the SNMP settings of the dynamic trap manager. Use the no form of the command to restore the dynamic trap manager to its default settings, and remove all notification type filters.

Syntax
snmp-server dynamic-trap-manager {traps|informs} {v1|v2c} community-name [udp-port port] [notification-list] no snmp-server dynamic-trap-manager notification-list

Parameters
Parameter traps Description Keyword indicating that the dynamic trap manager send messages without requesting acknowledgement. This is the default. Keyword indicating that the dynamic trap manager send messages requiring acknowledgement Keyword indicating that the dynamic trap manager use SNMP v1 functionality. This is the default. Keyword indicating that the dynamic trap manager use SNMP v2c functionality Possible Values Default Value

informs

v1

v2c

316 IG550 Integrated Gateway Administration and CLI Reference

Dynamic trap manager

Parameter community -name port notification -list

Description The community string for accessing SNMP services The udp port of the SNMP host The specific types of messages that the dynamic trap manager sends. Use this list to filter the messages controlled by the dynamic trap manager.

Possible Values

Default Value

all all traps generic generic traps hardware hardware faults rmon RMON rising/falling alarm dhcp server DHCP server error dhcp-clients DHCP client error rtp-stat-faults RTP statistics: QoS fault/clear traps rtp-stat-qos RTP statistics: end-of-call QoS traps wan WAN router traps media-gateway media gateway traps security security traps config configuration change notifications eth-port-faults notifications of Ethernet port faults sw-redundancy software redundancy notifications temperature temperature warning notifications cam-change notifications about changes in CAM l3-events notifications about L3 faults (duplicate IP, VLAN violations) lag-event notifications about link aggregation faults and configuration changes policy notifications about changes in policy (for L3 devices) link-faults link-down notifications supply power supply notifications

all

Issue 2 January 2008

317

CLI Commands

E1/T1 interfaces

User Level
admin

Context
general

Example
To modify the SNMP settings of the dynamic trap manager:
TGM550-001(super)# snmp-server dynamic-trap-manager traps v2c public all

E1/T1 interfaces
clock source
Use the clock source command to configure the clock source for an E1/T1 controller. Use the no form of the command to return the clock source to the default value of line.

Syntax
clock source {line | internal} no clock source

Parameters
Parameter line internal Description Keyword that specifies to use an external clock Keyword that specifies to synchronize to the internal clock Possible Values Default Value

User Level
read-write

Context
interface:Controller

318 IG550 Integrated Gateway Administration and CLI Reference

ETR

Example
To specify that controller number 5 uses an external clock:
TGM550-001(super-controller:5/1)# clock source line

Related Commands

ETR
set etr
Use the set etr command to enable or disable Emergency Transfer Relay (ETR) mode, or to allow the gateway to control ETR mode automatically. Note: In ETR mode, the TRK and LINE 1 ports are connected. All other telephone ports stop operating. Note: If a call is in progress when the communications problem ends, the gateway does not turn off ETR mode automatically. If you specify manual-off, the call terminates.

Note:

Note:

Syntax
set etr module {auto | manual-on | manual-off}

Parameters
Parameter module auto manual-on manual-off Description Module number Allow the gateway to control ETR mode automatically Keyword specifying to set ETR mode to on Keyword specifying to set ETR mode to off Possible Values 1-7 Default Value

User Level
read-write

Issue 2 January 2008

319

CLI Commands

ETR

Context
general

Example
To specify that the gateway will control ETR mode automatically on module 7:
TGM550-001(super)# set etr 7 auto

show etr
Use the show etr command to view the status of Emergency Transfer Relay (ETR) mode.

Syntax
show etr

User Level
read-only

Context
general

Example
To display the ETR status:
TGM550-001(super)# show etr Module: 7 Admin State: auto Module status: in service Trunk line line status ----- ---- ----------1 2 off hook System Name : System Location : System Contact : Uptime (d,h:m:s) : 0,7:36:43 MV Time : N/A MAC Address : 00:04:0d:29:c5:11 WAN MAC address : 00:04:0d:29:c5:10 Serial No : 03IS12345678 Model No : TGM550 Chassis HW Vintage : 00 HW Suffix : B FW Vintage : 0.0.15 HW Ready for FIPS : Yes

320 IG550 Integrated Gateway Administration and CLI Reference

Firmware management

Firmware management
copy ftp SW_imageA
Use the copy ftp SW_imageA command to download a software image from an FTP server into Bank A. The command prompts for the username and password.

Syntax
copy ftp SW_imageA filename ip

Parameters
Parameter filename ip Description File name on the FTP server IP address of the FTP server Possible Values Default Value

User Level
read-write

Context
general

Example
To download the software image file, TGM550.img, from the FTP site at IP address 135.64.10.33 using login dan:
TGM550-001(super)# copy ftp SW_imageA TGM550.img 135.64.10.33 Username: dan Password:

Issue 2 January 2008

321

CLI Commands

Firmware management

copy ftp SW_imageB


Use the copy ftp SW_imageB command to download a software image from an FTP server into Bank B. The command prompts for the username and password.

Syntax
copy ftp SW_imageB filename ip

Parameters
Parameter filename ip Description File name on the FTP server IP address of the FTP server Possible Values Default Value

User Level
read-write

Context
general

Example
To download the software image file TGM550.img from the FTP site at IP address 135.64.10.33 using login dan:
TGM550-001(super)# copy ftp SW_imageB TGM550.img 135.64.10.33 Username: dan Password:

copy tftp SW_imageA


Use the copy tftp SW_imageA command to update the software image in Bank A of the media gateway. To use this command, you need to have an active TFTP server, and to create a file into which to download the data. If Avaya Network Manager is running, you do not need an additional TFTP server.

Syntax
copy tftp SW_imageA filename ip

322 IG550 Integrated Gateway Administration and CLI Reference

Firmware management

Parameters
Parameter filename ip Description The file name, including the full path IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To download the software file, imgA.bin, from the TFTP server 149.49.36.200 into boot bank A:
TGM550-001(super)# copy tftp SW_imageA c:\imgA.bin 149.49.36.200 Beginning download operation ... This operation may take a few minutes... Please refrain from any other operation during this time.

copy tftp SW_imageB


Use the copy tftp SW_imageB command to update the software image in Bank B of the media gateway. To use this command, you need to have an active TFTP server, and to create a file into which to download the data. If Avaya Network Manager is running, you do not need an additional TFTP server.

Syntax
copy tftp SW_imageB filename ip

Parameters
Parameter filename ip Description The file name, including the full path IP address of the host Possible Values Default Value

Issue 2 January 2008

323

CLI Commands

Firmware management

User Level
read-write

Context
general

Example
To download the software file, imgB.bin, from the TFTP server 149.49.36.200 into boot bank B:
TGM550-001(super)# copy tftp SW_imageB c:\imgB.bin 149.49.36.200 Beginning download operation ... This operation may take a few minutes... Please refrain from any other operation during this time.

dir
Use the dir command to show:

The files that have been downloaded to the media gateway using the TGM550-001 Download interface and the SNMP MIB.

Syntax
dir module_number

Parameters
Parameter module_number Description Displays downloaded files for the specified module only Possible Values Default Value

User Level
read-write

Context
general

324 IG550 Integrated Gateway Administration and CLI Reference

Firmware management

Example
To display a list of downloaded files:
TGM550-001(super)# dir M# file ver num file type file location file description -- ----------- ---------------------- ---------------1 TIM510 5 SW RT Image Nv-Ram TIM510 - image 3 TIM514 17 SW RT Image Nv-Ram TIM514 - image 4 TIM521 2 SW RT Image Nv-Ram TIM521 - image 9 hi.wav N/A Annc files Nv-Ram Announcement files 9 hi1.wav N/A Annc files Nv-Ram Announcement files 9 hi2.wav N/A Annc files Nv-Ram Announcement files 10 startup-config N/A Startup Conf Nv-Ram Startup Config 10 running-config N/A Running Conf Ram Running Config 10 TGM550-A 24.6.0 SW RT Image Flash Bank A Software Image Bank A 10 TGM550-B 24.8.0 SW Component Flash Bank B Software Image Bank B 10 TGM550-Booter 21.12.0 SW BootImage Nv-Ram Booter Image 10 phone-ScriptA N/A Phone Script Nv-Ram N/A 10 phone-ScriptB N/A Phone Script Nv-Ram 46xxupgrade.scr 10 phone-ScriptC N/A Phone Script Nv-Ram N/A 10 phone-ScriptD N/A Phone Script Nv-Ram N/A

set boot bank


Use the set boot bank command to set the system boot bank for the active Supervisor Module.

Syntax
set boot bank value

Parameters
Parameter value Description Boot bank name Possible Values bank-a - set the boot bank to A bank-b - set the boot bank to B Default Value

User Level
read-write

Issue 2 January 2008

325

CLI Commands

Firmware management

Context
general

Example
To specify that the media gateway boots from boot bank A:
TGM550-001(super)# set boot bank bank-A boot bank set to bank-A

show boot bank


Use the show boot bank command to display the software bank from which the device boots at the next boot process.

Syntax
show boot bank

User Level
read-only

Context
general

Example
To display the bank from which booting currently takes place:
TGM550-001(super)# show boot bank Boot bank set to bank-a

show download software status


Use the show download software status command to display the status of the current firmware download process as the software is being loaded into the module.

Syntax
show download software status [module_number]

326 IG550 Integrated Gateway Administration and CLI Reference

Firmware management

Parameters
Parameter module_number Description The number of the module for which to display information Possible Values 0-10 Default Value

User Level
read-only

Context
general

Example
To display the status of a device software download into module 1:
TGM550-001(super)# show download software status 1 Module #1 =========== Module Source file Destination file Host Running state Failure display Last warning

: : : : : : :

1 d:\firmware\tgm550_4_0.bin tgm550_4_0.bin 149.49.70.61 Writing ... (null) No-warning

show image version


Use the show image version command to display the software version of the image on both memory banks of the device.

Syntax
show image version

User Level
read-only

Context
general

Issue 2 January 2008

327

CLI Commands

Fragmentation

Example
To display the current image software versions:
TGM550-001(super)# show image version Bank ----------A (current) B Version ------26.23.0 26.22.0

Fragmentation
clear fragment
Use the clear fragment command to clear the fragment database and restore its default values. Note: No IP reassembly is performed on packets in transit through the router.

Note:

Syntax
clear fragment

User Level
read-write

Context
general

fragment chain
Use the fragment chain command to set the maximum number of fragments that can comprise a single IP packet destined to the router. Use the no form of this command to set the fragment chain to its default value. Note: No IP reassembly is performed on packets in transit through the router.

Note:

328 IG550 Integrated Gateway Administration and CLI Reference

Fragmentation

Syntax
fragment chain chain_limit no fragment chain

Parameters
Parameter chain_ limit Description The maximum number of fragments that can comprise a single IP packet Possible Values 2-2048 Default Value 64

User Level
read-write

Context
general

Example
To set the maximum number of fragments for a single IP packet to 30:
TGM550-001(super)# fragment chain 30

fragment size
Use the fragment size command to set the maximum number of fragmented IP packets to reassemble at any given time. Use the no form of this command to set the fragment size to its default value. Note: No IP reassembly is performed on packets in transit through the router.

Note:

Syntax
fragment size database_limit no fragment size

Issue 2 January 2008

329

CLI Commands

Fragmentation

Parameters
Parameter database_ limit Description The maximum number of packets allowed to undergo re-assembly at any given time Possible Values 0-200 Default Value 100

User Level
read-write

Context
general

Example
To set the maximum number of packets to reassemble to 150:
TGM550-001(super)# fragment size 150

fragment timeout
Use the fragment timeout command to set the maximum number of seconds to reassemble a fragmented IP packet destined to the router. Use the no form of this command to set the fragment timeout to its default value. Note: No IP reassembly of packets in transit through the router is performed.

Note:

Syntax
fragment timeout timeout no fragment timeout

Parameters
Parameter timeout Description The maximum number of seconds to reassemble an IP packet Possible Values 5-120 Default Value 10

User Level
read-write

330 IG550 Integrated Gateway Administration and CLI Reference

Fragmentation

Context
general

Example
To set the maximum time to reassemble packets to be 30 seconds:
TGM550-001(super)# fragment timeout 30

show fragment
Use the show fragment command to display information about IP packets that are passing from or to the router. Note: No IP reassembly is performed on packets in transit through the router.

Note:

Syntax
show fragment

User Level
read-only

Context
general

Example
To display fragmented IP packets information:
TGM550-001(super)# show fragment Max number of concurrently reassembled packets is 100 Max number of fragments per packet is 64 Fragment timeout is 10 sec Number of packets waiting to be reassembled is 0 Number of successfully reassembled packets is 11954 Number of packets which failed to be reassembled is 0 Number of packets which overflowed the database is 0

Issue 2 January 2008

331

CLI Commands

Frame relay encapsulation

Frame relay encapsulation


show interfaces
Use the show interfaces command to display interface configuration and statistics for a particular interface or all interfaces. The Frame Relay sub-interface only includes the following counters:

packets & bytes in packets & bytes out input errors output drops

Syntax
show interfaces [interface_type interface_identifier]

Parameters
Parameter interface_type Description The type of interface Possible Values DIaler, FastEthernet, Serial, Vlan, Loopback, Console, Tunnel, USB For Serial(USP): 2/1 For Serial (DS1): module/port: 2/1 channel-group: E1: 0-30 T1: 0-23 For Loopback: 1-99 For Tunnel: 1-50 For Dialer: 1 Default Value

interface_ identifier

The interface number. The format varies depending on the value of interface_type: For FastEthernet: module/port For Serial: module/ port:channel-group For Vlan: Vlan id For LoopBack: Loopback number For Tunnel: Tunnel number

332 IG550 Integrated Gateway Administration and CLI Reference

Frame relay encapsulation

User Level
read-write

Context
general

Example
To show information about all the interfaces:
TGM550-001(super)# show interfaces Physical address is 00.04.0d.29.c5.11. Internet address is 172.16.1.139, mask is 255.255.255.240 MTU 1500 bytes. Bandwidth 100000 kbit. Reliability 255/255 txLoad 1/255 rxLoad 1/255 Link status trap disabled Full-duplex, 100Mb/s Last input 00:00:30, Last output 00:00:30 Last clearing of 'show interface' counters never. 5 minute input rate 144 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 3425 packets input, 323518 bytes 3425 broadcasts received, 0 giants 0 input errors, 0 CRC 32 packets output, 896 bytes 0 output errors, 0 collisions FastEthernet 10/2 is up, line protocol is down Physical address is 00.04.0d.29.c5.10. MTU 1500 bytes. Bandwidth 10000 kbit. Reliability 1/255 txLoad 255/255 rxLoad 255/255 Encapsulation ARPA Link status trap disabled Half-duplex, 10Mb/s, 10BaseTX ARP type: ARPA, ARP Timeout 04:00:00 Dynamic CAC BBL: 1500 kbps Dynamic CAC activation priority: 50 Dynamic CAC interface status: active Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions

Issue 2 January 2008

333

CLI Commands

Frame relay encapsulation

Tunnel 1 is up, line protocol is up Internet address is 177.0.0.17, mask is 255.0.0.0 MTU 468 bytes. Bandwidth 9 kbit Reliability 255/255 txLoad 1/255 rxLoad 1/255 Encapsulation GRE Link status trap enabled Keepalive set (10 sec), retries 3 Tunnel source 17.0.0.17, destination 12.0.0.3 Tunnel protocol/transport GRE/IP, key 777 Checksumming of packets enabled Tunnel DSCP 63, Tunnel TTL 255 Path MTU Discovery, ager 10 mins, MTU 976, expires 00:09:33 Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions Console asynchronous mode is terminal Terminal baud rate is 9600

show interfaces
Use the show interfaces command to display interface configuration and statistics for a particular interface or all interfaces. The Frame Relay sub-interface only includes the following counters:

packets & bytes in packets & bytes out input errors output drops

Syntax
show interfaces [interface_type interface_identifier]

334 IG550 Integrated Gateway Administration and CLI Reference

Frame relay encapsulation

Parameters
Parameter interface_type Description The type of interface Possible Values DIaler, FastEthernet, Serial, Vlan, Loopback, Console, Tunnel, USB For Serial(USP): 2/1 For Serial (DS1): module/port: 2/1 channel-group: E1: 0-30 T1: 0-23 For Loopback: 1-99 For Tunnel: 1-50 For Dialer: 1 Default Value

interface_ identifier

The interface number. The format varies depending on the value of interface_type: For FastEthernet: module/port For Serial: module/ port:channel-group For Vlan: Vlan id For LoopBack: Loopback number For Tunnel: Tunnel number

User Level
read-write

Context
general

Example
To show information about all the interfaces:
TGM550-001(super)# show interfaces Physical address is 00.04.0d.29.c5.11. Internet address is 172.16.1.139, mask is 255.255.255.240 MTU 1500 bytes. Bandwidth 100000 kbit. Reliability 255/255 txLoad 1/255 rxLoad 1/255 Link status trap disabled Full-duplex, 100Mb/s Last input 00:00:30, Last output 00:00:30 Last clearing of 'show interface' counters never. 5 minute input rate 144 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 3425 packets input, 323518 bytes 3425 broadcasts received, 0 giants

Issue 2 January 2008

335

CLI Commands

Frame relay encapsulation

0 input errors, 0 CRC 32 packets output, 896 bytes 0 output errors, 0 collisions FastEthernet 10/2 is up, line protocol is down Physical address is 00.04.0d.29.c5.10. MTU 1500 bytes. Bandwidth 10000 kbit. Reliability 1/255 txLoad 255/255 rxLoad 255/255 Encapsulation ARPA Link status trap disabled Half-duplex, 10Mb/s, 10BaseTX ARP type: ARPA, ARP Timeout 04:00:00 Dynamic CAC BBL: 1500 kbps Dynamic CAC activation priority: 50 Dynamic CAC interface status: active Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions Tunnel 1 is up, line protocol is up Internet address is 177.0.0.17, mask is 255.0.0.0 MTU 468 bytes. Bandwidth 9 kbit Reliability 255/255 txLoad 1/255 rxLoad 1/255 Encapsulation GRE Link status trap enabled Keepalive set (10 sec), retries 3 Tunnel source 17.0.0.17, destination 12.0.0.3 Tunnel protocol/transport GRE/IP, key 777 Checksumming of packets enabled Tunnel DSCP 63, Tunnel TTL 255 Path MTU Discovery, ager 10 mins, MTU 976, expires 00:09:33 Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions Console asynchronous mode is terminal Terminal baud rate is 9600

336 IG550 Integrated Gateway Administration and CLI Reference

ICMP errors

ICMP errors
ip icmp-errors
Use the ip icmp-errors command to set ICMP error messages to On. Use the no form of this command to set ICMP error messages to Off.

Syntax
[no] ip icmp-errors

User Level
read-write

Context
general

show ip icmp
Use the show ip icmp command to display the status of ICMP error messages.

Syntax
show ip icmp

User Level
read-only

Context
general

Example
To display ICMP error message status:
TGM550-001(super)# show ip icmp ICMP error messages status is ENABLE

Issue 2 January 2008

337

CLI Commands

IP interface configuration

IP interface configuration
interface console
Use the interface console command to enter the Console interface configuration mode. The interface is created if it does not exist. Use the no form of this command to set the Console parameters to their default values. Note: This mode is used for services logins only.

Note:

Syntax
[no] interface console

User Level
read-write

Context
general

Example
To enter the Console interface context:
TGM550-001(super)# interface console TGM550-001(if:Console)#

show ip interface
Use the show ip interface command to display information about the VoIP or Console interfaces.

Syntax
show ip interface [interface_name|ip_interface|ip_address]

338 IG550 Integrated Gateway Administration and CLI Reference

IP interface configuration

Parameters
Parameter interface_name ip_interface ip_address Description The name of the interface whose information you want to display The name of the IP interface whose information you want to display The IP address of the interface whose information you want to display string (1-32 chars) Possible Values Default Value

Note:

Note: When specifying an interface name that includes spaces, enclose the entire name in quotation marks (for example, FastEthernet 10/2).

User Level
read-only

Context
general

Example
To display all IP interfaces:
TGM550-001(super)# show ip interface Showing 1 Interface Voip 0 is up Internet address is 133.8.78.199, subnet mask is 255.255.255.0 Primary Management IP interface

Note:

Note: If address negotiation is configured on the PPP connection, the following appears:
Internet address will be negotiated using IPCP, or Address determined by IPCP.

If DHCP client was configured on the interface, the following appears: Internet
address will be negotiated using DHCP, or Address determined by DHCP.

Issue 2 January 2008

339

CLI Commands

IP interface configuration

Header Compression Output Fields


If header compression was enabled on the interface, one of the following header compression status messages appears: Status message RTP/IP header compression is enabled and not compressing RTP /IP header compression is enabled and compressing RTP /IP header compression is disabled TCP/IP header compression is enabled and not compressing TCP/IP header compression is enabled and compressing TCP/IP header compression is disabled Meaning RTP header compression was enabled on this interface, but is not actively compressing. This can be caused by failure to negotiate. RTP header compression was enabled on this interface, and is functioning properly RTP header compression is disabled (default) VJ header compression was enabled on this interface, but is not actively compressing. This can be caused by failure to negotiate. Header compression was enabled on this interface, and is functioning properly VJ header compression is disabled (default)

show ip interface brief


Use the show ip interface brief command to display a summary of the information for a specific interface or for all of the interfaces.

Syntax
show ip interface brief [interface_name|ip_interface|ip_address]

Parameters
Parameter interface_name Description The name of the interface whose information you want to display Possible Values Default Value

340 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

Parameter ip_interface ip_address

Description The name of the IP interface whose information you want to display The IP address of the interface whose information you want to display

Possible Values string (1-32 chars)

Default Value

Note:

Note: When specifying an interface name that includes spaces, enclose the entire name in quotation marks (for example, FastEthernet 10/2).

User Level
read-only

Context
general

Example
To show a summary of information for all interfaces (in this example, PPP is activated on the FastEthernet interface and no IP address has been gathered):
TGM550-001(super)# show ip interface brief

Showing 1 Interface Interface ------------------Voip

Address Mask Method ------------------ ---- -----10.3.0.3 32 manual

Status -----------up

IP phone upgrades
clear ip tftp-server statistics
Use the clear ip tftp-server statistics command to clear TFTP server statistics.

Syntax
clear ip tftp-server statistics

User Level
read-write

Issue 2 January 2008

341

CLI Commands

IP phone upgrades

Context
general

Example
To clear TFTP server statistics:
TGM550-001# clear ip tftp-server statistics

copy ftp phone-image


Use the copy ftp phone-image command to download a file from a remote FTP server to phone image bank A, B, C, or D in the local gateway TFTP directory. The TGM550 prompts you for a username and password when you enter a command to transfer a file using FTP.

Syntax
copy ftp phone-imageA|phone-imageB|phone-imageC|phone-imageD filename ip

Context
general

Parameters
Parameter filename ip Description The name of the image file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Example
To download 4602sape1_8.bin from a remote FTP server at IP address 192.168.49.10 to phone image bank A using login anonymous:
TGM550-001# copy ftp phone-imageA c:\IpphoneRelease\4602sape1_8.bin 192.168.49.10 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning download operation ...

342 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

This operation may take up to 20 seconds. Please refrain from any other operation during this time.

copy ftp phone-script


Use the copy ftp phone-script command to download a file from a remote FTP server to phone script bank A or B on the local TGM550 TFTP directory. The TGM550 prompts you for a username and password when you enter a command to transfer a file using FTP.

Syntax
copy ftp phone-scriptA|phone-scriptB filename ip

Parameters
Parameter filename ip Description The name of the configuration file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To download 46xxupgrade.txt from a remote FTP server at IP address 192.168.49.10 to phone script bank A using login anonymous:
TGM550-001# copy ftp phone-scriptA 46xxupgrade.txt 192.168.49.10 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning download operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time.

Issue 2 January 2008

343

CLI Commands

IP phone upgrades

copy phone-script ftp


Use the copy phone-script ftp command to upload a phone script file from the local TGM550 TFTP directory to a remote server, using FTP.

Syntax
copy phone-scriptA|phone-scriptB|phone-scriptC|phone-scriptD ftp filename ip

Parameters
Parameter filename ip Description The name of the configuration file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To upload 46xxupgrade.txt to the host at IP address 192.168.49.10 using login anonymous:
TGM550-001# copy phone-scriptA ftp 46xxupgrade.txt 192.168.49.10 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning upload operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time.

344 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

copy phone-script scp


Use the copy phone-script scp command to upload a phone script file from the local TGM550 TFTP directory to a remote server, using SCP.

Syntax
copy phone-scriptA|phone-scriptB|phone-scriptC|phone-scriptD scp filename ip

Parameters
Parameter filename ip Description The name of the configuration file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To copy 46xxupgrade.txt to the host at IP address 192.168.49.10 using login anonymous:
TGM550-001# copy phone-scriptA scp 46xxupgrade.txt 192.168.49.10 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning upload operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time.

Issue 2 January 2008

345

CLI Commands

IP phone upgrades

copy phone-script tftp


Use the copy phone-script tftp command to upload a phone script file from the local TGM550 TFTP directory to a remote server, using TFTP.

Syntax
copy phone-scriptA|phone-scriptB|phone-scriptC|phone-scriptD tftp filename ip

Parameters
Parameter filename ip Description The name of the configuration file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To upload 46xxupgrade.txt to the host at IP address 192.168.49.10:
TGM550-001(super)# copy phone-scriptA tftp 46xxupgrade.txt 192.168.49.10

copy scp phone-script


Use the copy scp phone-script command to download a file from a remote SCP server to phone script bank A or B in the local TGM550 TFTP directory.

Syntax
copy scp phone-scriptA|phone-scriptB filename ip

346 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

Parameters
Parameter filename ip Description The name of the configuration file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To download 46xxupgrade.txt from the host at IP address 192.168.49.10 using login anonymous:
TGM550-001# copy scp phone-scriptA 46xxupgrade.txt 192.168.49.10 Confirmation - do you want to continue (Y/N)? y Username: anonymous Password: Beginning download operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time.

copy tftp phone-image


Use the copy tftp phone-image command to download a file from a remote TFTP server to phone image bank A, B, C, or D in the local TGM550 TFTP directory.

Syntax
copy tftp phone-imageA|phone-imageB|phone-imageC|phone-imageD filename ip

Issue 2 January 2008

347

CLI Commands

IP phone upgrades

Parameters
Parameter filename ip Description The name of the configuration file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

Context
general

Example
To download 4602sape1_8.bin from the host at IP address 192.168.49.10:
TGM550-001(super)# copy tftp phone-imageA c:\IpphoneRelease\4602sape1_8.bin 192.168.49.10

copy tftp phone-script


Use the copy tftp phone-script command to download a file from a remote TFTP server to phone script bank A or B in the local TGM550 TFTP directory.

Syntax
copy tftp phone-scriptA|phone-scriptB filename ip

Parameters
Parameter filename ip Description The name of the configuration file, including the full path The IP address of the host Possible Values Default Value

User Level
read-write

348 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

Context
general

Example
To download file1.txt from the host at IP address 135.64.100.205:
TGM550-001(super)# copy tftp phone-scriptA file1.txt 135.64.100.205 Confirmation - do you want to continue (Y/N)? y

erase phone-image
Use the erase phone-image command to delete phone-image A, B, C, D, E, or F.

Syntax
erase phone-imageA|phone-imageB|phone-imageC|phone-imageD| phone-imageE|phone-imageF

User Level
read-write

Context
general

Example
To delete phone-image A:
TGM550-001# erase phone-imageA Beginning erase operation .... Done!

erase phone-script
Use the erase phone-script command to delete phone-script A, B, C, or D.

Syntax
erase phone-scriptA|phone-scriptB|phone-scriptC|phone-scriptD

User Level
read-write

Issue 2 January 2008

349

CLI Commands

IP phone upgrades

Context
general

Example
To delete phone-script A:
TGM550-001(super)# erase phone-scriptA Beginning erase operation .... Done!

ip tftp-server file-system size


Use the ip tftp-server file-system-size command to set the TFTP file system size. Use the no ip tftp-server file-system-size command to reset the TFTP file system size to its default size. Note: It is possible to increase the memory allocation for the Sniffer cache application at the expense of the TFTP file system size. The Sniffer cache application may have been configured to use up to 1000 Kb of the default TFTP allocation of 18560 Kb, which would cause a conflict when setting the TFTP allocation to a high value.

Note:

Syntax
[no] ip tftp-server file-system-size size

Parameters
Parameter size Description The TFTP server total file size in KB Possible Values 256-19456 Default Value 18560

User Level
read-write

Context
general

Example
To set the TFTP file system size to 18128 KB:
TGM550-001# ip tftp-server file-system-size 18128 To change ip tftp-server file system size, copy the running configuration to the start-up configuration file, and reset the device

350 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

show application-memory
Use the show application-memory CLI command to show the configured and allocated application memory.

Syntax
show application-memory

User Level
read-only

Context
general

Example
To show the configured and allocated application memory:
TGM550-001(super)# show application-memory Application ---------------------------------------Sniffer (capture buffer-size) TFTP (ip tftp-server file-system-size) ---------------------------------------Total used memory Total free memory Total memory (fixed) Memory(KB) Allocated Configured --------------------1024 1024 18560 18560 --------------------19584 19584 896 896 20480

show download phone-image-file status


Use the show download phone-image-file status command to display the status of the download of a phone-image file.

Syntax
show download phone-image-file status

Context
general

User Level
read-only

Issue 2 January 2008

351

CLI Commands

IP phone upgrades

Example
To display the status of the download of a phone-image file:
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Bytes Downloaded : show download phone-image-file status

10 start phone-ImageA 135.64.102.64 Idle (null) No-warning 7825

show download phone-script-file status


Use the show download phone-script-file status command to show the status of a download of a phone-script file.

Syntax
show download phone-script-file status

User Level
read-only

Context
general

Example
To show the status of a download of a phone-script file: If no download has been performed:
TGM550-001# show download phone-script-file status Module #10 =========== No dest file for download operation - no download operation was done.

If a download has been performed:


TGM550-001# show download phone-script-file status Module #10 =========== Module : 10 Source file : /home/p46xx-script Destination file : phone-ScriptA

352 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

Host Running state Failure display Last warning Bytes Downloaded

: : : : :

135.64.103.116 Idle (null) No-warning 27

show ip tftp-server files


Use the show ip tftp-server files command to display the phone image and script files.

Syntax
show ip tftp-server files

User Level
read-write

Example
To display the phone image and script files:
TGM550-001(super)# show ip tftp-server files File Bank Location Size (bytes) ---------------- ------------------- ------------46xxupgrade.txt phone-scriptA Nv-Ram 4096 46xxsettings.txt phone-scriptB Nv-Ram 16384 4602dbte1_8.bin phone-imageA Ram 1048576 4602dape1_8.bin phone-imageD Ram 2097152 Nv-Ram: Total bytes used: 20480 Total bytes free: 110592 Total bytes capacity (fixed): 131072 Ram: Total Total Total Total

bytes bytes bytes bytes

used: free: capacity (Allocated) capacity (Configured)

3166208 2076672 3166208 5242880

Issue 2 January 2008

353

CLI Commands

IP phone upgrades

show ip tftp-server statistics


Use the show ip tftp-server statistics command to display TFTP server error counters. The error counters count several types of errors in download and upload operations. Note: Upload operations by TFTP clients, such as IP phones, are not supported. Therefore, any attempts to upload files to the TGM550 TFTP server are counted as access violation errors.

Note:

Syntax
show ip tftp-server statistics

User Level
read-only

Context
general

Example
To display TFTP server error counters:
TGM550-001(super)# show ip tftp-server statistics Counter ---------------------------------------File downloads (OK) File download Timeouts Total TFTP server errors Non defined TFTP errors File not found errors Access violation errors Illegal TFTP operation errors Value -------0 0 0 0 0 0 0

Output fields
Name File downloads (OK) File download Timeouts Description The number of successful downloads The number of timeouts that occurred during download operations 1 of 2

354 IG550 Integrated Gateway Administration and CLI Reference

IP phone upgrades

Name Total TFTP server errors Non defined TFTP errors File not found errors Access violation errors

Description The total number of download/upload errors The number of undefined errors The number of file not found errors The number of access violation errors caused by requesting invalid filenames or file paths, or by attempts to upload files to the TFTP server directory The number of illegal TFTP operation errors 2 of 2

Illegal TFTP operation errors

show upload phone-script-file status


Use the show upload phone-script-file status command to display the upload phone-script file.

Syntax
show upload phone-script-file status

User Level
read-only

Context
general

Example
To display the upload phone-script file: (If no upload has been performed)
TGM550-001# show upload phone-script-file status Module #10 =========== No source file for upload operation - no upload operation was done. ==============================

Issue 2 January 2008

355

CLI Commands

License file of CM

(If an upload has been performed)


TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : show upload phone-script-file status

10 phone-ScriptB 444 135.64.102.114 Idle (null) No-warning

License file of CM
ip license-server
Use the ip license-server command to enable the media gateway to supply a hardware serial number on behalf of an S8500 local survivable processor (LSP). The serial number is required when an S8500 LSP registers with its primary controller (S8400 or S8500 Server) using the Processor Ethernet interface. The serial number might also be required if the S8500 is a primary controller, but is using Processor Ethernet exclusively with H.248 media gateways. In this case, the S8500 does not have an IPSI-controlled gateway to use for its hardware license verification. Note: There must be at least one H.248 media gateway (G700, G250, G350, G450, or IG550) for each LSP in the main servers network. Only one LSP or primary controller can use the serial number of a media gateway for license verification.

Note:

Syntax
ip license-server

User Level
read-only

Context
general

356 IG550 Integrated Gateway Administration and CLI Reference

Link status

Example
To enable the serial number assignment to an LSP:
TGM550-001(super)# ip license-server

Link status
show isdn bri link
Use the show isdn bri link command to view the status of all BRI links on a media module.

Syntax
show isdn bri link mmID

Parameters
Parameter mmID Description The Media Module ID Possible Values Default Value

User Level
read-only

Context
general

Example
To display the status of all BRI links on media module 1:
TGM550-001(super)# show isdn bri link 1 LOCATION TYPE LINK ID DLCI SIDE STATE --------- ------- ---------- ---------- ----- -----------v1 NO LINK N/A N/A N/A N/A

Issue 2 January 2008

357

CLI Commands

Link status

show isdn link summary


Use the show isdn link summary command to view a summary of all ISDN links.

Syntax
show isdn link summary

User Level
read-only

Context
general

Example
To display information about all ISDN links:
TGM550-001(super)# show isdn link summary LOCATION --------MG TYPE -------NO LINK NO. OF LINKS UP --------------N/A

show isdn pri link


Use the show isdn pri link command to view the status of all PRI links on a media module.

Syntax
show isdn pri link mmID

Parameters
Parameter mmID Description The Media Module ID Possible Values Default Value

User Level
read-only

358 IG550 Integrated Gateway Administration and CLI Reference

Logging

Context
general

Example
To display PRI link information for media module 1:
TGM550-001(super)# show isdn pri link 1 LOCATION TYPE LINK ID DLCI SIDE STATE --------- ------- ---------- ---------- ----- -----------v1 NO LINK N/A N/A N/A N/A

Logging
clear logging cdr file content
Use the clear logging cdr file content command to delete the cdr message log file and open a new, empty cdr log file.

Syntax
clear logging cdr file content

User Level
read-write

Context
general

Example
To delete the cdr message log:
TGM550-001(super)# clear logging cdr file content

Issue 2 January 2008

359

CLI Commands

Logging

clear logging file


Use the clear logging file command to delete the message log file being stored in non-volatile memory (NVRAM), including the history log, and open a new, empty log file.

Syntax
clear logging file

User Level
read-write

Context
general

Example
To delete the message log:
TGM550-001(super)# clear logging file

clear logging server


Use the clear logging server command to delete the specified Syslog message server from the Syslog server table.

Syntax
clear logging server {ip_address | hostname}

Parameters
Parameter ip_address hostname Description The IP address of the Syslog server The name of the Syslog server host Possible Values Default Value

User Level
read-write

360 IG550 Integrated Gateway Administration and CLI Reference

Logging

Context
general

Example:
To delete the Syslog message server with IP address 176.15.4.25:
TGM550-001(super)# clear logging server 176.15.4.25

set logging file


Use the set logging file command to manage the logging of system messages to non-volatile memory (NVRAM).

Syntax
set logging file {enable|disable} set logging file condition {all|MsgFacility} {none|severity}

Parameters
Parameter enable Description Keyword specifying to enable logging to the file sink Keyword specifying to disable logging to the file sink Keyword specifying to define a filter rule for logging Keyword specifying to apply the filter condition to all MsgFacilities Apply the filter condition to a specific MsgFacility boot, snmp, cdr, voice, cli, filesys, cna_tp, config, tftp, console, threshold, Possible Values Default Value

disable

condition

all

MsgFacility

Issue 2 January 2008

361

CLI Commands

Logging

Parameter none

Description Keyword specifying not to log messages to the file sink severity level is equal to or more severe than the specified level. 0 is the highest severity and 7 the lowest severity.

Possible Values

Default Value

severity

Use the text value or its numeric equivalent: emergency (0) alert (1) critical (2) error (3) warning (4) notification (5) informational (6) debugging (7)

User Level
read-write

Context
general

Example
To filter Config messages sending only those having a severity of critical or greater:
TGM550-001(super)# set logging file condition config critical

set logging server


Use the set logging server command to define a new Syslog output server for remote logging of system messages. A maximum of three Syslog servers can be configured. A new Syslog server is created in disabled mode.

Syntax
set logging server ip_address

Parameters
Parameter ip_address Description The IP address of the Syslog server Possible Values Default Value

362 IG550 Integrated Gateway Administration and CLI Reference

Logging

User Level
read-write

Context
general

Example
To define a Syslog server at IP address 147.2.3.66:
TGM550-001(super)# set logging server 147.2.3.66

set logging server access-level


Use the set logging server access-level command to define the access level associated with a Syslog server sink. You cannot specify an admission level higher than the assigned level.

Syntax
set logging server access-level admission_level {ip_address | hostname}

Parameters
Parameter admission_ level Description Possible Values read-only, read-write, admin The IP address of the Syslog server The name of the Syslog server host Default Value

ip_address hostname

User Level
read-write

Context
general

Example
To specify a read-write access level for the Syslog server at IP address 172.5.16.33:
TGM550-001(super)# set logging server access-level read-write 172.5.16.33

Issue 2 January 2008

363

CLI Commands

Logging

set logging server condition


Use the set logging server condition command to specify a filter for messages sent to the specified Syslog server. Messages can be filtered by source system, severity, or both.

Syntax
set logging server condition {all | Msgfacility} {none | severity} ip_address

Parameters
Parameter all Description Keyword specifying to apply this filter to all message facility systems Apply this filter to messages produced by a specific system Keyword specifying not to log any messages Only log messages whose severity level is equal to or more severe than the specified level. 0 is the highest severity and 7 the lowest severity. Use the text value or its numeric equivalent: emergency (0), alert (1), critical (2), error (3), warning (4), notification (5), informational (6), debugging (7) boot, snmp, cdr, voice, cli, filesys, cna_tp, config, tftp, console, threshold, Possible Values Default Value

MsgFacility

none severity

ip_address

The IP address of the Syslog server

User Level
read-write

Context
general

364 IG550 Integrated Gateway Administration and CLI Reference

Logging

Example
To filter cdr messages for the Syslog server at IP address 168.23.1.15, so that only cdr messages of warning-level severity or greater are sent:
TGM550-001(super)# set logging server condition cdr warning 168.23.1.15

set logging server enable | disable


Use the set logging server enable or set logging server disable command to enable or disable a specific Syslog server.

Syntax
set logging server {enable | disable} ip_address

Parameters
Parameter enable disable ip_address Description Keyword specifying to enable logging for the Syslog server Keyword specifying to disable logging for the Syslog server The IP address of the Syslog server Possible Values Default Value

User Level
read-write

Context
general

Example
To enable logging for the Syslog server at IP address 168.12.1.13:
TGM550-001(super)# set logging server enable 168.12.1.13

Issue 2 January 2008

365

CLI Commands

Logging

set logging server facility


Use the set logging server facility command to define an output facility for the specified Syslog server.

Syntax
set logging server facility facility ip_address

Parameters
Parameter facility Description The facility used in Syslog reports Possible Values auth (Authorization), daemon (Background System Process), clkd (Clock Daemon), clkd2 (Clock Daemon), mail (Electronic Mail), local0 local7 (For Local Use) ftpd (FTP Daemon), kern (Kernel), alert (Log Alert), audi (Log Audit), ntp (NTP Subsystem), lpr (Printing), sec (Security), syslog (System Logging), uucp (Unix-to-Unix Copy Program), news (Usenet news), user (User Process) Default Value

ip_address

The IP address of the Syslog server

User Level
read-write

Context
general

Example
To specify that messages for the Syslog server at IP address 168.12.1.15 be sent to the mail output facility:
TGM550-001(super)# set logging server facility mail 168.12.1.15

366 IG550 Integrated Gateway Administration and CLI Reference

Logging

set logging session


Use the set logging session command to manage message logging for the current console session.

Syntax
set logging session {enable | disable | condition {all | MsgFacility} {none | severity}}

Parameters
Parameter enable Description Keyword specifying to enable logging to the console session Keyword specifying to disable logging to the console session Keyword specifying to define a filter rule for logging Keyword specifying to apply the filter condition to all MsgFacilities Apply the filter condition to a specific MsgFacility boot, snmp, cdr, voice, cli, filesys, cna_tp, config, tftp, console, threshold, Possible Values Default Value

disable

condition

all

MsgFacility

none

Keyword specifying not to log messages to the console session Only log messages whose severity level is equal to or more severe than the specified level. 0 is the highest severity and 7 the lowest severity. Use the text value or its numeric equivalent: emergency (0), alert (1), critical (2), error (3), warning (4), notification (5), informational (6), debugging (7) 6

severity

Issue 2 January 2008

367

CLI Commands

Logging

User Level
read-write

Context
general

Example
To filter config messages for the session, sending only those config messages of alert severity or greater:
TGM550-001(super)# set logging session condition config alert

show dev log file


Use the show dev log file command to display the encrypted devices log file.

Syntax
show dev log file

User Level
read-write

Context
general

show logging file condition


Use the show logging file condition command to display all conditions that have been defined for the file output sink.

Syntax
show logging file condition

User Level
read-only

Context
general

368 IG550 Integrated Gateway Administration and CLI Reference

Logging

Example
To show information about conditions that are defined for the file output:
TGM550-001(super)# show logging file condition ****************************************************** *** Message logging configuration of FILE sink *** Sink Is Enabled Sink default severity: Informational Application ! Severity Override ------------------------------------------FAN ! Error VLAN ! Critical

show logging file content


Use the show logging file content command to output the messages in the log file to the CLI console. The output is arranged with the most recent event first. The content of the file is output according to the current filter settings and user access. If no parameters are specified, information for all message facilities and severities is displayed.

Syntax
show logging file content [severity] [all|Msgfacility] [number]

Parameters
Parameter severity all Msgfacility number Description Minimal severity of messages to be displayed Keyword specifying to display messages from all facilities Display messages from this facility only Maximum number of messages to display Possible Values Default Value

User Level
read-only

Context
general

Issue 2 January 2008

369

CLI Commands

Logging

Example
To display contents of the message file for all message facilities and severities:
TGM550-001(super)# show logging file content CLI-Notification: CLI-Notification: CLI-Notification: SECURITY-Warning: Protocol = 23 CLI-Notification: root: exit root: exit root: ip Unauthorized Access from IP address = 0.0.0.0, User = super, root: exit

show logging server condition


Use the show logging server condition command to display the filter conditions that have been defined for the Syslog output sink. If an IP address or hostname is not specified, the configuration of all of the Syslog servers is displayed.

Syntax
show logging server condition [ip_address | hostname]

Parameters
Parameter ip_address hostname Description The IP address of the Syslog server The name of the Syslog server host Possible Values Default Value

User Level
read-only

Context
general

Example
To display filter conditions defined for the Syslog server at IP address 172.16.1.139:
TGM550-001(super)# show logging server condition 172.16.1.139 Logging: enabled Logging severity: warning

370 IG550 Integrated Gateway Administration and CLI Reference

Logging

Facility Severity Override ----------------------------------System Critical Syslog server 222.222.222.222 Logging: enabled Logging severity: Debug Facility Severity Override ----------------------------------Kernel Critical

show logging session condition


Use the show logging session condition command to display the filter conditions defined for message logging to the current console session.

Syntax
show logging session condition

User Level
read-only

Context
general

Example
To display filter conditions defined for console messaging:
TGM550-001(super)# show logging session condition Logging console: enabled Logging session severity: warning Facility Severity Override ----------------------------------System Critical

Issue 2 January 2008

371

CLI Commands

Master key configuration

Master key configuration


key config-key password-encryption
Use the key config-key password-encryption command to change the default Master Key of the gateway, used to encrypt gateway secrets in the gateway configuration file. Note: For security reasons, it is recommended to define a new Master Key upon gateway installation. Otherwise, the default Master Key, common to all gateways, is used to encrypt gateway secrets. Note: Record the phrase you entered in the key config-key password-encryption command and keep it in a safe place. If you wish to copy one gateways configuration file to another gateway, you must first configure in the other gateway an identical Master Key (by using the same phrase), otherwise the copy operation will fail. Note: When you define a Master Key, you are prompted to save it by copying the running configuration to the start-up configuration using the copy running-config startup-config command. The Master Key will now be in effect. Note: The nvram initialize command deletes the user-defined Master Key, and returns it to its default value.

Note:

Note:

Note:

Note:

Syntax
key config-key password-encryption master-key-passphrase

Parameters
Parameter master-key-phrase Description The phrase used to generate the gateways Master Key, used for encrypting gateway secrets Possible Values A string of 13-64 printable ASCII characters Default Value

372 IG550 Integrated Gateway Administration and CLI Reference

MGC (Media Gateway Controller) configuration

User Level
admin

Context
general

Example
To change the default Master Key of the gateway to o;3qfhSE&Ydf1\:
TGM550(super)# key config-key password-encryption o;3qfhSE&Ydfl\

MGC (Media Gateway Controller) configuration


clear mgc list
Use the clear mgc list command to remove entries from the Media Gateway Controller list. Multiple entries can be removed together, by specifying a list of IP addresses separated by commas. If no arguments are provided, all entries are removed.

Syntax
clear mgc list [ipaddress1,]

Parameters
Parameter ipaddress1 Description The IP address of a call controller Possible Values Default Value

User Level
read-only

Context
general

Issue 2 January 2008

373

CLI Commands

MGC (Media Gateway Controller) configuration

Example
To remove two media gateway controllers from the list, with IP addresses of 132.236.73.2 and 177.13.2.45:
TGM550-001(super)# clear mgc list 132.236.73.2, 177.13.2.45

session
Use the session command to provide the means to establish a session with the active Media Gateway Controller, SAT, the Juniper Services Router CLI, or the device. This is an alias to Telnet. The mgc option Telnets to the active Media Gateway Controller. Note: For session mgc sat to access the server SAT terminal, the SAT port must be configured to 5023 on the server. For session mgc and session icc, the server should allow access to the Telnet port (23).

Note:

Syntax
session {{mgc [sat]} | chassis}

Parameters
Parameter mgc sat chassis Description Keyword for accessing the LINUX shell login Keyword for accessing the SAT login Keyword for accessing the Juniper Services Router CLI Possible Values Default Value

User Level
read-only

Context
general

Example
To establish a session with the active media gateway controller:
TGM550-001(super)# session mgc

374 IG550 Integrated Gateway Administration and CLI Reference

MGC (Media Gateway Controller) configuration

To establish a session with the Juniper Services Router:


TGM550-001(super)# session chassis

set mediaserver
Use the set mediaserver command to set server management ports.

Syntax
set mediaserver ip_address1 ip_address2 port name

Parameters
Parameter ip_address1 ip_address2 port name Description Controller IP address used for registration Management interface IP address Service port number Service type telnet, sat Possible Values Default Value

User Level
read-write

Context
general

Example
To set the server management sat port 3023 to have a controller IP address of 135.6.8.99 and a management IP address of 135.34.54.2:
TGM550-001# set mediaserver 135.6.8.99 135.34.54.2 3023 sat

Issue 2 January 2008

375

CLI Commands

MGC (Media Gateway Controller) configuration

set mgc list


Use the set mgc list command to permit the creation of a list of valid Media Gateway Controller(s). The user can configure up to four IP addresses separated by commas. Note: The set mgc list command appends the new controllers to the existing list of controllers, if any.

Note:

Syntax
set mgc list {ipaddress1,}

Parameters
Parameter ipaddress1 Description The IP address of the call controller Possible Values Default Value

User Level
read-write

Context
general

Example
To specify two media gateway controllers at IP addresses 132.236.73.2 and 119.52.3.27:
TGM550-001(super)# set mgc list 132.236.73.2, 119.52.3.27

set reset-times
Use the set reset-times command to set reset times.

Syntax
set reset-times { {total-search | primary-search} minutes | transition-point value }

376 IG550 Integrated Gateway Administration and CLI Reference

MGC (Media Gateway Controller) configuration

Parameters
Parameter total-search primary-search minutes transition-point value Description Keyword specifying to set the total search timer Keyword specifying to set the primary search timer Number of minutes Keyword specifying to set the entry point 1-4 1 1-60 total-search: 30 primary-search: 1 Possible Values Default Value

User Level
read-write

Context
general

Example
To set the primary search timer reset time to 20 minutes:
TGM550-001(super)# set reset-times primary-search 20

show mediaserver
Use the show mediaserver command to show server configuration information.

Syntax
show mediaserver

User Level
read-only

Context
general

Issue 2 January 2008

377

CLI Commands

MGC (Media Gateway Controller) configuration

Example
To display server configuration information:
TGM550-001(super)# show mediaserver MGC IP ADDRESS --------------135.8.65.107 SAT IP ADDRESS --------------135.8.65.107 SAT PORT SERVER IP ADDRESS SERVER PORT -------- ----------------- ----------5023 135.8.65.107 23

show mgc
Use the show mgc command to display the currently active media gateway controller state and setup parameters.

Syntax
show mgc

User Level
read-only

Context
general

Example
To display media gateway controller information:
TGM550-001(super)# show mgc CALL CONTROLLER STATUS ------------------------------------------Registered : NO Active Controller : 255.255.255.255 H248 Link Status : DOWN H248 Link Error Code: 0x0 CONFIGURED MGC HOST ---------------------- Not Available --- Not Available --- Not Available --- Not Available --

378 IG550 Integrated Gateway Administration and CLI Reference

MGC (Media Gateway Controller) configuration

show mgc list


Use the show mgc list command to display the list of available Media Gateway Controllers and their IP addresses. The show mgc list command also shows whether SLS survivability is enabled or disabled. If SLS is enabled, the following message appears at the end of the MGC list:
SLS

If SLS is disabled, the following message appears at the end of the MGC list:
SLS disabled

Syntax
show mgc list

User Level
read-only

Context
general

Example
To display the list of media gateway controllers:
TGM550-001(super)# show mgc list CONFIGURED MGC HOST --------------------135.8.48.220 135.34.54.2 149.49.70.230 -- Not Available -SLS

Issue 2 January 2008

379

CLI Commands

MGC (Media Gateway Controller) configuration

Output fields
Field CONFIGURED MGC HOST Description Lists five administered elements: The first three are the IP addresses of the next-available call controller in the administered list The fourth element (--Not Available--) The fifth element is either: - SLS SLS is enabled - SLS disabled SLS is disabled

show recovery
Use the show recovery command to show the media gateway monitoring and recovery setup.

Syntax
show recovery

User Level
read-only

Context
general

Example
To show recovery information:
TGM550-001(super)# show recovery RECOVERY TIMES -------------------------------Primary Search : 1 Total Search : 30 Transition Point: 1

380 IG550 Integrated Gateway Administration and CLI Reference

Modem configuration Console port

Modem configuration Console port


interface console
Use the interface console command to enter the Console interface configuration mode. The interface is created if it does not exist. Use the no form of this command to set the Console parameters to their default values. Note: This mode is used for services logins only.

Note:

Syntax
[no] interface console

User Level
read-write

Context
general

Example
To enter the Console interface context:
TGM550-001(super)# interface console TGM550-001(if:Console)#

Issue 2 January 2008

381

CLI Commands

MSS notifications

MSS notifications
icmp in-echo-limit
Use the icmp in-echo-limit command to set the maximum number of echo requests that can be received in one second. Use the no form of the command to return the limit to its default value.

Syntax
[no]icmp in-echo-limit size

Parameters
Parameter size Description The number of echo requests Possible Values 1-10000 Default Value

User Level
read-write

Context
general

Example
To set the echo request limit at 500 packets per second:
TGM550-001(super)# icmp in-echo-limit 500

icmp
Use the icmp command to specify that the current rule applies to a specific type of ICMP packet. Use the not form of this command to specify that the rule applies to all packets except those of the requested ICMP attribute. If the IP protocol is not ICMP, it is set to ICMP. Use the no form of the command to specify that the current rule applies to any type of ICMP packet.

382 IG550 Integrated Gateway Administration and CLI Reference

MSS notifications

Note:

Note: The icmp command also sets the IP protocol to ICMP.

Syntax
[not] icmp {name | {icmp_type icmp_code}} no icmp

Parameters
Parameter name icmp_type icmp_code Description Specify that the rule applies to this ICMP name Specify that the rule applies to this icmp type Specify that the rule applies to this icmp code For an ip-rule: 0-256 For a QoS rule: 0-65535 For an ip-rule: 0-256 For a QoS rule: 0-65535 Possible Values Default Value

User Level
read-write

Context
ip capture-list/ip-rule, ip access-control-list/ip-rule, ip pbr-list/ip-rule, ip qos-list/ip-rule, ip crypto-list ip-rule Note: The not form of the command is not relevant in the crypto-list ip-rule context.

Note:

Example
To specify that rule 27 applies to ICMP error-reply packets:
TGM550-001(ACL 333/ip rule 27)# icmp Echo-Reply

To specify that rule 33 applies to any ICMP packet type except type 1 code 2:
TGM550-001(ACL 333/ip rule 33)# not icmp 1 2

Issue 2 January 2008

383

CLI Commands

MSS notifications

icmp
Use the icmp command to specify that the current rule applies to a specific type of ICMP packet. Use the not form of this command to specify that the rule applies to all packets except those of the requested ICMP attribute. If the IP protocol is not ICMP, it is set to ICMP. Use the no form of the command to specify that the current rule applies to any type of ICMP packet. Note: The icmp command also sets the IP protocol to ICMP.

Note:

Syntax
[not] icmp {name | {icmp_type icmp_code}} no icmp

Parameters
Parameter name icmp_type icmp_code Description Specify that the rule applies to this ICMP name Specify that the rule applies to this icmp type Specify that the rule applies to this icmp code For an ip-rule: 0-256 For a QoS rule: 0-65535 For an ip-rule: 0-256 For a QoS rule: 0-65535 Possible Values Default Value

User Level
read-write

Context
ip capture-list/ip-rule, ip access-control-list/ip-rule, ip pbr-list/ip-rule, ip qos-list/ip-rule, ip crypto-list ip-rule Note: The not form of the command is not relevant in the crypto-list ip-rule context.

Note:

384 IG550 Integrated Gateway Administration and CLI Reference

Policy - QoS lists

Example
To specify that rule 27 applies to ICMP error-reply packets:
TGM550-001(ACL 333/ip rule 27)# icmp Echo-Reply

To specify that rule 33 applies to any ICMP packet type except type 1 code 2:
TGM550-001(ACL 333/ip rule 33)# not icmp 1 2

Policy - QoS lists


icmp
Use the icmp command to specify that the current rule applies to a specific type of ICMP packet. Use the not form of this command to specify that the rule applies to all packets except those of the requested ICMP attribute. If the IP protocol is not ICMP, it is set to ICMP. Use the no form of the command to specify that the current rule applies to any type of ICMP packet. Note: The icmp command also sets the IP protocol to ICMP.

Note:

Syntax
[not] icmp {name | {icmp_type icmp_code}} no icmp

Parameters
Parameter name icmp_type icmp_code Description Specify that the rule applies to this ICMP name Specify that the rule applies to this icmp type Specify that the rule applies to this icmp code For an ip-rule: 0-256 For a QoS rule: 0-65535 For an ip-rule: 0-256 For a QoS rule: 0-65535 Possible Values Default Value

Issue 2 January 2008

385

CLI Commands

Port classification

User Level
read-write

Context
ip capture-list/ip-rule, ip access-control-list/ip-rule, ip pbr-list/ip-rule, ip qos-list/ip-rule, ip crypto-list ip-rule Note: The not form of the command is not relevant in the crypto-list ip-rule context.

Note:

Example
To specify that rule 27 applies to ICMP error-reply packets:
TGM550-001(ACL 333/ip rule 27)# icmp Echo-Reply

To specify that rule 33 applies to any ICMP packet type except type 1 code 2:
TGM550-001(ACL 333/ip rule 33)# not icmp 1 2

Port classification
show port classification
Use the show port classification command to display a ports classification. If no port is specified, information for all ports is displayed.

Syntax
show port classification [module/[port]]

Parameters
Parameter module port Description Number of the module Number of the port on the module. You can also specify a range of ports separated by a dash. Possible Values Default Value

386 IG550 Integrated Gateway Administration and CLI Reference

Port classification

User Level
read-only

Context
general

Example
To display information for port :
TGM550-001(super)# show port classification 6/5 Port Port Classification ------ --------------------6/5 regular

show interfaces
Use the show interfaces command to display interface configuration and statistics for a particular interface or all interfaces. The Frame Relay sub-interface only includes the following counters:

packets & bytes in packets & bytes out input errors output drops

Syntax
show interfaces [interface_type interface_identifier]

Issue 2 January 2008

387

CLI Commands

Port classification

Parameters
Parameter interface_type interface_ identifier Description The type of interface The interface number. The format varies depending on the value of interface_type: For Serial: module/ port:channel-group Possible Values Serial, Console, For Serial(USP): 2/1 For Serial (DS1): module/port: 2/1 channel-group: E1: 0-30 T1: 0-23 Default Value

User Level
read-write

Context
general

Example
To show information about all the interfaces:
TGM550-001(super)# show interfaces Physical address is 00.04.0d.29.c5.11. Internet address is 172.16.1.139, mask is 255.255.255.240 MTU 1500 bytes. Bandwidth 100000 kbit. Reliability 255/255 txLoad 1/255 rxLoad 1/255 Link status trap disabled Full-duplex, 100Mb/s Last input 00:00:30, Last output 00:00:30 Last clearing of 'show interface' counters never. 5 minute input rate 144 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 3425 packets input, 323518 bytes 3425 broadcasts received, 0 giants 0 input errors, 0 CRC 32 packets output, 896 bytes 0 output errors, 0 collisions FastEthernet 10/2 is up, line protocol is down Physical address is 00.04.0d.29.c5.10. MTU 1500 bytes. Bandwidth 10000 kbit. Reliability 1/255 txLoad 255/255 rxLoad 255/255

388 IG550 Integrated Gateway Administration and CLI Reference

Port classification

Encapsulation ARPA Link status trap disabled Half-duplex, 10Mb/s, 10BaseTX ARP type: ARPA, ARP Timeout 04:00:00 Dynamic CAC BBL: 1500 kbps Dynamic CAC activation priority: 50 Dynamic CAC interface status: active Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions Tunnel 1 is up, line protocol is up Internet address is 177.0.0.17, mask is 255.0.0.0 MTU 468 bytes. Bandwidth 9 kbit Reliability 255/255 txLoad 1/255 rxLoad 1/255 Encapsulation GRE Link status trap enabled Keepalive set (10 sec), retries 3 Tunnel source 17.0.0.17, destination 12.0.0.3 Tunnel protocol/transport GRE/IP, key 777 Checksumming of packets enabled Tunnel DSCP 63, Tunnel TTL 255 Path MTU Discovery, ager 10 mins, MTU 976, expires 00:09:33 Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions Console asynchronous mode is terminal Terminal baud rate is 9600

Issue 2 January 2008

389

CLI Commands

QoS

QoS
set qos bearer
Use the set qos bearer command to permit the setting of VoIP QoS-bearer related parameters for the Media Gateway Processor and VoIP engines. Since Media Gateway Controller and VoIP engines share the same setup, local values are not set to entered values unless set qos control local has been executed (refer to set qos control on page 391).

Syntax
set qos bearer {bbedscp | efdscp | 802p | rtpmin | rtpmax} value

Parameters
Parameter bbedscp efdscp 802p rtpmin Description Keyword specifying that the following value is the BBE differentiated services code point Keyword specifying that the following value is the EF differentiated services code point Keyword specifying that the following value is the 802 priority value Keyword specifying that the following value is the RTP port min value. The rtpmin value must be an even number, and the difference between rtpmin and rtpmax must be at least 129. Keyword specifying that the following value is the RTP port max value. The rtpmax value must be an odd number and the difference between rtpmax and rtpmin must be at least 129. A value for the specified keyword Possible Values 0-63 0-63 0-7 2048-65406 Default Value 43 46 6 2048

rtpmax

2177-65535

65535

value

User Level
read-write

Context
general

390 IG550 Integrated Gateway Administration and CLI Reference

QoS

Example
To set the BBE differentiated services code point to 43:
TGM550-001(super)# set qos bearer bbedscp 43

set qos control


Use the set qos control command to define the source for QoS control parameters. The source can be either local where the user configures the values via the CLI, or remote in which case the values are obtained from the media gateway controller. The default value is remote.

Syntax
set qos control {local | remote}

Parameters
Parameter local remote Description Keyword that specifies to configure QoS values via the CLI Keyword that specifies to obtain QoS values from the media gateway controller Possible Values Default Value

User Level
read-write

Context
general

Example
To specify that QoS values are configured locally via the CLI:
TGM550-001(super)# set qos control local

Issue 2 January 2008

391

CLI Commands

QoS

set qos signal


Use the set qos signal command to provide the means to set up QoS signaling parameters, DSCP or 802.1Q, for the Media Gateway Processor.

Syntax
set qos signal {dscp | 802p} value

Parameters
Parameter dscp 802p value Description Keyword that specifies to setup DSCP parameters Keyword that specifies to setup 802.1Q parameters Parameter value For dscp: 0-63 For 802p: 0-7 For dscp: 34 For 802p: 7 Possible Values Default Value

User Level
read-write

Context
general

Example
To set up DSCP parameter 43:
TGM550-001(super)# set qos signal dscp 43

show qos-rtcp
Use the show qos-rtcp command to display QoS, RTCP, and RSVP parameters.

Syntax
show qos-rtcp

User Level
admin

392 IG550 Integrated Gateway Administration and CLI Reference

QoS

Context
general

Example
To display QoS, RSVP and RTCP parameters:
TGM550-001(super)# show qos-rtcp PARAMETERS IN EFFECT: -- Downloaded -QOS PARAMETERS -------------------Signal 802 Priority: Signal DSCP : Bearer 802 Priority: Bearer BBE DSCP : Bearer EF DSCP : Minimum RTP Port : Maximum RTP Port : RSVP PARAMETERS -------------------State : Retry on Failure : Retry Delay(secs) : Service Profile : RTCP MON PARAMETERS -------------------State : IP Address : Listening Port : Report Period(secs): LOCALLY SET --------------7 34 6 43 46 3 65535 LOCALLY SET --------------Enabled Yes 15 Guaranteed LOCALLY SET --------------Enabled 0.0.0.0 5005 5 DOWNLOADED --------------0 0 6 43 46 2048 65535 DOWNLOADED --------------Disabled Yes 15 Guaranteed DOWNLOADED --------------Disabled 0.0.0.0 5005 5

show voip-parameters
Use the show voip-parameters command to display information about the VoIP engine.

Syntax
show voip-parameters

User Level
read-only

Issue 2 January 2008

393

CLI Commands

RADIUS authentication

Context
general

Examples
To display VoIP information:
TGM550-001(super)# show voip-parameters VOIP ENGINE PARAMETERS --------------------------------------------------------IP (PMI) : 172.16.1.139 DSP Firmware Version: 200 DSP Hardware Vintage: 1.0 Fault Status : No Fault Messages Additional Status : No Status Messages CURRENT STATE --------------------------------------------------------In Use : 0 channels, 0 of 300 points (0.0% used) DSPs State : Idle Admin State: Release

RADIUS authentication
clear radius authentication server
Use the clear radius authentication server command to clear the primary or secondary RADIUS server IP address.

Syntax
clear radius authentication server {primary|secondary}

394 IG550 Integrated Gateway Administration and CLI Reference

RADIUS authentication

Parameters
Parameter primary secondary Description Keyword specifying to clear the primary RADIUS server Keyword specifying to clear the secondary RADIUS server Possible Values Default Value

User Level
admin

Context
general

Example
To clear the secondary RADIUS authentication server:
TGM550-001(super)# clear radius authentication server secondary

set radius authentication


Use the set radius authentication command to enable or disable RADIUS authentication.

Syntax
set radius authentication {enable | disable}

Parameters
Parameter enable disable Description Keyword specifying to enable RADIUS authentication Keyword specifying to disable RADIUS authentication (default) Possible Values Default Value

User Level
read-write

Issue 2 January 2008

395

CLI Commands

RADIUS authentication

Context
general

Example
To enable RADIUS authentication:
TGM550-001(super)# set radius authentication enable

set radius authentication retry-number


Use the set radius authentication retry-number command to set the number of times to resend an access request when there is no response.

Syntax
set radius authentication retry-number number

Parameters
Parameter number Description The number of times to resend an access request if there is no response Possible Values 165535 Default Value

User Level
read-write

Context
general

Example
To set the number of retries for RADIUS authentication to 3:
TGM550-001# set radius authentication retry-number 3

396 IG550 Integrated Gateway Administration and CLI Reference

RADIUS authentication

set radius authentication retry-time


Use the set radius authentication retry-time command to set the time to wait before resending an access request.

Syntax
set radius authentication retry-time seconds

Parameters
Parameter seconds Description The time in seconds to wait before resending an access request Possible Values 165535 Default Value

User Level
read-write

Context
general

Example
To specify to wait 5 seconds before retrying an access request:
TGM550-001# set radius authentication retry-time 5

set radius authentication secret


Use the set radius authentication secret command to enable secret authentication.

Syntax
set radius authentication secret string

Parameters
Parameter string Description The text password Possible Values Default Value

Issue 2 January 2008

397

CLI Commands

RADIUS authentication

User Level
admin

Context
general

Example
To set the RADIUS authentication password to hush:
TGM550-001# set radius authentication secret hush

set radius authentication server


Use the set radius authentication server command to set the IP address of the primary or secondary RADIUS Authentication server.

Syntax
set radius authentication server ip_addr {primary | secondary}

Parameters
Parameter ip_addr primary secondary Description IP address of RADIUS authentication server Keyword that specifies to set the primary authentication server (default) Keyword that specifies to set the secondary authentication server Possible Values Default Value

User Level
read-write

Context
general

Example
To set the primary RADIUS authentication server IP address to be 192.40.12.36:
TGM550-001# set radius authentication server 192.40.12.36 primary

398 IG550 Integrated Gateway Administration and CLI Reference

RADIUS authentication

set radius authentication udp-port


Use the set radius authentication udp-port command to set the RFC 2138 approved UDP port number. Normally, the UDP port number should be set to its default value of 1812. Some early implementations of the RADIUS server used port number 1645.

Syntax
set radius authentication udp-port number

Parameters
Parameter number Description The UDP port number Possible Values Default Value 1812

User Level
read-write

Context
general

Example
To set the UDP port number to 1645:
TGM550-001# set radius authentication udp-port number 1645

show radius authentication


Use the show radius authentication command to display all RADIUS authentication configurations. Shared secrets are not displayed.

Syntax
show radius authentication

User Level
read-only

Context
general

Issue 2 January 2008

399

CLI Commands

Recovery password

Example
To show RADIUS authentication information:
TGM550-001(super)# show radius authentication Mode: Primary-server: Secondary-server: Retry-number: Retry-time: UDP-port: Disable 0.0.0.0 0.0.0.0 4 5 1812

Recovery password
set terminal recovery password
Use the set terminal recovery password command to enable or disable the recovery password. Note: This command can only be issued via the console port (not via a modem port).

Note:

Syntax
set terminal recovery password action

Parameters
Parameter action Description The state of the recovery password Possible Values enable, disable Default Value

User Level
admin

Context
general

400 IG550 Integrated Gateway Administration and CLI Reference

Restoring gateway configuration

Example
To disable the recovery password:
TGM550-001(super)# set terminal recovery password disable

Restoring gateway configuration

show restore status


Use the show restore status command to display information regarding the status of a restore operation of gateway files. The output displays the list of files restored so far.

Syntax
show restore status

User Level
read-only

Context
general

Example
To display information regarding the status of a gateway file restore operation:
TGM550-001(super)# show restore status Files restored: Type FileName Status ----------------------------------------------------------startup-config startup_config.cfg OK auth-file auth-file.cfg OK phone-script 46xxupgrade.scr OK phone-script 46xxsettings.txt OK phoneImageFile 4602dbte1_82.bin OK phoneImageFile 4601dbte1_82.bin OK phoneImageFile 4602dape1_82.bin OK phoneImageFile 4601dape1_82.bin OK announcement A01100.wav OK announcement Ann7.wav OK

Issue 2 January 2008

401

CLI Commands

Routing table configuration

Routing table configuration


traceroute
Use the traceroute command to trace the route packets are taking to a particular host by displaying the hops along the path. Note: Pressing any key while traceroute is operating, terminates the ongoing trace. However, pressing any key while traceroute is probing a locally terminated tunnel (GRE, ESP) exits the tunnel without terminating the ongoing trace.

Note:

Syntax
traceroute host [local-address ip-addr] [probe-count count] [dest-port-base dest-port] [dest-port-increment increment] [source-port source-port] [timeout timeout] [dscp dscp] [next-hop {next-hop-if-name | next-hop-ip-addr}] [max-ttl max-ttl] [size size] [protocol protocol] [include-tunnel-hops] [set-df-bit]

Parameters
Parameter host Description The destination host of the traceroute probes, specified as an IP address or host name The local IP address of the traceroute probes The outbound interface address 1-5 1,02465,535 0-254 3 33,434 1 Possible Values Default Value

ip_addr

count dest-port increment

The number of times each TTL value is repeated for a traceroute The destination port of the first probe sent An integer that determines by how much the destination port is incremented for each probe sent, starting from base port The source port of the traceroute probes

source-port

1,02465,535

33,434

402 IG550 Integrated Gateway Administration and CLI Reference

Routing table configuration

Parameter timeout

Description The duration, in milliseconds, that traceroute waits for a response for each probe sent, until it gives up and marks this probe as unreachable The value of the DS field of the traceroute probes The interface name of the next hop The IP address of the next hop Do not probe over this TTL value The L4 payload length, in bytes The protocol type of the traceroute probes Keyword that specifies that traceroute display the route taken by the probes as they traverse locally terminated tunnels (such as GRE, ESP) Keyword that specifies to set the Don't-Fragment field of the traceroute probes

Possible Values 10ms120sec in milliseconds 0-63

Default Value 2 seconds in milliseconds 0

dscp next-hop-if -name next-hop-ip -addr max-ttl size protocol includetunnel-hops

1-50 8-4,088 ICMP, UDP

30 40 UDP

set-df-bit

User Level
read-only

Context
general

Example
To trace the route to IP address 60.60.60.1, including the route taken by the probes as they traverse locally terminated tunnels:
TGM550-001(super)# traceroute 60.60.60.1 include-tunnel-hops Tracing route to 60.60.60.1 over a maximum of 30 hops, 40 bytes packets. Press any key to abort. 1 3 ms 3 ms 3 ms 111.111.111.114 ESP tunnel 2 6 ms 5 ms 6 ms 60.60.60.1 GRE tunnel Trace complete.

Issue 2 January 2008

403

CLI Commands

RTCP

RTCP
set qos rtcp
Use the set qos rtcp command to permit the setup of RTCP parameters. The parameters that can be set are enabling or disabling RTCP reporting capability, setting the IP address of the monitor, setting the reporting period, and defining the listening port number.

Syntax
set qos rtcp {{enable|disable} | monip ip-address | reportper seconds | listenport portno}

Parameters
Parameter enable disable ip-address seconds portno Description Keyword that specifies to enable RTCP reporting capability Keyword that specifies to disable RTCP reporting capability The IP address of the monitor The reporting period in seconds The listening port number 5-30 1-65535 5 5005 Possible Values Default Value

User Level
read-write

Context
general

Example
To set the monitoring IP address to 132.123.23.12:
TGM550-001(super)# set qos rtcp monip 132.123.23.12

To set the reporting period to 10 seconds:


TGM550-001(super)# set qos rtcp reportper 10

404 IG550 Integrated Gateway Administration and CLI Reference

RTCP

To set the listening port number to 5000:


TGM550-001(super)# set qos rtcp listenport 5000

To enable reporting capability:


TGM550-001(super)# set qos rtcp enable

show qos-rtcp
Use the show qos-rtcp command to display QoS and RTCP parameters.

Syntax
show qos-rtcp

User Level
admin

Context
general

Example
To display QoS, RSVP and RTCP parameters:
TGM550-001(super)# show qos-rtcp PARAMETERS IN EFFECT: -- Downloaded -QOS PARAMETERS -------------------Signal 802 Priority: Signal DSCP : Bearer 802 Priority: Bearer BBE DSCP : Bearer EF DSCP : Minimum RTP Port : Maximum RTP Port : RSVP PARAMETERS -------------------State : Retry on Failure : Retry Delay(secs) : Service Profile : LOCALLY SET --------------7 34 6 43 46 3 65535 LOCALLY SET --------------Enabled Yes 15 Guaranteed DOWNLOADED --------------0 0 6 43 46 2048 65535 DOWNLOADED --------------Disabled Yes 15 Guaranteed

Issue 2 January 2008

405

CLI Commands

RTP statistics

RTCP MON PARAMETERS -------------------State : IP Address : Listening Port : Report Period(secs):

LOCALLY SET --------------Enabled 0.0.0.0 5005 5

DOWNLOADED --------------Disabled 0.0.0.0 5005 5

RTP statistics
rtp-stat clear
Use the rtp-stat clear command to reset the RTP statistics application. When you reset the application, all counters are reset and the RTP statistics history is erased.

Syntax
rtp-stat clear

User Level
read-write

Context
general

Example
To reset the RTP statistics application:
TGM550-001(super)# rtp-stat clear

406 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

rtp-stat event-threshold
Use the rtp-stat event-threshold command to set thresholds on the QoS event counters incremented by the RTP statistics application. If one or more event thresholds are exceeded during an RTP stream and the RTP statistics application is configured to generate QoS SNMP traps, a trap is generated upon termination of the RTP stream. Use the rtp-stat qos-trap command to configure the RTP statistics application to automatically generate QoS traps. Use the rtp-stat threshold command to configure the QoS metric thresholds. Event thresholds should be configured such that the sending of a trap corresponds to a customers actual experience of QoS problems during the stream.

Syntax
rtp-stat event-threshold {all|codec-loss|codec-rtt|echo-return-loss|loss|remote-loss|rtt| jitter|remote-jitter|ssrc-change} num no rtp-stat event-threshold {all|codec-loss|codec-rtt|echo-return-loss|loss|remote-loss|rtt| jitter|remote-jitter|ssrc-change}

Parameters
Parameter all Description Possible Values Default Value

Keyword specifying to set all event thresholds to the specified number Keyword specifying to set the event threshold for the codec-loss metric Keyword specifying to set the event threshold for the codec-rtt metric Keyword specifying to set the event threshold for the echo-return-loss metric Keyword specifying to set the event threshold for the loss metric Keyword specifying to set the event threshold for the remote-loss metric

codec-loss

codec-rtt

echo-return-loss

loss

remote-loss

Issue 2 January 2008

407

CLI Commands

RTP statistics

Parameter rtt

Description

Possible Values

Default Value

Keyword specifying to set the event threshold for the rtt metric Keyword specifying to set the event threshold for the jitter metric Keyword specifying to set the event threshold for the remote-jitter metric Keyword specifying to set the event threshold for the ssrc-change metric The number of events

jitter

remote-jitter

ssrc-change

num

User Level
read-write

Context
general

Example
To set RTP-stat echo-return-loss event-threshold to 2:
TGM550-001(super)# rtp-stat event-threshold echo-return-loss 2

rtp-stat fault
Use the rtp-stat fault command to configure the RTP statistics application to send QoS fault and/or clear traps. A QoS fault trap is sent when a specified number of active RTP sessions have QoS indicators over the configured thresholds. A QoS clear trap is sent after a QoS fault trap when the number of active RTP sessions with QoS indicators over the configured thresholds reduces to a specified number. QoS fault and clear traps are enabled by default.

Syntax
rtp-stat fault [fault [clear]] [no] rtp-stat fault

408 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

Parameters
Parameter fault Description The fault trap boundary. If the number of active sessions with QoS faults reaches the fault trap boundary, a QoS fault trap is sent. The clear trap boundary. If the number of active sessions with QoS faults reduces to the clear trap boundary after a QoS fault trap was sent, a QoS clear trap is sent. Possible Values 1-100 Default Value 3

clear

0-99

User Level
read-write

Context
general

Example
To set the fault trap boundary to 1 and the clear trap boundary to 0:
TGM550-001(super)# rtp-stat fault 1 0 The fault trap boundary was set to 1 (default: 3) The clear trap boundary was set to 0

rtp-stat min-stat-win
Use the rtp-stat min-stat-win command to set the minimum statistic window for the RTP statistics application. The minimum statistics window is the minimum number of observed RTP sequence increments for which the application evaluates packet loss. Use the no form of this command to reset the minimum statistic window to its default value. The VoIP engine evaluates the current received packet loss every RTCP interval. The RTCP interval is usually between 5 and 8 seconds. The VoIP engine postpones loss estimation to the next interval if the number of received packets is less than the minimum statistic window.

Syntax
[no] rtp-stat min-stat-win packets

Issue 2 January 2008

409

CLI Commands

RTP statistics

Parameters
Parameter packets Description Possible Values 10-1000 Default Value

The minimum number of observed RTP sequence increments for which the application evaluates packet loss

User Level
read-write

Context
general

Example
To set the minimum statistic window to 50:
TGM550-001(super)# rtp-stat min-stat-win 50

rtp-stat qos-trap
Use the rtp-stat qos-trap command to enable the RTP statistics application to automatically generate QoS traps upon the terminations of RTP streams in which one or more QoS event counters exceeded their configured thresholds. The traps are sent by an SNMP agent to the SNMP trap manager on the Media Gateway Controller (MGC) They are converted to Syslog messages and stored in the messages file on the MGC. Use the no form of this command to disable QoS traps. By default, QoS traps are enabled.

Syntax
[no] rtp-stat qos-trap

User Level
read-write

Context
general

410 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

Example
To enable QoS traps:
TGM550-001(super)# rtp-stat qos-trap The RTP statistics QoS trap is enabled

rtp-stat qos-trap-rate-limit
Use the rtp-stat qos-trap-rate-limit command to configure the QoS trap rate limiter. The trap rate limiter limits the rate at which QoS traps are sent to the SNMP trap manager on the MGC. The trap rate limiter uses a token bucket scheme, in which traps are sent only if there are tokens in a virtual bucket. Tokens are added to the bucket every token interval, which sets the maximum long term trap rate. Each time a trap is sent, the number of tokens in the bucket decrements. The bucket size is the maximum number of tokens that the bucket can hold. The bucket size limits the trap burst size.

Syntax
rtp-stat qos-trap-rate-limit token-interval bucket-size

Parameters
Parameter token-interval bucket-size Description The interval, in hundredths of seconds, between additions of a token to the bucket The maximum number of tokens stored in the bucket Possible Values 10-100000 1-1000 Default Value 1000 5

User Level
read-write

Context
general Example To limit the QoS trap rate to a token every 10 hundredths of a second up to 50 tokens:
TGM550-001(super)# rtp-stat qos-trap-rate-limit 10 50

Issue 2 January 2008

411

CLI Commands

RTP statistics

rtp-stat-service
Use the rtp-stat-service command to enable the RTP statistics application. Use the no form of this command to disable the RTP statistics application. By default, the RTP statistics application is disabled.

Syntax
[no] rtp-stat-service

User Level
admin

Context
general

Example
To enable the RTP statistics application:
TGM550-001 (super)# rtp-stat-service The RTP statistics service is enabled.

rtp-stat threshold
Use the rtp-stat threshold command to set thresholds for QoS metrics sampled by the RTP statistics application. An event counter for each metric increments every time the metric exceeds its threshold during an RTP session. Use the rtp-stat threshold command also to set thresholds on averages of metrics. When an RTP session terminates, the RTP statistics application evaluates the average metrics and generates a QoS trap (if QoS traps are configured) if one or more of them is over its corresponding threshold. See also rtp-stat event-threshold on page 407.

Syntax
rtp-stat threshold {codec-loss|average-codec-loss|loss|average-loss|remote-loss| average-remote-loss} percentage rtp-stat threshold {codec-rtt|rtt|jitter|remote-jitter} milliseconds rtp-stat threshold echo-return-loss db

412 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

no rtp-stat threshold {all|codec-loss|average-codec-loss|codec-rtt|echo-return-loss|loss| average-loss|remote-loss|average-remote-loss|rtt|jitter|remote-loss| echo-return-loss}

Parameters
Parameter codec-loss Description Keyword specifying to set the percentage of time the codec plays fill frames due to lack of valid RTP frames. Possible causes include jitter and packet loss. Keyword specifying to set the average codec loss measurement since the beginning of the RTP stream Keyword specifying to set the estimated network RTP packet loss. The VoIP engine evaluates the current received packet loss every RTCP interval usually 5 to 8 seconds. The VoIP engine postpones loss estimation until the next interval if the number of packets received is less than the minimum statistic window. The minimum statistic window is configured with the CLI command rtp-stat min-stat-win. Keyword specifying to set the average packet loss evaluation since the beginning of the RTP stream Keyword specifying to set the network loss according to the remote RTP receiver. The device learns of the remote packet loss from received RTCP messages. Keyword specifying to set the average remote network loss measurement since the beginning of the RTP stream The percent value 0.0-100.0 Possible Values Default Value

average-codec-loss

loss

average-loss

remote-loss

average-remote-loss

percentage

Issue 2 January 2008

413

CLI Commands

RTP statistics

Parameter codec-rtt

Description Keyword specifying to set an estimation of the overall Round Trip Time (RTT) on the voice-channel, including the network delay and internal delays. Round Trip Time is the time taken for a message to get to the remote peer and back to the local receiver. Keyword specifying to set the network RTT. This metric does not include internal delay. The device learns of the RTT from RTCP messages. Keyword specifying to set the variation in delay of packet delivery to the local peer Keyword specifying to set the variation in delay of packet delivery to the remote peer. The device learns of the remote jitter from RTCP messages.

Possible Values

Default Value

rtt

jitter

remote-jitter

milliseconds echo-return-loss db all Keyword specifying to set the echo cancellation loss on the TDM bus The db value Keyword specifying to clear all configured thresholds

0-5000

0-100

User Level
read-write

Context
general

Example
To set the echo return loss threshold to 5 dB:
TGM550-001(super)# rtp-stat threshold echo-return-loss 5

414 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

show rtp-stat config


Use the show rtp-stat config command to display the RTP statistics application configuration.

Syntax
show rtp-stat config

User Level
read-only

Context
general

Example
To display the configuration of the RTP statistics application:
TGM550-001(super)# show rtp-stat config RTP Statistic: Enabled QoS Trap: Enabled QoS Fault Trap: Enabled Fault: 1 Clear: 0 QoS Trap Rate Limiter: Token Interval: 10.00 seconds Bucket Size: 5 Session Table: Size: 128 Reserved: 64 Min Stat Win: 50

Note:

Note: For an explanation of the output fields, see the table describing the output of the show rtp-stat config command in Chapter 10: Configuring monitoring applications on page 179.

Issue 2 January 2008

415

CLI Commands

RTP statistics

show rtp-stat detailed


Use the show rtp-stat detailed command to display a detailed QoS log for a specific RTP session.

Syntax
show rtp-stat detailed session-id

Parameters
Parameter session-id The index of a specific RTP session Description Possible Values Default Value

User Level
read-only

Context
general

Example
To display RTP statistics for RTP session 35:
TGM550-001(super)# show rtp-stat detailed 35 Session-ID: 35 Status: Active, QOS: Faulted, EngineId: 0 Start-Time: 2004-10-20,11:09:07, End-Time: Duration: 00:03:11 CName: gwp@135.8.118.252 Phone: Local-Address: 135.8.118.252:2045 SSRC 154611212 Remote-Address: 135.8.76.107:2061 SSRC 2989801899 (0) Samples: 38 (5 sec) Codec: G723 62B 30mS Off, Silence-suppression(Tx/Rx) Disabled/Not-Supported, Play-Time 186.690sec, Loss 0.0% #1, Avg-Loss 0.1%, RTT 816mS #18, Avg-RTT 463mS, JBuf-under/overruns 0.2%/0.0%, Jbuf-Delay 60mS, Max-Jbuf-Delay 60mS Received-RTP: Packets 6372, Loss 0.0% #0, Avg-Loss 0.0%, RTT 603mS #18, Avg-RTT 267mS, Jitter 0mS #0, Avg-Jitter 0mS, TTL(last/min/max) 63/63/63, Duplicates 0, Seq-Fall 0, DS

416 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

CP 46, L2Pri 12, RTCP 37 Transmitted-RTP: VLAN 1, DSCP 184, L2Pri 6, RTCP 43 Remote-Statistics: Loss 0.0% #0, Avg-Loss 0.0%, Jitter 0mS #0, Avg-Jitter 0mS Echo-Cancellation: Loss 45dB #1, Len 32mS RSVP: Status Disabled, Failures 0

Note:

Note: For an explanation of the output fields, see the table describing the output of the show rtp-stat detailed command in Chapter 10: Configuring monitoring applications on page 179.

show rtp-stat sessions


Use the show rtp-stat sessions command to display a summary of the active and/or terminated RTP sessions in the session table. If no parameters are specified, a summary of all RTP session information is displayed.

Syntax
show rtp-stat sessions [active|active-events|history|events] [destination-ip {remote-subnet remote-subnet-mask}|{host rem-addr}] [last last-N]

Parameters
Parameter active active-events history events Description Keyword specifying to display only active sessions Keyword specifying to display only active sessions experiencing bad QoS conditions Keyword specifying to display only terminated sessions Keyword specifying to display only terminated sessions that experienced bad QoS conditions Keyword specifying to display only sessions to this destination subnet The destination subnet Possible Values Default Value

destination-ip remote-subnet

Issue 2 January 2008

417

CLI Commands

RTP statistics

Parameter remote-subnet-mask host rem-addr last last-N

Description The destination subnet mask Keyword specifying to display only sessions to this specific address The specific IP address Keyword specifying to display only the last N entries in the history The number of entries in the history to display

Possible Values

Default Value

User Level
read-only

Context
general

418 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

Example
To display all RTP sessions:
TGM550-001(super)# show rtp-stat sessions ID QoS Start date and time End Time ----- --- ------------------- -------00001 * 2004-10-15,16:57:48 17:00:15 00002 2004-10-15,16:59:06 17:00:15 00003 * 2004-10-15,17:00:41 17:01:40 00004 * 2004-10-18,10:28:33 10:30:29 00005 * 2004-10-18,10:39:03 10:42:15 00006 * 2004-10-18,10:52:26 10:53:15 00007 * 2004-10-18,10:53:42 10:54:29 00008 * 2004-10-18,10:56:31 10:57:34 00009 2004-10-18,10:57:39 11:02:38 00010 2004-10-18,11:03:13 11:06:07 00011 2004-10-18,11:13:56 11:16:46 00012 2004-10-18,11:13:58 11:16:46 00013 * 2004-10-18,11:18:47 11:19:32 00014 * 2004-10-18,11:18:50 11:19:59 00015 * 2004-10-18,11:20:23 11:20:53 00016 * 2004-10-18,11:21:04 11:21:55 00017 * 2004-10-18,11:22:11 11:23:02 00018 2004-10-18,11:22:42 11:23:02 00019 * 2004-10-18,11:40:12 11:42:10 00020 * 2004-10-18,11:46:43 11:50:33 00021 * 2004-10-18,11:47:07 11:50:33 00022 * 2004-10-18,11:47:27 11:50:31 00023 2004-10-18,11:48:34 11:50:43 00024 2004-10-18,11:48:34 11:50:43 00025 * 2004-10-18,11:54:01 11:55:27 00026 * 2004-10-18,11:54:02 11:55:27 00027 * 2004-10-18,13:43:18 13:54:53 00028 * 2004-10-18,13:56:57 08:40:39 00029 2004-10-19,17:24:00 17:28:10 00030 * 2004-10-19,17:29:06 09:04:04 00031 2004-10-20,10:51:36 10:59:07 00032 * 2004-10-20,10:53:42 10:57:36 00033 * 2004-10-20,10:58:21 10:59:06 00034 2004-10-20,11:08:40 00035 2004-10-20,11:09:07 Type Destination -------- --------------G729 135.8.76.64 G729 135.8.76.62 G723 135.8.76.107 G729 135.8.76.64 G723 135.8.76.107 G729 135.8.76.64 G723 135.8.76.107 G729 135.8.76.64 G729 135.8.76.64 G723 135.8.76.13 G723 135.8.76.35 G723 135.8.76.14 G723 135.8.76.107 G723 135.8.76.107 G723 135.8.76.107 G723 135.8.76.107 G729 135.8.76.64 G729 135.8.76.62 G723 135.8.76.107 G723 135.8.76.107 G723 135.8.76.107 G723 135.8.76.107 G723 135.8.76.35 G723 135.8.76.14 G723 135.8.76.13 G729 135.8.76.62 G723 135.8.76.107 G723 135.8.76.107 G711A 135.8.76.107 G723 135.8.76.107 G729 135.8.76.64 G723 135.8.76.107 G723 135.8.76.107 G729 135.8.76.64 G723 135.8.76.107

Issue 2 January 2008

419

CLI Commands

RTP statistics

To display the last five sessions:


TGM550-001(super)# show rtp-stat sessions last 5 ID QoS Start date and time End Time Type Destination ----- --- ------------------- -------- ------- --------------00031 2004-10-20,10:51:36 10:59:07 G729 135.8.76.64 00032 * 2004-10-20,10:53:42 10:57:36 G723 135.8.76.107 00033 * 2004-10-20,10:58:21 10:59:06 G723 135.8.76.107 00034 2004-10-20,11:08:40 - G729 135.8.76.64 00035 * 2004-10-20,11:09:07 - G723 135.8.76.107

Note:

Note: For an explanation of the output fields, see the explanations in Chapter 10: Configuring monitoring applications on page 179.

show rtp-stat summary


Use the show rtp-stat summary command to display a summary of the RTP statistics.

Syntax
show rtp-stat summary

User Level
read-write

Context
general

Example
To display a summary of the RTP statistics (in this example, there are two active sessions, one with QoS problems (35)):
TGM550-001(super)# show rtp-stat summary Total QoS traps: 23 QoS traps Drop : 0 Qos Fault Engine ID Description --- -------------000 internal

Uptime ----------04,18:15:15

Active Session ------3/1

Total Session ------35/24

Mean Duration -------01:04:44

Tx TTL ---64

420 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

Note:

Note: For an explanation of the output fields, see the table describing the output of the show rtp-stat summary command in Chapter 10: Configuring monitoring applications on page 179.

show rtp-stat thresholds


Use the show rtp-stat thresholds command to display the configured thresholds and event-thresholds for QoS metrics sampled by the RTP statistics application during RTP streams.

Syntax
show rtp-stat thresholds

User Level
read-only

Context
general

Example
To display the configured RTP statistics application thresholds:
TGM550-001(super)# show rtp-stat thresholds Item -------------------Codec Loss Average Codec Loss Codec RTT Echo Return Loss Loss Average Loss Remote Loss Average Remote Loss RTT Local Jitter Remote Jitter SSRC Changes Threshold ------------6.0% 3.0% 700mS 0dB 6.0% 3.0% 6.0% 3.0% 500mS 50mS 50mS N/A Event Threshold ----------------1 N/A 1 1 1 N/A 1 N/A 1 1 1 1

Issue 2 January 2008

421

CLI Commands

RTP statistics

Note:

Note: For an explanation of the output fields, see the table describing the output of the show rtp-stat thresholds command in the Chapter 10: Configuring monitoring applications on page 179.

show rtp-stat traceroute


If the RTP statistics application is enabled (see rtp-stat-service), the TGM550 VoIP engine issues a UDP traceroute for every active RTP session. The traceroute is performed 10 seconds after the session begins. A traceroute is not performed if there is another active session to the same destination for which a traceroute was already performed within the last 5 seconds. Use the show rtp-stat traceroute command to display the automatic session traceroute result. You can filter the results according to subnet address or rtp-statistics session index.

Syntax
Show rtp-stat traceroute [{session session-id] | destination-ip remote-subnet remote-subnet-mask [last Last-N]}]

Parameters
Parameter session-id The index of a specific RTP statistics session remote-subnet remote-subnetmask last The remote subnet address The remote subnet mask Keyword indicating to display only the last N entries in the history The number of entries in the history to display Description Possible Values Default Value

last-N

User Level
read-only

Context
general

422 IG550 Integrated Gateway Administration and CLI Reference

RTP statistics

Example
To display the automatic session traceroute result, filtered by subnet address with remote subnet 10.2.5.0 and remote subnet mask 255.255.255.0:
TGM550-001(super)# show rtp-stat traceroute destination-ip 10.2.5.0 255.255.255.0 Session ID: 1234 From: 123.21.11.5, To: 10.2.4.15, At: 2004-12-26,12:21:55 TTL HOP ADDRESS DELAY --- --------------- -------1 123.21.11.1 2ms 2 212.201.233.102 65ms 3 213.21.51.12 110ms 4 10.2.4.15 175ms Session ID: 1234 From: 123.21.11.5, To: 10.2.4.5, At: 2004-12-26,13:30:15 TTL HOP ADDRESS DELAY --- --------------- -------1 123.21.11.1 2ms 2 212.201.233.102 65ms 3 213.21.51.12 110ms 4 10.2.4.5 145ms

Output fields:
Field Session ID From To At TTL HOP ADDRESS DELAY Description The RTP statistics index for the RTP session The IP address of the TGM550 The IP address of the session destination (in this case, a destination within the specified subnet) The time the traceroute is performed The hop count and TTL field value of probe packets The hop IP address The round trip time per probe packet. Three probe packets are sent per hop address, and the displayed value is the average of the three round-trip times. An asterisk (*) indicates that the probe packets timed out.

Issue 2 January 2008

423

CLI Commands

SAT

SAT
sat
Use the sat command to provide a shortcut method to access the System Access Terminal (SAT) so that Avaya Communication Manager translation work can be performed. See the description for session on page 374 for more information. The server must configure the SAT port to 5023.

Syntax
sat

User Level
read-only

Context
general

Example
To open a connection directly to the Avaya Communication Manager SAT application in the MGC:
TGM550-001(super)# session mgc sat

SLS survivability
sls
Use the sls command to enter the sls context. In this context, you can administer the SLS data set from the TGM550 Telephony Gateway Module CLI. Type exit to leave the sls context. Several second-level subcontexts within the sls context help SLS administration. While in the sls context type these commands to enter the respective subcontexts:

station extension class to enter the station context

424 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

trunk-group tgnum [group-type] to enter the trunk-group context ds1 port-address to enter the ds1 context sig-group sgnum to enter the sig-group context bri port-address to enter the bri context dial-pattern dialed-string to enter the dial-pattern context incoming-routing tgnum mode [pattern length] to enter the incoming-routing context

!
Important:

Important: If you issue this command on a TGM550 with insufficient memory, the sls command aborts and entry into the sls context is denied.

Syntax
sls

User Level
read-write

Context
general

Example
To enter the sls context:
TGM550-001(super)# sls TGM550-001(super-sls)#

set sls
Use the set sls command to enable or disable SLS. Note: If the SLS survivable call engine is currently running, you can issue this command to stop SLS from operating. Note: If you enabled SLS and then entered additional administration, you must first disable SLS and then re-enable it. This will cause the SLS application to resynchronize its administrative database with the gateway's global CLI command database.

Note:

Note:

Issue 2 January 2008

425

CLI Commands

SLS survivability

Syntax
set sls {enable | disable}

Parameters
Parameter enable Keyword indicating to enable SLS Keyword indicating to disable SLS Description Possible Values Default Value

disable

User Level
read-write

Context
general

Example
To enable SLS:
TGM550-001(super-sls)# set sls enable Survivable Call Engine is enabled

show sls
Use the show sls command to display SLS status (enabled or disabled).

Syntax
show sls

User Level
read-write

Context
general

Example
To display SLS status:
TGM550-001(super)# show sls Survivable Call Engine is: enabled

426 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

bri
Use the bri command within the sls context to enter a second-level subcontext for administering ISDN Basic Rate Interface (BRI) for SLS. After issuing this command, the prompt changes to sls-bri <slot-address>. Type exit to leave the bri context, and return to the sls context.

Syntax
bri slot-address

Parameters

Parameter slot-address

Description The physical module address on the gateway as described in Table 65

Possible Values

Default Value

Note:

Note: The BRI slot address must agree with the slot assignment administration (see set slot-config on page 487).

Table 65: Slot and board matrix for SLS Router model J4350/ J6350 J2320 J2350 BRI media module TIM521 TIM521 TIM521 Description Four (4) BRI trunk ports (8 trunks) Four (4) BRI trunk ports (8 trunks) Four (4) BRI trunk ports (8 trunks) Permitted slots v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 SLS configured? Yes Yes Yes

User Level
read-write

Context
sls

Issue 2 January 2008

427

CLI Commands

SLS survivability

Example
To enter the second-level subcontext for administering ISDN BRI for slot address v401:
TGM550-001(super-sls)# bri v401 TGM550-001(sls-bri 401)#

Sub-commands
The following commands are available once you are inside the sls > bri context: BRI sub-commands set bearer-capability set country-protocol set directory-number-a set directory-number-b set endpoint-init set interface set interface-companding set layer1-stable set name set side set spid-a set spid-b set tei-assignment show (bri)

Additional SLS commands


clear bri, set sls, show bri, show sls, sls

set bearer-capability
Use the set bearer-capability command to set the Information Transfer Rate field of the Bearer Capability IE in SLS. Note: This command is only valid for a DS1 or BRI circuit employed with ISDN.

Note:

428 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Syntax
set bearer-cability bearer

Parameters
Parameter bearer Description The Information Transfer Rate field of the Bearer Capability IE. 3khz 3.1kHz audio encoding speech Speech encoding Possible Values 3khz speech Default Value speech

User Level
read-write

Context
sls > ds1 sls > bri

Example
To set the Information Transfer Rate field to speech for DS1:
TGM550-001 (sls-ds1-<port address>)# set bearer-capability speech

To set the Information Transfer Rate field to speech for BRI:


TGM550-001 (sls-bri-<port address>)# set bearer-capability speech

Related DS1 commands


clear ds1, set bearer-capability, set channel-numbering, set connect, set country-protocol, set interface, set interface-companding, set long-timer, set name, set protocol-version, set side, set signaling-mode, set sls, show (ds1), show ds1, show sls, sls

set country-protocol
Use the set country-protocol command to specify the ISDN Layer-3 country protocol type in SLS. Note: This command is only valid for a BRI circuit or DS1 circuit employed with ISDN.

Note:

Syntax
set country-protocol country-code

Issue 2 January 2008

429

CLI Commands

SLS survivability

Parameters
Parameter Description Possible Default Values Value 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 etsi qsig 1

country-code The ISDN Layer-3 country protocol type: 1 United States (AT&T mode, also called 5ESS) 2 Australia (Australia National PRI) 3 Japan 4 Italy 5 Netherlands 6 Singapore 7 Mexico 8 Belgium 9 Saudi Arabia 10 United Kingdom (ETSI) 11 Spain 12 France (ETSI) 13 Germany (ETSI) 14 Czech Republic 15 Russia 16 Argentina 17 Greece 18 China 19 Hong Kong 20 Thailand 21 Macedonia 22 Poland 23 Brazil 24 Nordic countries 25 South Africa etsi ETSI (no use of RESTART message) qsig QSIG

User Level
read-write

Context
sls > ds1 sls > bri

Example
To specify the ISDN Layer-3 country protocol type as Australia:
TGM550-001 (sls-ds1-<port address>)# set country-protocol 2

430 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set directory-number-a
Use the set directory-number-a command to assign a directory number to the B1 channel of the BRI interface in SLS.

!
Important:

Important: This number must be identical to the provisioned number that the network provider has assigned to this circuit.

Note:

Note: This command is valid only for a BRI circuit employed with ISDN.

Syntax
set directory-number-a number

Parameters
Parameter number Description String of 1-10 digits describing the directory number to the B1 channel of the BRI interface Possible Values 0-9 Default Value

User Level
read-write

Context
sls > bri

Example
To assign directory number 3035381000 to the B1 channel of the BRI interface:
TGM550-001(sls-bri <port address>)# set directory-number-a 3035381000

Issue 2 January 2008

431

CLI Commands

SLS survivability

set directory-number-b
Use the set directory-number-b command to assign a directory number to the B2 channel of the BRI interface in SLS.

!
Important:

Important: This number must be identical to the provisioned number that the network provider has assigned to this circuit.

Note:

Note: This command is valid only for a BRI circuit employed with ISDN.

Syntax
set directory-number-b number

Parameters
Parameter number Description String of 1-10 digits describing the directory number to the B2 channel of the BRI interface Possible Values 0-9 Default Value

User Level
read-write

Context
sls > bri

Example
To assign directory number 3035381004 to the B2 channel of the BRI interface:
TGM550-001(sls-bri <port address>)# set directory-number-b 3035381004

set endpoint-init
Use the set-endpoint-init command to determine whether or not the far-end supports endpoint initialization in SLS. Note: This command is valid only for a BRI circuit employed with ISDN.

Note:

432 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Syntax
set endpoint-init {yes | no} Note: The default for this command is no.

Note:

User Level
read-write

Context
sls > bri

Example
To determine that the far-end does not support endpoint initialization:
TGM550-001(sls-bri <port address>)# set endpoint-init no

set interface
Use the set interface command to specify the glare-handling convention for a DS1 or BRI link in SLS. This command also determines the polarity of the ISDN Layer 2 (LAPD) protocol operation. Note: For a DS1 circuit, this command specifies the glare-handling convention for the set connect command that has been administered as pbx at the far-end of the DS1 link. Note: This command is only valid for a DS1 or BRI circuit.

Note:

Note:

Syntax
set interface glare-mode

Issue 2 January 2008

433

CLI Commands

SLS survivability

Parameters
Parameter glare-mode Description The glare-handling convention for a DS1 or BRI link. For non-QSIG calls: network If the gateway is connected to a host computer and encounters glare, it overrides the far-end user If the gateway is connected to a public network and encounters glare, it releases the circuit For QSIG calls: peerMaster SLS overrides the other end when glare occurs peerSlave SLS releases the circuit when glare occurs Possible Values network user peerMaster peerSlave Default Value user

User Level
read-write

Context
sls > ds1 sls > bri

Example
To specify the glare-handling convention as network:
TGM550-001 (sls-ds1-<port address>)# set interface network

set interface-companding
Use the set interface-companding command to set the interface to agree with the companding method used by the far-end of the DS1 circuit for SLS mode.

Syntax
set interface-companding type

434 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter type Description The type of interface to agree the companding method used by the far-end of the DS1 circuit. alaw A-law companding ulaw U-law companding Possible Values alaw ulaw Default Value ulaw

User Level
read-write

Context
sls > ds1 sls > bri Example To set the interface to agree with A-law companding for DS1:
TGM550-001 (sls-ds1-<port address>)# set interface-companding alaw

to set the interface to agree with A-law companding for BRI:


TGM550-001 (sls-bri-<port address>)# set interface-companding alaw

set layer1-stable
Use the set layer1-stable command to determine whether or not to keep the physical layer active (stable) between calls in SLS. Some European countries, France, for example, require that the physical layer is deactivated when there is no active call. Note: This command is valid only for a BRI circuit employed with ISDN.

Note:

Syntax
set layer1-stable {yes | no}

Issue 2 January 2008

435

CLI Commands

SLS survivability

Parameters
Parameter yes Description Keyword specifying to keep the physical layer active between calls. This is the default. Keyword specifying not to keep the physical layer active between calls Possible Values Default Value

no

User Level
read-write

Context
sls > bri

Example
To not keep the physical layer active between calls:
TGM550-001(sls-bri <port address>)# set layer1-stable no

set name
Use the set name command to identify the username for a station, a trunk group, a DS1, or ISDN facility in SLS.

Syntax
set name name

436 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter name Description The name as specified on the corresponding Communication Manager form (add trunk-group n). This name is typically used to identify an individual, a service provider, or a site. If the file name includes spaces, use quotes. The length of the name is: DS1 and BRI: 1 -15 characters station and trunk-group: 1-27 characters Possible Values Default Value

User Level
read-write

Context
sls > station sls > trunk-group sls > ds1 sls > bri

Examples
To set the username Joe Smith for a given station:
TGM550-001 (sls-station-<extension>)# set name Joe Smith

set side
Use the set side command to specify the glare-handling conditions when the set interface command has been administered as peerMaster or peerSlave for the ISDN link in SLS. Note: This command is only valid for ISDN.

Note:

Syntax
set side side

Issue 2 January 2008

437

CLI Commands

SLS survivability

Parameters
Parameter side Description Glare mode Possible Values a b Default Value a

User Level
read-write

Context
sls > ds1 sls >bri

Examples
To set the glare-handling conditions to mode a in DS1:
TGM550-001 (sls-ds1-<port address>)# set side a

To set the glare-handling conditions to mode a in BRI:


TGM550-001 (sls-bri-<port address>)# set side a

set spid-a
Use the set spid-a command to assign a Service Profile Identifier (SPID) to a North American BRI trunk in SLS. The trunk circuit cannot be placed in service unless the SPID initialization is successful. Note: This command is valid only for a BRI circuit employed with ISDN.

Note:

Syntax
set spid-a spid-number

Parameters
Parameter spid-number Description String of 1-14 digits describing the SPID (Service Profile Identifier) to the circuit Possible Values 0-9 Default Value

438 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

User Level
read-write

Context
sls > bri

Example
To assign SPID number 30353810041111 to the B1 channel of a North American BRI trunk:
TGM550-001(sls-bri <port address>)# set spid-a 30353810041111

set spid-b
Use the set spid-b command to assign a Service Profile Identifier (SPID) to a North American BRI trunk in SLS. The trunk circuit cannot be placed in service unless the SPID initialization is successful. Note: This command is valid only for a BRI circuit employed with ISDN.

Note:

Syntax
set spid-b spid-number

Parameters
Parameter spid-number Description String of 1-14 digits describing the SPID (Service Profile Identifier) to the circuit Possible Values 0-9 Default Value

User Level
read-write

Context
sls > bri

Example
To assign SPID number 30353810041111 to the B2 channel of a North American BRI trunk:
TGM550-001(sls-bri <port address>)# set spid-b 30353810041111

Issue 2 January 2008

439

CLI Commands

SLS survivability

set tei-assignment
Use the set tei-assignment command to select the method by which the Layer 2 (LAPD) protocol obtains its Terminal Endpoint Identification (TEI) address in SLS. Note: This command is valid only for a BRI circuit employed with ISDN.

Note:

Syntax
set tei-assignment tei

Parameters
Parameter tei Description The method by which the Layer 2 (LAPD) protocol obtains its Terminal Endpoint Identification (TEI) address in SLS. auto TEI is assigned by the network provider zero TEI is fixed Possible Values auto zero Default Value auto

User Level
read-write

Context
sls > bri

Example
To set the method by which the LAPD protocol obtains its TEI address as automatic:
TGM550-001(sls-bri <port address>)# set tei-assignment auto

show (bri)
Use the show command to list the administered BRI parameters for SLS for this BRI interface port.

Syntax
show

440 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

User Level
read-write

Context
sls > bri

Example
To list all of the subcontext parameters in the bri context:
TGM550-001(sls-bri 401)# show Name = Willow Steet 2 BRI Interface Sid Country Bearer Compand TEI Endpt-Init Layer1-Stable ---- --------- ---- -------- -------- ------- ---- ---------- ------------v401 user a country1 speech ulaw auto yes yes Dir-NumberA Dir-NumberB Spid-A Spid-B ----------- ----------- -------------- -------------3035381002 3035381003 30353810021111 30353810031111

Output fields
Field BRI Interface Description The physical module address The glare-handling convention if the equipment at the far-end of the link has been administered as pbx. Possible values: network (Non-QSIG calls) user (Non-QSIG calls) peerMaster (QSIG calls) peerSlave (QSIG calls) The glare-handling condition if the equipment at the far-end of the link has been administered as peerMaster or peerSlave. Possible values: a b The ISDN Layer-3 country protocol type The Information Transfer Rate field of the Bearer Capability IE. Possible values: 3khz (3.1kHz audio encoding) speech (speech encoding) 1 of 2

Sid

Country Bearer

Issue 2 January 2008

441

CLI Commands

SLS survivability

Field Compand

Description The far-end companding method. Possible values: alaw (A-law companding) ulaw (U-law companding) The method by which the Layer 2 (LAPD) protocol obtains its Terminal Endpoint Identification (TEI) address. Possible values: auto (TEI is assigned by the network provider) zero (TEI is fixed) Whether or not the far-end supports endpoint initialization Whether or not to keep the physical layer active (stable) between calls The directory number to the B1 channel of the BRI interface The directory number to the B2 channel of the BRI interface The Service Profile Identifier (SPID) to a North American BRI trunk The Service Profile Identifier (SPID) to a North American BRI trunk 2 of 2

TEI

Endpt-Init Layer1-Stable Dir-NumberA Dir-NumberB Spid-A Spid-B

clear attendant
Use the clear attendant command to delete attendant provisioning in SLS.

Syntax
clear attendant

User Level
read-write

Context
sls

442 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Example
To delete attendant provisioning:
TGM550-001(super-sls)# clear attendant

clear bri
Use the clear bri command to delete the administration for a given BRI channel in SLS.

Syntax
clear bri slot-address

Parameters

Parameter slot-address

Description The administered slot address

Possible Values

Default Value

User Level
read-write

Context
sls

Example
To delete the administration for BRI channel v401:
TGM550-001(super-sls)# clear bri v401

clear dial-pattern
Use the clear dial-pattern command to delete a single dialed string pattern entry in the SLS data set.

Syntax
clear dial-pattern dialed-string

Issue 2 January 2008

443

CLI Commands

SLS survivability

Parameters
Parameter dialed-string Description Specifies the dialed string pattern Possible Values Any defined dial string pattern. Use show dial-pattern to display defined values. Default Value

User Level
read-write

Context
sls

Example
To delete dialed string pattern entry 49139:
TGM550-001(super-sls)# clear dial-pattern 49139 Dial Pattern 49139 was removed.

clear ds1
Use the clear ds1 command to delete the administration for a specific DS1 channel in SLS.

Syntax
clear ds1 slot-address Note: See ds1 for valid slot address values.

Note:

User Level
read-write

Context
sls

Example
To delete the administration for DS1 channel v4:
TGM550-001(super-sls)# clear ds1 v4

444 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

clear extension
Use the clear extension command to delete a particular extension number in the SLS data set. The extension number that you want to clear must have been previously administered in the station subcontext. Note: It is preferable to use the clear station command, which is equivalent to the clear extension command.

Note:

Syntax
clear extension extnum

Parameters
Parameter extnum Description Specifies the extension number to delete Possible Values 1-13 digit number Default Value

User Level
read-write

Context
sls

Example
To delete extension number 1234:
TGM550-001(super-sls)# clear extension 1234 Extension 1234 was removed.

clear fac
Use the clear fac command to delete an administered Feature Access Code for SLS.

Syntax
clear fac feature

Issue 2 January 2008

445

CLI Commands

SLS survivability

Parameters
Parameter feature Description The type of feature for which the FAC code applies Possible Values ars1 ars2 hold Default Value

User Level
read-write

Context
sls

Example
To delete an administered Feature Access Code for feature contact-open:
TGM550-001(super-sls)# clear fac contact-open Done!

clear incoming-routing
Use the clear incoming-routing command to delete an entry for a particular incoming routed string that is associated with a given trunk group in SLS. This removes administration from the incoming-routing subcontext.

Syntax
clear incoming-routing tgnum mode [pattern length]

446 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter tgnum mode Description ISDN (t1isdn or e1isdn or bri) trunk group number Protocol for receiving incoming digits: enbloc All digits in SETUP message overlap Not all digits available in the SETUP message; some digits delivered in subsequent INFO message Incoming alphanumeric string of 1-16 characters Numeric string of 0-21 digits 0-9 Possible Values 1-2000 enbloc overlap Default Value

pattern length

User Level
read-write

Context
sls

Example
To delete an entry for incoming routed string enbloc protocol associated with trunk group 99:
TGM550-001(super-sls)# clear incoming-routing 99 enbloc

clear sig-group
Use the clear sig-group command to delete the administration for a given ISDN signaling group in SLS.

Syntax
clear sig-group sgnum

Parameters
Parameter sgnum Description Signaling group number Possible Values 1-650 Default Value

Issue 2 January 2008

447

CLI Commands

SLS survivability

User Level
read-write

Context
sls

Example
To delete the administration for ISDN signaling group 99:
TGM550-001(super-sls)# clear sig-group 99

clear slot-config
Use the clear slot-config command to delete the slot configuration administration in the media gateway for SLS.

Syntax
clear slot-config slot-number

Parameters
Parameter slot-number Description Identifies the slot number Possible Values The slot number must correspond to Table 67: Slot and board matrix for SLS on page 487 Default Value

Note:

Note: If either trunk or station ports have been previously administered for the media module in this slot, you must remove the port administration (remove port) first before removing the slot-configuration administration.

User Level
read-write

448 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls

Example
To delete the slot configuration administration for slot v1 in the media gateway:
TGM550-001 (super-sls)# clear slot-config v1

clear station
Use the clear station command to delete a particular extension number in the SLS data set. The extension number that you want to clear must have been previously administered in the station subcontext.

Syntax
clear station extension

Parameters
Parameter extension Description 1-13 digit number which specifies the extension number to delete Possible Values 0-9 Default Value

User Level
read-write

Context
sls

Example
To delete station extension number 1234:
TGM550-001(super-sls)# clear station 1234 Station 1234 was removed.

Issue 2 January 2008

449

CLI Commands

SLS survivability

clear survivable-config
Use the clear survivable-config command to set the SLS parameters to their default values.

Syntax
clear survivable-config

User Level
read-write

Context
sls

Example
To set the SLS parameters to their default values:
TGM550-001(super-sls)# clear survivable-config Survivable Configuration is cleared

clear trunk-group
Use the clear trunk-group command to delete a trunk group entry from the SLS data set. Note: The trunk group must have already been administered with the trunk-group command before this command will work.

Note:

Syntax
clear trunk-group tgnum

Parameters
Parameter tgnum Description Specifies the trunk group to delete Possible Values 1-2000 Default Value

User Level
read-write

450 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls

Example
To delete trunk group entry 13:
TGM550-001(super-sls)# clear trunk-group 13 Trunk group 13 was removed.

dial-pattern
Use the dial-pattern command within the sls context to enter a second-level subcontext for administering ARS dial patterns for SLS. After issuing this command, the prompt changes to sls-dial-pattern <dialed-string>. Type exit to leave the dial-pattern context, and return to the sls context.

Syntax
dial-pattern dialed string

Parameters

Parameter dialed string

Description The dialed string. It can contain a maximum of 28 characters. You can configure a maximum of 30 patterns.

Possible Values 0-9, '*' and 'X' or 'x' as a pre-string or mid-string replacement. 'X' or x cannot be used at the end of a dialed string.

Default Value

User Level
read-write

Context
sls

Example
To enter the subcontext for dial-pattern 91:
TGM550-001(super-sls)# dial-pattern 91 TGM550-001(sls-dial-pattern 91)#

Issue 2 January 2008

451

CLI Commands

SLS survivability

Sub-commands
The following commands are available once you are inside the sls > dial-pattern context: Dial-pattern sub-commands set delete-digits set deny set insert-digits (dial-pattern) set max-length set min-length set tgnum set type (dial-pattern) show (dial-pattern)

Additional SLS commands


clear dial-pattern, set sls, show dial-pattern, show sls, sls

set delete-digits
Use the set delete-digits command to specify the number of digits to be deleted from the beginning of the dialed string for an outbound call in SLS.

Syntax
set delete-digits del-number

Parameters
Parameter del-number Description The number of digits to delete from the beginning of the dialed string Possible Values 0-28 Default Value 0

User Level
read-write

452 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls > dial-pattern

Example
To specify that 1 digit be deleted from the beginning of the dialed string for an outbound call:
TGM550-001(sls-dial-pattern <dialed-string>)# set delete-digits 1

set deny
Use the set deny command to permit or deny access to an outbound trunk in SLS.

Syntax
set deny {yes | no} Note: The default value is no (access permitted).

Note:

User Level
read-write

Context
sls > dial-pattern

Example
To prevent a station from originating an outgoing analog loop-start trunk call:
TGM550-001(sls-dial-pattern <dialed-string>)# set deny yes Done!

set insert-digits (dial-pattern)


Use the set insert-digits command to specify the digits to be inserted at the beginning of the dialed string for an outbound call in SLS.

Syntax
set insert-digits digits

Issue 2 January 2008

453

CLI Commands

SLS survivability

Parameters
Parameter digits Description 0-36 digits/special characters to insert at the beginning of the dialed string. Note: The special character , (comma) designates that a pause of "X" seconds is to be sent between the digits that are being transmitted out to the PSTN facility. The value of "X" has a default of 1.5 seconds in Avaya Communication Manager administration. This setting may be changed. You may not insert , as the first character in the dialed string. In addition, you can use , only on analog and non-ISDN digital trunks. Possible Values " " (no digits inserted) 0-9 plus * , #, and , Default Value ""

User Level
read-write

Context
sls > dial-pattern

Examples
To insert the digits "9719" to the dialed string:
TGM550-001(super-sls-incoming-routing <tgnum>)# set insert-digits 9719

To remove the digit-treatment (removes data administered with set insert-digits (dial-pattern)):
TGM550-001(super-sls-incoming-routing <tgnum>)# set insert-digits ""

set max-length
Use the set max-length command to establish the maximum length of the dialed string in SLS.

Syntax
set max-length length

454 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter length Description A numeric value equal to the maximum dialed-string value (see dial-pattern) Possible Values 1-28 Default Value The number of digits set by the dial-pattern command.

User Level
read-write

Context
sls > dial-pattern

Example
To set the maximum length of the dialed string to 10:
TGM550-001(sls-dial-pattern <dialed-string>)# set max-length 10

set min-length
Use the set min-length command to establish the minimum length of the dialed string in SLS. Note: The maximum length must be set using set max-length prior to setting the minimum length if the minimum length is longer than the default value.

Note:

Syntax
set min-length length

Parameters
Parameter length Description A numeric value equal to the minimum dialed-string value (see dial-pattern) and a maximum value equal to the number of dialed digits established by the set max-length command Possible Values 1-28 Default Value The number of digits set by the dial-pattern command

Issue 2 January 2008

455

CLI Commands

SLS survivability

User Level
read-write

Context
sls > dial-pattern

Example
To set the minimum length of the dialed string to 7:
TGM550-001(sls-dial-pattern <dialed-string>)# set min-length 7

set tgnum
Use the set tgnum command to designate the trunk-group number in SLS.

Syntax
set tgnum tgnum

Parameters
Parameter tgnum Description The trunk group number Possible Values 1-2000 Default Value

User Level
read-write

Context
sls > dial-pattern

Example
To designate the trunk-group number as 99:
TGM550-001(sls-dial-pattern <dialed-string>)# set tgnum 99

456 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set type (dial-pattern)


Use the set type command to administer the type of outbound call in SLS. The SLS call-engine uses the dial pattern as part of its ARS routing for outbound trunk calls.

Syntax
set type dial-type

Parameters
Parameter dial-type Description The dial pattern as part of its ARS routing for outbound trunk calls. emer Emergency call fnpa 10-digit North American Numbering Plan (NANP) call hnpa 7-digit NANP call intl Public-network international number call iop International operator call locl Public-network local number call natl Non-NANP call op Operator assisted call svc Service call Possible Values emer fnpa hnpa intl iop locl natl op svc Default Value

SLS uses the dial-pattern field as part of its ARS routing for station dialed calls that are to be directed to the other stations and to make outbound trunk calls. Make sure to synchronize your choice of station COR and dial-plan dial-type. The following figure illustrates the relationship between the dial-type value and the set cor value (configured in station context). Note the following:

The outer boundary of a stations COR class inherit all the properties of the class symbols encompassed by this class. For example, the 'Local' COR class is also able to dial the 'Emergency' COR. COR set to 'Emergency' is the most restricted class. If a station's COR is set to this mode, the only calls that are allowed are those which have an "emergency" type identified in the ARS Analysis table. COR set to 'Internal' enables the station to place calls to other stations supported by this gateway. The station is also able to dial calls that match dial patterns with dial-type set to 'emergency'. COR set to 'Local' enables the station to place calls that match dial patterns with dial-types set to 'local', 'operator', 'service', or 'hnpa'. In addition, the station may place calls to the 'Emergency' and 'Internal' classes.

Issue 2 January 2008

457

CLI Commands

SLS survivability

COR set to 'Toll' enables the station to place calls that match dial patterns with dial-types set to 'fnpa' and 'natl'. In addition, the station may place calls to the 'Emergency', 'Internal', and 'Local' classes. COR set to 'Unrestricted' enables the station to place calls to any dial patterns that are not explicitly labeled as 'denied' class within the ARS Analysis table. This class of COR effectively inherits the call permission properties of all the other classes. The Emergency Transfer Relay (ETR) mode is basically equivalent to the 'Unrestricted' class. When power is lost and the gateway enters ETR mode, the station port is directly connected to the trunk port and receives central office dial tone directly. This ETR station port may dial any number that the central office dialing plan affords for this analog trunk.

Station <cor>

Dial-Plan <type>
Emergency intra-switch calls (default) local (public-network local number call), operator, service, or hnpa (7-digit NANP call)

Emergency

Internal Local (In-Country) Toll Unrestricted and ETR

fnpa (10-digit NANP call) or (1 + 10-digit NAMP) or natl (non-NANP call) International, or IOP (International op)

User Level
read-write

Context
sls > dial-pattern

Example
To designate the type of outbound call as a public-network local number call:
TGM550-001(sls-dial-pattern <dialed-string>)# set type locl

458 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

show (dial-pattern)
Use the show command to list all dial-pattern strings in the SLS data set in tabular format.

Syntax
show

User Level
read-write

Context
sls > dial-pattern

Example
To list all dial-pattern strings in tabular format:
TGM550-001(sls-dial-pattern 91)# show Dialed-String/Deny Min/Max Type Trunk Delete/Insert Length Group Digits ------------------ ------- ---- ----- -----------------------------------95381000/n 9/9 locl 2 1/303

Output fields
Field Dialed-String/Deny Min/Max Length Type Description The administered ARS dial string and whether the call should be permitted (n) or denied (y) The minimum and maximum number of digits in the dial string The type of dial string. Possible types include: emer emergency call fnpa 10-digit NANP call hnpa 7-digit NANP call intl public-network international number call iop international operator call locl public-network local number call natl non-NANP call op operator svc service 1 of 2

Issue 2 January 2008

459

CLI Commands

SLS survivability

Field Trunk group Delete/Insert Digits

Description The trunk-group number The number of digits to add or remove from a dialed string 2 of 2

ds1
Use the ds1 command within the sls context to enter a second-level subcontext for administering DS1 trunks for SLS. After issuing this command, the prompt changes to sls-ds1-<port-address>. Type exit to leave the DS1 context, and return to the sls context.

Syntax
ds1 slot-address

Parameters

Parameter slot-address

Description The physical module address on the gateway, as described in Table 66

Possible Values

Default Value

Note:

Note: The DS1 port address must agree with the slot assignment administration (see set slot-config on page 487).

Table 66: Slot and board matrix for SLS J-series router model J4350/ J6350 J2320 J2350 BRI Media Module TIM510 TIM510 TIM510 Description Permitted slots v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 SLS configured? Yes Yes Yes

One T1/E1 trunk port One T1/E1 trunk port One T1/E1 trunk port

460 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

User Level
read-write

Context
sls

Example
To enter the subcontext for administering DS1 trunks for SLS at the port address v4:
TGM550-001 (super-sls)# ds1 v4 TGM550-001 (sls-ds1-<v4>)#

Sub-commands
The following commands are available once you are inside the sls > ds1 context: DS1 sub-commands set bearer-capability set bit-rate set channel-numbering set connect set country-protocol set interface set interface-companding set long-timer set name set protocol-version set side set signaling-mode show (ds1)

Additional SLS commands


set sls, show ds1, show sls, sls

Issue 2 January 2008

461

CLI Commands

SLS survivability

set bearer-capability
Use the set bearer-capability command to set the Information Transfer Rate field of the Bearer Capability IE in SLS. Note: This command is only valid for a DS1 or BRI circuit employed with ISDN.

Note:

Syntax
set bearer-cability bearer

Parameters
Parameter bearer Description The Information Transfer Rate field of the Bearer Capability IE: 3khz 3.1kHz audio encoding speech Speech encoding Possible Values 3khz speech Default Value speech

User Level
read-write

Context
sls > ds1 sls > bri

Example
To set the Information Transfer Rate field to speech for DS1:
TGM550-001 (sls-ds1-<port address>)# set bearer-capability speech

To set the Information Transfer Rate field to speech for BRI:


TGM550-001 (sls-bri-<port address>)# set bearer-capability speech

462 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set bit-rate
Use the set bit-rate command to set the maximum transmission rate for the DS1 facility in SLS. Note: This command is only valid for DS1. If this command is invoked to change the transmission rate and the DS1 facility and associated signaling group have already been provisioned, the command is blocked and a warning message, "Administrative change is in violation with existing trunk member provisioning", is displayed.

Note:

Syntax
set bit-rate rate

Parameters
Parameter rate Description The maximum transmission rate for the DS1 facility: 1544 Sets the transmission rate at 1.544 Mbps (T1) 2048 Sets the transmission rate at 2.048 Mbps (E1) Possible Values 1544 2048 Default Value 1544

User Level
read-write

Context
sls > ds1

Example
To set the maximum transmission rate to 2.048 Mbps:
TGM550-001 (sls-ds1-<port address>)# set bit-rate 2048

Issue 2 January 2008

463

CLI Commands

SLS survivability

set channel-numbering
Use the set channel-numbering command to select the channel-numbering method for B-channels on an E1 interface in SLS.

Syntax
set channel-numbering method

Parameters
Parameter method Description The channel-numbering method for B-channels on an E1 interface: seq Sequential codes of B-channels 1-30 in the ISDN Channel Identification IE tslot Timeslot method Possible Values seq tslot Default Value tslot

User Level
read-write

Context
sls > ds1

Example
To select the channel-numbering method for B-channels to seq:
TGM550-001 (sls-ds1-<port address>)# set channel-numbering seq

set connect
Use the set connect command to specify the equipment at the far-end of the DS1 link in SLS.

Syntax
set connect far-end

464 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter far-end Description The equipment at the far-end of the DS1 link: host Data application (computer or server) lineside Terminal equipment (video multiplexer) network Central office pbx Private communication system (another pbx) Possible Values host lineside network pbx Default Value network

User Level
read-write

Context
sls > ds1

Example
To specify that the central office is at the far-end of the DS1 link:
TGM550-001 (sls-ds1-<port address>)# set connect network

set country-protocol
Use the set country-protocol command to specify the ISDN Layer-3 country protocol type in SLS. Note: This command is only valid for a BRI circuit or DS1 circuit employed with ISDN.

Note:

Syntax
set country-protocol country-code

Issue 2 January 2008

465

CLI Commands

SLS survivability

Parameters
Parameter Description Possible Default Values Value 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 etsi qsig 1

country-code The ISDN Layer-3 country protocol type: 1 United States (AT&T mode, also called 5ESS) 2 Australia (Australia National PRI) 3 Japan 4 Italy 5 Netherlands 6 Singapore 7 Mexico 8 Belgium 9 Saudi Arabia 10 United Kingdom (ETSI) 11 Spain 12 France (ETSI) 13 Germany (ETSI) 14 Czech Republic 15 Russia 16 Argentina 17 Greece 18 China 19 Hong Kong 20 Thailand 21 Macedonia 22 Poland 23 Brazil 24 Nordic countries 25 South Africa etsi ETSI (no use of RESTART message) qsig QSIG

User Level
read-write

Context
sls > ds1 sls > bri

Example
To specify the ISDN Layer-3 country protocol type as Australia:
TGM550-001 (sls-ds1-<port address>)# set country-protocol 2

466 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set interface
Use the set interface command to specify the glare-handling convention for a DS1 or BRI link in SLS. This command also determines the polarity of the ISDN Layer 2 (LAPD) protocol operation. Note: For a DS1 circuit, this command specifies the glare-handling convention for the set connect command that has been administered as pbx at the far-end of the DS1 link. Note: This command is only valid for a DS1 or BRI circuit.

Note:

Note:

Syntax
set interface glare-mode

Parameters
Parameter glare-mode Description The glare-handling convention for a DS1 or BRI link. For non-QSIG calls: network If the gateway is connected to a host computer and encounters glare, it overrides the far-end user If the gateway is connected to a public network and encounters glare, it releases the circuit For QSIG calls: peerMaster SLS overrides the other end when glare occurs peerSlave SLS releases the circuit when glare occurs Possible Values network user peerMaster peerSlave Default Value user

User Level
read-write

Context
sls > ds1 sls > bri

Issue 2 January 2008

467

CLI Commands

SLS survivability

Example
To specify the glare-handling convention as network:
TGM550-001 (sls-ds1-<port address>)# set interface network

set interface-companding
Use the set interface-companding command to set the interface to agree with the companding method used by the far-end of the DS1 circuit for SLS mode.

Syntax
set interface-companding type

Parameters
Parameter type Description The interface to agree with the companding method used by the far-end of the DS1 circuit: alaw A-law companding ulaw U-law companding Possible Values alaw ulaw Default Value ulaw

User Level
read-write

Context
sls > ds1 sls > bri

Example
To set the interface to agree with A-law companding for DS1:
TGM550-001 (sls-ds1-<port address>)# set interface-companding alaw

to set the interface to agree with A-law companding for BRI:


TGM550-001 (sls-bri-<port address>)# set interface-companding alaw

468 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set long-timer
Use the set long-timer command to increase the duration of the T303 (call establishment) timer in SLS.

Syntax
set long-timer {yes | no}

Parameters
Parameter yes no Description Keyword specifying to extend the T303 timer from 4 seconds to 13 seconds Keyword specifying that the T303 timer remain at 4 seconds. This is the default. Possible values Default value

User Level
read-write

Context
sls > ds1

Example
To extend the T303 timer to 13 seconds:
TGM550-001 (sls-ds1-<port address>)# set long-timer yes

set name
Use the set name command to identify the username for a station, a trunk group, a DS1, or ISDN facility in SLS.

Syntax
set name name

Issue 2 January 2008

469

CLI Commands

SLS survivability

Parameters
Parameter name Description The name as specified on the corresponding Communication Manager form (add trunk-group n). This name is typically used to identify an individual, a service provider, or a site. If the file name includes spaces, use quotes. The length of the name is: DS1 and BRI: 1 -15 characters station and trunk-group: 1-27 characters Possible Values Default Value

User Level
read-write

Context
sls > station sls > trunk-group sls > ds1 sls > bri

Examples
To set the username Joe Smith for a given station:
TGM550-001 (sls-station-<extension>)# set name Joe Smith

set protocol-version
Use the set protocol-version command for countries whose public networks allow for multiple ISDN Layer-3 country protocols for ISDN Primary Rate service in SLS. Note: This command is only valid for a DS1 circuit employed with ISDN.

Note:

Syntax
set protocol-version option

470 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter option Description The ISDN Layer-3 country protocols for ISDN Primary Rate service. Note: The combination of the country and the protocol versions must match (see set country-protocol). For Country 1 (United States): - a AT&T mode (also known as 5ESS) - b National ISDN-1 - c Nortel mode (also known as DMS) - d Telecordia (NI-2) For Country 2 (Australia): - a Australia National PRI - b ETSI - c invalid - d invalid For Country 10 (United Kingdom): - a DASS - b ETSI - c invalid - d invalid For Country 12 (France) - a French National PRI - b ETSI - c invalid - d invalid For Country 13 (Germany): - a German National PRI - b ETSI - c invalid - d invalid For ETSI: - a Full message set, including RESTART - b No RESTART message - c invalid - d invalid Possible Values a b c d Default Value a

User Level
read-write

Context
sls > ds1

Issue 2 January 2008

471

CLI Commands

SLS survivability

Example
To set the ISDN Layer-3 protocols relative to the country specified by set country-protocol to option a:
TGM550-001 (sls-ds1-<port address>)# set protocol-version a

set side
Use the set side command to specify the glare-handling conditions when the set interface command has been administered as peerMaster or peerSlave for the ISDN link in SLS. Note: This command is only valid for ISDN.

Note:

Syntax
set side side

Parameters
Parameter side Description Glare mode Possible Values a b Default Value a

User Level
read-write

Context
sls > ds1 sls > bri

Examples
To set the glare-handling conditions to mode a in DS1:
TGM550-001 (sls-ds1-<port address>)# set side a

To set the glare-handling conditions to mode a in BRI:


TGM550-001 (sls-bri-<port address>)# set side a

472 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set signaling-mode
Use the set signaling-mode command to set the signaling mode for the DS1 facility in SLS. Note: This command is only valid for DS1. If this command is invoked to change the transmission rate and the DS1 facility and associated signaling group have already been provisioned, the command is blocked and a warning message, "Administrative change is in violation with existing trunk member provisioning", is displayed.

Note:

Syntax
set signaling-mode mode-type

Parameters
Parameter mode-type Description The signaling mode for the DS1 facility. cas Out-of-band signaling for E1 service, yielding thirty 64kbps B-channels for voice transmission robbedbit In-band signaling for T1 service, yielding twenty-four 56kbps B-channels for voice transmission idsnpri Use this setting for either T1 or E1 ISDN Primary Rate service (supports both FAS and NFAS) isdnext NFAS T1 or E1 ISDN service for: - T1 facility in which all 24 channels are for bearer transport - E1 facility in which all 31 channels are for bearer transport Possible Values cas robbedbit idsnpri isdnext Default Value idsnpri

User Level
read-write

Context
sls > ds1

Issue 2 January 2008

473

CLI Commands

SLS survivability

Example
To set the signaling mode for the DS1 facility to PRI:
TGM550-001 (sls-ds1-<port address>)# set signaling-mode isdnpri

show (ds1)
Use the show command to list the administered DS1 parameters for SLS for this trunk interface.

Syntax
show

User Level
read-write

Context
sls > ds1

Example
To list the administered DS1 parameters for this trunk interface:
TGM550-001(sls-ds1-<port address>)# show Name = Willow Steet DS1 Rate Signaling Channel ---- ---- --------- ------v4 1544 isdnpri seq 2 Connect Interface Side Protocol Ver Bearer Cmpd Ltm ------- --------- ---- -------- --- ------ ---- --network user a country1 a speech ulaw no

Output fields
Field DS1 Rate Description The physical module address on the gateway The maximum transmission rate for the DS1 facility. Possible values: 1.544 Mbps (T1) 2.048 Mbps (E1) 1 of 3

474 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Field Signaling

Description The signaling mode for the DS1 facility. Possible values: cas robbedbit idsnpri isdnextshowmgc The channel-numbering method for B-channels on an E1 interface. Possible values: seq (sequential codes of B-channels 1-30 in the ISDN Channel Identification IE) tslot (timeslot method) The equipment at the far-end of the DS1 link. Possible values: host (data application computer or server) lineside (terminal equipment video multiplexer) network (central office) pbx (private communication system another pbx) The glare-handling convention if the equipment at the far-end of the link has been administered as pbx. Possible values: network (Non-QSIG calls) user (Non-QSIG calls) peerMaster (QSIG calls) peerSlave (QSIG calls) The glare-handling condition if the equipment at the far-end of the link has been administered as peerMaster or peerSlave. Possible values: a b The ISDN Layer-3 country protocol type The protocol version, for countries whose public networks allow for multiple ISDN Layer-3 country protocols for ISDN Primary Rate service The Information Transfer Rate field of the Bearer Capability IE. Possible values: 3khz (3.1kHz audio encoding) speech (speech encoding) 2 of 3

Channel

Connect

Interface

Side

Protocol Ver

Bearer

Issue 2 January 2008

475

CLI Commands

SLS survivability

Field Cmpd

Description The far-end companding method. Possible values: alaw (A-law companding) ulaw (U-law companding) Whether to increase the duration of the T303 (call establishment) timer. Possible values: yes (the T303 timer is extended from 4 seconds to 13 seconds) no (the T303 timer remains at 4 seconds) 3 of 3

Ltm

incoming-routing
Use the incoming-routing command within the sls context to enter a second-level subcontext for administering digit-treatment for incoming routed calls in SLS. After issuing this command, the prompt changes to sls-incoming-routing <tgnum>. Type exit to leave the incoming-routing context, and return to the sls context.

Syntax
incoming-routing tgnum mode [pattern length]

Parameters
Parameter tgnum mode Description ISDN (t1isdn or e1isdn) trunk group number Protocol for receiving incoming digits: enbloc All digits in SETUP message overlap Not all digits available in the SETUP message; some digits delivered in subsequent INFO message Incoming alphanumeric string of 0-16 characters. If you do not enter a pattern, this is interpreted as a wild card entry. The length of the received dialed string, expressed as a numeric string of 0-21 digits 0-9 Possible Values 1-2000 enbloc* overlap Default Value

pattern

length

476 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

* Each entry must be an enbloc match-pattern entry. If you administer the mode as enbloc, you may use the set insert-digits (dial-pattern) command to administer the inserted dial string, and the set delete-digits command to administer the number of digits to be deleted from the received digit string. There is a maximum of 50 entries for enbloc receiving mode. Either the set delete-digits or the set insert-digits subcommand is available for overlap, however both of these commands cannot be optioned for the same trunk group. That is, you can either delete or insert digits, not both. There is a maximum of one entry for overlap receiving mode. This field applies only if the mode is set to enbloc.

User Level
read-write

Context
sls

Example
To enter the subcontext for administering digit-treatment for incoming routed calls in SLS for ISDN trunk group 99 with enbloc protocol:
TGM550-001(super-sls)# incoming-routing 99 enbloc TGM550-001(super-sls-incoming-routing 99)#

Sub-commands
The following commands are available once you are inside the sls >incoming-routing context: Incoming-routing sub-commands set delete-digits set insert-digits (dial-pattern) set length set match-pattern show (incoming-routing)

Additional SLS commands


clear incoming-routing, set sls, show incoming-routing, show sls, sls

Issue 2 January 2008

477

CLI Commands

SLS survivability

set delete-digits
Use the set delete-digits command to specify number of digits to be deleted from the beginning of the dialed string for an inbound trunk call in SLS.

!
Important:

Important: This command is required to complete the incoming-routing administration in which the mode is set to enbloc. The command is optional when the mode is set to overlap.

Syntax
set delete-digits count

Parameters
Parameter count Description The number of digits to be deleted from the beginning of the dialed string. This number ranges from 0 to the maximum length of the received dialed string. Possible Values 0-21 Default Value 0

User Level
read-write

Context
sls > incoming-routing

Example
To specify that 1 digit be deleted from the beginning of the dialed string for an inbound trunk call:
TGM550-001(super-sls-incoming-routing <tgnum>)# set delete-digits 1

478 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set insert-digits (incoming-routing)


Use the set insert-digits command to specify number of digits to be inserted at the beginning of the dialed string for an inbound trunk call in SLS.

!
Important:

Important: This command is required to complete the incoming-routing administration in which the mode is set to enbloc. The command is optional when the mode is set to overlap.

Syntax
set insert-digits digits

Parameters
Parameter digits Description 0-16 digits/special characters to insert at the beginning of the dialed string Possible Values " " (no digits inserted) 0-9 plus * and # Default Value ""

User Level
read-write

Context
sls > incoming-routing

Examples
To insert the digits "9719" to the dialed string:
TGM550-001(sls-dial-pattern <dialed-string>)# set insert-digits 9719

To remove the digit-treatment (removes data administered with set insert-digits (incoming-routing)):
TGM550-001(sls-dial-pattern <dialed-string>)# set insert-digits ""

Issue 2 January 2008

479

CLI Commands

SLS survivability

set length
Use the set length command to specify the length of the dialed string in SLS. Note: There is an actual service offered in some public networks, such as in Japan, where the ISDN Called Party Number IE's 'Number Digits' table entry in octet 4 has no information. In order to program the Incoming Routing Table to handle this case, the pattern field in set match-pattern should be set to "", and the length field in set length should be set to "0". This indicates that there has been a successful match, and that the digits field in set insert-digits will be used to provide the destination number so that the SLS dial plan may route this incoming call.

Note:

Syntax
set length length

Parameters
Parameter length Description The length of the dialed string, expressed as a numeric string of 0-21 digits. If the pattern field in set match-pattern is set to the empty string (wild card), then this length field may be set to 0 to designate a wild card. A wild card designation means that a received digit string of any length (0 to 21 digits) may constitute a length field match. Possible Values 0-9 Default Value 0

User Level
read-write

Context
sls > incoming-routing

Example
To set the dialed string length to 7 digits:
TGM550-001(super-sls-incoming-routing <tgnum>)# set length 7

480 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set match-pattern
Use the set match-pattern command to specify the beginning digit pattern of the incoming alphanumeric dial string to be matched against in SLS.

Syntax
set match-pattern pattern

Parameters
Parameter pattern Description Incoming alphanumeric string of 0-16 characters. The empty string entry ("") means that any incoming dial pattern may be used to satisfy a correct pattern match for this row entry. Possible Values "" (empty string) Alphanumeric characters Default Value

User Level
read-write

Context
sls > incoming-routing

Example
To specify that alphanumeric dial string 234 be matched against:
TGM550-001(super-sls-incoming-routing <tgnum>)# set match-pattern 234

show (incoming-routing)
Use the show command to display all of the administered dial patterns in SLS.

Syntax
show

User Level
read-write

Issue 2 January 2008

481

CLI Commands

SLS survivability

Context
sls > incoming-routing

Example
To display all the administered dial patterns in SLS:
TGM550-001(super-sls-incoming-routing 99)# show Match-pattern Length Del Insert-Digits Mode tgnum ------------------ ------ --- ------------------ ------- ----234 7 3 5381000 enbloc 99

Output fields
Field Match-pattern Length Del Insert-Digits Mode Description The beginning digit pattern of the incoming alphanumeric dial string to be matched The length of the dialed string The number of digits to be deleted from the beginning of the dialed string for an inbound trunk call The number of digits to be inserted from the beginning of the dialed string for an inbound trunk call The protocol for receiving incoming digits. Possible values: enbloc (all digits in SETUP message) overlap (not all digits available in the SETUP message; some digits delivered in subsequent INFO message) The ISDN (t1isdn or e1isdn) trunk group number

tgnum

set attendant
Use the set attendant command to set an attendant access code for the purpose of call routing in SLS. Incoming trunk calls that have dialed strings that can not be completely routed, are routed by SLS to this attendant position. In addition, stations in the branch office may directly dial this attendant using the access-code.

Syntax
set attendant access-code extension

482 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter access-code extension Description The dial access code which is recognized as the attendant feature The station serving as the branch office attendant position. You must enter an extension that was previously administered using the station command. Possible Values 1-3 digit string 1-13 digit string Default Value

User Level
read-write

Context
sls

Example
To set the station with extension number 23456 as the attendant station, with access-code 00:
TGM550-001(super-sls)# set attendant 00 23456

set date-format
Use the set date-format command to set a date format for the SLS data set. The default date format is mm/dd/yy.

Syntax
set date format {mm/dd/yy | dd/mm/yy | yy/mm/dd}

User Level
read-write

Context
sls

Example
To set the date format to dd/mm/yy:
TGM550-001(super-sls)# set date-format dd/mm/yy Date Format is dd/mm/yy

Issue 2 January 2008

483

CLI Commands

SLS survivability

set fac
Use the set fac command to administer the Feature Access Code for SLS. Note: If you are on an active call and issue this command, you will enter the hard hold state. If you issue the command again, you will return to the active call.

Note:

Syntax
set fac feature fac

Parameters
Parameter feature Description The type of feature for which the FAC code applies Possible Values ars1 ars2 hold 0-9 plus * and # as leading characters only Default Value

fac

The unique, 1 to 4 digit dial-string identifier that specifies the feature. Note: Rotary-dial, analog phones do not support * and #.

User Level
read-write

Context
sls

Example
To administer an ars1 FAC specified by dial-string *88:
TGM550-001(super-sls)# set fac ars1 *88 Done!

484 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set ip-codec-set
Use the set ip-codec-set command to configure an IP codec set within the SLS data set. Note: When you use this command, silence is set to no, and the frame size is set to 20 mSec.

Note:

Syntax
set ip-codec-set codec

Parameters
Parameter codec Description Codec type Possible Values g.711mu g.711a Default Value

User Level
read-write

Context
sls

Example
To configure IP codec set g.711mu within the SLS data set:
TGM550-001(super-sls)# set ip-codec-set g.711mu IP codec g.711mu is set

set max-ip-registrations
Use the set max-ip-registrations command to configure the maximum number of IP registrations allowed in the SLS data set.

Syntax
set max-ip-registrations number

Issue 2 January 2008

485

CLI Commands

SLS survivability

Parameters
Parameter number Description Maximum number of IP registrations Possible Values 1-100 Default Value 75

User Level
read-write

Context
sls

Example
To set the maximum number of IP registrations to 10:
TGM550-001(super-sls)# set max-ip-registrations 10 Maximum IP Registrations is set to 10

set pim-lockout
Use the set pim-lockout command to prevent or enable Provisioning and Installation Manager (PIM) updates while you are working on SLS administration or the gateway.

Syntax
set pim-lockout {yes | no}

Parameters
Parameter yes no Description Keyword specifying to prevent PIM updates Keyword specifying to enable PIM updates. This is the default. Possible Values Default Value

User Level
read-write

486 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls

Example
To prevent PIM updates:
TGM550-001(super-sls)# set pim-lockout yes

set slot-config
Use the set slot-config command to define the slot and the board type in the media gateway for SLS.

Syntax
set slot-config slot-number board-type

Parameters
Parameter slot-number board-type Description Identifies the slot number See Table 67 Defines the allowable board type Possible Values Default Value

Table 67: Slot and board matrix for SLS Media Module TGM550 Description Central processing and resources. Note: Only 1 allowed per system. This board also provides two analog trunk ports (ports #1 and #2) and two analog station ports (ports #3 and #4). J-series router model J4350/J6350 J2320 J2350 Permitted slots v1 (recommended), v2, v3, v4, v5, v6 v1 (recommended), v2, v3 v1 (recommended), v2, v3, v4, v5 SLS configured? Yes Yes Yes 1 of 2

Issue 2 January 2008

487

CLI Commands

SLS survivability

Table 67: Slot and board matrix for SLS (continued) Media Module TIM508 Description Eight analog line ports J-series router model J4350/J6350 J2320 J2350 TIM510 One T1/E1 trunk port J4350/J6350 J2320 J2350 TIM514 Four analog trunk ports and four analog station/DID ports J4350/J6350 J2320 J2350 TIM516 16 analog line ports J4350/J6350 J2320 J2350 TIM518 Eight analog line ports and eight analog trunk ports J4350/J6350 J2320 J2350 TIM521 Four BRI trunk ports (8 trunks) J4350/J6350 J2320 J2350 Permitted slots v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 v1, v2, v3, v4, v5, v6 v1, v2, v3 v1, v2, v3, v4, v5 SLS configured? Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes 2 of 2

User Level
read-write

Context
sls

Example
To define the slot type as v1 and the board type as TIM516 in the gateway:
TGM550-001 (super-sls)# set slot-config v1 TIM516

488 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

show attendant
Use the show attendant command to display attendant provisioning in SLS.

Syntax
show attendant

User Level
read-write

Context
sls

Example
To display attendant provisioning:
TGM550-001(super-sls)# show attendant Attendant Access-Code Station-extension --------------------- ----------------00 23456

show bri
Use the show bri command to list the administered BRI parameters for SLS. If no channel parameters are specified, information about all BRI channels is displayed.

Syntax
show bri list

Parameters
Parameter list Description The administered BRI parameters to list: all Lists all administered BRI channels port-address Lists only the parameters for a single BRI circuit Possible Values all port-address Default Value all

Issue 2 January 2008

489

CLI Commands

SLS survivability

User Level
read-write

Context
sls

Example
To list all administered BRI parameters:
TGM550-001(super-sls)# show bri all Name = Willow Steet 2 BRI Interface Side Country Bearer Compand TEI Endpt-Init Layer1-Stable ---- --------- ---- -------- -------- ------- ---- ---------- ------------v401 user a country1 speech ulaw auto yes yes Dir-NumberA Dir-NumberB Spid-A Spid-B ----------- ----------- -------------- -------------3035381002 3035381003 30353810021111 30353810031111

Name = Willow Steet 3 BRI Interface Side Country Bearer Compand TEI Endpt-Init Layer1-Stable ---- --------- ---- -------- -------- ------- ---- ---------- ------------v402 user a country1 speech ulaw auto yes yes Dir-NumberA Dir-NumberB Spid-A Spid-B ----------- ----------- -------------- -------------3035381004 3035381005 30353810041111 30353810051111

show date-format
Use the show date-format command to display the current date format in effect for the SLS data set.

Syntax
show date-format

User Level
read-write

Context
sls

490 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Example
To display the current date format:
TGM550-001(super-sls)# show date-format Date Format is mm/dd/yy

show dial-pattern
Use the show dial-pattern command to list all dial-pattern strings in the SLS data set in tabular format.

Syntax
show dial-pattern list

Parameters
Parameter list Description Dial-pattern strings in the SLS data set in tabular format: all Lists all administered dial patterns dialed-string Lists only the parameters for a specific dialed string dialed-string + n List starts with the specific dialed string + n entries Possible Values all dialed-string dialed-string + n Default Value all

User Level
read-write

Context
sls

Example
To list all dial-pattern strings in tabular format:
TGM550-001(super-sls)# show dial-pattern all Dialed-String/Deny Min/Max Length ------------------ ------95381000/n 9/9 95350000/n 9/9 Type Trunk Group ---- ----locl 2 locl 3 Delete/Insert Digits -----------------------------------1/303 1/720

Issue 2 January 2008

491

CLI Commands

SLS survivability

Output fields
Field Dialed-String/Deny Min/Max Length Type Description The administered ARS dial string and whether the call should be permitted (no) or denied (yes) The minimum and maximum number of digits in the dial string. The type of dial string. Possible types include: emer emergency call fnpa 10-digit NANP call hnpa 7-digit NANP call intl public-network international number call iop international operator call locl public-network local number call natl non-NANP call op operator svc service The number of digits to add or remove from a dialed string

Delete/Insert Digits

show ds1
Use the show ds1 command to list the administered DS1 parameters for SLS.

Syntax
show ds1 list

Parameters
Parameter list Description The DS1 channels to list: all Lists all administered DS1 channels port-address Lists only the parameters for a single DS1 channel Possible Values all port-address Default Value all

User Level
read-write

492 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls

Example
To list the administered DS1 parameters:
TGM550-001(super-sls)# show ds1 all Name = 'Willow Steet DS1 Rate Signaling Channel ---- ---- --------- ------v4 1544 isdnpri seq 2' Connect Interface Side Protocol Ver Bearer Cmpd Ltm ------- --------- ---- -------- --- ------ ---- --network user a country1 a speech ulaw no

Name = 'Willow Steet DS1 Rate Signaling Channel ---- ---- --------- ------v5 1544 isdnpri seq

3' Connect Interface Side Protocol Ver Bearer Cmpd Ltm ------- --------- ---- -------- --- ------ ---- --network user a country1 a speech ulaw no

show extension
Use the show extension command to display extension-specific SLS data parameters. If no extension parameters are specified, information for all extensions is displayed. Note: It is preferable to use the show station command.

Note:

Syntax
show extension list

Parameters
Parameter list Description The extension-specific SLS data parameters to list: all Lists all administered extensions extension Lists only the numbered extension extension + n Lists the numbered extension + n entries Possible Values all extension extension + n Default Value

User Level
read-write

Issue 2 January 2008

493

CLI Commands

SLS survivability

Context
sls

Example
To display SLS data parameters for all extensions:
TGM550-001(super-sls)# show extension Extension Type --------- ---49138 ip4620 49139 ip4610sw 49140 analog2500 Name = Joe Smith Port ---xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx v305 Cor --unrestr unrestr internal Trk-Des ------yes yes yes Exp-Mod Flash Passwd ------- ----- -----no ****** yes ****** yes ******

Note:

Note: If an IP station or Softphone is currently registered when the command is run, the Port column shows the IP address of the IP station or Softphone.

Output fields
Field Extension Type Port Cor Description The extension number of the phone (1-13 digits) The station type The module/port location The Class of Restriction. Possible classes include: emergency internal local toll unrestricted Indicates whether to permit (yes) or deny (no) the call
Yes means that an expansion module is administered for this station; no means that there is no expansion module associated with this station Yes means that SLS will recognize the switchhook flash on this station; no means that flashing the switchhook has no effect

Trk-Des Exp-Mod

Flash Passwd

Asterisks (*) indicate an administered password. See set password for password requirements on IP endpoints. If the field is blank, no password is administered for this extension.

494 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

show fac
Use the show fac command to list the administered Feature Access Codes for SLS.

Syntax
show fac

User Level
read-write

Context
sls

Example
To list the administered Feature Access Codes:
TGM550-001(super-sls)# show fac Feature ------------contact-pulse contact-close contact-open hold ars1 ars2 Done! Access Code ----------*84 *85 *86 *87 *88 *89

show incoming-routing
Use the show incoming-routing command to show all of the administered dial patterns in SLS for one, several, or all trunk groups.

Syntax
show incoming-routing [list]

Issue 2 January 2008

495

CLI Commands

SLS survivability

Parameters
Parameter list Description The administered dial patterns to list: all Lists all administered dial patterns tgnum Lists the dial pattern parameters for a single trunk group tgnum + n Lists the dial pattern parameters starting with a specific trunk group for a total of "n" entries Possible Values all tgnum tgnum + n Default Value

User Level
read-write

Context
sls

Example
To show all of the administered dial patterns:
TGM550-001(super-sls)# show incoming-routing Match-pattern Length Del Insert-Digits Mode tgnum ------------------ ------ --- ------------------ ------- ----234 7 3 5381000 enbloc 99 235 7 3 5381001 enbloc 98

show ip-codec-set
Use the show ip-codec-set command to list the codec set entries for SLS.

Syntax
show ip-codec-set

User Level
read-only

Context
sls

496 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Example
To list codec set entries:
TGM550-001(super-sls)# show ip-codec-set Ip codec g.711 mu, priority 1, frames 2

Output fields
Field IP codec Priority Frames Description The administered codec type (g.711 mu or g.711 a) The numeric priority of the codec. SLS supports a single priority level (designated as priority 1). The frame size. The frames supported are 20 milliseconds in size. Since the incremental building size is in terms of 10 milliseconds, the display reports 2 times the 10 milliseconds.

show last-pim-update
Use the show last-pim-update command to display when the last Provisioning and Update Manager (PIM) update of the SLS data occurred. The time value is given for the time zone in which the PIM server is located.

Syntax
show last-pim-update

User Level
read-write

Context
sls

Example
To display when the last update occurred:
TGM550-001(super-sls)# show last-pim-update Last PIM update occured at 15:47:0 on 2/28/2005

Issue 2 January 2008

497

CLI Commands

SLS survivability

show max-ip-registrations
Use the show max-ip-registrations command to display the maximum IP registration administration in the SLS data on the TGM550 Telephony Gateway Module.

Syntax
show max-ip-registrations

User Level
read-write

Context
sls

Example
To display the maximum IP registration administration:
TGM550-001(super-sls)# show max-ip-registrations Maximum IP Registrations is 12

show pim-lockout
Use the show pim-lockout command to display the current status of the setting for the Provisioning and Installation Manager (PIM) lockout feature.

Syntax
show pim-lockout

User Level
read-only

Context
sls

Example
To display the current status of the PIM lockout feature:
TGM550-001(super-sls)# show pim-lockout PIM lockout = yes

498 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

show sig-group
Use the show sig-group command to list all administered signaling groups in SLS.

Syntax
show sig-group list

Parameters
Parameter list Description The administered signaling groups to list: all Lists all administered signaling groups sgnum Lists only the specified signaling group Possible Values all sgnum Default Value all

User Level
read-write

Context
sls

Example
To list all administered signaling groups: (In this example, trunk group 98 is administered on a DS1 module, managed by signaling group 10, in slot v4. Two additional DS1 facilities located in slot v5 and slot v6 share an NFAS managed group, managed by signaling group 12. The NFAS group D-channel is in the slot v5 DS1 module. All trunk members are contained in trunk group 100.)
TGM550-001(super-sls)# show sig-group all Sig-group Tg-Select Assoc-Sig Prime-Dchan Nfas-Modules/Nfas-Id --------- --------- --------- ----------- --------------------------------10 98 yes 005v424 12 100 no 005v524 005v5:0,005v6:1

Issue 2 January 2008

499

CLI Commands

SLS survivability

show slot-config
Use the show slot-config command to list the slot and board administration in the media gateway for SLS.

Syntax
show slot-config

User Level
read-write

Context
sls

Examples
To list the slot and board administration in the TGM550 gateway:
TGM550-001 (super-sls)# show slot-config Slot SLS-Configured Inserted Board-type Board-type ---- -------------- ----------v1: v2: v3: v4: tim521 tim521 v5: tim510 tim510 v6: tim514 tim514

Note:

Note: If there is no module administered for a slot, the display shows "-", and if an unknown media module is inserted, the display shows "unknown".

show station
Use the show station command to display extension-specific SLS data parameters. If no extension parameters are specified, information about all extensions is displayed.

Syntax
show station list

500 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter list Description The extension-specific SLS data parameters to list: all Lists all administered extensions extension Lists only the numbered extension extension + n Lists the numbered extension + n entries Possible Values all, extension extension + n Default Value all

User Level
read-write

Context
sls

Example
To display extension-specific SLS data parameters:
TGM550-001(super-sls)# show station Extension Type --------- ---49138 ip4620 49139 ip4610sw 49140 analog2500 Name = Joe Smith Port ---xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx v305 Cor --unrestr unrestr internal Trk-Des ------yes yes yes Exp-Mod ------no yes Flash Passwd ----- ------ ****** - ****** yes ******

Note:

Note: If an IP station or Softphone is currently registered when the command is run, the Port column shows the IP address of the IP station or Softphone.

Output fields
Field Extension Type Port Description The extension number of the phone (1-13 digits) The station type The module/port location 1 of 2

Issue 2 January 2008

501

CLI Commands

SLS survivability

Field Cor

Description The Class of Restriction. Possible classes include: emergency internal local toll unrestricted Indicates whether to permit (yes) or deny (no) the call
Yes means that an expansion module is administered for this station; no means that there is no expansion module associated with this station Yes means that SLS will recognize the switchhook flash on this station; no means that flashing the switchhook has no effect

Trk-Des Exp-Mod

Flash Passwd

Asterisks (*) indicate an administered password. See set password for password requirements on IP endpoints. If the field is blank, no password is administered for this extension. 2 of 2

show trunk-group
Use the show trunk-group command to display trunk group administration in SLS.

Syntax
show trunk-group list

Parameters
Parameter list Description The administered trunk groups to list: all Lists all administered trunk groups trunk-group Lists only the numbered trunk group extension + n Lists the numbered trunk group + n entries Possible Values all trunk-group extension + n Default Value all

User Level
read-only

502 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls

Example
To display trunk group administration for all administered trunk groups:
TGM550-001(super-sls)# show trunk-group all Group ----1 2 Type ---loop-start did Dial ---dtmf dtmf Tac --99 88 Ports ----v301 v305 Supervision ----------wink Treat ----insert3 Insert -----538

Output fields
Field Group Type Dial Tac Description The trunk group number (1-2000) The trunk group type (loop-start, did) The dial type (rotary or dtmf) The Trunk Access Code (1 to 4 digits). "#" and "*" are valid entries and are only allowed as the first character of the TAC. The virtual integrated port assignment Incoming signaling supervision mode (immediate, wink) The digit treatment (blank, absorb 1-5, insert 1-4) The digits to insert in the dial string The Q.931 codeset that sends display information to the user phone (codeset0, codeset6, codeset7) The Q.931 codeset that sends National IE display information to the user phone (codeset6, codeset7) Defines how the Channel Identification IE field is encoded (exclusive, preferred) Defines how the inbound/outbound calls handle the transmission/reception of the dialed pattern (enbloc-enbloc, enbloc-overlap, overlap-enbloc, overlap-overlap) 1 of 2

Port Supervision Treat Insert Codeset Display Codeset National Channel Preference Digit Handling

Issue 2 January 2008

503

CLI Commands

SLS survivability

Field Japan Discon Send Name

Description Whether to perform a disconnect sequence (CONNECT message followed by a DISCONNECT message) Whether the calling, connected, called, or busy partys administered name is sent to the network on outgoing or incoming calls (yes, no, restricted) Whether the calling, connected, called, or busy partys administered number is sent to the network on outgoing or incoming calls (yes, no, restricted) The numbering plan for this trunk. The numbering plan encodes the Numbering Plan Indicator and Type of Number fields in the Calling/Connected Party Number IE in the ISDN protocol (unknown, public, private, unknownprivate). The trunk-hunting search within a facility in an ISDN trunk group or through a non-ISDN digital trunk group (ascend, cyclical, descend) 2 of 2

Send Number

Format Number

Trunk Hunt

sig-group
Use the sig-group command within the sls context to enter a second-level subcontext for administering signaling groups for SLS. After issuing this command, the prompt changes to sls-sig-group <sgnum>. Type exit to leave the sig-group context, and return to the sls context.

Syntax
sig-group sgnum

Parameters
Parameter sgnum Description Signaling group number* Possible Values 1-650 Default Value

* If you have created more than one trunk group within a single DS1 circuit, it is possible that one signaling group can support multiple trunk groups.

User Level
read-write

504 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls

Example
To enter the second-level subcontext of sls-sig-group 100:
TGM550-001(super-sls)# sig-group 100 TGM550-001(sls-sig-group 100)#

Sub-commands
The following commands are available once you are inside the sig-group context: Signaling groups sub-commands add nfas-interface remove nfas-interface set associated-signaling set primary-dchannel set trunk-group-chan-select show (sig-group)

add nfas-interface
Use the add nfas-interface command to identify a list of DS1 modules that are controlled by the primary D-channel in SLS. Note: This command applies only to ISDN-PRI trunks in a NFAS-managed group. Note: This command is not valid unless the slot configuration has already been administered (see set slot-config) and the set associated-signaling command is set to no (NFAS). Note: The North American Public Network Service Providers do not allow any part of a T1 to be shared outside of this NFAS-trunk group. In other words, they do not allow one of the T1 interfaces (of this NFAS group) to be fractionalized into 2 or more uses. It must be dedicated to this given customer. Therefore the following usage rules apply:

Note:

Note:

Note:

Issue 2 January 2008

505

CLI Commands

SLS survivability

- All members of an NFAS DS1 (that are administered) must belong to the same trunk-group. - All members of this trunk-group must belong to a single signaling group.

Syntax
add nfas-interface {gateway module [interface-id]}

Parameters
Parameter gateway module Description 3-digit gateway number (for example, 005) 2-character slot number (for example, v4). This number identifies a port on an already-provisioned DS1 board module (see add port). The DS1 circuit number that is associated with the NFAS group. This number must be coordinated with the public network service provider so that the signaling protocol operates correctly. 0-31 Possible Values Default Value

interface-id

User Level
read-write

Context
sls > sig-group

Example
To identify a list of DS1 modules that are controlled by the primary D-channel for gateway 005, module v5, and DS1 circuit number 0:
TGM550-001(sls-sig-group 100)# add nfas-interface 005v5 0

remove nfas-interface
Use the remove nfas-interface command to remove a member from a NFAS-managed DS1 group in SLS. This command removes the add nfas-interface gateway and module administration. Note: This command applies only to ISDN-PRI trunks in a NFAS-managed group.

Note:

506 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Note:

Note: This command is not valid unless the slot configuration has already been administered (see set slot-config) and the set associated-signaling command is set to no (NFAS).

Syntax
remove nfas-interface gateway module

Parameters
Parameter gateway module Description 3-digit gateway number (for example, 005) 2-character slot number (for example, v4). This number identifies a port on an already-provisioned DS1 board module (see add port). Possible Values Default Value

User Level
read-write

Context
sls > sig-group

Example
To remove gateway 3 with module v5 from the NFAS-managed DS1 group:
TGM550-001(sls-sig-group 100)# remove nfas-interface 005v5

set associated-signaling
Use the set associated-signaling command to specify whether the D-channel is physically present in the DS1 interface in SLS. Note: If this command is invoked to change the transmission rate and the DS1 facility and associated signaling group have already been provisioned, the command is blocked and a warning message, "Administrative change is in violation with existing trunk member provisioning", is displayed.

Note:

Syntax
set associated-signaling {yes | no}

Issue 2 January 2008

507

CLI Commands

SLS survivability

Parameters
Parameter yes no Description Keyword specifying the D-channel is present in the same DS1 interface. This is the default. Keyword specifying to use Non-Facility Associated Signaling (NFAS) Default Value

User Level
read-write

Context
sls > sig-group

Example
To specify that the D-channel is present:
TGM550-001(sls-sig-group 100)# set associated-signaling yes

set primary-dchannel
Use the set primary-dchannel command to identify the D-channel number in SLS.

Syntax
set primary-dchannel circuit-number

Parameters
Parameter circuit-number Description 3-digit gateway number (for example, 005) 2-character slot number (for example, v4) 2-digit circuit number: T1-ISDN: 24 E1-ISDN: 16 Possible Values Default Value 24

User Level
read-write

508 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls > sig-group

Example
To identify the D-channel number for gateway 005, slot v4 in a T1-ISDN line:
TGM550-001(sls-sig-group 100)# set primary-dchannel 005v424

set trunk-group-chan-select
Use the set trunk-group-chan-select command to specify the trunk-group number that can accept incoming calls in cases where the Information Channel Selection field does not specify a preferred channel for bearer transport in SLS.

Syntax
set trunk-group-chan-select tgnum

Parameters
Parameter tgnum Description Trunk group number. Note: Use the 0 value to clear any previously set tgnum value. Possible Values 0 1-2000 Default Value

User Level
read-write

Context
sls > sig-group

Example

To specify that trunk-group 99 can accept incoming calls:

TGM550-001(sls-sig-group 100)# set trunk-group-chan-select 99

To clear any previously set value for trunk-group selection:

TGM550-001(sls-sig-group 100)# set trunk-group-chan-select 0

Issue 2 January 2008

509

CLI Commands

SLS survivability

show (sig-group)
Use the show command to list the parameters of this signaling group.

Syntax
show

User Level
read-write

Context
sls > sig-group

Example
To list all of the subcontext parameters in the sig-group context:
TGM550-001(sls-sig-group 100)# show Sig-group Tg-Select Assoc-Sig Prime-Dchan Nfas-Modules/Nfas-Id --------- --------- --------- ----------- -------------------10 98 yes 005v424

Output fields
Field Sig-group Tg-Select Description Signaling group number The trunk-group number that can accept incoming calls in cases where the Information Channel Selection field does not specify a preferred channel for bearer transport Whether the D-channel is physically present in the DS1 interface The D-channel number The DS1 modules that are controlled by the primary D-channel. The DS1 circuit number that is associated with the NFAS group.

Assoc-Sig Prime-Dchan Nfas-Modules / Nfas-Id

510 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

station
Use the station command within the sls context to enter a second-level subcontext for administering stations for SLS. After issuing this command, the prompt changes to sls-station <extension>. Type exit to leave the station context, and return to the sls context.

Syntax
station extension [class]

Parameters
Parameter extension Description A 1-13 digit unique numeric string Possible Values 0 through 9; an extension can begin with the digit 0 analog ip Default Value

class

The station class. Note: This parameter is only mandatory for the creation of a station administrative instance. Subsequent command accesses to modify/show do not require this parameter to be entered.

User Level
read-write

Context
sls

Example
To enter the second-level context of sls-station for analog station extension 23456:
TGM550-001(super-sls)# station 23456 analog TGM550-001(super-sls-station <extension>)#

Issue 2 January 2008

511

CLI Commands

SLS survivability

Sub-commands
Depending on the class of station, the following sub-commands are available: Command set cor set expansion-module set name set password set port set swhook-flash set trunk-destination set type (station) show (station) X X X X X X X X X Analog X IP X X X X

Additional SLS commands


set sls, show (station), show sls, sls

set cor
Use the set cor command to administer the class-of-restriction values for each station that uses SLS.

Syntax
set cor cor

Parameters
Parameter cor Description The class of restriction for a station users dialing Possible Values* emergency internal local toll unrestricted Default Value internal

* As the class of restriction moves from emergency to unrestricted, each level increases the range of dialing abilities for this station. For example, toll level includes local, internal, and emergency.

512 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

SLS uses the dial-pattern field as part of its ARS routing for station dialed calls that are to be directed to the other stations and to make outbound trunk calls. Make sure to synchronize your choice of station COR and dial-plan dial-type. The following figure illustrates the relationship between the set cor value and the set type (dial-pattern) value (configured in dial-pattern context). Note the following:

The outer boundary of a stations COR class inherit all the properties of the class symbols encompassed by this class. For example, the 'Local' COR class is also able to dial the 'Emergency' COR. COR set to 'Emergency' is the most restricted class. If a station's COR is set to this mode, the only calls that are allowed are those which have an "emergency" type identified in the ARS Analysis table. COR set to 'Internal' enables the station to place calls to other stations supported by this gateway. The station is also able to dial calls that match dial patterns with dial-type set to 'emergency'. COR set to 'Local' enables the station to place calls that match dial patterns with dial-types set to 'local', 'operator', 'service', or 'hnpa'. In addition, the station may place calls to the 'Emergency' and 'Internal' classes. COR set to 'Toll' enables the station to place calls that match dial patterns with dial-types set to 'fnpa' and 'natl'. In addition, the station may place calls to the 'Emergency', 'Internal', and 'Local' classes. COR set to 'Unrestricted' enables the station to place calls to any dial patterns that are not explicitly labeled as 'denied' class within the ARS Analysis table. This class of COR effectively inherits the call permission properties of all the other classes. The Emergency Transfer Relay (ETR) mode is basically equivalent to the 'Unrestricted' class. When power is lost and the gateway enters ETR mode, the station port is directly

Issue 2 January 2008

513

CLI Commands

SLS survivability

connected to the trunk port and receives central office dial tone directly. This ETR station port may dial any number that the central office dialing plan affords for this analog trunk.

Station <cor>

Dial-Plan <type>
Emergency intra-switch calls (default) local (public-network local number call), operator, service, or hnpa (7-digit NANP call)

Emergency

Internal Local (In-Country) Toll Unrestricted and ETR

fnpa (10-digit NANP call) or (1 + 10-digit NAMP) or natl (non-NANP call) International, or IOP (International op)

User Level
read-write

Context
sls > station

Example
To set the restriction for a station users dialing to unrestricted:
TGM550-001 (sls-station <extension>)# set cor unrestricted

514 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set expansion-module
Use the set expansion-module command to administer an IP station for an expansion module in SLS.

Syntax
set expansion-module {yes | no}

Parameters
Parameter yes no Description Keyword indicating that this station can have an expansion module Keyword indicating that this station cannot have an expansion module. This is the default value. Possible Values Default Value

User Level
read-write

Context
sls > station

Example
To allow the station to have an expansion module:
TGM550-001 (sls-station <extension>)# set expansion-module yes

set name
Use the set name command to identify the username for a station, a trunk group, a DS1, or ISDN facility in SLS.

Syntax
set name name

Issue 2 January 2008

515

CLI Commands

SLS survivability

Parameters
Parameter name Description The name as specified on the corresponding Communication Manager form (add trunk-group n). This name is typically used to identify an individual, a service provider, or a site. If the file name includes spaces, use quotes. The length of the name is: DS1 and BRI: 1 -15 characters station and trunk-group: 1-27 characters Possible Values Default Value

User Level
read-write

Context
sls > station sls > trunk-group sls > ds1 sls > bri

Examples
To set the username Joe Smith for a given station:
TGM550-001 (sls-station-<extension>)# set name Joe Smith

set password
Use the set password command to administer a station password for IP station sets in SLS.

Syntax
set password password

Parameters
Parameter password Description A 4-8 digit numeric password Possible Values Default Value

516 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

User Level
read-write

Context
sls > station

Example
To set a given station password to 12345:
TGM550-001 (sls-station <extension>)# set password 12345

set port
Use the set port command to administer a port on a station for SLS.

Syntax
set port module-port

Parameters
Parameter module-port Description The virtual integrated port assignment for the TGM550 Possible Values Depends on class administered with the set type (station) command; see below Default Value

Assign a port from this list:

Issue 2 January 2008

517

CLI Commands

SLS survivability

Table 68: Module-port values in SLS station configuration mode Gateway J2320, J2350, J4350, J6350 Media module TGM550 TGM514 TIM508 TIM516 TIM518 Analog station ports* 3, 4 5, 6, 7, 8 1 through 8 1 through 16 1 through 8 DCP

* You cannot select these modules/ports if they are already assigned as DID trunks.

User Level
read-write

Context
sls > station

Example
To set virtual integrated port v305 to a given station:
TGM550-001 (sls-station-<extension>)# set port v305

set swhook-flash
Use the set swhook-flash command to enable SLS to recognize the switchhook flash signal from a particular analog station and to provide subsequent transfer service. Note: This command is valid only when the station type is analog2500.

Note:

Syntax
set swhook-flash {yes | no}

518 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Parameters
Parameter yes Description Keyword indicating that SLS recognizes the switchhook signal and transfers the call. This is the default for analog phone only. Keyword indicating that SLS does not recognize the switchhook signal and transfers the call. This is the default for IP and DCP phones only. Possible Values Default Value

no

User Level
read-write

Context
sls > station

Example
To enable SLS to recognize the switchhook flash signal and to provide subsequent transfer service:
TGM550-001 (sls-station <extension>)# set swhook-flash yes

set trunk-destination
Use the set trunk-destination command to administer a station extension to be included in a pool of stations that can receive incoming analog loop-start trunk calls in circular queueing in SLS. Note: This command does not apply to analog DID trunks.

Note:

Syntax
set trunk-destination {yes | no}

Issue 2 January 2008

519

CLI Commands

SLS survivability

Parameters
Parameter yes Description Keyword indicating that this extension can receive incoming analog loop-start trunk calls as part of the station pool which is available in a circular queueing fashion across the first available idle station. This is the default. Keyword indicating that this extension cannot receive incoming analog loop-start trunk calls as part of the station pool which is available Possible Values Default Value

no

User Level
read-write

Context
sls > station

Example
To designate that a given station extension be included in the station pool:
TGM550-001 (sls-station <extension>)# set trunk-destination yes

set type (station)


Use the set type command to administer specific phone models for SLS. Note: The new Avaya 96xx IP phone family is not directly referenced in the CLI. When you administer these phones via the CLI, use the following mapping: Module name 9610 9620 9630 9640 9650 CLI interface name 4606 4610 4620 4620 4620

Note:

520 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Syntax
set type model

Parameters
Parameter model Description Model type Possible Values Default Value IP ip4601 ip4602 ip4602sw ip4606 ip4610sw ip4612 ip4620 ip4620sw ip4624 ip4621 ip4622 ip4625

Analog analog 2500

User Level
read-write

Context
sls > station

Example
To administer phone model ip4625:
TGM550-001 (sls-station <extension>)# set type ip4625

show (station)
Use the show command to list extension-specific SLS data parameters for this station.

Syntax
show

Issue 2 January 2008

521

CLI Commands

SLS survivability

User Level
read-write

Context
sls > station

Example
To list extension-specific SLS data parameters for this station:
TGM550-001 (sls-station <extension>)# show Extension Type Port Co Trk-Des Exp-Mod Flash Passwd --------- ---------- ---------------- ------- ------- ------- ----- -----49138 ip4620 111.222.223.200 unrestr yes no ****** Name = Joe Smith

Note:

Note: If an IP Softphone or an IP phone is currently registered when the command is run, the Port column shows the IP address of the IP Softphone or IP phone.

Output fields
Field Extension Type Port Cor Description The extension number of the phone (1-13 digits) The telephone model The module/port location Class of restriction assigned to the station, which determines the range of dialing ability for the station. Possible values, ranging from most restricted to unrestricted, are: emergency internal local toll unrestricted Less restricted classes include all dialing abilities included in more restricted classes. Whether or not to permit the station to receive incoming analog loop-start trunk calls in circular queueing 1 of 2

Trk-Des

522 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Field Exp-Mod

Description
Yes means that an expansion module is administered for this station; no means that there is no expansion module

associated with this station Flash


Yes means that SLS will recognize the switchhook flash on this station; no means that flashing the switchhook has

no effect Passwd Asterisks (*) indicate an administered password 2 of 2

trunk-group
Use the trunk-group command within the sls context to enter a second-level subcontext for administering trunks for SLS. After issuing this command, the prompt changes to sls-trunk-group-<tgnum>. Type exit to leave the trunk-group context, and return to the sls context.

Syntax
trunk-group tgnum [group-type]

Parameters
Parameter tgnum group-type Description The required trunk group number The trunk group type. This argument is required to enter the trunk-group context. See the following for capacities by group type: J2320, J2350, J4350 and J6350: Table 69 Possible Values 1-2000 loop-start (analog) did (analog) ground-start (analog) bri (ISDN basic rate) t1isdn (ISDN primary rate on 1.544 Mbps facility) e1isdn (ISDN primary rate on 2.048 Mbps facility) t1inband (non-ISDN rate on 1.544 Mbps facility) e1inband (non-ISDN rate on 2.048 Mbps facility) Default Value

Issue 2 January 2008

523

CLI Commands

SLS survivability

You can create a trunk group that does not have any assigned members. Once a valid port is assigned as a trunk group member, this trunk group becomes active and may be employed by SLS call processing for incoming/outgoing trunk operation. The slot-configuration table will be used together with the port capacity for the given module to determine the validity of a port assignment at administration time. As a corollary to this, there may not be more active trunk groups than there are physical trunk members within a given gateway. Secondly, a combo-port may only be used for one active assignment. For example, the analog station/DID trunk ports may be either allocated to serve as an analog station or as an analog DID trunk, but not BOTH. The maximum limits for a given trunk type are defined by the slot-configuration assignment for the TGM550. The maximum number of ports allowed per interface module is defined in Table 69. Table 69: SLS group type assignments Group type loop-start ground-start loop-start ground-start loop-start ground-start did did did did did bri t1isdn t1isdn Media Module TGM550 TIM514 TIM518 TGM550 TIM514 TIM508 TIM516 TIM518 TIM521 TIM510 TIM510 Number of ports/channels 2 4 8 2 4 8 8 16 8 23 24 D-channel is associated with this facility (FAS) D-channel is not associated with this facility (NFAS), and the DS1s signaling-mode is set to isdnext D-channel is associated with this facility (FAS) 1 of 2 Description 1, 2 1, 2, 3, 4 9, 10, 11, 12, 13, 14, 15, 16 3, 4 5, 6, 7, 8 1, 2, 3, 4, 5, 6, 7, 8 1 through 8 1 through 16

t1isdn

TIM510

30

524 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Table 69: SLS group type assignments (continued) Group type e1isdn Media Module TIM510 Number of ports/channels 31 Description D-channel is not associated with this facility (NFAS), and the DS1s signaling-mode is set to isdnext

t1inband e1inband

TIM510 TIM510

24 30 2 of 2

Note:

Note: There is no way to disable the ETR feature when the TGM550 gateway models are in powered-down mode. For the following models, it is recommended not to use the Integrated port as DID: - TGM550: Integrated port 3

User Level
read-write

Context
sls

Example
To enter the second-level subcontext of sls-trunk-group-<tgnum> where the trunk group is number 200 of type loop-start:
TGM550-001(super-sls)# trunk-group 200 loop-start TGM550-001(sls-trunk-group-<200>)#

Sub-commands
Depending on the group type, the following commands are available once you are inside the trunk-group context: Command add port clear tac remove port ground-start, loop-start X X X did X X X t1isdn, e1isdn, bri X X X e1inband, t1inband X X X

Issue 2 January 2008

525

CLI Commands

SLS survivability

Command set cbc set cbc-parameter set cbc-service-feature, set channel-preference set codeset-display set codeset-national set dial set digits set digit-handling set digit-treatment set incoming-destination set incoming-dialtone set japan-disconnect set name set numbering-format set send-name set send-number set supervision set tac set trunk-hunt show (trunk-group)

ground-start, loop-start

did

t1isdn, e1isdn, bri X X X X X X

e1inband, t1inband

X X X X

X X

X X X X

X X X X

X X X X X X X X

X X X X

Additional SLS commands


clear trunk-group, set sls, show sls, show trunk-group sls

526 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

add port
Use the add port command to administer the port appropriate for SLS. The port can belong to one trunk group only, and the port assignment depends on the group-type parameter for the trunk-group command.

Syntax
add port module port [sig-group] Note: The sig-group argument is only necessary for Digital trunks.

Note:

Parameters
Parameter module port sig-group Description The virtual integrated port assignment for this group-type Specifies the signaling group associated with the management of this trunk member Possible Values See either Analog trunks Digital trunks Number between 1- 650 Default Value

Analog trunks
See Table 70 (99 trunks per trunk group) Note: If you attempt to assign more than the maximum number of trunk members, an error message instructs you to delete a trunk member before you can add a new one. A physical trunk port may only be a member of a single trunk group and cannot be shared across two or more trunk groups.

Note:

Issue 2 January 2008

527

CLI Commands

SLS survivability

Note:

Note: There is no way to disable the ETR feature when the TGM550 gateway models are in powered-down mode. Therefore, on the TGM550 models, the integrated port 3 should be discouraged from being used as a DID port (to avoid having the ETR "loop-start" trunk connected directly to the tip and ring circuit of the DID trunk and having two battery feed circuits driving one another). Table 70: TGM550 SLS analog port assignments Group type CO did CAMA (911) CO did CAMA (911) Trunk type loop-start ground-start wink-start immediate-start CAMA loop-start ground-start wink-start immediate-start CAMA Media Module TGM550 TGM550 TIM514 TIM514 TIM514 TIM514 Number of ports/channels 2 2 2 4 4 4 Description 1, 2 3, 4 1, 2 1, 2, 3, 4 5, 6, 7, 8 1, 2, 3, 4

Example (analog trunk port)


This example adds an analog trunk port for the fourth physical port of the TIM514 in slot 3:
TGM550-001 (sls-trunk-group-<tgnum>)# add port v304

Digital trunks

TGM550: 99 trunks per trunk group (see Table 71: J2320, J2350, J4350, and J6350 SLS digital port assignments on page 529). The number of ISDN channels depends on whether the signaling D-channel is associated with this facility (FAS) or not (NFAS).

528 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Note:

Note: You cannot mix BRI and PRI trunk members within the same trunk group. If you attempt to assign more than the maximum number of trunk members, an error message instructs you to delete a trunk member before you can add a new one. A physical trunk port may only be a member of a single trunk group and cannot be shared across two or more trunk groups. Table 71: J2320, J2350, J4350, and J6350 SLS digital port assignments Group type bri t1isdn e1isdn t1inband e1inband Media Module TIM 521 MM510 MM510 MM510 MM510 Number of ports/ channels 8 23 (FAS) 24 (NFAS)* 30 (FAS) 31 (NFAS)* 24 30

* The DS1s signaling-mode field is set to isdnext.

User Level
read-write

Context
sls > trunk-group

clear tac
Use the clear tac command to remove a Trunk Access Code (TAC) assignment from a trunk group in SLS. The set tac command establishes the TAC assignment to the trunk group.

Syntax
clear tac

User Level
read-write

Issue 2 January 2008

529

CLI Commands

SLS survivability

Context
sls > trunk-group

Example
To remove TAC assignment from trunk group 200:
TGM550-001 (sls-trunk-group-<200>)# clear tac Done!

remove port
Use the remove port command to remove the virtual integrated port assignment from a trunk group in SLS. The port assignment is administered with the add port command.

Syntax
remove port module port

Parameters
Parameter module port Description The virtual integrated port assignment for this group-type Possible Values See the add port command for port values Default Value

User Level
read-write

Context
sls > trunk-group

Example
To remove the virtual integrated port assignment of port v301:
TGM550-001 (sls-trunk-group-<tgnum>)# remove port v301

530 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set cbc
Use the set cbc command to specify whether the ISDN trunk group is to operate by declaring the service type explicitly on a call-by-call basis in SLS. Note: This command only applies to ISDN Primary Rate trunks.

Note:

Syntax
set cbc {yes | no}

Parameters
Parameter yes Description Keyword indicating that the SLS Q.931 state machine will define the service type in the Network Specific Facilities information element that is sent with the SETUP message on outbound calls Keyword indicating that the Network Specific Facilities information element will not be sent. This is the default value. Possible Values Default Value

no

User Level
read-write

Context
sls > trunk-group

Example
To specify that the ISDN trunk group will declare the service type explicitly:
TGM550-001 (sls-trunk-group-<tgnum>)# set cbc yes

Issue 2 January 2008

531

CLI Commands

SLS survivability

set cbc-parameter
Use the set cbc command to define what class of service is being specified, as part of the scocs service in the Network Services Facility information element sent to the network service provider on outgoing calls in SLS. Note: This command only applies to ISDN Primary Rate trunks Note: This command is available only if set cbc is set to yes, and set cbc-service-feature is set to scocs.

Note:

Note:

Syntax
set cbc-parameter class

Parameters
Parameter class Description The class of service specified as part of the scocs service in the Network Services Facility information element Possible Values An integer from 0-99999 Default Value 1

User Level
read-write

Context
sls > trunk-group

Example
To define the class of service specified as part of the scocs service in the Network Services Facility information element:
TGM550-001 (sls-trunk-group-<tgnum>)# set cbc-parameter 2

532 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set cbc-service-feature
Use the set cbc-service-feature command to specify the type of service or feature being specified in the Network Services Facility information element (as part of the SETUP message) that is sent to the network service provider on outgoing calls in SLS. Note: This command only applies to ISDN Primary Rate trunks. Note: This command is available only if set cbc is set to yes.

Note:

Note:

Syntax
set cbc-service-feature type

Parameters
Parameter type Description The type of service or feature being specified in the Network Services Facility information element. If you specify scocs service, use the set cbc-parameter command to define the desired grade of service. Possible Values Feature types: operator sub-operator Service types: sdn megacom lds scocs Default Value sdn

User Level
read-write

Context
sls > trunk-group

Example
To specify that the scocs service will be specified in the Network Services Facility information element:
TGM550-001 (sls-trunk-group-<tgnum>)# set cbc-service-feature scocs

Issue 2 January 2008

533

CLI Commands

SLS survivability

set channel-preference
Use the set channel-preference command to define how the Channel Identification IE field is encoded in SLS. Note: This command only applies to ISDN trunks.

Note:

Syntax
set channel-preference type

Parameters
Parameter type Description Encoding of the Channel Identification IE field: exclusive The central office must have the ability to grant a call on this channel or reject the call attempt preferred The central office might offer the call request on another available channel Possible Values exclusive preferred Default Value preferred

User Level
read-write

Context
sls > trunk-group

Example
To define that the Channel Identification IE field is encoded to preferred status:
TGM550-001 (sls-trunk-group-<tgnum>)# set channel-preference preferred

set codeset-display
Use the set codeset-display command to identify which Q.931 codesets are allowed to send display information to the user phone in SLS. Note: This command only applies to ISDN trunks.

Note:

534 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Syntax
set codeset-display codeset

Parameters
Parameter codeset Description The Q.931 codeset that sends display information to the user phone Possible Values codeset0 codeset6 codeset7 Default Value codeset6

User Level
read-write

Context
sls > trunk-group

Example
To identify that codeset6 is allowed to send display information to the user phone:
TGM550-001 (sls-trunk-group-<tgnum>)# set codeset-display codeset6

set codeset-national
Use the set codeset-national command to identify which Q.931 codesets are allowed to send National Information Elements (IEs, or display information) to the user phone in SLS. Note: This command only applies to ISDN trunks.

Note:

Syntax
set codeset-national codeset

Issue 2 January 2008

535

CLI Commands

SLS survivability

Parameters
Parameter codeset Description The Q.931 codeset that sends National IE display information to the user phone. Note: This value depends on the local central office switch. Possible Values codeset6 codeset7 Default Value codeset6

User Level
read-write

Context
sls > trunk-group

Example
To specify that codeset6 is allowed to send National Information Elements to the user phone:
TGM550-001 (sls-trunk-group-<tgnum>)# set codeset-national codeset6

set dial
Use the set dial command to define the method for sending outbound digits in SLS.

Syntax
set dial dial-type

Parameters
Parameter dial-type Description The method used to send digits toward the outbound trunk Possible Values rotary dtmf Default Value dtmf

User Level
read-write

Context
sls > trunk-group

536 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Example
To define the method for sending outbound digits as DTMF:
TGM550-001 (sls-trunk-group-<200>)# set dial dtmf

set digit-handling
Use the set digit-handling command to define how the inbound/outbound calls handle the reception/transmission of the dialed pattern in SLS. Note: This command only applies to ISDN trunks.

Note:

Syntax
set digit-handling method

Parameters
Parameter method Description How the inbound/outbound calls handle the reception/transmission of the dialed pattern. Enbloc requires sending the entire collected digit string in one block. Overlap sends the digits one at a time as they are collected. Note: If you specify enbloc for transmission of outbound calls, the dialing technique should be ARS. Note: If you are employing TAC dialing for a trunk-group, set the transmission for outbound trunk calls to overlap. Possible Values enbloc-enbloc enbloc-overlap overlap-enbloc overlap-overlap Default Value enbloc-enbloc

User Level
read-write

Context
sls > trunk-group

Issue 2 January 2008

537

CLI Commands

SLS survivability

Example
To define that inbound and outbound calls handle reception and transmission as enbloc and enbloc respectively:
TGM550-001 (sls-trunk-group-<tgnum>)# set digit-handling enbloc-enbloc

set digits
Use the set digits command to define the inserted dial string that is added to the beginning of the received DID incoming dial string for analog DID trunks or for DS1 TIE trunks using in-band signaling in SLS. Note: You must have executed the set digit-treatment command before this command will work.

Note:

Syntax
set digits digits

Parameters
Parameter digits Description The inserted dial string that is added to the start of the received DID incoming dial string Possible Values* 0-9 plus * and # Default Value

* The number of digits must agree with the digit-treat parameter in the set digit-treatment command. If the digit-treat parameter is insert3, then the digits parameter for this command must be three digits in length.

User Level
read-write

Context
sls > trunk-group

Example
To define the inserted dial string as 538:
TGM550-001 (sls-trunk-group-<tgnum>)# set digits 538

538 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

set digit-treatment
Use the set digit-treatment command to define the incoming digit treatment for analog DID trunks or for DS1 TIE trunks using in-band signaling in SLS.

Syntax
set digit-treatment digit-treat

Parameters
Parameter digit-treat Description The incoming digit treatment for analog DID trunks only Possible Values blank (removes digit treatment), absorb1 absorb2 absorb3 absorb4 absorb5 insert1 insert2 insert3 insert4 Default Value blank

User Level
read-write

Context
sls > trunk-group

Examples
To define the incoming digit treatment as absorb 1:
TGM550-001 (sls-trunk-group-<tgnum>)# set digit-treatment absorb 1

To remove incoming digit treatment:


TGM550-001 (sls-trunk-group-<tgnum>)# set digit-treatment blank

Issue 2 January 2008

539

CLI Commands

SLS survivability

set incoming-destination
Use the set incoming-destination command to identify an extension to directly receive an incoming trunk call, for example, an attendant or a voice response/recording system in SLS. Note: This command only applies to non-ISDN digital, analog loop-start, and analog ground-start trunks.

Note:

Syntax
set incoming-destination extension

Parameters
Parameter extension Description The extension to receive an incoming trunk call, for example, an attendant or a voice response/recording system Possible Values "0 - 9," string may begin with "0" 0-13 characters, consistent with the local dial plan Any administered SLS extension Default Value " " (no station administered)*

* To clear the incoming-destination administration use the set incoming-destination " " command.

User Level
read-write

Context
sls > trunk-group

Example
To identify extension 5381000 to receive an incoming trunk call:
TGM550-001 (sls-trunk-group-<tgnum>)# set incoming-destination 5381000

set incoming-dialtone
Use the set incoming-dialtone command to provide a dial tone in response to far-end trunk group seizures in SLS. Note: This command only applies to digital DS1 trunks set up for inband signaling.

Note:

540 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Syntax
set incoming-dialtone {yes | no} Parameter yes no Description A keyword indicating to provide a dial tone A keyword indicating trunks that are not sending digits, for example, an incoming call on a loop-start central office trunk. This is the default value. Possible Values Default Value

User Level
read-write

Context
sls > trunk-group

Example
To withhold a dial tone:
TGM550-001 (sls-trunk-group-<tgnum>)# set incoming-dialtone no

set japan-disconnect
Use the set japan-disconnect command to perform a disconnect sequence (CONNECT message followed by a DISCONNECT message) in SLS. Note: This command only applies to ISDN trunks.

Note:

Syntax
set japan-disconnect {yes | no}

Issue 2 January 2008

541

CLI Commands

SLS survivability

Parameters
Parameter yes no Description Keyword specifying to perform a disconnect sequence Keyword specifying not to perform a disconnect sequence. This is the default. Possible Values Default Value

User Level
read-write

Context
sls > trunk-group

Example
To choose not to perform a disconnect sequence:
TGM550-001 (sls-trunk-group-<tgnum>)# set japan-disconnect no

set name
Use the set name command to identify the username for a station, a trunk group, a DS1, or ISDN facility in SLS.

Syntax
set name name

Parameters
Parameter name Description The name as specified on the corresponding Communication Manager form (add trunk-group n). This name is typically used to identify an individual, a service provider, or a site. If the file name includes spaces, use quotes. The length of the name is: DS1 and BRI: 1 -15 characters station and trunk-group: 1-27 characters Possible Values Default Value

542 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

User Level
read-write

Context
sls > station sls > trunk-group sls > ds1 sls > bri

Examples
To set the username Joe Smith for a given station:
TGM550-001 (sls-station-<extension>)# set name Joe Smith

set numbering-format
Use the set numbering-format command to specify the numbering plan for the current trunk in SLS. The numbering plan encodes the Numbering Plan Indicator and Type of Number fields in the Calling/Connected Party Number IE in the ISDN protocol. Note: Leave the setting of type to be unknown since SLS does not currently support an administrative table to calculate the Calling Party Number that is consistent with the numbering plan of the PSTN service provider. Note: This command only applies to ISDN trunks.

Note:

Note:

Syntax
set numbering-format type

Parameters
Parameter type Description The numbering plan for the current trunk. unknown Both the Numbering Plan Indicator and Type of Number are unknown public The Numbering Plan Indicator meets the E.164 standard and the Type of Number is national Possible Values unknown public Default Value unknown

Issue 2 January 2008

543

CLI Commands

SLS survivability

User Level
read-write

Context
sls > trunk-group

Example
To specify the numbering plan for the current trunk as public:
TGM550-001 (sls-trunk-group-<tgnum>)# set numbering-format public

set send-name
Use the set send-name command to define whether or not the calling, connected, called, or busy partys administered name is sent to the network on outgoing or incoming calls in SLS. Note: Leave the setting of method to be no, since sending a Calling Party Name is a future feature. Note: This command only applies to ISDN trunks.

Note:

Note:

Syntax
set send-name method

Parameters
Parameter method Description Specifies whether or not the calling, connected, called, or busy partys administered name is sent to the network on outgoing or incoming calls: yes The name is sent to the network for incoming or outgoing calls no The name is not sent to the network for incoming or outgoing calls restricted The name is sent to the network as Presentation restricted Note: If the name is not administered for the calling, connected, called, or busy station, the extension number is sent in place of the name. Possible Values yes no restricted Default Value no

544 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

User Level
read-write

Context
sls > trunk-group

Example
To define that the calling, connected, called, or busy partys administered name is sent to the network on outgoing or incoming calls:
TGM550-001 (sls-trunk-group-<tgnum>)# set send-name yes

set send-number
Use the set send-number command to define whether or not the calling, connected, called, or busy partys administered number is sent to the network on outgoing or incoming calls in SLS. Note: Leave the setting of method to be no, since sending a Calling Party Number is a future feature. Note: This command only applies to ISDN trunks.

Note:

Note:

Syntax
set send-number method

Parameters
Parameter method Description Specifies whether or not the calling, connected, called, or busy partys administered number is sent to the network on outgoing or incoming calls: yes The number is sent to the network for incoming or outgoing calls no The number is not sent to the network for incoming or outgoing calls restricted The number is sent to the network as Presentation restricted Possible Values yes no restricted Default Value no

Issue 2 January 2008

545

CLI Commands

SLS survivability

User Level
read-write

Context
sls > trunk-group

Example
To define that the calling, connected, called, or busy partys administered number is sent to the network on outgoing or incoming calls:
TGM550-001 (sls-trunk-group-<tgnum>)# set send-number yes

set supervision
Use the set supervision command to define the incoming signaling supervision mode for analog DID trunks or DS1 tie trunks only in SLS.

Syntax
set supervision sup-type

Parameters
Parameter sup-type Description For analog-did group types: The incoming signaling supervision mode for analog DID trunks For t1inband and e1inband group types: Signaling supervision for the non-ISDN digital trunks* Possible Values immediate wink loop-start ground-start wink-wink wink-immediate wink-auto immediate-immediate auto-auto auto-wink Default Value wink

wink-wink

* For TIE trunks you must specify both the incoming and outgoing modes. For example, wink-immediate requires the DS1 interface to use wink supervision to answer an incoming call and use an immediate seizure protocol for outbound calls.

User Level
read-write

546 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

Context
sls > trunk-group

Example
To define the incoming signaling supervision mode as wink mode:
TGM550-001 (sls-trunk-group-<tgnum>)# set supervision wink

To define the incoming signaling supervision mode as wink-wink mode:


TGM550-001 (sls-trunk-group-<tgnum>)# set supervision wink-wink

set tac
Use the set tac command to administer the trunk-access codes for SLS. You must issue this command before the trunk group is enabled in the SLS database.

Syntax
set tac tac

Parameters
Parameter tac Description Unique dial string identifies the trunk group* (circumvents normal Automatic Route System dial string analysis) Possible Values 1-4 digits (can include # and * as the leading digit only) Default Value

* This trunk-access code must be unique across all trunk groups, extension numbers, and any ARS Feature Access Code strings.

User Level
read-write

Context
sls > trunk-group

Example
To administer the trunk-access codes for trunk group 88:
TGM550-001 (sls-trunk-group-<200>)# set tac 88

Issue 2 January 2008

547

CLI Commands

SLS survivability

set trunk-hunt
Use the set trunk-hunt command to specify the trunk-hunting search within a facility in an ISDN trunk group or through a non-ISDN digital trunk group in SLS. Note: This command only applies to DS1 trunks.

Note:

Syntax
set trunk-hunt type

Parameters
Parameter type Description The trunk-hunting search type within a facility in an ISDN trunk group, or through a non-ISDN digital trunk group: ascend A linear search from the lowest to the highest numbered available channels cyclical A circular search beginning with the point at which the search previously ended. When the search has reached the top of the channel list, it resumes at the bottom of the list in wrap-around fashion. descend A linear search from the highest to the lowest numbered available channels Possible Values ascend cyclical descend Default Value cyclical

User Level
read-write

Context
sls > trunk-group

Example
To specify that the trunk-hunting search proceed in a cyclical fashion:
TGM550-001 (sls-trunk-group-<tgnum>)# set trunk-hunt cyclical

548 IG550 Integrated Gateway Administration and CLI Reference

SLS survivability

show (trunk-group)
Use the show command to display trunk group administration in SLS for this trunk group.

Syntax
show

User Level
read-write

Context
sls > trunk-group

Example
This example shows four BRI trunks assigned to one trunk-group
TGM550-001(sls-trunk-group-<tgnum>)# show Group Type Dial Tac ----- ---------- ------ ---1 bri - *99 Name = Willow Street 2 Ports = v401,v402,v417,v418 Codeset Codeset Channel Display National Preference -------- -------- ---------codeset6 codeset6 exclusive Send Send Name Number ---- -----yes yes Number Trunk Format Hunt ------ -------public ascend Supervision Treat Insert ------------------- ------- ------

Digit Japan Handling Discon --------------- -----enbloc-enbloc no

This example shows twelve ports assigned as T1inband signalling


TGM550-001(sls-trunk-group-<tgnum>)# show Group Type Dial Tac Supervision Treat Insert ----- ---------- ------ ---- ------------------- ------- -----1 t1-inband dtmf *96 wink/immediate Name = Willow Street 2 Ports = v401,v402,v403,v404,v405,v406,v407,v408,v409,v410,v411,v412 Incoming-Dest Incoming-Dial Trunk-Hunt ------------- ------------- ---------no ascend

Issue 2 January 2008

549

CLI Commands

SLS survivability

This example shows twelve ports assigned as t1-isdn signaling:


TGM550-001(sls-trunk-group-<tgnum>)# show Group Type Dial Tac Supervision Treat Insert ----- ---------- ------ ---- ------------------- ------- -----1 t1-isdn - *99 Name = Willow Street 2 Ports = v401,v402,v403,v404,v405,v406,v407,v408,v409,v410,v411,v412 Codeset Codeset Channel Digit Japan Display National Preference Handling Discon -------- -------- ---------- --------------- -----codeset6 codeset6 exclusive enbloc-enbloc no Send Send Name Number ---- -----yes yes Number Trunk Format Hunt ------ -------public ascend

Cbc Cbc-service-feature Cbc-parameter --- ------------------- ------------yes sdn -

Output fields
Field Group Type Description The trunk group index The trunk group type. Possible values: loop-start (analog loopstart) did (analog DID) The method for sending outbound digits. Possible values:

Dial

rotary dtmf

Tac Ports Supervision

The trunk-access code - a unique dial string that identifies the trunk group The virtual integrated port assignment The incoming signaling supervision mode for analog DID trunks only. Possible values:

immediate wink

Treat

The incoming digit treatment for analog DID trunks only 1 of 2

550 IG550 Integrated Gateway Administration and CLI Reference

SNMP access configuration

Field Insert Incoming Dest Incoming-Dial Trunk-Hunt

Description The dial string that is added to the start of the received DID incoming dial string The extension to receive an incoming trunk call Whether a dial tone is set in response to far-end trunk group seizures The trunk-hunting search within a facility in an ISDN trunk group or through a non-ISDN digital trunk group. Possible values:

ascend cyclical descend 2 of 2

SNMP access configuration


ip snmp
Use the ip snmp command to enable the SNMP agent for the TGM550. Use the no form of the command to disable the SNMP agent for the TGM550. Disabling the SNMP agent also blocks SNMP traps. However, users can change SNMP configuration settings even when the agent is disabled.

Syntax
ip snmp no ip snmp

User Level
admin

Context
general

Issue 2 January 2008

551

CLI Commands

SNMP access configuration

set snmp community


Use the set snmp community command to set or modify the media gateways SNMP community strings.

Syntax
set snmp community {read-only | read-write} [community_string]

Parameters
Parameter read-only read-write community_string Description Keyword specifying the read-only access level Keyword specifying the read-write access level Specifies the name of the SNMP community. If no community string is specified, the community string configured for the specified access type is cleared. Possible Values Default Value

User Level
read-write

Context
general

Example
To set the read-only community string to read:
TGM550-001(super)# set snmp community read-only read SNMP read-only community string set

show snmp
Use the show snmp command to display SNMP configuration information.

Syntax
show snmp

552 IG550 Integrated Gateway Administration and CLI Reference

SNMP access configuration

User Level
read-only

Context
general

Example
To display SNMP configuration information:
TGM550-001(super)# show snmp Authentication trap disabled Community-Access ---------------read-only read-write Community-String ---------------***** *****

SNMPv3 Notification Status ---------------------------Traps: Enabled Informs: Enabled Retries: 3 SNMP-Rec-Address Model ---------------- ----149.49.70.137 v1 UDP port: 162 DM

Timeout: 3 seconds Trap/Inform ----------trap User name ---------ReadCommN

Level Notification ----------------noauth all

show snmp engineID


Use the show snmp engineID command to display the SNMP engine ID for the TGM550.

Syntax
show snmp engineid

User Level
admin

Context
general

Issue 2 January 2008

553

CLI Commands

SNMP access configuration

Example
To display the SNMP engine ID:
TGM550-001(super)# show snmp engineid EngineId: 00:00:00:09:00:d0:00:4c:18:00 Engine Boots: 1234455

show snmp group


Use the show snmp group command to display configuration information about the SNMP groups or about a specified SNMP group.

Syntax
show snmp group [group-name]

User Level
admin

Context
general

Parameters
Parameter group-name Description The name of a specific SNMP group Possible Values Default Value

Example
To display configuration information for the ReadCommG SNMP group:
TGM550-001(super)# show snmp group readcommg Group Name: ReadCommG Security Model: v1 Security Level: noauth Read View: snmpv1View Write View: Notify View: snmpv1View

554 IG550 Integrated Gateway Administration and CLI Reference

SNMP access configuration

show snmp user


Use the show snmp user command to display configuration information for all SNMP users or for a specified SNMP user.

Syntax
show snmp user [username]

Parameters
Parameter username Description The username of the user whose information you wish to display Possible Values Default Value

User Level
admin

Context
general

Example
To display configuration information for SNMP user john:
TGM550-001(super)# show snmp user john EngineId: 00:11:22:33:44 User Name: john Authentication Protocol: Privacy Protocol: des56 Group for Security Model Group for Security Model Group for Security Model Storage Type: volatile Row status: active

md5 v1: v2: v3: RestrictedGroup RestrictedGroup RestrictedGroup

Issue 2 January 2008

555

CLI Commands

SNMP access configuration

show snmp usertogroup


Use the show snmp usertogroup command to show the mapping table between SNMPv3 users and groups.

Syntax
show snmp usertogroup [username]

Parameters
Parameter username Description Specifies an SNMPv3 username Possible Values Default Value

User Level
admin

Context
general

Example
To show the mapping table between SNMPv3 users and groups:
TGM550-001(super)# show snmp usertogroup Security Model: v1 Security Name: WriteCommN Group Name: WriteCommG Security Model: v2c Security Name: ReadCommN Group Name: ReadCommG Security Model: v2c Security Name: WriteCommN Group Name: WriteCommG

556 IG550 Integrated Gateway Administration and CLI Reference

SNMP access configuration

show snmp view


Use the show snmp view command to display configuration information for all SNMP views or for a specific SNMP view.

Syntax
show snmp view [view-name]

Parameters
Parameter view-name Description Specifies the view name Possible Values Default Value

User Level
admin

Context
general

Example
To display configuration information for all SNMP views:
TGM550-001(super)# show snmp view View Name: iso Subtree Oid: 1 Subtree Mask: View Type: include Storage Type: nonVolatile Status: active

snmp-server community
Use the snmp-server community command to enable read-only and read-write access to SNMP services via community strings. Use the no form of the command to prevent access to SNMP services using community strings. By default, community string access is enabled.

Syntax
[no] snmp-server community read-only community-name read-write community-name

Issue 2 January 2008

557

CLI Commands

SNMP access configuration

Parameters
Parameter community-name Description Assigns a read-only or read-write community string Possible Values Default Value

User Level
admin

Context
general

Example
To enable read-only access to SNMP services via the read-com community string and read-write access to SNMP services via the write-com community string:
TGM550-001(super)# snmp-server community read-only read-com read-write write-com

snmp-server engineID
Use the snmp-server engineID command to specify the SNMP Engine ID for the TGM550. Use the no form of the command to return the device to its default Engine ID. Note: The SNMP Engine ID must be unique for all devices on the network. Note: When you change the SNMP Engine ID, all users other than the default user are invalidated and must be redefined. Note: When the IP address of the TGM550 changes, the SNMP Engine ID is automatically changed.

Note:

Note:

Note:

Syntax
snmp-server engineID engineID no snmp-server engineID

558 IG550 Integrated Gateway Administration and CLI Reference

SNMP access configuration

Parameters
Parameter engineID Description 12 byte hexadecimal string, with each byte separated by a colon. For example, 00:00:00:81:0a:fe:ff:12:97:33:45:12. Possible Values Default Value

User Level
admin

Context
general

Example
To specify SNMP Engine 00:02:00:81:00:d0:00:4c:18:00 for the TGM550:
TGM550-001(super)# snmp-server engineid 00:02:00:81:00:d0:00:4c:18:00

snmp-server group
Use the snmp-server group command to define a new SNMPv3 group, or to configure settings for the group. An SNMP group associates users with views. Use the no form of the command to remove the specified group. Note: If you use the no form of the command with no additional parameters, all instances of the specified group are removed. If you specify a particular security group, only that group instance is removed.

Note:

Syntax
snmp-server group groupname {v1|v2c|{v3 level}} [read read-view] [write write-view] [notify notify-view] no snmp-server group groupname [v1|v2c|{v3 level}]

Issue 2 January 2008

559

CLI Commands

SNMP access configuration

Parameters
Parameter groupname v1 v2c v3 Description A character string specifying the group name Keyword indicating that the group is limited to SNMP v1 functionality Keyword indicating that the group is limited to SNMP v2c functionality Keyword indicating that the group has full SNMP v3 functionality. This is the default. The groups level of authentication auth the group authenticates packets noauth the group does not authenticate packets priv the group authenticates and encrypts packets A string of up to 64 characters noauth Possible Values A string of up to 32 characters Default Value

level

read-view

A character string specifying the view name for the read view. Users of this group have read access to the set of MIB objects specified in the read view. If no view is specified, the default is an empty view. A character string specifying the view name for the write view. Users of this group have write access to the set of MIB objects specified in the write view. If no view is specified, the default is an empty view. A character string specifying the view name for the notify view. Users of this group have notify access to the set of MIB objects specified in the notify view. If no view is specified, the default is an empty view.

write-view

A string of up to 64 characters

notify-view

A string of up to 64 characters

User Level
admin

560 IG550 Integrated Gateway Administration and CLI Reference

SNMP access configuration

Context
general

Example
To define or edit SNMPv3 group 12groupRO to authenticate packets with read view view1, write view notify, and notify view view2:
TGM550-001(super)# snmp-server group 12groupRO v3 auth read view1 notify view2

snmp-server remote-user
Use the snmp-server remote-user command to configure settings for a remote SNMPv3 user. If the user does not exist, it is created. Use the no form of the command to remove the user from specific groups. If no groups are specified, the user is removed from all groups.

Syntax
snmp-server remote-user username engineID groupname [auth {md5|sha} auth-password [priv des56 priv-password]] no snmp-server remote-user username [groupname]

Parameters
Parameter username Description A character string specifying the username of this user The remote device Engine ID for this user A character string specifying the groupname this user is associated with Keyword specifying to use the MAC-MD5-96 authentication protocol Keyword specifying to use the HMAC-SHA-96 authentication protocol A string of up to 32 characters Possible Values A string of up to 32 characters Default Value

engineID groupname

md5 sha

Issue 2 January 2008

561

CLI Commands

SNMP access configuration

Parameter auth-password

Description A character string no longer than 64 characters specifying the authentication password. An authentication password is required if the auth keyword is used. The minimum length is 8 characters. A character string no longer than 64 characters specifying the privacy password. The minimum length is 8 characters.

Possible Values

Default Value

priv-password

User Level
admin

Context
general

Example
To create or configure a remote SNMPv3 user, with username john, associated with group L2Group, and accessing engine 00:02:00:81:00:d0:00:4c:18:00:
TGM550-001(super)# snmp-server remote-user john L2Group 00:02:00:81:00:d0:00:4c:18:00

snmp-server user
Use the snmp-server user command to configure settings for an SNMPv3 user. If the user does not exist, it is created. Use the no form of the command to remove the user from specific groups. If no groups are specified, the user is removed from all groups.

Syntax
snmp-server user username groupname {{v1|v2c}|{v3 [auth {md5|sha} auth-password [priv des56 priv-password]]}} no snmp-server user username [groupname {v1|v2c|v3}]]

562 IG550 Integrated Gateway Administration and CLI Reference

SNMP access configuration

Parameters
Parameter username Description A character string specifying the username of this user A character string specifying the groupname this user is associated with Keyword specifying that the user is authorized for SNMP v1 functionality in the specified group Keyword specifying that the user is authorized for SNMP v2c functionality in the specified group Keyword specifying that the user is authorized for SNMP v3 functionality in the specified group Keyword specifying to use the MAC-MD5-96 authentication protocol Keyword specifying to use the HMAC-SHA-96 authentication protocol A character string specifying the authentication password. An authentication password is required if the auth keyword is used. The minimum length is 8 characters. A character string specifying the privacy password. The minimum length is 8 characters. A string of between 8 and 64 characters Possible Values A string of up to 32 characters A string of up to 32 characters Default Value

groupname

v1

v2c

v3

md5 sha auth-password

priv-password

A string of between 8 and 64 characters

User Level
admin

Context
general

Example
To configure settings for an SNMPv3 user with username john and groupname L2Group, authorized for SNMP v3 functionality, using the MAC-MD5-96 authentication protocol, with authentication password katmandu and privacy password uktanatan:
TGM550-001(super)# snmp-server user john L2Group v3 auth md5 katmandu des56 uktanatan priv

Issue 2 January 2008

563

CLI Commands

SNMP access configuration

snmp-server view
Use the snmp-server view command to configure settings for an SNMP MIB view. If the view does not exist, it is created. An MIB view specifies a particular section or subsection of the MIB tree. You can create a view that includes a particular subsection, or excludes one. Use the no form of the command to delete the current view.

Syntax
snmp-server view view-name oid-subtree {included|excluded} no snmp-server view view-name [oid-subtree]

Parameters
Parameter view-name oid-subtree Description The name of the view The object identifier subtree to be included in or excluded from this view. Oid-subtree is specified as a series of period-separated numbers. In order to include a subtree family, use an asterisk as a wildcard character. Symbolic MIB object names are not supported. Keyword indicating that the view includes the specified subtree (this is the default) Keyword indicating that the view excludes the specified subtree Possible Values Default Value

included excluded

User Level
admin

Context
general

Example
To configure settings for an SNMP MIB view named internet including Oidtree 1.3.6.1:
TGM550-001(super)# snmp-server view internet 1.3.6.1 included

564 IG550 Integrated Gateway Administration and CLI Reference

SNMP trap configuration

SNMP trap configuration


set snmp trap enable | disable auth
Use the set snmp trap enable|disable auth command to enable or disable SNMP authentication failure traps for all managers.

Syntax
set snmp trap {enable|disable} auth

User Level
admin

Context
general

show snmp
Use the show snmp command to display SNMP configuration information.

Syntax
show snmp

User Level
read-only

Context
general

Issue 2 January 2008

565

CLI Commands

SNMP trap configuration

Example
To display SNMP configuration information:
TGM550-001(super)# show snmp Community-Access read-only read-write trap Trap-Rec-Addr Community-String public private secret Status Traps configured

SNMPv3 Notifications Status Traps: Disabled Informs: Disabled Retries: 3 SNMP Rec-Addr Mode Level l 129.22.22.22 v1 noauth UDP port: 162 DM 129.11.33.44 v2c noauth UDP port: 162

Timeout: 3 seconds Notification Trap/ Inform all trap all inform

User Name ReadCommN WriteCommN

snmp-server enable notifications


Use the snmp-server enable notifications command to enable the sending of all traps and informs from the TGM550. Use the no form of the command to disable the sending of all traps and informs from the TGM550. Note: This command overrides the enabling of individual notifications using the snmp-server host command.

Note:

Syntax
[no] snmp-server enable notifications

User Level
admin

Context
general

566 IG550 Integrated Gateway Administration and CLI Reference

SNMP trap configuration

Example
To enable the sending of all traps and informs from the TGM550:
TGM550-001(super)# snmp-server enable notifications

snmp-server host
Use the snmp-server host command to identify an SNMP management server, and specify the kind of messages it receives. Use the no form of the command to remove the specified server, or to disable a particular set of notification types. Note: If you use the no snmp-server host command without a notification type list, all notification types are disabled.

Note:

Syntax
snmp-server host host_address {traps | informs} {{{v1 | v2c} community-name} | {v3 level username}} [udp-port port] [notification-list] no snmp-server host host_address [{traps|informs} notification-list]

Parameters
Parameter host_address traps Description The IP address of the SNMP host Keyword specifying to send traps to this host (messages not requiring acknowledgement). This is the default. Keyword specifying to send informs to this host (messages requiring acknowledgement) Keyword specifying to use SNMP v1 functionality with this host Keyword specifying to use SNMP v2c functionality with this host Possible Values Default Value

informs

v1

v2c

Issue 2 January 2008

567

CLI Commands

SNMP trap configuration

Parameter community-name

Description The community string to use to connect to the specified host (for v1 or v2c) Keyword specifying to use SNMP v3 functionality with this host The level of authentication to apply to messages to this host

Possible Values

Default Value

v3

level

auth authenticate messages to this host noauth do not authenticate messages to this host priv authenticate and encrypt messages to this host

noauth

username

The username to use for authentication on the specified host Which port of the target host to use 162

port

568 IG550 Integrated Gateway Administration and CLI Reference

SNMP trap configuration

Parameter notificationlist

Description List of notification types that are enabled for this host

Possible Values all all traps generic generic traps hardware hardware faults rmon RMON rising/falling alarm dhcp server DHCP server error dhcp-clients DHCP client error rtp-stat-faults RTP statistics: QoS fault/clear traps rtp-stat-qos RTP statistics: end-of-call QoS traps wan WAN router traps media-gateway media gateway traps security security traps config configuration change notifications eth-port-faults notifications of Ethernet port faults sw-redundancy software redundancy notifications temperature temperature warning notifications cam-change notifications about changes in CAM l3-events notifications about L3 faults (duplicate IP, VLAN violations) lag-event notifications about link aggregation faults and configuration changes policy notifications about changes in policy (for L3 devices) link-faults link-down notifications supply power supply notifications

Default Value all

User Level
admin

Issue 2 January 2008

569

CLI Commands

SNMP trap configuration

Context
general

Example
To identify an SNMP management server with host 10.1.2.4, connecting through udp-port 789, sending informs to its host using v3 SNMP functionality, authenticating messages with the username John, and having generic traps and configuration change notifications enabled:
TGM550-001(super)# snmp-server host 10.1.2.4 informs v3 auth John udp-port 789 config generic

snmp-server informs
Use the snmp-server informs command to configure settings for SNMP inform messages.

Syntax
snmp-server informs retries retries-num timeout timeout

Parameters
Parameter retries-num timeout Description The maximum number of times to resend an inform message The number of seconds to wait for an acknowledgement before resending an inform message Possible Values 0-255 1-65536 Default Value 3 3

User Level
admin

Context
general

Example
To configure a maximum of 5 retries and a 3 second timeout for SNMP inform messages:
TGM550-001(super)# snmp-server informs retries 5 timeout 3

570 IG550 Integrated Gateway Administration and CLI Reference

SSH protocol

SSH protocol
clear ssh-client known-hosts
Use the clear ssh-client known-hosts command to clear the SSH known-host file content. This command is used to unlock the man-in-the-middle attack prevention mechanism, and allow SCP server authentication after an SCP server public key change.

Syntax
clear ssh-client known-hosts

User Level
admin

Context
general

Example
To clear the SSH known-host file content:
TGM550-001(super)# clear ssh-client known-hosts

disconnect ssh
Use the disconnect ssh command to disconnect an existing SSH session.

Syntax
disconnect ssh session_id

Parameters
Parameter session_id Description The number of the SSH session to disconnect Possible Values Default Value

Issue 2 January 2008

571

CLI Commands

SSH protocol

User Level
admin

Context
general

hostname
Use the hostname command to change the Command Line Interface (CLI) prompt. The prompt is written as hostname-registration, where the hostname is the value entered with the hostname command, and registration is the media gateway registration information. If the device is registered, the current media gateway number appears. If the device is not registered, question marks are displayed. Use the hostname command with no parameters to display the current prompt value. Use the no form of this command to return the CLI prompt to the default.

Syntax
hostname [hostname_string] no hostname

Parameters
Parameter hostname_ string Description The hostname Possible Values a string of up to 20 characters Default Value TGM550

User Level
read-write

Context
general

Example
To set the CLI prompt to GTW-HQ:
TGM550-001(super)# hostname GTW-HQ GTW-HQ-001(super)# hostname Session hostname is 'GTW-HQ'

572 IG550 Integrated Gateway Administration and CLI Reference

SSH protocol

To reset the CLI prompt to the default:


GTW-HQ-001(super)# no hostname TGM550-001(super)#

ip ssh
Use the ip ssh command to enable the Secure Shell (SSH) service. SSH is a security protocol that enables you to establish a remote session over a secured tunnel, also called a remote shell. Use the no form of the command to disable the SSH service, and close any open connections currently using SSH. When disabling the service, the TGM550 issues a message listing all current management interfaces. If SSH is currently the only enabled management interface, the user is warned that the remote connection will be lost. Note: For normal execution of SSH protocol, the TGM550 must first be assigned host name identification. Use the hostname command to assign host name identification. Note: In order to enable SSH to be used, you must configure the server host key. See the crypto-key generate command.

Note:

Note:

Syntax
[no] ip ssh

User Level
admin

Context
general

Example
To disable SSH service:
TGM550-001(super)# no ip ssh This will prevent future remote SSH sessions and disconnect all active SSH sessions - do you want to continue (Y/N)? y

Issue 2 January 2008

573

CLI Commands

SSH protocol

show ip ssh
Use the show ip ssh command to display general SSH information and information about the currently active connections that are using SSH.

Syntax
show ip ssh

User Level
admin

Context
general

Example
To display SSH information:
TGM550-001(super)# show ip ssh Max Sessions: 2 Key type: DSA , 512 bit Listen Port: 22 Ciphers List: 3des-cbc Session Version Encryption Username IP/Port 0 1.5 3des-cbc guest 11.11.11.1/34444

Output fields
Name Max Sessions Key type Listen Port Ciphers List Session Version Encryption Username IP/Port Description The maximum number of concurrent sessions The type of SSH key (always DSA) and the key length The SSH server listening port (always 22) List of supported ciphers Session ID of each currently active session The version of the SSH protocol used by the session The encryption method used by the session The name of the user that initiated the session The IP address and port number of the client

574 IG550 Integrated Gateway Administration and CLI Reference

Synchronization

Synchronization
clear sync interface
Use the clear sync interface command to disassociate an interface previously specified as the primary or secondary clock synchronization source. Note: The primary interface must be disassociated before the secondary interface is disassociated.

Note:

Syntax
clear sync interface {primary | secondary}

Parameters
Parameter primary secondary Description Keyword specifying the primary clock synchronization source Keyword specifying the secondary clock synchronization source Possible Values Default Value

User Level
read-write

Context
general

Example
To disassociate the interface that is specified as the primary clock synchronization source:
TGM550-001(super)# clear sync interface primary

Issue 2 January 2008

575

CLI Commands

Synchronization

set sync interface


Use the set sync interface command to define the specified module and port as a potential source for clock synchronization for the media gateway.

Syntax
set sync interface {primary | secondary} mmID [portID]

Parameters
Parameter primary secondary mmID Description Keyword that specifies normal failover Keyword that specifies to override normal failover, generate a trap, and assert a fault The Media Module ID number of a stratum clock source, of the form vn where n is the slot number Port or port range for an ISDN clock source candidate Possible Values Default Value

portID

User Level
read-write

Context
general

Example
To specify that ports 1, 3, 5, 6, 7, and 8 of media module 2 are used for normal failover:
TGM550-001(super)# set sync interface primary v2 1,3,5-8

set sync source


Use the set sync source command to specify which clock source is the active clock source. The identity of the current synchronization source is not stored in persistent storage.

Syntax
set sync source {primary | secondary | local}

576 IG550 Integrated Gateway Administration and CLI Reference

Synchronization

Parameters
Parameter primary secondary Description Keyword specifying to set the primary clock source to be active Keyword specifying to set the secondary clock source to be active, and the primary clock source on standby Keyword specifying to set the local clock to be active Possible Values Default Value

local

User Level
read-write

Context
general

Example
To set the primary clock as the clock source:
TGM550-001(super)# set sync source primary

If the secondary interface is not configured, the sync source set operation will fail:
TGM550-001(super)# set sync source secondary Operation Failed Cannot set the secondary clock source to be the active clock source

set sync switching


Use the set sync switching command to toggle automatic failover and failback between designated primary and secondary synchronization sources.

Syntax
set sync switching {enable | disable}

Issue 2 January 2008

577

CLI Commands

Synchronization

Parameters
Parameter enable disable Description Keyword specifying to enable automatic sync source switching Keyword specifying to disable automatic sync source switching Possible Values Default Value

User Level
read-write

Context
general

Example
To enable sync source switching:
TGM550-001(super)# set sync switching enable

show sync timing


Use the show sync timing command to display the status of the primary, secondary, and local clock sources.

Syntax
show sync timing

User Level
read-only

Context
general

Example
To display clock source information:
TGM550-001(super)# show sync timing

578 IG550 Integrated Gateway Administration and CLI Reference

SYN-cookies

SOURCE --------Primary Secondary Local

MM -------------------

v0

STATUS ----------------------Not Configured Not Configured Active

FAILURE -----------

None

Active Source: v0

Sync Source Switching: Enabled

SYN-cookies
clear tcp syn-cookies counters
Use the clear tcp syn-cookies counters command to clear the SYN cookies counters.

Syntax
clear tcp syn-cookies counters

User Level
read-only

Context
general

Examples
To clear the SYN cookies counters:
TGM550-001(super)# clear tcp syn-cookies counters

show tcp syn-cookies


Use the show tcp syn-cookies command to show SYN cookies statistics for inbound TCP connections.

Syntax
show tcp syn-cookies

Issue 2 January 2008

579

CLI Commands

SYN-cookies

User Level
read-only

Context
general

Example
To show SYN cookies statistics:
TGM550-001(super)# show tcp syn-cookies Status: Enabled Statistics: SYN rcvd Connections established local address --------------------192.113.241.201:60342 192.113.241.201:23 192.113.241.201:23

10 9 remote address -------------------111.211.131.1:80 221.2.11.11:432 121.192.171.121:7311 state -------------IN_PROGRESS ESTABLISHED CLOSING Last access (sec) ---------------1 1200 10

Output fields
Field Status SYN rcvd Connections established local address remote address state Description The operational status of the TCP SYN cookies defense mechanism: Enabled or Disabled The total number of TCP SYN packets received since the last time the counters were reset The total number of connections that were established since the last time the counters were reset The local IP address and port of the connection The remote IP address and port of the connection The state of the connection: IN_PROGRESS connection is in progress ESTABLISHED connection is established CLOSING connection is closing The seconds elapsed since the last time a packet was received on the connection from either side

Last access

580 IG550 Integrated Gateway Administration and CLI Reference

SYN-cookies

tcp syn-cookies
Use the tcp syn-cookies command to enable the TCP SYN cookies defense mechanism against SYN attacks. Use the no form of this command to disable the TCP SYN cookies defense mechanism against SYN attacks. Note: SYN cookies are disabled by default. Note: When enabling or disabling SYN cookies, you are prompted to copy the running configuration to the start-up configuration using the copy running-config startup-config command, and then to reset the device.

Note:

Note:

Syntax
[no] tcp syn-cookies

User Level
read-write

Context
general

Examples
To enable SYN cookies:
TGM550-001(config)# tcp syn-cookies To enable tcp syn-cookies copy the running configuration to the start-upconfiguration file, and reset the device. TGM550-001(config)# copy running-config startup-config TGM550-001(config)# reset ... ! Coming up from reset - syn-cookies are now enabled

To disable SYN cookies:


TGM550-001(config)# no tcp syn-cookies To disable tcp syn-cookies copy the running configuration to the start-upconfiguration file, and reset the device.

Issue 2 January 2008

581

CLI Commands

Syslog files

Syslog files
copy syslog-file ftp
Use the copy syslog-file ftp command to copy the Syslog file to a remote server using FTP.

Syntax
copy syslog-file ftp filename ip

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Example
To copy the syslog file syslog1 to the host with IP address 192.168.49.10:
TGM550-001(super)# copy syslog-file ftp syslog1 192.168.49.10

copy syslog-file scp


Use the copy syslog-file scp command to copy the Syslog file to a remote server using SCP.

Syntax
copy syslog-file scp filename ip

582 IG550 Integrated Gateway Administration and CLI Reference

Syslog files

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Example
To copy the Syslog file syslog1 to the host with IP address 192.168.49.10:
TGM550-001(super)# copy syslog-file scp syslog1 192.168.49.10

copy syslog-file tftp


Use the copy syslog-file tftp command to copy the Syslog file to a remote server using TFTP.

Syntax
copy syslog-file tftp filename ip

Parameters
Parameter filename ip Description File name with full path IP address of the host Possible Values string IP address Default Value

User Level
admin

Context
general

Issue 2 January 2008

583

CLI Commands

Syslog files

Example
To copy the Syslog file syslog1 to the host with IP address 192.168.49.10:
TGM550-001(super)# copy syslog-file tftp syslog1 192.168.49.10

show upload syslog-file status


Use the show upload syslog-file status command to view the status of the upload operation of a Syslog file.

Syntax
show upload syslog-file status

User Level
read-only

Context
general

Example
To view the status of the upload operation of a Syslog file: (In this example, an upload command has been issued and the upload succeeds.)
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : show upload syslog-file status

10 syslog file 444 135.64.102.114 Idle (null) No-warning

(In this example, an upload command has been issued, but the upload fails.)
TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Failure display : Last warning : Show upload syslog-file status

10 syslog file d:\zion\run.cfg 135.64.102.39 Idle SCP - Permission denied No-warning

584 IG550 Integrated Gateway Administration and CLI Reference

System identification

(In this example, no upload command has been issued.)


TGM550-001(super)# Show upload syslog-file status Module #10 ========== No source file for upload operation - no upload operation was done.

System identification
set system contact
Use the set system contact command to set the contact information for this media gateway system.

Syntax
set system contact [string]

Parameters
Parameter string Description The contact name string should be typed inside double quotes. The name is cleared if you leave this field blank. Possible Values Default Value

User Level
read-write

Context
general

Example
To set the contact information of the system to Larry Williams:
TGM550-001# set system contact Larry Williams *** Set system contact *** system contact set

Issue 2 January 2008

585

CLI Commands

System identification

set system location


Use the set system location command to set the location information for this media gateway system.

Syntax
set system location [string]

Parameters
Parameter string Description The location name string should be typed inside double quotes. The location is cleared if you leave this field blank. Possible Values Default Value

User Level
read-write

Context
general

Example
To set the location information of the system to tech-support:
TGM550-001# set system location tech-support *** Set system location *** system location set

set system name


Use the set system name command to specify the name of the media gateway system. Note: Set the name of the media gateway to be consistent with the Name field on the Media Gateway administration form in Avaya Communication Manager (add media-gateway).

Note:

Syntax
set system name [string]

586 IG550 Integrated Gateway Administration and CLI Reference

Telnet access

Parameters
Parameter string Description The system name string, typed inside quotes. The name is cleared if you leave this field blank. Possible Values Default Value

User Level
read-write

Context
general

Examples
To set the name of the system to TGM550-HQ:
TGM550-001(super)# set system name TGM550-HQ *** Set system name *** system name set

Telnet access
ip telnet
Use the ip telnet command to enable the Telnet server. Use the no form of the command to disable the Telnet server. Note: For security reasons, this command can only be executed from the Console port. Note: The ip telnet command is a secured command and will not be displayed together with the running configuration (using the show running-config command). To see the status of this command, use the show protocol command (refer to show protocol on page 313).

Note:

Note:

Syntax
ip telnet [port port_number]

Issue 2 January 2008

587

CLI Commands

Telnet access

no ip telnet

Parameters
Parameter port port_number Description Keyword that changes the default port of the Telnet server The number of the new port for the Telnet server 1-65535 23 Possible Values Default Value

User Level
admin

Context
general

ip telnet-client
Use the ip telnet-client command to enable the Telnet client. Use the no form of the command to disable the Telnet client. Note: For security reasons, this command can only be executed from the console port. Note: The ip telnet command is a secured command and will not be displayed together with the running configuration (using the show running-config command). To see the status of this command, use the show protocol command (refer to show protocol on page 313).

Note:

Note:

Syntax
[no] ip telnet-client

User Level
admin

Context
general

588 IG550 Integrated Gateway Administration and CLI Reference

Telnet access

show ip telnet
Use the show ip telnet command to display the configuration and status of the Telnet server and the current Telnet connections.

Syntax
show ip telnet

User Level
read-only

Context
general

Example
To display the configuration and status of the Telnet server and the current Telnet connections:
TGM550-001(super)# show ip telnet Telnet Engine: Enable Max Sessions: 5 Listen Port: 23 Session-Id User 0 root IP:Port 135.64.102.29:1059

telnet
Use the telnet command to initiate a login session via Telnet to a network host.

Syntax
telnet ipaddress [port_number]

Parameters
Parameter ipaddress port_number Description The Telnet IP address The Telnet port number 23 Possible Values Default Value

Issue 2 January 2008

589

CLI Commands

TFTP server

User Level
read-only

Context
general

Example
To initiate a Telnet session to IP address 133.23.6.66:
TGM550-001(super)# telnet 133.23.6.66

TFTP server
clear ip tftp-server statistics
Use the clear ip tftp-server statistics command to clear TFTP server statistics.

Syntax
clear ip tftp-server statistics

User Level
read-write

Context
general

Example
To clear TFTP server statistics:
TGM550-001# clear ip tftp-server statistics

590 IG550 Integrated Gateway Administration and CLI Reference

TFTP server

ip tftp-server
Use the ip tftp-server command to enable the TFTP server. Use the no ip tftp-server command to disable the TFTP server.

Syntax
[no] ip tftp-server

User Level
read-write

Context
general

Example
To enable TFTP server:
TGM550-001(super)# ip tftp-server

ip tftp-server file-system size


Use the ip tftp-server file-system-size command to set the TFTP file system size. Use the no ip tftp-server file-system-size command to reset the TFTP file system size to its default size. Note: It is possible to increase the memory allocation for the Sniffer cache application at the expense of the TFTP file system size. The Sniffer cache application may have been configured to use up to 1000 Kb of the default TFTP allocation of 18560 Kb, which would cause a conflict when setting the TFTP allocation to a high value.

Note:

Syntax
[no] ip tftp-server file-system-size size

Parameters
Parameter size Description The TFTP server total file size in KB Possible Values 256-19456 Default Value 18560

Issue 2 January 2008

591

CLI Commands

TFTP server

User Level
read-write

Context
general

Example
To set the TFTP file system size to 18128 KB:
TGM550-001# ip tftp-server file-system-size 18128 To change ip tftp-server file system size, copy the running configuration to the start-up configuration file, and reset the device

show application-memory
Use the show application-memory CLI command to show the configured and allocated application memory.

Syntax
show application-memory

User Level
read-only

Context
general

Example
To show the configured and allocated application memory:
TGM550-001(super)# show application-memory Application ---------------------------------------Sniffer (capture buffer-size) TFTP (ip tftp-server file-system-size) ---------------------------------------Total used memory Total free memory Total memory (fixed) Memory(KB) Allocated Configured --------------------1024 1024 18560 18560 --------------------19584 19584 896 896 20480

592 IG550 Integrated Gateway Administration and CLI Reference

Traffic shaping

Traffic shaping
dir
Use the dir command to show:

The files that have been downloaded to the media gateway using the TGM550-001 Download interface and the SNMP MIB.

Syntax
dir [module_number]

Parameters
Parameter module_number Description Displays downloaded files for the specified module only Possible Values Default Value

User Level
read-write

Context
general

Issue 2 January 2008

593

CLI Commands

Traffic shaping

Example
To display a list of downloaded files:
TGM550-001(super)# dir M# file ver num file type file location file description -- ----------- ---------------------- ---------------1 TIM510 5 SW RT Image Nv-Ram TIM510 - image 3 TIM514 17 SW RT Image Nv-Ram TIM514 - image 4 TIM521 2 SW RT Image Nv-Ram TIM521 - image 9 hi.wav N/A Annc files Nv-Ram Announcement files 9 hi1.wav N/A Annc files Nv-Ram Announcement files 9 hi2.wav N/A Annc files Nv-Ram Announcement files 10 startup-config N/A Startup Conf Nv-Ram Startup Config 10 running-config N/A Running Conf Ram Running Config 10 TGM550-A 24.6.0 SW RT Image Flash Bank A Software Image Bank A 10 TGM550-B 24.8.0 SW Component Flash Bank B Software Image Bank B 10 TGM550-Booter 21.12.0 SW BootImage Nv-Ram Booter Image 10 phone-ScriptA N/A Phone Script Nv-Ram N/A 10 phone-ScriptB N/A Phone Script Nv-Ram 46xxupgrade.scr 10 phone-ScriptC N/A Phone Script Nv-Ram N/A 10 phone-ScriptD N/A Phone Script Nv-Ram N/A

show restore status


Use the show restore status command to display information regarding the status of a restore operation of gateway files. The output displays the list of files restored so far.

Syntax
show restore status

User Level
read-only

Context
general

Example
To display information regarding the status of a gateway file restore operation:
TGM550-001(super)# show restore status Files restored:

594 IG550 Integrated Gateway Administration and CLI Reference

Users

Type FileName Status ----------------------------------------------------------startup-config startup_config.cfg OK auth-file auth-file.cfg OK phone-script 46xxupgrade.scr OK phone-script 46xxsettings.txt OK phoneImageFile 4602dbte1_82.bin OK phoneImageFile 4601dbte1_82.bin OK phoneImageFile 4602dape1_82.bin OK phoneImageFile 4601dape1_82.bin OK announcement A01100.wav OK announcement Ann7.wav OK

Users
show username
Use the show username command to display local user accounts.

Syntax
show username

User Level
admin

Context
general

Example
To display all defined user accounts:
TGM550-001(super)# show username User account password access-type ------------------ -----------root ***** admin tsmith ***** read-only readwrite ***** read-write

Issue 2 January 2008

595

CLI Commands

Users

username
Use the username command to add a local user account. Use the no form of the command to remove the user account from the system. By default there is only a single user account, named root, with password root, which accesses the administrator level. You cannot delete this basic user account, nor modify its access level. However, you can modify its basic password. Note: For security reasons, you should change the root password immediately.

Note:

Syntax
username name [password passwd | asg-secret secret] access-type access_type no username name

Parameters
Parameter name passwd secret access_type Description New user name or dadmin Users password ASG secret key of a dadmin user Access type definition Possible Values minimum four character string minimum eight character string 32 hexadecimal characters read-only, read-write, admin Note: A dadmin user and a root user must be assigned an admin access type. Default Value

User Level
admin

Context
general

596 IG550 Integrated Gateway Administration and CLI Reference

VoIP

Example
To create a new user account with username john, password johnnysm, and a read-write access:
TGM550-001(super)# username john password johnnysm access-type read-write User account added.

To change the password of the root user:


TGM550-001(super)# username root password mysecret access-type admin User account modified.

Note:

Note: You cannot change the access type of the root user:

TGM550-001(super)# username root password verysecret access-type read-write ERROR: User account root has always an administrator access type.

Note:

Note: If you wish to define a username which includes spaces, you must enclose the entire name in quotation marks, for example new york.

VoIP
campon-busyout voip-dsp
Use the campon-busyout voip-dsp command to put the entire VoIP engine or individual DSP childboard in busyout (not available) state for maintenance or firmware upgrade.

Syntax
campon-busyout voip-dsp [dsp-id[/core-id]]

Parameters
Parameter dsp-id core-id Description Keyword indicating the slot number of the VoIP DSP childboard Keyword indicating the core ID Possible Values 1-4 1-4 Default Value

Issue 2 January 2008

597

CLI Commands

VoIP

User Level
read-write

Context
general

Example
To camp on busyout the entire VoIP engine:
TGM550-001(super)# campon-busyout voip-dsp

To camp on busyout DSP childboard #3:


TGM550-001(super)# campon-busyout voip-dsp 3

To camp on busyout DSP childboard #3, Core 2:


TGM550-001(super)# campon-busyout voip-dsp 3/2

reset voip-dsp
Use the reset voip-dsp command to reset a VoIP DSP childboard on the motherboard.

Syntax
reset voip-dsp dsp-id

Parameters
Parameter dsp-id Description The slot number of the VoIP DSP childboard Possible Values 1-4 Default Value

User Level
read-write

Context
general

Example
To reset the VoIP childboard in slot 2:
TGM550-001(super)# reset voip-dsp 2

598 IG550 Integrated Gateway Administration and CLI Reference

VoIP

show voip-dsp
Use the show voip-dsp command to display information about the DSP and DSP cores parameters, status and occupancy.

Syntax
show voip-dsp [dsp-id]

Parameters
Parameter dsp-id Description Keyword indicating the slot number of the VoIP DSP childboard Possible Values 1-4 Default Value

User Level
read-only

Context
general

Examples
To display DSP parameters of DSP 1 use:
TGM550-001(super)# show voip-dsp 1 DSP #1 PARAMETERS --------------------------------------------------------Slot : 1 Board type : 8122 Hw Vintage : 3 FW Vintage : 235 DSP #1 CURRENT STATE --------------------------------------------------------In Use : 10 of 80 channels, 37 of 300 points (0.0% used) State : InUse Admin State: Release

Issue 2 January 2008

599

CLI Commands

VoIP

Core# ---1 2 3 4

Channels In Use ------4 of 20 1 of 20 5 of 20 0 of 20

Admin state ----------Release Camp-on Release Busyout

State ----InUse InUse InUse Idle

Error Msg -----------------No Status Messages No Status Messages No Status Messages No Status Messages

show voip-parameters
Use the show voip-parameters command to display information about the VoIP engine.

Syntax
show voip-parameters

User Level
read-only

Context
general

Examples
To display VoIP information:
TGM550-001(super)# show voip-parameters VOIP ENGINE PARAMETERS --------------------------------------------------------IP (PMI) : 172.16.1.139 DSP Firmware Version: 200 DSP Hardware Vintage: 1.0 Fault Status : No Fault Messages Additional Status : No Status Messages CURRENT STATE --------------------------------------------------------In Use : 0 channels, 0 of 300 points (0.0% used) DSPs State : Idle Admin State: Release

600 IG550 Integrated Gateway Administration and CLI Reference

VoIP testing

VoIP testing
busyout voip-dsp
Use the busyout voip-dsp command to put the VoIP entity in busyout (not available) state. This is recommended before starting a Bit Transfer Rate test. Note: Status changes made during the Bit Transfer Rate test create SNMP traps.

Note:

Syntax
busyout voip-dsp [dsp-id[/core-id]]

Parameters
Parameter dsp-id core-id Description The slot number of the VoIP DSP childboard The core ID Possible Values 1-4 1-4 Default Value

User Level
read-write

Context
general

Example
To busyout DSP childboard #3:
TGM550-001(super)# busyout voip-dsp 3

To busyout DSP childboard # 1, Core 2:


TGM550-001(super)# busyout voip-dsp 1/2

Issue 2 January 2008

601

CLI Commands

VoIP testing

release voip-dsp
Use the release voip-dsp command to release the VoIP entity from a busyout (not available) state. This command also ends a running Bit Transfer Rate test. Note: Status changes that occur during the Bit Transfer Rate test create SNMP traps.

Note:

Syntax
release voip-dsp [dsp-id[/core-id]]

Parameters
Parameter dsp-id core-id Description The slot number of the VoIP DSP childboard The core ID Possible Values 1-4 1-4 Default Value

User Level
read-write

Context
general

Example
To release the VoIP engine:
TGM550-001(super)# release voip-dsp

To release DSP childboard #2:


TGM550-001(super)# release voip-dsp 2

To release core #4 in DSP childboard #1:


TGM550-001(super)# release voip-dsp 1/4

602 IG550 Integrated Gateway Administration and CLI Reference

VoIP testing

show voip-parameters
Use the show voip-parameters command to display information about the current VoIP engine.

Syntax
show voip-parameters

User Level
read-only

Context
general

Examples
To display VoIP information:
TGM550-001(super)# show voip-parameters VOIP ENGINE PARAMETERS --------------------------------------------------------IP (PMI) : 172.16.1.139 DSP Firmware Version: 200 DSP Hardware Vintage: 1.0 Fault Status : No Fault Messages Additional Status : No Status Messages CURRENT STATE --------------------------------------------------------In Use : 0 channels, 0 of 300 points (0.0% used) DSPs State : Idle Admin State: Release

test voip-dsp
Use the test voip-dsp command to start a BTR test on the VoIP engine. Also refer to busyout voip-dsp on page 601, and release voip-dsp on page 602. Note: If you do not run the busyout voip-dsp command before the test voip-dsp command, only non-disruptive tests will run.

Note:

Issue 2 January 2008

603

CLI Commands

VoIP testing

Note:

Note: Status changes during the test create SNMP traps.

Syntax
test voip-dsp [dsp-id[/core-id]]

Parameters
Parameter dsp-id core-id Description The slot number of the VoIP DSP childboard The core ID Possible Values 1-4 1-4 Default Value

User Level
read-write

Context
general

Example:
To start a BTR test:
TGM550-001(super)# test voip-dsp DSP TEST RESULTS -------------------------DSP 0 PASS DSP 1 PASS

604 IG550 Integrated Gateway Administration and CLI Reference

WAN configuration, verifying

WAN configuration, verifying


show interfaces
Use the show interfaces command to display interface configuration and statistics for a particular interface or all interfaces. The Frame Relay sub-interface only includes the following counters:

packets & bytes in packets & bytes out input errors output drops

Syntax
show interfaces [interface_type interface_identifier]

Parameters
Parameter interface_type Description The type of interface Possible Values DIaler, FastEthernet, Serial, Vlan, Loopback, Console, Tunnel, USB For Serial(USP): 2/1 For Serial (DS1): module/port: 2/1 channel-group: E1: 0-30 T1: 0-23 For Loopback: 1-99 For Tunnel: 1-50 For Dialer: 1 Default Value

interface_ identifier

The interface number. The format varies depending on the value of interface_type: For FastEthernet: module/port For Serial: module/ port:channel-group For Vlan: Vlan id For LoopBack: Loopback number For Tunnel: Tunnel number

Issue 2 January 2008

605

CLI Commands

WAN configuration, verifying

User Level
read-write

Context
general

Example
To show information about all the interfaces:
TGM550-001(super)# show interfaces Physical address is 00.04.0d.29.c5.11. Internet address is 172.16.1.139, mask is 255.255.255.240 MTU 1500 bytes. Bandwidth 100000 kbit. Reliability 255/255 txLoad 1/255 rxLoad 1/255 Link status trap disabled Full-duplex, 100Mb/s Last input 00:00:30, Last output 00:00:30 Last clearing of 'show interface' counters never. 5 minute input rate 144 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 3425 packets input, 323518 bytes 3425 broadcasts received, 0 giants 0 input errors, 0 CRC 32 packets output, 896 bytes 0 output errors, 0 collisions FastEthernet 10/2 is up, line protocol is down Physical address is 00.04.0d.29.c5.10. MTU 1500 bytes. Bandwidth 10000 kbit. Reliability 1/255 txLoad 255/255 rxLoad 255/255 Encapsulation ARPA Link status trap disabled Half-duplex, 10Mb/s, 10BaseTX ARP type: ARPA, ARP Timeout 04:00:00 Dynamic CAC BBL: 1500 kbps Dynamic CAC activation priority: 50 Dynamic CAC interface status: active Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions

606 IG550 Integrated Gateway Administration and CLI Reference

WAN configuration, verifying

Tunnel 1 is up, line protocol is up Internet address is 177.0.0.17, mask is 255.0.0.0 MTU 468 bytes. Bandwidth 9 kbit Reliability 255/255 txLoad 1/255 rxLoad 1/255 Encapsulation GRE Link status trap enabled Keepalive set (10 sec), retries 3 Tunnel source 17.0.0.17, destination 12.0.0.3 Tunnel protocol/transport GRE/IP, key 777 Checksumming of packets enabled Tunnel DSCP 63, Tunnel TTL 255 Path MTU Discovery, ager 10 mins, MTU 976, expires 00:09:33 Last input never, Last output never Last clearing of 'show interface' counters never. 5 minute input rate 0 bits/sec, 0 packets/sec 5 minute output rate 0 bits/sec, 0 packets/sec 0 input drops, 0 output drops, 0 unknown protocols 0 packets input, 0 bytes 0 broadcasts received, 0 giants 0 input errors, 0 CRC 0 packets output, 0 bytes 0 output errors, 0 collisions Console asynchronous mode is terminal Terminal baud rate is 9600

Issue 2 January 2008

607

CLI Commands

WAN configuration, verifying

608 IG550 Integrated Gateway Administration and CLI Reference

Appendix A: Traps and MIBs


This appendix contains a list of all TGM550 Telephony Gateway Module traps and all MIBs.

TGM550 Telephony Gateway Module traps


.

Enterprise

Trap ID 1

Name

Msg Facility Boot

Severity

Description / Resolution

snmpTraps

coldStart

Warning

The entity is reinitializing itself in such a way as to potentially cause the alteration of either the agents configuration or the entitys implementation. This trap is always enabled. The entity is reinitializing itself in such a way as to keep both the agents configuration and the entitys implementation intact. This trap is always enabled. The protocol is not properly authenticated. An attempt has been made to logon to the device with an invalid userid/password. A security configuration change occurred. A userid/password was locked out. The MSS notification sent on DoS attack. Encryption keys mismatch error. Configuration download operation is aborted. Configuration Master key was changed. 1 of 10

snmpTraps

warmStart

Boot

Warning

snmpTraps avayaG350 LannetTraps LannetTraps secMng secMng

5 68

authenticFailure lntUnAuthorizedAccessEvent IntConfigChangeEvent IntAccountLockoutEvent avMSSDenialOfService avConfigurationEncKeyMismatchFaul t

Security

Notification Notification Notification Notification Notification Notification

secMng

avConfigurationMasterKeyChange

Notification

Issue 2 January 2008

609

Traps and MIBs

Enterprise

Trap ID 22

Name

Msg Facility Temp

Severity

Description / Resolution

avEntTraps

avEntAmbientHiThresholdTempFlt

Error

The ambient temperature in the device is above the acceptable temperature range. 1. Verify there are faults in the system. Use the TGM550 Telephony Gateway Module CLI command show faults to display any faults on the TGM550 Telephony Gateway Module. 2. If there is a temperature fault, turn off the TGM550 Telephony Gateway Module and allow it to cool. 3. Reboot the TGM550 Telephony Gateway Module. Check to see if the fans are working and/or if there is sufficient space around the TGM550 Telephony Gateway Module for air circulation. Use the CLI show faults command to check for fan problems. 4. Low voltage may be responsible for slower fans. Voltage may be reduced by a short in one of the media modules or a bad power supply. If there are no fan faults, use the CLI command show voltages to display voltages applied to components on the motherboard and to the media modules. 5. If the media module voltage is out of tolerance, systematically, remove each media module to determine if one of the media modules is responsible for reducing the voltage level. If one is found, replace the media module. If no media module is found to be bad, the power supply is suspect. Replace the TGM550 Telephony Gateway Module.

avEntTraps avEntTraps avEntTraps avLoad avLoad

23 24 25

avEntAmbientHiThresholdTempOk avEntAmbientLoThresholdTempFlt avEntAmbientLoThresholdTempOk avDownloadBegun avDownloadSuccess

Temp Temp Temp

Notification Error Notification Notification Notification

The ambient temperature in the device has returned to the acceptable range. The ambient temperature in the device is below the acceptable temperature range. The ambient temperature in the device has returned to the acceptable range. The device has begun download operation. The device has completed successful download operation 2 of 10

610 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module traps

Enterprise

Trap ID

Name

Msg Facility

Severity

Description / Resolution

avLoad avLoad

avDownloadFault avUploadBegun

Notification Notification

The download operation was failed. The device has begun download operation. The device has completed successful download operation. The download operation was failed. The survivable local server application has been administratively enabled. The survivable local server application has been administratively disabled. The survivable local server application is now the call controller and is processing calls. The survivable local server application has stopped processing calls. Another processor, either an LSP or a main server, is now processing calls. The RTP sessionhas terminated with bad QoS. More than the allowable number of streams suffer from bad QoS. The RTP QOS fault condition has ended. TFTP client failed to download file from gateway TFTP server. TFTP client failed to upload file to gateway TFTP server. 3 of 10

avLoad

avUploadSuccess

Notification

avLoad avSurv avSurv avSurv

avUploadFault avSurvEnabled avSurvDisabled avSurvActive

Notification Notification Notification Notification

avSurv

avSurvInactive

Notification

avEntTraps avEntTraps avEntTraps avEntTraps avEntTraps

avRtpQoSTrap avRtpQoSFault avRtpQoSClear cigTftpServerDownloadFailureTrap cigTftpServersUploadFailureTrap

Notification Notification Notification Notification Notification

Issue 2 January 2008

611

Traps and MIBs

Enterprise

Trap ID 30

Name

Msg Facility Voice

Severity

Description / Resolution

cmgTrapTypes

cmgSyncSignalFault

Notification

The synchronization signal has been lost. Check that the provisioned clock-sync source has a good signal using the Media Gateway CLI command show sync timing. To set synchronization timing sources on E1/T1 MM or MM710: 1. If the E1/T1 MM has not been added properly on the server, you must use the SAT command ADD DS1 before using the Media Gateway CLI commands set sync interface or set sync source. 2. Specify the primary and secondary clock sources for synchronizing the E1/T1 span, using the CLI command set synch interface. Note: The local clock is built-in and not provisionable. 3. Use a set sync source command to set to the specific MM710 E1/T1 media module to be used as the active clock reference. 4. Use a show sync timing command to ensure that the source is provisioned and active, or visually inspect the Yellow LED on the MM710 media module. Note: When the Yellow LED is on 2.7 seconds and off 0.3 seconds, this means the tone-clock synchronizer is in active mode, and an external synchronization source is being used as a synchronization reference. Setting the sync timing was successful. When the Yellow LED is on 0.3 seconds and off 2.7 seconds, this means the tone-clock synchronizer is in active mode and the internal (on-board) clock is being used as a synchronization reference. Setting the sync timing was not successful. 5. If there is more than one MM710 media module, and they have been set up as primary and secondary, this behavior could be on the second and not the timing of the bus.

cmgTrapTypes cmgTrapTypes

31 32

cmgSyncSignalClear cmgVoipHardwareFault

Voice Voice

Notification Warning

The synchronization signal has been regained. A DSP complex serving the VoIP engines has failed. 4 of 10

612 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module traps

Enterprise

Trap ID 33

Name

Msg Facility Voice

Severity

Description / Resolution

cmgTrapTypes

cmgVoipHardwareClear

Warning

The DSP complex serving the VoIP engines has returned to normal functioning. Synchronization signal lost. Synchronization signal normal. The synchronization signal source (primary or secondary) is experiencing excessive failures in a short period of time causing excessive switching to an alternate source. Synchronization signal source which was causing excessive switching due to excessive failures is now normal. A media module has been removed. The insertion sequence for a media module has failed. A media module has been inserted. An administrator has moved a media module or port to the busy-out state. An administrator has moved a media module or port from the busy-out state back into service. The event is sent when a module is inserted to a slot where it can be identified but not supported due to hardware limitations. This event is generated when a data module is found in a slot that was administered without hardware as a voice module in the call controller. The Media Gateway has successfully registered with a Media Controller. The Media Gateway is beginning a user-requested reset operation. A media module is beginning a user-requested reset operation. 5 of 10

cmgTrapTypes cmgTrapTypes cmgTrapTypes

34 35 36

cmgSyncSignalWarn cmgSyncWarnClear cmgSyncSignalExcess

Voice Voice Voice

Error Notification Notification

cmgTrapTypes

37

cmgSyncExcessClear

Voice

Notification

cmgTrapTypes cmgTrapTypes cmgTrapTypes cmgTrapTypes cmgTrapTypes

50 52 53

cmgModuleRemove cmgModuleInsertFault cmgModuleInsertSuccess cmgMgBusyout cmgMgRelease

Voice Voice Voice Voice Voice

Notification Alert Notification Notification Notification

cmgTrapTypes

cmgUnsupportedMmEnrolement

Voice

Notification

cmgTrapTypes

57

cmgDataModuleAwohConflict

Voice

Error

cmgTrapTypes cmgTrapTypes cmgTrapTypes

73 74 75

cmgRegistrationSuccess cmgMgManualReset cmgModuleManualReset

Voice Voice Voice

Notification Error Error

Issue 2 January 2008

613

Traps and MIBs

Enterprise

Trap ID 102

Name

Msg Facility Voice

Severity

Description / Resolution

cmgTrapTypes

cmgPrimaryControllerFault

Error

The Media Gateway cannot contact the first controller in its controller list. 1. Verify that the controller list is correct. From the CLI, use the command show mgc list. The IP address should match the server or the server IP addresses. 2. If needed, correct this in configure mode in the CLI. Clear the mgc list first with the clear mgc list command. Then use a set mgc list with the correct IP addresses. 3. Verify that the primary controller is up. 4. If so, shut down every LSP

cmgTrapTypes

103

cmgPrimaryControllerClear

Voice

Notification

The media gateway has successfully contacted the first controller in its controller list. The Media Gateway does not have any controllers in its controller list. 1. Verify that the controller list is empty. From the CLI, use the command show mgc list to verify that there are no controllers listed. 2. If none are listed, correct this by adding the correct IP address of the S8700/S8710/S8500/S8300. In the CLIs 'configure' mode, use a set mgc list command with the correct IP address.

cmgTrapTypes

104

cmgNoControllerFault

Voice

Error

cmgTrapTypes

105

cmgnoControllerClear

Voice

The cmgNoControllerFault trap has been cleared. 6 of 10

614 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module traps

Enterprise

Trap ID 106

Name

Msg Facility Voice

Severity

Description / Resolution

cmgTrapTypes

cmgRegistrationFault

Error

The Media Gateway cannot register with any controllers in its controller list. 1. Verify that the controller list is correct. From the CLI, use the command show mgc list. The IP address should match the server CLAN or the server IP addresses. 2. If needed, correct this in the CLIs 'configure' mode. Clear the mgc list with the clear mgc list command. Then use a set mgc list with the correct IP addresses. 3. If the IP address in the mgc list matches the server CLAN or the server IP addresses, there may be a network problem. 4. Verify that the primary controller is up.

cmgTrapTypes

108

cmgH248LinkDown

Voice

Error

An H.248 link between the Media Gateway and its controller is down. 1. Check the S8300, S8500, or S8700/S8710. If down, bring up. 2. If not, check the TGM550 Telephony Gateway Module administration. Since the following command causes a brief service outage, it should only be executed at the customers convenience. 3. If the administration is correct, reboot the TGM550 Telephony Gateway Module. 4. If the problem persists, check network connectivity. Use ping or traceroute to the S8300/S8500/S8700/S8710 to check connectivity. 5. If the problem persists, speak to an Avaya technical professional.

cmgTrapTypes

109

cmgH248LinkUp

Voice

Notification

An H.248 link between the Media Gateway and its controller that was down has come back up. 7 of 10

Issue 2 January 2008

615

Traps and MIBs

Enterprise

Trap ID 114

Name

Msg Facility Voice

Severity

Description / Resolution

cmgTrapTypes

cmgMgAutoReset

Error

The Media Gateway automatically reset. This may be due to a critical error from which the Media Gateway could not recover. It may be due to a maintenance test running on the call controller. It may also be due to the Media Gateways reregistration with a call controller after being out of contact for too long. 1. Check to see if a maintenance test that resets the processor was run. 2. Check to see if the reset was due to the link with the call controller going down. If so, follow call controller link failure troubleshooting procedures. 3. Check the Media Gateway and insure that it has the latest version of firmware installed. If it does not, install the latest version of firmware and continue to monitor. 4. If this trap occurs infrequently, the trap may be due to an unusual transient condition. Monitor future traps. 5. If this trap occurs and the Media Gateway is frequently resetting, manually reset the media gateway. Escalate and have Tier 3 personnel capture the trap information and the event logs for analysis. 6. If this trap occurs frequently and the Media Gateway is not resetting, the Media Gateway may be functionally impaired, and is not capable of resetting itself to restore service. If service is impaired, reset the Media Gateway manually. Escalate and have Tier 3 personnel capture the trap information and the event logs for analysis. 8 of 10

616 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module traps

Enterprise

Trap ID 116

Name

Msg Facility Voice

Severity

Description / Resolution

cmgTrapTypes

cmgModuleAutoReset

Error

cmgModuleAutoReset A media module in the Media Gateway automatically reset (rebooted). To resolve the problem, take the following steps: 1. Check if a maintenance test that resets the media module was run. 2. Check the media module and insure that it has the latest version of firmware installed. If not, install the latest version of firmware and continue to monitor. 3. If this trap occurs infrequently, the trap may be due to an unusual transient condition. Monitor future traps. 4. If this trap occurs and the media module does not return to service, or if this trap occurs frequently, attempt to reset the failing module from the SAT or CLI and see if this returns it to stable service. 5. If manually resetting the media module does not return it to service, and if a spare media module of the same time is available, replace the failing media module with the spare and see if the spare media module goes into service. If so, follow procedures for dealing with the original bad media module. 6. If the spare media module fails to go into service, it is possible that the spare media module is also bad. If not, manually reset the Media Gateway at a time convenient to the customer. If this restores service, both the original and the spare media modules can be considered okay. The problem is probably with the Media Gateway itself. Escalate and have Tier 3 personnel capture the trap information and the event logs for analysis.

cmgTrapTypes cmgTrapTypes cmgTrapTypes

117 118 119

cmgModuleAutoResetClear cmgModulePostFault cmgModulePostClear

Voice Voice Voice

Notification Warning Notification 9 of 10 A media module failed its power-on start-up test.

Issue 2 January 2008

617

Traps and MIBs

Enterprise

Trap ID 124 125 128

Name

Msg Facility Voice Voice Voice

Severity

Description / Resolution

cmgTrapTypes cmgTrapTypes cmgTrapTypes

cmgVoipOccFault cmgVoipOccClear cmgVoipAutoReset

Notification Information al Warning The VoIP module in the Media Gateway automatically reset.To resolve the problem, take the following steps: 1. Check if a maintenance test that resets the VoIP module was run. 2. Check to see if the VoIP module had its IP address re-administered. 3. Check to see if the IP address administered on the VoIP module is correct. 4. Check to see if the IP address of the Media Gateway itself can be pinged. Physical or logical connectivity issues (cabling or routing problems) in the data network can cause ping failures. 5. Check the VoIP module and insure that it has the latest version of firmware installed. If not, install the latest version of firmware and continue to monitor. 6. If this trap occurs infrequently, the trap may be due to an unusual transient condition. Monitor future traps. 7. If this trap occurs and the VoIP module does not return to service, or if this trap occurs frequently, attempt to reset the failing module from the SAT or CLI. 8. Manually reset the Media Gateway at a time convenient to the customer. If this restores service, the problem is probably with the Media Gateway itself. Capture the trap information. If possible, capture the event logs, using the show event-log CLI command, for analysis. Escalate. 9. If none of this works, capture the trap information. If possible, capture the event logs, using the show event-log CLI command, for analysis. Escalate.

cmgTrapTypes

129

cmgVoipAutoResetClear

Voice 10 of 10

618 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

TGM550 Telephony Gateway Module MIB files


MIB File Load.MIB RFC1315-MIB.my ENTITY-MIB.my IP-FORWARD-MIB.my UTILIZATION-MANAGEMENT-MIB.my ENTITY-SENSOR-MIB.my RSTP-MIB.my APPLIC-MIB.MY DS1-MIB.my RFC1213-MIB.my AVAYA-ENTITY-MIB.MY Rnd.MIB CROUTE-MIB.MY IF-MIB.my DS0BUNDLE-MIB.my RFC1406-MIB.my DS0-MIB.my CONFIG-MIB.MY G700-MG-MIB.MY FRAME-RELAY-DTE-MIB.my IP-MIB.my Load12.MIB SNMPv2-MIB.my MIB Module Supported by TGM550 Telephony Gateway Module LOAD-MIB RFC1315-MIB ENTITY-MIB IP-FORWARD-MIB UTILIZATION-MANAGEMENT-MIB ENTITY-SENSOR-MIB RSTP-MIB APPLIC-MIB DS1-MIB RFC1213-MIB AVAYA-ENTITY-MIB RND-MIB CROUTE-MIB IF-MIB DS0BUNDLE-MIB RFC1406-MIB DS0-MIB CONFIG-MIB G700-MG-MIB FRAME-RELAY-DTE-MIB IP-MIB LOAD-MIB SNMPv2-MIB 1 of 2

Issue 2 January 2008

619

Traps and MIBs

MIB File USM-MIB.my VACM-MIB.my

MIB Module Supported by TGM550 Telephony Gateway Module USM-MIB VACM-MIB 2 of 2

MIB files in the Load.MIB file


The following table provides a list of the MIBs in the Load.MIB file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Object genOpModuleId genOpIndex genOpRunningState genOpSourceIndex genOpDestIndex genOpServerIP genOpUserName genOpPassword genOpProtocolType genOpFileName genOpRunningStateDisplay genOpLastFailureIndex genOpLastFailureDisplay genOpLastWarningDisplay genOpErrorLogIndex genOpResetSupported genOpEnableReset OID 1.3.6.1.4.1.1751.2.53.1.2.1.1 1.3.6.1.4.1.1751.2.53.1.2.1.2 1.3.6.1.4.1.1751.2.53.1.2.1.3 1.3.6.1.4.1.1751.2.53.1.2.1.4 1.3.6.1.4.1.1751.2.53.1.2.1.5 1.3.6.1.4.1.1751.2.53.1.2.1.6 1.3.6.1.4.1.1751.2.53.1.2.1.7 1.3.6.1.4.1.1751.2.53.1.2.1.8 1.3.6.1.4.1.1751.2.53.1.2.1.9 1.3.6.1.4.1.1751.2.53.1.2.1.10 1.3.6.1.4.1.1751.2.53.1.2.1.11 1.3.6.1.4.1.1751.2.53.1.2.1.12 1.3.6.1.4.1.1751.2.53.1.2.1.13 1.3.6.1.4.1.1751.2.53.1.2.1.14 1.3.6.1.4.1.1751.2.53.1.2.1.15 1.3.6.1.4.1.1751.2.53.1.2.1.16 1.3.6.1.4.1.1751.2.53.1.2.1.17 1 of 2

620 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

Object genOpNextBootImageIndex genOpLastBootImageIndex genOpFileSystemType genOpReportSpecificFlags genOpOctetsReceived genAppFileId genAppFileName genAppFileType genAppFileDescription genAppFileSize genAppFileVersionNumber genAppFileLocation genAppFileDateStamp genAppFileRowStatus

OID 1.3.6.1.4.1.1751.2.53.1.2.1.18 1.3.6.1.4.1.1751.2.53.1.2.1.19 1.3.6.1.4.1.1751.2.53.1.2.1.20 1.3.6.1.4.1.1751.2.53.1.2.1.21 1.3.6.1.4.1.1751.2.53.1.2.1.22 1.3.6.1.4.1.1751.2.53.2.1.1.1 1.3.6.1.4.1.1751.2.53.2.1.1.2 1.3.6.1.4.1.1751.2.53.2.1.1.3 1.3.6.1.4.1.1751.2.53.2.1.1.4 1.3.6.1.4.1.1751.2.53.2.1.1.5 1.3.6.1.4.1.1751.2.53.2.1.1.6 1.3.6.1.4.1.1751.2.53.2.1.1.7 1.3.6.1.4.1.1751.2.53.2.1.1.8 1.3.6.1.4.1.1751.2.53.2.1.1.9 2 of 2

MIB files in the ENTITY-MIB.my file


The following table provides a list of the MIBs in the ENTITY-MIB.my file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Object entPhysicalDescr entPhysicalVendorType entPhysicalContainedIn entPhysicalClass entPhysicalParentRelPos OID 1.3.6.1.2.1.47.1.1.1.1.2 1.3.6.1.2.1.47.1.1.1.1.3 1.3.6.1.2.1.47.1.1.1.1.4 1.3.6.1.2.1.47.1.1.1.1.5 1.3.6.1.2.1.47.1.1.1.1.6 1 of 2

Issue 2 January 2008

621

Traps and MIBs

Object entPhysicalName entPhysicalHardwareRev entPhysicalFirmwareRev entPhysicalSoftwareRev entPhysicalSerialNum entPhysicalMfgName entPhysicalModelName entPhysicalAlias entPhysicalAssetID entPhysicalIsFRU

OID 1.3.6.1.2.1.47.1.1.1.1.7 1.3.6.1.2.1.47.1.1.1.1.8 1.3.6.1.2.1.47.1.1.1.1.9 1.3.6.1.2.1.47.1.1.1.1.10 1.3.6.1.2.1.47.1.1.1.1.11 1.3.6.1.2.1.47.1.1.1.1.12 1.3.6.1.2.1.47.1.1.1.1.13 1.3.6.1.2.1.47.1.1.1.1.14 1.3.6.1.2.1.47.1.1.1.1.15 1.3.6.1.2.1.47.1.1.1.1.16 2 of 2

MIB files in the UTILIZATION-MANAGEMENT-MIB.my file


The following table provides a list of the MIBs in the UTILIZATION-MANAGEMENT-MIB.my file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Object genCpuIndex genCpuUtilizationEnableMonitoring genCpuUtilizationEnableEventGeneration genCpuUtilizationHighThreshold genCpuAverageUtilization genCpuCurrentUtilization genMemUtilizationTotalRAM genMemUtilizationOperationalImage genMemUtilizationDynAllocMemUsed OID 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.1 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.2 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.3 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.4 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.5 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.6 1.3.6.1.4.1.6889.2.1.11.1.2.1 1.3.6.1.4.1.6889.2.1.11.1.2.2 1.3.6.1.4.1.6889.2.1.11.1.2.3.1 1 of 2

622 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

Object genMemUtilizationDynAllocMemMaxUsed genMemUtilizationDynAllocMemAvailable genMemUtilizationAllocationFailures genMemUtilizationID genMemUtilizationPhyRam genMemUtilizationPercentUsed

OID 1.3.6.1.4.1.6889.2.1.11.1.2.3.2 1.3.6.1.4.1.6889.2.1.11.1.2.3.3 1.3.6.1.4.1.6889.2.1.11.1.2.4 1.3.6.1.4.1.6889.2.1.11.1.2.6.1.1 1.3.6.1.4.1.6889.2.1.11.1.2.6.1.2 1.3.6.1.4.1.6889.2.1.11.1.2.6.1.3 2 of 2

MIB files in the ENTITY-SENSOR-MIB.my file


The following table provides a list of the MIBs in the ENTITY-SENSOR-MIB.my file that are supported by the TGM550 Telephony Gateway Module and their OIDs:

! CAUTION:
CAUTION:

Items show only temperature-sensor-related information. Object entPhySensorType entPhySensorScale entPhySensorPrecision entPhySensorValue entPhySensorOperStatus entPhySensorUnitsDisplay entPhySensorValueTimeStamp entPhySensorValueUpdateRate OID 1.3.6.1.2.1.99.1.1.1.1 1.3.6.1.2.1.99.1.1.1.2 1.3.6.1.2.1.99.1.1.1.3 1.3.6.1.2.1.99.1.1.1.4 1.3.6.1.2.1.99.1.1.1.5 1.3.6.1.2.1.99.1.1.1.6 1.3.6.1.2.1.99.1.1.1.7 1.3.6.1.2.1.99.1.1.1.8

Issue 2 January 2008

623

Traps and MIBs

MIB files in the RFC1213-MIB.my file


The following table provides a list of the MIBs in the RFC1213-MIB.my file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Note: The "if" items are reported on the VoIP interface only. Object ifNumber ifIndex ifDescr ifType ifMtu ifSpeed ifPhysAddress ifAdminStatus ifOperStatus ifLastChange ifInOctets ifInUcastPkts ifInNUcastPkts ifInDiscards ifInErrors ifInUnknownProtos ifOutOctets ifOutUcastPkts ifOutNUcastPkts ifOutDiscards ifOutErrors OID 1.3.6.1.2.1.2.1 1.3.6.1.2.1.2.2.1.1 1.3.6.1.2.1.2.2.1.2 1.3.6.1.2.1.2.2.1.3 1.3.6.1.2.1.2.2.1.4 1.3.6.1.2.1.2.2.1.5 1.3.6.1.2.1.2.2.1.6 1.3.6.1.2.1.2.2.1.7 1.3.6.1.2.1.2.2.1.8 1.3.6.1.2.1.2.2.1.9 1.3.6.1.2.1.2.2.1.10 1.3.6.1.2.1.2.2.1.11 1.3.6.1.2.1.2.2.1.12 1.3.6.1.2.1.2.2.1.13 1.3.6.1.2.1.2.2.1.14 1.3.6.1.2.1.2.2.1.15 1.3.6.1.2.1.2.2.1.16 1.3.6.1.2.1.2.2.1.17 1.3.6.1.2.1.2.2.1.18 1.3.6.1.2.1.2.2.1.19 1.3.6.1.2.1.2.2.1.20 1 of 3

Note:

624 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

Object ifOutQLen ifSpecific ipForwarding ipDefaultTTL ipInReceives ipInHdrErrors ipInAddrErrors ipForwDatagrams ipInUnknownProtos ipInDelivers ipOutDiscards ipOutNoRoutes ipReasmTimeout ipReasmReqds ipReasmOKs ipReasmFails ipFragOKs ipFragFails ipFragCreates ipAdEntAddr ipAdEntIfIndex ipAdEntNetMask ipAdEntBcastAddr ipAdEntReasmMaxSize snmpInPkts snmpOutPkts

OID 1.3.6.1.2.1.2.2.1.21 1.3.6.1.2.1.2.2.1.22 1.3.6.1.2.1.4.1 1.3.6.1.2.1.4.2 1.3.6.1.2.1.4.3 1.3.6.1.2.1.4.4 1.3.6.1.2.1.4.5 1.3.6.1.2.1.4.6 1.3.6.1.2.1.4.7 1.3.6.1.2.1.4.9 1.3.6.1.2.1.4.11 1.3.6.1.2.1.4.12 1.3.6.1.2.1.4.13 1.3.6.1.2.1.4.14 1.3.6.1.2.1.4.15 1.3.6.1.2.1.4.16 1.3.6.1.2.1.4.17 1.3.6.1.2.1.4.18 1.3.6.1.2.1.4.19 1.3.6.1.2.1.4.20.1.1 1.3.6.1.2.1.4.20.1.2 1.3.6.1.2.1.4.20.1.3 1.3.6.1.2.1.4.20.1.4 1.3.6.1.2.1.4.20.1.5 1.3.6.1.2.1.11.1 1.3.6.1.2.1.11.2 2 of 3

Issue 2 January 2008

625

Traps and MIBs

Object snmpInBadVersions snmpInBadCommunityNames snmpInBadCommunityUses snmpInASNParseErrs snmpInTooBigs snmpInNoSuchNames snmpInBadValues snmpInReadOnlys snmpInGenErrs snmpInTotalReqVars snmpInTotalSetVars snmpInGetRequests snmpInGetNexts snmpInSetRequests snmpInGetResponses snmpInTraps snmpOutTooBigs snmpOutNoSuchNames snmpOutBadValues snmpOutGenErrs snmpOutGetRequests snmpOutGetNexts snmpOutSetRequests snmpOutGetResponses snmpOutTraps snmpEnableAuthenTraps

OID 1.3.6.1.2.1.11.3 1.3.6.1.2.1.11.4 1.3.6.1.2.1.11.5 1.3.6.1.2.1.11.6 1.3.6.1.2.1.11.8 1.3.6.1.2.1.11.9 1.3.6.1.2.1.11.10 1.3.6.1.2.1.11.11 1.3.6.1.2.1.11.12 1.3.6.1.2.1.11.13 1.3.6.1.2.1.11.14 1.3.6.1.2.1.11.15 1.3.6.1.2.1.11.16 1.3.6.1.2.1.11.17 1.3.6.1.2.1.11.18 1.3.6.1.2.1.11.19 1.3.6.1.2.1.11.20 1.3.6.1.2.1.11.21 1.3.6.1.2.1.11.22 1.3.6.1.2.1.11.24 1.3.6.1.2.1.11.25 1.3.6.1.2.1.11.26 1.3.6.1.2.1.11.27 1.3.6.1.2.1.11.28 1.3.6.1.2.1.11.29 1.3.6.1.2.1.11.30 3 of 3

626 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

MIB files in the AVAYA-ENTITY-MIB.my file


The following table provides a list of the MIBs in the AVAYA-ENTITY-MIB.my file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Note: This list applies only to temperature sensor information. Object avEntPhySensorHiShutdown avEntPhySensorHiWarning avEntPhySensorHiWarningClear avEntPhySensorLoWarningClear avEntPhySensorLoWarning avEntPhySensorLoShutdown avEntPhySensorEventSupportMask OID 1.3.6.1.4.1.6889.2.1.99.1.1.1 1.3.6.1.4.1.6889.2.1.99.1.1.2 1.3.6.1.4.1.6889.2.1.99.1.1.3 1.3.6.1.4.1.6889.2.1.99.1.1.4 1.3.6.1.4.1.6889.2.1.99.1.1.5 1.3.6.1.4.1.6889.2.1.99.1.1.6 1.3.6.1.4.1.6889.2.1.99.1.1.7

Note:

MIB files in the IF-MIB.my file


The following table provides a list of the MIBs in the IF-MIB.my file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Note: Items are reported for the VoIP interface only. Object ifName ifInMulticastPkts ifInBroadcastPkts ifOutMulticastPkts ifOutBroadcastPkts ifHCInOctets OID 1.3.6.1.2.1.31.1.1.1.1 1.3.6.1.2.1.31.1.1.1.2 1.3.6.1.2.1.31.1.1.1.3 1.3.6.1.2.1.31.1.1.1.4 1.3.6.1.2.1.31.1.1.1.5 1.3.6.1.2.1.31.1.1.1.6 1 of 2

Note:

Issue 2 January 2008

627

Traps and MIBs

Object ifHCInUcastPkts ifHCInMulticastPkts ifHCInBroadcastPkts ifHCOutOctets ifHCOutUcastPkts ifHCOutMulticastPkts ifHCOutBroadcastPkts ifLinkUpDownTrapEnable ifHighSpeed ifPromiscuousMode ifConnectorPresent ifAlias ifCounterDiscontinuityTime

OID 1.3.6.1.2.1.31.1.1.1.7 1.3.6.1.2.1.31.1.1.1.8 1.3.6.1.2.1.31.1.1.1.9 1.3.6.1.2.1.31.1.1.1.10 1.3.6.1.2.1.31.1.1.1.11 1.3.6.1.2.1.31.1.1.1.12 1.3.6.1.2.1.31.1.1.1.13 1.3.6.1.2.1.31.1.1.1.14 1.3.6.1.2.1.31.1.1.1.15 1.3.6.1.2.1.31.1.1.1.16 1.3.6.1.2.1.31.1.1.1.17 1.3.6.1.2.1.31.1.1.1.18 1.3.6.1.2.1.31.1.1.1.19 2 of 2

MIB files in the CONFIG-MIB.my file


The following table provides a list of the MIBs in the CONFIG-MIB.MY file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Note: All items apply to the TGM550 Gateway Modules slot number. Object chNumberOfSlots chReset chGroupList genGroupId OID 1.3.6.1.4.1.81.7.2 1.3.6.1.4.1.81.7.7 1.3.6.1.4.1.81.7.18 1.3.6.1.4.1.81.8.1.1.1 1 of 2

Note:

628 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

Object genGroupSWVersion genGroupType genGroupDescr genGroupNumberOfPorts genGroupReset genGroupConfigurationSymbol genGroupFaultMask genGroupTypeName genGroupAgentSlot genGroupMngType genGroupNumberOfInterfaces genGroupLogFileClear genGroupBootVersion genGroupSerialNumber genGroupFips140Ready

OID 1.3.6.1.4.1.81.8.1.1.2 1.3.6.1.4.1.81.8.1.1.4 1.3.6.1.4.1.81.8.1.1.5 1.3.6.1.4.1.81.8.1.1.6 1.3.6.1.4.1.81.8.1.1.8 1.3.6.1.4.1.81.8.1.1.21 1.3.6.1.4.1.81.8.1.1.36 1.3.6.1.4.1.81.8.1.1.37 1.3.6.1.4.1.81.8.1.1.38 1.3.6.1.4.1.81.8.1.1.39 1.3.6.1.4.1.81.8.1.1.41 1.3.6.1.4.1.81.8.1.1.47 1.3.6.1.4.1.81.8.1.1.48 1.3.6.1.4.1.81.8.1.1.50 1.3.6.1.4.1.81.8.1.1.51 2 of 2

MIB files in the G700-MG-MIB.my file


The following table provides a list of the MIBs in the G700-MG-MIB.MY file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Object cmgHWType cmgModelNumber cmgDescription cmgSerialNumber OID 1.3.6.1.4.1.6889.2.9.1.1.1 1.3.6.1.4.1.6889.2.9.1.1.2 1.3.6.1.4.1.6889.2.9.1.1.3 1.3.6.1.4.1.6889.2.9.1.1.4 1 of 5

Issue 2 January 2008

629

Traps and MIBs

Object cmgHWVintage cmgHWSuffix cmgStackPosition cmgModuleList cmgReset cmgHardwareFaultMask cmgHardwareStatusMask cmgModuleSlot cmgModuleType cmgModuleDescription cmgModuleName cmgModuleSerialNumber cmgModuleHWVintage cmgModuleHWSuffix cmgModuleFWVersion cmgModuleNumberOfPorts cmgModuleFaultMask cmgModuleStatusMask cmgModuleReset cmgModuleNumberOfChannels cmgGatewayNumber cmgMACAddress (for TGM550) cmgFWVersion cmgCurrentIpAddress (for TGM550) cmgMgpFaultMask cmgQosControl cmgRemoteSigDscp

OID 1.3.6.1.4.1.6889.2.9.1.1.5 1.3.6.1.4.1.6889.2.9.1.1.6 1.3.6.1.4.1.6889.2.9.1.1.7 1.3.6.1.4.1.6889.2.9.1.1.8 1.3.6.1.4.1.6889.2.9.1.1.9 1.3.6.1.4.1.6889.2.9.1.1.10.12 1.3.6.1.4.1.6889.2.9.1.1.10.13 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.1 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.2 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.3 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.4 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.5 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.6 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.7 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.8 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.9 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.10 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.11 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.12 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.13 1.3.6.1.4.1.6889.2.9.1.2.1.1 1.3.6.1.4.1.6889.2.9.1.2.1.2 1.3.6.1.4.1.6889.2.9.1.2.1.3 1.3.6.1.4.1.6889.2.9.1.2.1.4 1.3.6.1.4.1.6889.2.9.1.2.1.15 1.3.6.1.4.1.6889.2.9.1.2.2.1 1.3.6.1.4.1.6889.2.9.1.2.2.2 2 of 5

630 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

Object cmgRemoteSig802Priority (always value 0) cmgLocalSigDscp cmgLocalSig802Priority (always value 0) cmgStatic802Vlan (always value 0) cmgCurrent802Vlan (always value 0) cmgPrimaryClockSource cmgSecondaryClockSource cmgActiveClockSource cmgRegistrationState cmgActiveControllerAddress cmgH248LinkStatus cmgH248LinkErrorCode cmgUseDhcpForMgcList (always value 2) cmgStaticControllerHosts cmgDhcpControllerHosts cmgPrimarySearchTime cmgTotalSearchTime cmgTransitionPoint cmgVoipEngineUseDhcp cmgVoipQosControl cmgVoipRemoteBbeDscp cmgVoipRemoteEfDscp cmgVoipRemote802Priority (always value 0) cmgVoipRemoteMinRtpPort cmgVoipRemoteMaxRtpPort cmgVoipRemoteRtcpEnabled

OID 1.3.6.1.4.1.6889.2.9.1.2.2.3 1.3.6.1.4.1.6889.2.9.1.2.2.4 1.3.6.1.4.1.6889.2.9.1.2.2.5 1.3.6.1.4.1.6889.2.9.1.2.2.6 1.3.6.1.4.1.6889.2.9.1.2.2.7 1.3.6.1.4.1.6889.2.9.1.2.3.1 1.3.6.1.4.1.6889.2.9.1.2.3.2 1.3.6.1.4.1.6889.2.9.1.2.3.3 1.3.6.1.4.1.6889.2.9.1.3.1 1.3.6.1.4.1.6889.2.9.1.3.2 1.3.6.1.4.1.6889.2.9.1.3.3 1.3.6.1.4.1.6889.2.9.1.3.4 1.3.6.1.4.1.6889.2.9.1.3.5 1.3.6.1.4.1.6889.2.9.1.3.6 1.3.6.1.4.1.6889.2.9.1.3.7

1.3.6.1.4.1.6889.2.9.1.4.1 1.3.6.1.4.1.6889.2.9.1.4.2 1.3.6.1.4.1.6889.2.9.1.4.3.1.1 1.3.6.1.4.1.6889.2.9.1.4.3.1.2 1.3.6.1.4.1.6889.2.9.1.4.3.1.3 1.3.6.1.4.1.6889.2.9.1.4.3.1.4 1.3.6.1.4.1.6889.2.9.1.4.3.1.5 1.3.6.1.4.1.6889.2.9.1.4.3.2.1 3 of 5

Issue 2 January 2008

631

Traps and MIBs

Object cmgVoipRemoteRtcpMonitorIpAddress cmgVoipRemoteRtcpMonitorPort cmgVoipRemoteRtcpReportPeriod cmgVoipRemoteRsvpEnabled cmgVoipRemoteRetryOnFailure cmgVoipRemoteRetryDelay cmgVoipRemoteRsvpProfile cmgVoipLocalBbeDscp cmgVoipLocalEfDscp cmgVoipLocal802Priority (always value 0) cmgVoipLocalMinRtpPort cmgVoipLocalMaxRtpPort cmgVoipLocalRtcpEnabled cmgVoipLocalRtcpMonitorIpAddress cmgVoipLocalRtcpMonitorPort cmgVoipLocalRtcpReportPeriod cmgVoipLocalRsvpEnabled cmgVoipLocalRetryOnFailure cmgVoipLocalRetryDelay cmgVoipLocalRsvpProfile cmgVoipSlot (always value 10 for the TGM550 DSP module) cmgVoipMACAddress (always value 0) cmgVoipStaticIpAddress (for the TGM550) cmgVoipCurrentIpAddress (for the TGM550) cmgVoipJitterBufferSize (always value 2560, for maximum jitter buffer of 320 ms.)

OID 1.3.6.1.4.1.6889.2.9.1.4.3.2.2 1.3.6.1.4.1.6889.2.9.1.4.3.2.3 1.3.6.1.4.1.6889.2.9.1.4.3.2.4 1.3.6.1.4.1.6889.2.9.1.4.3.3.1 1.3.6.1.4.1.6889.2.9.1.4.3.3.2 1.3.6.1.4.1.6889.2.9.1.4.3.3.3 1.3.6.1.4.1.6889.2.9.1.4.3.3.4 1.3.6.1.4.1.6889.2.9.1.4.4.1.1 1.3.6.1.4.1.6889.2.9.1.4.4.1.2 1.3.6.1.4.1.6889.2.9.1.4.4.1.3 1.3.6.1.4.1.6889.2.9.1.4.4.1.4 1.3.6.1.4.1.6889.2.9.1.4.4.1.5 1.3.6.1.4.1.6889.2.9.1.4.4.2.1 1.3.6.1.4.1.6889.2.9.1.4.4.2.2 1.3.6.1.4.1.6889.2.9.1.4.4.2.3 1.3.6.1.4.1.6889.2.9.1.4.4.2.4 1.3.6.1.4.1.6889.2.9.1.4.4.3.1 1.3.6.1.4.1.6889.2.9.1.4.4.3.2 1.3.6.1.4.1.6889.2.9.1.4.4.3.3 1.3.6.1.4.1.6889.2.9.1.4.4.3.4 1.3.6.1.4.1.6889.2.9.1.4.5.1.1 1.3.6.1.4.1.6889.2.9.1.4.5.1.2 1.3.6.1.4.1.6889.2.9.1.4.5.1.3 1.3.6.1.4.1.6889.2.9.1.4.5.1.4 1.3.6.1.4.1.6889.2.9.1.4.5.1.5

4 of 5

632 IG550 Integrated Gateway Administration and CLI Reference

TGM550 Telephony Gateway Module MIB files

Object cmgVoipTotalChannels cmgVoipChannelsInUse cmgVoipAverageOccupancy cmgVoipHyperactivity cmgVoipAdminState cmgVoipDspFWVersion cmgVoipDspStatus cmgVoipEngineReset cmgVoipFaultMask cmgTrapManagerAddress cmgTrapManagerControl cmgTrapManagerMask cmgTrapManagerRowStatus cmgEtrModule cmgEtrAdminState cmgEtrNumberOfPairs cmgEtrStatus cmgEtrCurrentLoopDetect cmgDynCacStatus cmgDynCacRBBL cmgDynCacLastUpdate

OID 1.3.6.1.4.1.6889.2.9.1.4.5.1.6 1.3.6.1.4.1.6889.2.9.1.4.5.1.7 1.3.6.1.4.1.6889.2.9.1.4.5.1.8 1.3.6.1.4.1.6889.2.9.1.4.5.1.9 1.3.6.1.4.1.6889.2.9.1.4.5.1.10 1.3.6.1.4.1.6889.2.9.1.4.5.1.11 1.3.6.1.4.1.6889.2.9.1.4.5.1.12 1.3.6.1.4.1.6889.2.9.1.4.5.1.13 1.3.6.1.4.1.6889.2.9.1.4.5.1.14

1.3.6.1.4.1.6889.2.9.1.7.1.1.1 1.3.6.1.4.1.6889.2.9.1.7.1.1.2 1.3.6.1.4.1.6889.2.9.1.7.1.1.3 1.3.6.1.4.1.6889.2.9.1.7.1.1.4 1.3.6.1.4.1.6889.2.9.1.7.1.1.5 1.3.6.1.4.1.6889.2.9.1.8.1 1.3.6.1.4.1.6889.2.9.1.8.2 1.3.6.1.4.1.6889.2.9.1.8.3 5 of 5

Issue 2 January 2008

633

Traps and MIBs

MIB files in the SNMPv2-MIB.my file


The following table provides a list of the MIBs in the SNMPv2-MIB.my file that are supported by the TGM550 Telephony Gateway Module and their OIDs: Object sysDescr sysObjectID sysUpTime sysContact (value set by J-series router) sysName (value set by J-series router) sysLocation (value set by J-series router) sysServices OID 1.3.6.1.2.1.1.1 1.3.6.1.2.1.1.2 1.3.6.1.2.1.1.3 1.3.6.1.2.1.1.4 1.3.6.1.2.1.1.5 1.3.6.1.2.1.1.6 1.3.6.1.2.1.1.7

634 IG550 Integrated Gateway Administration and CLI Reference

Appendix B: Configuring the routers modem interface for remote dial-in and dial backup
USB modems are supported on the J-series Services Routers as a backup for a primary Internet connection. The J-series Services Routers can be configured to "fail over" to an USB modem connection when the primary connection experiences interruptions in Internet connectivity. Note: Low latency traffic such as VoIP traffic is not supported over USB modem connections. Note: We recommend using a Multi-Tech MultiModem MT5634ZBA-USB-V92 USB modem with J-series Services Routers.

Note:

Note:

You use either the J-Web configuration editor or CLI configuration editor to configure the USB modem and its supporting dialer interfaces.

USB Modem Interface Overview


You configure two types of interfaces for USB modem connectivity: a physical interface and a logical interface called the dialer interface. The USB modem physical interface uses the naming convention umd0. The Services Router creates this interface when a USB modem is connected to the USB port. The dialer interface, dln, is a logical interface for configuring dialing properties for USB modem connections. The dialer interface can be configured using PPP encapsulation. For information about interface names, see "J-series Interface Naming Conventions" in J-series Services Router Basic LAN and WAN Access Configuration Guide.

Issue 2 January 2008

635

Configuring the routers modem interface for remote dial-in and dial backup

The following rules apply when you configure dialer interfaces for USB modem connections: 1. The dialer interface must be configured to use PPP encapsulation. You cannot configure Cisco High-Level Data Link Control (HDLC) or Multilink PPP (MLPPP) encapsulation on dialer interfaces. 2. The dialer interface cannot be configured as a constituent link in a multilink bundle. For information about configuring multilink bundles, see "Configuring Link Services Interfaces" in J-series Services Router Basic LAN and WAN Access Configuration Guide. 3. The dialer interface cannot be configured simultaneously in the following modes:

As a backup interface and a dialer filter As a backup interface and dialer watch interface As a dialer watch interface and a dialer filter As a backup interface for more than one primary interface

Before You Begin


Before you configure USB modems, you need to perform the following tasks:

Install Services Router hardware. For more information, see the Getting Started Guide for your router. Establish basic connectivity. For more information, see the Getting Started Guide for your router. Order a Multi-Tech MultiModem MT5634ZBA-USB-V92 USB modem from Multi-Tech Systems (http://www.multitech.com/). Order a PSTN line from your telecommunications service provider. Contact your service provider for more information. If you do not already have a basic understanding of physical and logical interfaces and Juniper Networks interface conventions, read "Interfaces Overview" in J-series Services Router Basic LAN and WAN Access Configuration Guide.

636 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Connecting the USB Modem to the Services Router's USB Port


Note:

Note: The J4350 and J6350 Services Routers have two USB ports. However, you can connect only one USB modem to the USB ports on these routers. If you connect USB modems to both the USB ports, the router detects only the first USB modem connected. Note: When you connect the USB modem to the USB port on the router, the USB modem is initialized using the modem initialization string configured for the USB modem interface on the router. For more information, see Configuring the USB Modem Initialization String on page 657.

Note:

To connect the USB modem to the USB port on the router: 1. Plug the modem into the USB port. 2. Connect the modem to your telephone network.

Configuring the USB Modems with a Configuration Editor


To configure USB modem interfaces, perform the following tasks.

Configuring an USB Modem Interface on page 637 Configuring a Dialer Interface on page 640 Configuring Dial Backup on page 642 Configuring Dial-In on page 654 Configuring CHAP on Dialer Interfaces (Optional) on page 656

Configuring an USB Modem Interface


To configure an USB modem interface for the Services Router: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 72: Adding a USB modem interface on page 638. 3. Go on to Configuring a Dialer Interface on page 640.

Issue 2 January 2008

637

Configuring the routers modem interface for remote dial-in and dial backup

Adding a USB modem interface Table 72: Adding a USB modem interface Task Navigate to the Interfaces level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Configure or Edit. 1. Next to Interface, click Add new entry. 2. In the Interface name box, type the name of the new interface, umd0. 3. Click OK. 1 of 2 CLI Configuration Editor

From the [edit] hierarchy level, enter edit interfaces umd0.

Create the new interface umd0

638 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 72: Adding a USB modem interface (continued) Task Configure dialer options: Name the dialer pool configured on the dialer interface you want to use for USB modem connectivity for example, usb-modem-dialer-pool. For more information, see Configuring a Dialer Interface on page 640. Set the dialer pool priority for example, 25. Dialer pool priority has a range from 1 to 255, with 1 designating lowest-priority interfaces and 255 designating the highest-priority interfaces.

J-Web Configuration Editor 1. In the Encapsulation column, next to the new interface, click Edit. 2. Next to Dialer options, select Yes, and then click Configure. 3. Next to Pool, click Add new entry. 4. In the Pool identifier box, type usb-modem-dialer-pool. 5. In the Priority box, type 25. 6. Click OK until you return to the Interface page.

CLI Configuration Editor

From the [edit interfaces umd0] hierarchy, enter set dialer-options pool usb-modem-dialer-poo l priority 25

Configure the modem to auto answer calls after a specified number of rings. The default modem initialization string is AT S7=45 S0=0 V1 X4 &C1 E0 Q0 &Q8 %C0, where the AT command S0=0 disables the modem from auto answering calls.

1. Next to Modem options, click Configure. 2. In the Init command string box, type ATS0=2 to configure the modem to auto answer after two rings. 3. Click OK.

From the [edit interfaces umd0] hierarchy, enter set modem-options init-command-string "ATS0=2\n".

2 of 2

Issue 2 January 2008

639

Configuring the routers modem interface for remote dial-in and dial backup

Configuring a Dialer Interface


The dialer interface (dl) is a logical interface configured to establish USB modem connectivity. You can configure multiple dialer interfaces for different functions on the Services Router. To configure a logical dialer interface for the Services Router: Table 73: Adding a Dialer Interface to a Services Router Task Navigate to the Interfaces level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Configure or Edit. 3. Next to Interface, click Add new entry. 4. In the Interface name box, type dl0. 5. In the Description box, type USB-modem-backup. 6. Click OK. 1. In the Encapsulation column, next to the new interface, click Edit. 2. From the Encapsulation list, select ppp. CLI Configuration Editor

From the [edit] hierarchy level, enter edit interfaces

Create the new interface for example, dl0. Adding a description can differentiate between different dialer interfaces for example, USB-modem-backup.

Enter the following commands: edit dl0 set description USB-modem-backup

Configure Point-to-Point Protocol (PPP) encapsulation. You cannot configure Cisco High-Level Data Link Control (HDLC) or Multilink PPP (MLPPP) encapsulation on dialer interfaces used in USB modem connections. Create the logical unit 0. You can set the logical unit to 0 only.

Enter set encapsulation ppp.

1. Next to Unit, click Add new entry. 2. In the Interface unit number box, type 0. 3. Next to Dialer options, select Yes, and then click Configure.

Enter set unit 0.

1 of 3

640 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 73: Adding a Dialer Interface to a Services Router (continued) Task Configure dialer options. Activation delay Time to wait before activating the backup USB modem interface once the primary interface is down for example, 30. Default value is 0 seconds with a maximum value of 60 seconds. Use only for dialer backup and dialer watch. Deactivation delay Time to wait before deactivating the backup USB modem interface once the primary interface is up for example, 30. Default value is 0 seconds with a maximum value of 60 seconds. Use only for dialer backup and dialer watch. Idle timeout Time a connection is idle before disconnecting for example, 30. Default value is 120 seconds with a range from 0 to 4294967295. Initial route check Time to wait before checking if the primary interface is up for example, 30. Default value is 120 seconds with a range of 1 to 300 seconds. Pool Name of the dialer pool to use for USB modem connectivity for example, usb-modem-dialer-pool. J-Web Configuration Editor 1. In the Activation delay box, type 60. 2. In the Deactivation delay box, type 30. 3. In the Idle timeout box, type 30. 4. In the Initial route check box, type 30. 5. In the Pool box, type usb-modem-dialer-po ol. CLI Configuration Editor Enter the following commands:

edit unit 0 dialer-options set activation-delay 60 set deactivation-dela y 30 set idle-timeout 30 initial-route-che ck 30 pool usb-modem-dialerpool

2 of 3

Issue 2 January 2008

641

Configuring the routers modem interface for remote dial-in and dial backup

Table 73: Adding a Dialer Interface to a Services Router (continued) Task Configure the telephone number of the remote destination to call if the primary interface goes down for example, 5551212. Configure source and destination IP addresses for the dialer interface for example, 172.20.10.2 and 172.20.10.1. If you configure multiple dialer interfaces, ensure that the same IP subnet address is not configured on different dialer interfaces. Configuring the same IP subnet address on different dialer interfaces can result in inconsistency in the route and packet loss. Packets can be routed through any of the dialer interfaces with the IP subnet address, instead of being routed through the dialer interface to which the USB modem call is mapped. J-Web Configuration Editor 1. Next to Dial string, click Add new entry. 2. In the Dial string box, type 5551212. 3. Click OK. 1. Select Inet under Family, and click Edit. 2. Next to Address, click Add new entry. 3. In the Source box, type 172.20.10.2. 4. In the Destination box, type 172.20.10.1. 5. Click OK. CLI Configuration Editor

Enter set dial-string 5551212

From the [edit] hierarchy level, enter edit interfaces dl0 unit 0 Enter set family inet address 172.20.10.2 Enter set family inet address 172.20.10.2 destination 172.20.10.1

3 of 3

Configuring Dial Backup


Dial backup allows one or more dialer interfaces to be configured as the backup link for the primary serial interface. The backup dialer interfaces are activated only when the primary interface fails. USB modem backup connectivity is supported on all interfaces except ls-0/0/0. For dial backup, you need to configure the primary interface for backup connectivity and configure a dialer filter, firewall filter or a dialer watch on the dialer interface you want to use for USB modem backup connectivity. The following example illustrates a backup configuration using a primary serial interface, two dialer interfaces, and a physical USB modem interface.

642 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Figure 14: Sample Modem Dial Backup Configuration

In this example, you configure:

The dialer interface dl0 as the backup interface on the branch office router's primary T1 interface t1-0/0/0. For more information about configuring a dialer interface as a backup interface on a primary interface, see Configuring a Primary Interface for Backup Connectivity on page 644.

A dialer filter, firewall filter or dial watch on the dialer interface dl0 on the branch office router. For more information about configuring dialer filters, see Applying the Dial-on-Demand Dialer Filter to the Dialer Interface on page 646. For more information about configuring firewall filters, see Configuring a Dialer Filter for Dial-on-Demand Routing Backup on page 645. For more information about configuring dialer watch, see Configuring Dialer Watch on page 651.

Dial-in on the dialer interface dl0 on the head office router. For more information about configuring dial-in, see Configuring Dial-In on page 654.

Issue 2 January 2008

643

Configuring the routers modem interface for remote dial-in and dial backup

Configuring a Primary Interface for Backup Connectivity


To configure a primary interface for backup connectivity: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 74: Configuring an Interface for USB Modem Dial Backup on page 644. 3. Configure a dialer filter or dialer watch. For more information about configuring dialer filters, see Configuring a Dialer Filter for Dial-on-Demand Routing Backup on page 645. For more information about configuring firewall filters, seeConfiguring a Firewall Filter for Dial-on-Demand Routing Backup on page 647. For more information about configuring dialer watch, see Configuring Dialer Watch on page 651. Table 74: Configuring an Interface for USB Modem Dial Backup Task Navigate to the Interfaces level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. 1. Next to Backup options, click Configure. 2. In the Interface box, type dl0.0. 3. Click OK until you return to the Interfaces page.

CLI Configuration Editor

From the [edit] hierarchy level, enter edit interfaces t1-0/0/0 unit 0

Select the physical interface for USB modem USB modem backup connectivity for example, t1-0/0/0.

Configure the backup dialer interface for instance, dl0.0.

Enter set backup-options interface dl0.0

644 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Configuring a Dialer Filter for Dial-on-Demand Routing Backup


This dial-on-demand routing backup method allows an USB modem connection to be activated only when network traffic configured as an "interesting packet" arrives on the network. Once the network traffic is sent, an inactivity timer is triggered and the connection is closed. You define an interesting packet using the dialer filter feature of the Services Router. There are two steps to configuring dial-on-demand routing backup using a dialer filter:

Configuring the Dialer Filter on page 645 Applying the Dial-on-Demand Firewall Filter to the Dialer Interface on page 650

Configuring the Dialer Filter


To configure the dialer filter: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 75: Configuring a Dialer Filter for Interesting Packets on page 645. 3. Go on to Applying the Dial-on-Demand Dialer Filter to the Dialer Interface on page 646. Table 75: Configuring a Dialer Filter for Interesting Packets Task Navigate to the Firewall level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Firewall, click Edit. 1. Next to Inet, click Configure or Edit. 2. Next to Dialer filter, click Add new entry. 3. In the Filter name box, type interesting-traffic. CLI Configuration Editor

From the [edit] hierarchy level, enter edit firewall

Configure the dialer filter name for example, interesting-traffic.

Enter edit family inet Then enter edit dialer-filter interesting-traffic 1 of 2

Issue 2 January 2008

645

Configuring the routers modem interface for remote dial-in and dial backup

Table 75: Configuring a Dialer Filter for Interesting Packets (continued) Task Configure the dialer filter rule name for example, term1. Configure term behavior. For example, you might want to configure the dialer filter to allow only traffic between the TGM550 gateway module installed in the Services Router and the Media Gateway Controller (MGC) over the backup USB modem connection. In this example, the TGM550 has the IP address 20.20.90.4/ 32 and the MGC has the IP address 200.200.201.1/32. To configure the term completely, include both from and then statements. J-Web Configuration Editor 1. Next to Term, click Add new entry. 2. In the Rule name box, type term1. 3. Next to From, click Configure. 4. Next to Source address, click Add new entry. 5. In the Address box, type 20.20.90.4/32. 6. Click OK. 7. Next to Destination address, click Add new entry. 8. In the Address box, type 200.200.201.1/32. 9. Click OK. 10.Click OK until you return to the Term page. 1. Next to Then, click Configure. 2. From the Designation list, select Note. 3. Click OK. CLI Configuration Editor

Enter edit term term1. Enter set from source-address 20.20.90.4/32. Enter set from destination-addres s 200.200.201.1/ 32.

Configure the then part of the dialer filter to discard telnet traffic between the TGM550 and the MGC.

Enter set then note.

2 of 2

Applying the Dial-on-Demand Dialer Filter to the Dialer Interface


To complete dial-on-demand routing with dialer filter configuration: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Applying the Dialer Filter to the Dialer Interface on page 647. 3. When you are finished configuring the router, commit the configuration.

646 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 76: Applying the Dialer Filter to the Dialer Interface Task Navigate to the Interfaces level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. 1. In the Interface name column, click dl0. 2. Under Unit, in the Mtu column, click Edit. 1. In the Family section, next to Inet, click Edit. 2. Next to Filter, click Configure. 3. In the Dialer box, type interesting-traffic, the dialer-filter configured in Configuring the Dialer Filter on page 645, as the dialer-filter. 4. Click OK.

CLI Configuration Editor

From the [edit] hierarchy level, enter edit interfaces dl0 unit 0

Select the dialer interface to apply the filter for example, dl0.

Apply the dialer filter to the dialer interface.

Enter edit family inet filter. Enter set dialer interesting-traffi c.

Configuring a Firewall Filter for Dial-on-Demand Routing Backup


This dial-on-demand routing backup method allows you to configure the type of packets that should be sent over the USB modem connection. You define the types of packets that should be allowed or rejected using the firewall filter feature of the Services Router. There are two steps to configuring dial-on-demand routing backup using a firewall filter:

Configuring the Firewall Filter on page 648 Applying the Dial-on-Demand Firewall Filter to the Dialer Interface on page 650

Issue 2 January 2008

647

Configuring the routers modem interface for remote dial-in and dial backup

Configuring the Firewall Filter


To configure the firewall filter: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Configuring a Firewall Filter on page 648. 3. Go on to Applying the Dial-on-Demand Firewall Filter to the Dialer Interface on page 650. Table 77: Configuring a Firewall Filter Task Navigate to the Firewall level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Firewall, click Edit. 3. Next to Filter, click Add new entry. 4. In the Filter name box, type no-voip-traffic. CLI Configuration Editor

From the [edit] hierarchy level, enter edit firewall.

Configure the firewall filter name for example, no-voip-traffic.

Enter edit filter no-voip-traffic.

1 of 2

648 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 77: Configuring a Firewall Filter (continued) Task Configure the firewall filter rule name for example, term1. Configure term behavior. For example, you might want to configure the firewall filter to discard all VoIP traffic between the subnet to which the TGM550 belongs and the subnet to which the Media Gateway Controller (MGC) belongs. This ensures that only data traffic is sent over the backup USB modem connection. In this example, the TGM550 belongs to the subnet 20.20.90.0/24 and the MGC belongs to the subnet 200.200.201.0/24. To configure the term completely, include both from and then statements. J-Web Configuration Editor 1. Next to Term, click Add new entry. 2. In the Rule name box, type term2. 3. Next to From, click Configure. 4. Next to Source address, click Add new entry. 5. In the Address box, type 20.20.90.0/24. 6. Click OK. 7. Next to Destination address, click Add new entry. 8. In the Address box, type 200.200.201.0/24. 9. Click OK. 10.From the Dscp choice list, select Dscp. 11.Next to Dscp, click Add new entry. 12.From the Value keyword list, select af11. 13.Click OK. 14.Click OK until you return to the Term page. 1. Next to Then, click Configure. 2. In the Count box, type voip-counter. 3. From the Designation list, select Discard. 4. Click OK. CLI Configuration Editor

Enter edit term term1 Enter set from source-address 20.20.90.0/24 Enter set from destination-addres s 200.200.201.0/24 Enter set from destination-addres s 200.200.201.0/24 Enter set from dscp af11

Configure the then part of the dialer filter to discard all VoIP traffic between the subnet to which the TGM550 belongs and the subnet to which the Media Gateway Controller (MGC) belongs.

Enter set then count voip-counter Enter set then discard

2 of 2

Issue 2 January 2008

649

Configuring the routers modem interface for remote dial-in and dial backup

Applying the Dial-on-Demand Firewall Filter to the Dialer Interface


To complete dial-on-demand routing with firewall filter configuration: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 80 on page 277. 3. When you are finished configuring the router, commit the configuration. Table 78: Applying the Dial-on-Demand Firewall Filter to the Dialer Interface Task Navigate to the Interfaces level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. 1. In the Interface name column, click dl0. 2. Under Unit, in the Mtu column, click Edit. 1. In the Family section, next to Inet, click Edit. 2. Next to Filter, click Configure. 3. From the Output choice list, select Output. 4. In the Output box, type no-voip-traffic, the firewall filter configured in Configuring the Dialer Filter on page 645, as the firewall filter. 5. Click OK.

CLI Configuration Editor

From the [edit] hierarchy level, enter edit interfaces dl0 unit 0

Select the dialer interface to apply the filter for example, dl0. Apply the firewall filter to the dialer interface.

Enter edit family inet filter Enter set output no-voip-traffic

650 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Configuring Dialer Watch


Dialer watch is a backup method that integrates backup dialing with routing capabilities and provides reliable connectivity without relying on a dialer filter to trigger outgoing USB modem connections. With dialer watch, the Services Router monitors the existence of a specified route and if the route disappears, the dialer interface initiates the USB modem connection as a backup connection.

Adding a Dialer Watch Interface on the Services Router


In this example, you configure dialer watch to enable the Services Router to monitor the existence of the route to the Media Gateway Controller (MGC) with the IP address 200.200.201.1/32 and initiate USB modem backup connectivity if the route disappears. To configure dialer watch: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Adding a Dialer Watch Interface on page 651. 3. Go on to Configuring the USB Modem Interface for Dialer Watch on page 652. Table 79: Adding a Dialer Watch Interface Task Navigate to the Interfaces level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. 1. Under Interface name, select dl0. 2. In the Description box, type dialer-watch. CLI Configuration Editor From the [edit] hierarchy level, enter edit interfaces

Select a dialer interface for example, dl0. Adding a description, such as dialer-watch, can help you identify one dialer interface from another.

Enter edit dl0 Enter set description dialer-watch

1 of 2

Issue 2 January 2008

651

Configuring the routers modem interface for remote dial-in and dial backup

Table 79: Adding a Dialer Watch Interface (continued) Task On a logical interface for example, 0 configure the list of routes for dialer watch for example, 200.200.201.1/32. J-Web Configuration Editor 1. Under Unit, click the logical unit number 0. 2. Next to Dialer options, click Edit. 3. Next to Watch list, click Add new entry. 4. In the Prefix box, type 200.200.201.1/32. 5. Click OK. 1. In the Pool box, type dw-pool. CLI Configuration Editor Enter edit unit 0 dialer-options Enter set watch-list 200.200.201.1/32

Configure the name of the dialer pool to use for dialer watch for example, dw-pool.

Enter set pool dw-pool

2 of 2

Configuring the USB Modem Interface for Dialer Watch


To configure the USB modem interface to participate as a dialer watch interface: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 80: Configuring an USB Modem Interface for Dialer Watch on page 653. 3. If you are finished configuring the router, commit the configuration.

652 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 80: Configuring an USB Modem Interface for Dialer Watch Task Navigate to the Interfaces level in the configuration hierarchy, and select the USB modem physical interface umd0. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. 3. Under Interface name, click umd0. 1. Next to Dialer options, click Edit. 2. Next to Pool, click Add new entry. 3. In the Pool identifier box, type dw-pool. 4. Click OK. CLI Configuration Editor From the [edit] hierarchy level, enter edit interfaces umd0 dialer-options pool dw-pool

Configure dialer watch options for the USB modem interface participating in the dialer watch. The USB modem interface must have the same pool identifier to participate in dialer watch. Therefore, the dialer pool name dw-pool, for the dialer watch interface configured in Table 79: Adding a Dialer Watch Interface on page 651, is used when configuring the USB modem interface.

Issue 2 January 2008

653

Configuring the routers modem interface for remote dial-in and dial backup

Configuring Dial-In
You can configure a dialer interface to accept all incoming calls or accept only calls from one or more caller IDs. If the dialer interface is configured to accept only calls from a specific called ID, the Services Router matches the incoming call's caller ID against the caller IDs configured on its dialer interfaces. If an exact match is not found and the incoming call's caller ID has more digits than the configured caller IDs, the Services Router performs a right-to-left match of the incoming call's caller ID with the configured caller IDs and accepts the incoming call if a match is found. For example, if the incoming call's caller ID is 4085321091 and the caller ID configured on a dialer interface is 5321091, the incoming call is accepted. Each dialer interface accepts calls from only callers whose caller IDs are configured on it. To configure a dialer interface for dial-in: 1. Navigate to the top of the configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 83 on page 280. 3. If you are finished configuring the router, commit the configuration. Table 81: Configuring the Dialer Interface for Dial-In Task Navigate to the Interfaces level in the configuration hierarchy, and select a dialer interface for example, dl0. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>View and Edit>Edit Configuration. 2. Next to Interfaces, click Edit. 3. Next to dl0, click Edit. CLI Configuration Editor From the [edit] hierarchy level, enter edit interfaces dl0

1 of 2

654 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 81: Configuring the Dialer Interface for Dial-In (continued) Task On logical interface 0, configure the incoming map options for the dialer interface. accept-all Dialer interface accepts all incoming calls. You can configure the accept-all option for only one of the dialer interfaces associated with an USB modem physical interface. The dialer interface with the accept-all option configured is used only if the incoming call's caller ID does not match the caller IDs configured on other dialer interfaces. caller Dialer interface accepts calls from a specific caller ID for example, 4085551515. You can configure a maximum of 15 caller IDs per dialer interface. The same caller ID must not be configured on different dialer interfaces. However, you can configure caller IDs with more or fewer digits on different dialer interfaces. For example, you can configure the caller IDs 14085551515, 4085551515, and 5551515 on different dialer interfaces. J-Web Configuration Editor 1. In the Unit section, for logical unit number 0, click Dialer options under Encapsulation. 2. Next to Incoming map, click Configure. 3. From the Caller type menu, select Caller. 4. Next to Caller, click Add new entry. 5. In the Caller id box, type 4085551515. CLI Configuration Editor

Enter edit unit 0 Enter edit dialer-options Enter set incoming-map caller 4085551515

2 of 2

Issue 2 January 2008

655

Configuring the routers modem interface for remote dial-in and dial backup

Configuring CHAP on Dialer Interfaces (Optional)


You can optionally configure dialer interfaces to support the PPP Challenge Handshake Authentication Protocol (CHAP). When you enable CHAP on a dialer interface, the Service Router can authenticate its peer and be authenticated by its peer. For more information about CHAP, see the JUNOS Network Interfaces Configuration Guide. To configure CHAP on the dialer interface: 1. Navigate to the top of the configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 82: Configuring CHAP on Dialer Interfaces on page 656. 3. If you are finished configuring the router, commit the configuration. Table 82: Configuring CHAP on Dialer Interfaces Task Define a CHAP access profile for example, usb-modem-access-profile with a client (username) named usb-modem-user and the secret (password) my-secret. J-Web Configuration Editor 1. On the main Configuration page next to Access, click Configure or Edit. 2. Next to Profile, click Add new entry. 3. In the Profile name box, type usb-modem-access-profile. 4. Next to Client, click Add new entry. 5. In the Name box, type usb-modem-user. 6. In the Chap secret box, type my-secret. 7. Click OK until you return to the main Configuration page. CLI Configuration Editor From the [edit] hierarchy level, enter set access profile usb-modem-access-prof ile client usb-modem-user chap-secret my-secret

1 of 2

656 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 82: Configuring CHAP on Dialer Interfaces (continued) Task Navigate to the appropriate dialer interface level in the configuration hierarchy for example, dl0 unit 0. J-Web Configuration Editor 1. On the main Configuration page next to Interfaces, click Configure or Edit. 2. In the interface name box, click dl0. 3. In the Interface unit number box, click 0. 1. Next to Ppp options, click Configure. 2. Next to Chap, click Configure. 3. In the Access profile box, type usb-modem-access-profile. 4. Click OK. CLI Configuration Editor From the [edit] hierarchy level, enter edit interfaces dl0 unit 0

Configure CHAP on the dialer interface and specify a unique profile name containing a client list and access parameters for example, usb-modem-access-profile.

Enter set ppp-options chap access-profile usb-modem-access-prof ile

2 of 2

Configuring and Administering USB Modems


This section contains the following topics:

Configuring the USB Modem Initialization String on page 657 Resetting USB Modems on page 659

Configuring the USB Modem Initialization String


Note: These instructions use Hayes-compatible modem commands to configure the modem. If your modem is not Hayes-compatible, refer to the documentation for your modem and enter equivalent modem commands. Note: When you connect the USB modem to USB port on the router for the first time, the modem is initialized with the default initialization string AT S7=45 S0=0 V1 X4 &C1 E0 Q0 &Q8 %C0. Table 83: Modem Commands in Default Initialization String on page 658 describes the modem commands in the default initialization string. For more information on these commands, refer to the documentation for your modem.

Note:

Note:

Issue 2 January 2008

657

Configuring the routers modem interface for remote dial-in and dial backup

Table 83: Modem Commands in Default Initialization String Modem Command AT S7=45 S0=0 V1 &C1 E0 Q0 &Q8 %C0 Description Attention. Informs the modem that a command follows it. Waits 45 seconds for a carrier before aborting the call. Disables auto answer. Displays result codes as words. Disables reset on loss of carrier. Disables echo of commands issued to the modem in the local terminal. Enables result codes. Enables Microcom Networking Protocol (MNP) error control mode. Disables data compression.

You can use the configuration editor to override the value of a command in the modem initialization string or configure additional modem commands for initializing USB modems. Note: If you configure the modem initialization string when a call is in progress, the new initialization string is applied on the modem only when the call ends.

Note:

In this example, you override the value of the S0=0 command in the default modem initialization string and add the L2 command to the modem initialization string. To configure the initialization string for the USB modem: 1. Navigate to the top of the interfaces configuration hierarchy in either the J-Web or CLI configuration editor. 2. Perform the configuration tasks described in Table 84: Configuring the USB Modem Initialization String on page 659. 3. If you are finished configuring the router, commit the configuration.

658 IG550 Integrated Gateway Administration and CLI Reference

Connecting the USB Modem to the Services Router's USB Port

Table 84: Configuring the USB Modem Initialization String Task Navigate to the Interfaces level in the configuration hierarchy. J-Web Configuration Editor 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Configure or Edit. 1. Next to Modem options, click Configure. 2. In the Init command string box, type "AT S0=2 L2 " 3. Click OK. CLI Configuration Editor From the [edit] hierarchy level, enter edit interfaces umd0

Configure the modem AT commands to initialize the USB modem.

The command S0=2 configures the modem to auto answer calls on the second ring. The command L2 configures medium speaker volume on the modem.

From the [edit interfaces umd0] hierarchy, enter set modem-options init-command-string "AT S0=2 L2"

Resetting USB Modems


If the USB modem does not respond, you can reset the modem.

! CAUTION:
CAUTION:

If you reset the modem when a call is in progress, the call is terminated.

To reset the USB modem: 1. Enter operational mode in the CLI. 2. To reset the USB modem, enter the following command: user@host> request interface modem reset umd0.

Issue 2 January 2008

659

Configuring the routers modem interface for remote dial-in and dial backup

Configuring a personal computer for remote dial access through the routers modem
To access the J-series router with a remote PPP connection through a modem, you must configure the personal computer you are using for the modem connection. Note: This procedure is for a modem connection with a static IP address to the router. You can also configure the router for dynamic IP addressing. This procedure is also for password-protected (chap-secret) access to the router. 1. On your personal computer, select Start>Settings>Control Panel or Start>Control Panel. The Control Panel appears. 2. Select Network and Dial-up Connections. The Network Connections window appears. 3. Click on the connection for the modem.

Note:

660 IG550 Integrated Gateway Administration and CLI Reference

Configuring a personal computer for remote dial access through the routers modem

4. In the Phone Number field, type the phone number of the J-series router modem. Depending on the dial plan for this gateway, this number may need to include a trunk access code, the modems area code, and the seven-digit phone number. 5. Click the Configure button. The Modem Configuration screen appears.

6. In the Maximum speed (bps) field, select a transmission speed that matches the speed of the J-series modem. 7. Click OK. The Modem Configuration screen disappears.

Issue 2 January 2008

661

Configuring the routers modem interface for remote dial-in and dial backup

8. Click the Options tab. The Options screen appears.

9. Select Prompt for name and password certificate, etc.

662 IG550 Integrated Gateway Administration and CLI Reference

Configuring a personal computer for remote dial access through the routers modem

10. Click the Security tab. The Security screen appears.

11. In the Validate my identity as follows: field, select the appropriate password level.

Issue 2 January 2008

663

Configuring the routers modem interface for remote dial-in and dial backup

12. Click the Networking tab. The Networking screen appears.

13. In the Type of dial-up server I am calling: field, select PPP for your personal computer. 14. Click the Settings button. The PPP Settings window appears.

15. Ensure that Enable software compression is not selected. Click OK. The PPP Settings window disappears. 16. In the Components check are used by the connection box on the Networking tab, check and highlight the Internet Protocol (TCP/IP) option.

664 IG550 Integrated Gateway Administration and CLI Reference

Configuring a personal computer for remote dial access through the routers modem

17. Click the Properties button. The Internet Protocol (TCP/IP) Properties window appears.

18. Select the Obtain an IP address automatically option.

Issue 2 January 2008

665

Configuring the routers modem interface for remote dial-in and dial backup

19. Click the Advanced button. The Advanced TCP/IP Settings window appears.

20. Verify that the Use default gateway on remote network field is not selected. Generally, if you are connected to a corporate network, selecting this option will prevent a connection to corporate network resources. 21. Ensure that the Use IP header compression is not selected. IP header compression should not be used for the PPP connection to the J-series router. 22. Click OK. The Advance TCP/IP Settings window disappears. 23. Click OK on the Internet Protocol (TCP/IP) Properties window. The Internet Protocol (TCP/IP) Properties window disappears.

666 IG550 Integrated Gateway Administration and CLI Reference

Configuring a personal computer for remote dial access through the routers modem

24. Click the Advanced or Sharing tab. The Advanced or Sharing screen appears.

25. Ensure that the Allow other network user to connect through this computers Internet connection field is not selected. 26. Click OK. The settings for the modem PPP connection are complete.

Issue 2 January 2008

667

Configuring the routers modem interface for remote dial-in and dial backup

668 IG550 Integrated Gateway Administration and CLI Reference

Index

Index
Avaya Voice Announcement Manager (VAM) . . . . 175

A
Access Security Gateway (ASG) authentication Accessing Avaya Communication Manager . . . . . . CLI . . . . . . . . . . . . . . . . . . . MGC . . . . . . . . . . . . . . . . . . . PIM . . . . . . . . . . . . . . . . . . . via modem . . . . . . . . . . . . . . . . Announcement files CLI commands . . . . . . . . . . . . . . copy announcement-file ftp . . . . . . . . copy announcement-file scp . . . . . . . . copy ftp announcement-file . . . . . . . . copy scp announcement-file . . . . . . . . erase announcement-file . . . . . . . . . managing and transferring using SCP . . . rename announcement-file . . . . . . . . show announcements files . . . . . . . . show download announcement-file status . show upload announcement-file status . . . ASG authentication . . . . . . . . . . . . . copy auth-file ftp . . . . . . . . . . . . . copy auth-file scp . . . . . . . . . . . . . copy auth-file tftp . . . . . . . . . . . . . copy ftp auth-file . . . . . . . . . . . . . copy scp auth-file . . . . . . . . . . . . . copy tftp auth-file . . . . . . . . . . . . . login authentication . . . . . . . . . . . . login authentication local-craft-password . . login authentication response-time . . . . . login authentication services-login . . . . . show auth-file info . . . . . . . . . . . . show download auth-file status . . . . . . show login authentication . . . . . . . . . show upload auth-file status . . . . . . . . username . . . . . . . . . . . . . . . . ASG commands . . . . . . . . . . . . . . . Authenticating Service logins . . . . . . . . . . . . . . Auto Fallback in SLS . . . . . . . . . . . . . Avaya Communication Manager accessing . . . . . . . . . . . . . . . . configuring for SLS . . . . . . . . . . . . functions . . . . . . . . . . . . . . . . . Avaya Services authenticating logins with ASG . . . . . . Avaya Site Administration . . . . . . . . . .

. . . 34 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31 27 31 31 30

B
Backing up show backup status . . . . . . . . . . . . . . 258 Backup service . . . . . . . . . . . . . . . . . . 159 BRI links, see Link status

. 177 . 237 . 238 . 239 . 240 . 241 . 175 . 241 . 242 . 243 . 244 . 34 . 246 . 246 . 247 . 248 . 249 . 250 . 251 . 252 . 252 . 253 . 254 . 254 . 255 . 256 257, 596 . . . 38

C
CDR file copy cdr-file ftp . . . . . . . . . . copy cdr-file scp . . . . . . . . . . copy cdr-file tftp . . . . . . . . . . show upload cdr-file status . . . . . CDR, SLS information . . . . . . . . Chatter, see CNA test plugs CLI accessing from local network . . . . accessing from remote location. . . accessing with console device . . . accessing with modem. . . . . . . accessing, general . . . . . . . . listing files . . . . . . . . . . . . managing configuration files . . . . managing firmware banks . . . . . online help . . . . . . . . . . . . overview . . . . . . . . . . . . . upgrading firmware using FTP/TFTP using to configure the system . . . viewing device status . . . . . . . CLI sessions exit . . . . . . . . . . . . . . . . reset . . . . . . . . . . . . . . . retstatus . . . . . . . . . . . . . set logout . . . . . . . . . . . . . show logout . . . . . . . . . . . . tech . . . . . . . . . . . . . . . tree . . . . . . . . . . . . . . . . CNA test plugs CLI commands . . . . . . . . . . cna testplug . . . . . . . . . . . . clear counters . . . . . . . . . control-port . . . . . . . . . . rtp-echo-port . . . . . . . . . . rtp-test-port . . . . . . . . . . scheduler . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

259 259 260 261 . 81

. . . . . . . . . . . . .

29 30 29 30 27 67 65 61 29 27 62 24 57

. . . 34 . . . 69 . . . 31 . . . 83 . . . 31 . . . 34 . . . 31

262 262 263 264 265 265 266 225 267 267 268 269 269 270

Issue 2 January 2008

669

Index

shutdown . . . . . . . . . . test-rate-limit . . . . . . . . cna-testplug-service . . . . . . configuration example . . . . . . configuring for registration . . . . functionality . . . . . . . . . . overview . . . . . . . . . . . . show cna testplug . . . . . . . Codec . . . . . . . . . . . . . . . Commands add nfas-interface . . . . . . . add port . . . . . . . . . . . . bri . . . . . . . . . . . . . . . clear attendant . . . . . . . . . clear bri . . . . . . . . . . . . clear counter . . . . . . . . . . clear counters . . . . . . . . . clear dial-pattern . . . . . . . . clear ds1 . . . . . . . . . . . . clear dynamic-trap-manager . . . clear extension . . . . . . . . . clear fac . . . . . . . . . . . . clear incoming-routing . . . . . clear logging file . . . . . . . . clear logging server . . . . . . . clear mgc list . . . . . . . . . . clear radius authentication server clear sig-group . . . . . . . . . clear slot-config . . . . . . . . . clear ssh-client known-hosts . . . clear station . . . . . . . . . . clear survivable-config . . . . . clear sync interface . . . . . . . clear tac . . . . . . . . . . . . clear tcp syn-cookies counters . . clear trunk-group . . . . . . . . cna-testplug . . . . . . . . . . cna-testplug-service . . . . . . control-port . . . . . . . . . . . copy announcement-file ftp . . . copy announcement-file scp . . . copy announcement-file usb . . . copy auth-file ftp . . . . . . . . copy auth-file scp . . . . . . . . copy auth-file tftp . . . . . . . . copy auth-file usb . . . . . . . . copy capture-file ftp . . . . . . . copy capture-file scp . . . . . . copy cdr-file ftp . . . . . . . . . copy cdr-file scp . . . . . . . . copy dhcp-binding ftp . . . . . . copy dhcp-binding scp . . . . . copy ftp announcement-file . . . copy ftp auth-file . . . . . . . . copy ftp EW_archive . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. 271 . 272 . 272 . 223 . 222 . 220 . 220 . 273 . 155

. . . . 127, 136 . . . . 121, 137 . . 107, 118, 131 . . . . . . . 132 . . . . 118, 132 . . . . . . . 225 . . . . . . . 225 . . . . 128, 132 . . . . 113, 132 . . . . . . . 172 . . . . .111, 132 . . . . . . . 132 . . . . . . . 132 . . . . 143, 152 . . . . . . . 141 . . . . . . 55, 56 . . . . . . . 44 . . . . 127, 132 . . . . . . . 132 . . . . . . 41, 42 . . . . . . . 132 . . . . . . . 132 . . . . 228, 229 . . . . . . . 137 . . . . . . . 49 . . . . 120, 132 . . . . 222, 225 . . . . 222, 225 . . . . 222, 225 . 63, 64, 175, 177 . 63, 64, 175, 177 . . . . . . . 176 . . 36, 38, 63, 64 . . 36, 38, 63, 64 . . . . . . 36, 39 . . . . . . . 36 . . . . . . 63, 64 . . . . . . 63, 64 . . . . . . 63, 64 . . . . . . 63, 64 . . . . . . 63, 64 . . . . . . 63, 64 . . . . 176, 178 . . . . . . 35, 39 . . . . . . . 62

copy ftp module . . . . . . . . . . . . . . copy ftp startup-config . . . . . . . . . . . copy ftp SW_imageA . . . . . . . . . . . copy ftp SW_imageB . . . . . . . . . . . copy ftp sw_imageB . . . . . . . . . . . . copy running-config ftp. . . . . . . . . . . copy running-config scp . . . . . . . . . . copy running-config startup-config . . . . . copy running-config tftp . . . . . . . . . . copy scp announcement-file . . . . . . . . copy scp auth-file . . . . . . . . . . . . . copy scp startup-config . . . . . . . . . . copy startup-config ftp . . . . . . . . . . . copy startup-config scp . . . . . . . . . . copy startup-config tftp. . . . . . . . . . . copy tftp auth-file . . . . . . . . . . . . . copy tftp EW_archive . . . . . . . . . . . copy tftp startup-config. . . . . . . . . . . copy tftp SW_imageA . . . . . . . . . . . copy tftp SW_imageB . . . . . . . . . . . copy usb auth-file . . . . . . . . . . . . . crypto key generate . . . . . . . . . . . . dial-pattern . . . . . . . . . . . . . . 108, dir . . . . . . . . . . . . . . . . . . . . disconnect ssh . . . . . . . . . . . . . . ds1 . . . . . . . . . . . . . . . . . . . . erase announcement-file . . . . . . . . . . erase auth-file . . . . . . . . . . . . . . . help . . . . . . . . . . . . . . . . . . . hostname . . . . . . . . . . . . . . . . . incoming-routing . . . . . . . . . . . 108, interface . . . . . . . . . . . . . . . . . ip snmp . . . . . . . . . . . . . . . . . . ip ssh . . . . . . . . . . . . . . . . . . . ip telnet . . . . . . . . . . . . . . . . . . ip telnet-client . . . . . . . . . . . . . . . key config-key password-encryption . . . . login authentication . . . . . . . . . . . . login authentication local-craft-password . . login authentication lockout . . . . . . . . login authentication response-time . . . . . login authentication services-logins . . . . . ppp authentication ASG authentication . . . . . . . . . . . remove nfas-interface . . . . . . . . . . . remove port . . . . . . . . . . . . . . . . rename announcement-file . . . . . . . . . rtp-echo-port . . . . . . . . . . . . . . . rtp-stat clear . . . . . . . . . . . . . . . rtp-stat event-threshold . . . . . . . . . . rtp-stat fault . . . . . . . . . . . . . . . . rtp-stat min-stat-win . . . . . . . . . . . . rtp-stat qos-trap . . . . . . . . . . . . . . rtp-stat qos-trap-rate-limit . . . . . . . . . rtp-stat service . . . . . . . . . . . . . .

. . 64 65, 66 62, 64 . . 64 . . 62 65, 66 65, 66 46, 48 65, 66 175, 178 . 36, 39 . 65, 66 . 65, 66 . . . 66 . 65, 66 . 36, 39 . . . 62 . 65, 66 . . . 64 . 62, 64 . . . 36 . . . 40 128, 132 . . . 67 . . . 40 107, 133 . . 178 . 35, 39 . . . 29 . . . 40 129, 134 . . . 51 . . 169 . 40, 41 . 45, 46 . 45, 46 . 46, 47 . . . 36 . 37, 39 . 37, 39 . 36, 39 . . . 39 . . . 37 . . 136 . . 137 176, 178 222, 225 184, 217 183, 217 188, 217 187, 217 188, 217 189, 218 . . 218

. . . . . . . . .

670 IG550 Integrated Gateway Administration and CLI Reference

Index

rtp-stat thresholds . . . . . . . . rtp-stat-service . . . . . . . . . . rtp-test-port. . . . . . . . . . . . running-config startup-config . . . scheduler . . . . . . . . . . . . session . . . . . . . . . . . . . set associated-signaling . . . . . . set attendant . . . . . . . . . . . set bearer-capability (bri) . . . . . set bearer-capability (ds1) . . . . . set bit-rate . . . . . . . . . . . . set boot bank . . . . . . . . . . . set cbc . . . . . . . . . . . . . . set cbc-parameter . . . . . . . . set cbc-service-feature . . . . . . set channel-numbering . . . . . . set channel-preferences . . . . . . set codeset-display . . . . . . . . set codeset-national . . . . . . . set connect . . . . . . . . . . . . set cor . . . . . . . . . . . . . . set country-protocol (bri) . . . . . set country-protocol (ds1) . . . . . set date-format . . . . . . . . . . set delete-digits (dial-pattern) . . . set delete-digits (incoming-routing) . set deny . . . . . . . . . . . . . set dial . . . . . . . . . . . . . . set digit-handling . . . . . . . . . set digits . . . . . . . . . . . . . set digit-treatment . . . . . . . . set directory-number-a . . . . . . set directory-number-b . . . . . . set endpoint-init . . . . . . . . . set etr . . . . . . . . . . . . . . set expansion-module . . . . . . . set fac . . . . . . . . . . . . . . set incoming-destination . . . . . set incoming-dialtone . . . . . . . set insert-digits (dial-pattern) . . . set insert-digits (incoming-routing) . set interface (bri) . . . . . . . . . set interface (ds1) . . . . . . . . set interface-companding (bri) . . . set interface-companding (ds1) . . set ip-codec-set . . . . . . . . . set japan-disconnect . . . . . . . set layer 1-stable . . . . . . . . . set length . . . . . . . . . . . . set logging file . . . . . . . . . . set logging file condition . . . . . . set logging file disable . . . . . . set logging file enable . . . . . . . set logging server . . . . . . . . . set logging server access level . . set logging server access-level . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

183, 218 . . . 184 222, 225 . . 25, 26 222, 225 . . . 56 127, 136 110, 134 118, 131 116, 133 114, 133 . . 61, 64 . . . 137 . . . 137 . . . 137 . . . 133 124, 137 124, 137 124, 137 114, 133 112, 136 118, 131 115, 133 108, 110, 134 . . 129, 133 . . 130, 134 . . 129, 133 . . 121, 137 . . 124, 137 . . 124, 138 . . 123, 138 . . 119, 131 . . 119, 131 . . 119, 131 . . 159, 160 . . 113, 136 . . . . . 134 . . 126, 138 . . 126, 138 . . 129, 133 . . 130, 134 . . 118, 131 . . 114, 133 . . 119, 131 . . 117, 133 . . 108, 134 . . 125, 138 . . 119, 131 . . 130, 134 . . 147, 152 . . . . . 147 . . . . . 143 . . . . . 143 140, 152, 153 . . . . . 153 . . . . . 141

. . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . .

set logging server condition . . . . . set logging server disable . . . . . . set logging server enable . . . . . . set logging server facility . . . . . . . set logging session . . . . . . . . . session log . . . . . . . . . . . set logging session condition . . . . . set logging session disable . . . . . . set long-timer . . . . . . . . . . . . set match-pattern . . . . . . . . . . set max-ip-registrations . . . . . . . set max-length . . . . . . . . . . . set mediaserver . . . . . . . . . . . set mgc list . . . . . . . . . . . . . set min-length . . . . . . . . . . . . set name (bri) . . . . . . . . . . . . set name (ds1) . . . . . . . . . . . set name (station) . . . . . . . . . . set name (trunk-group) . . . . . . . set numbering-format . . . . . . . . set password . . . . . . . . . . . . set pim-lockout . . . . . . . . . . . set port . . . . . . . . . . . . . . . set port trap . . . . . . . . . . . . . set primary-dchannel . . . . . . . . set protocol-version . . . . . . . . . set qos bearer . . . . . . . . . . . . set qos control . . . . . . . . . . . set qos rsvp . . . . . . . . . . . . . set qos rtcp . . . . . . . . . . . . . set qos signal . . . . . . . . . . . . set radius authentication . . . . . . . set radius authentication retry-number set radius authentication retry-time . . set radius authentication secret. . . . set radius authentication server . . . set radius authentication udp-port . . set reset-times . . . . . . . . . . . set send-name . . . . . . . . . . . set send-number . . . . . . . . . . set side (bri). . . . . . . . . . . . . set side (ds1) . . . . . . . . . . . . set signaling-mode . . . . . . . . . set slot-config . . . . . . . . . . . . set sls . . . . . . . . . . . . . . . set snmp community . . . . . . . . . set snmp retries . . . . . . . . . . . set snmp trap . . . . . . . . . . . . set snmp trap disable frame-relay . . set snmp trap enable frame-relay . . . set spid-a . . . . . . . . . . . . . . set spid-b . . . . . . . . . . . . . . set supervision . . . . . . . . . . . set swhook-flash . . . . . . . . . . set sync interface . . . . . . . . . . set sync source . . . . . . . . . . .

. . . 147, 153 . . . . . 141 . . . . . 140 . . . 140, 153 . . . . . 153 . . . . . 145 . . . . . 147 . . . . . 145 . . . 117, 133 . . . 130, 134 . . . 108, 135 . . . 129, 133 . . . . . . 56 . . 53, 55, 56 . . . 129, 133 . . . 118, 131 . . . 114, 134 . . . 113, 136 . . . 124, 138 . . . 125, 138 . . . 113, 136 . 108, 110, 135 . . . 112, 136 . . . . . 167 . . . 127, 136 . . . 115, 134 . . . 156, 157 . . . 155, 157 . . . 156, 157 . . . 156, 157 . . . 156, 157 . . 42, 43, 44 . . . . 43, 44 . . . . 43, 44 . . . . 42, 44 . . . . 42, 44 . . . . 43, 44 . . . . 55, 56 . . . 125, 138 . . . 125, 138 . . . 118, 131 . . . 115, 134 . . . 114, 134 . . . 108, 135 . 93, 110, 131 . . . . . 170 . . . . . 169 . . . . . 169 . . . . . 167 . . . . . 167 . . . 119, 131 . . . 119, 132 . . . 123, 138 . . . 113, 136 . . . . . 229 . . . 227, 229

Issue 2 January 2008

671

Index

set sync switching . . . . . . . . . . . . 228, 229 set tac . . . . . . . . . . . . . . . . . . 121, 138 set tei-assignment . . . . . . . . . . . . 119, 132 set terminal recovery password . . . . . . . . . 45 set tgnum . . . . . . . . . . . . . . . . 129, 133 set trunk-destination . . . . . . . . . . . 113, 137 set trunk-group-chan-select . . . . . . . . 127, 136 set trunk-hunt. . . . . . . . . . . . . . . 126, 138 set type (dial-pattern) . . . . . . . . . . . 128, 133 set type (station) . . . . . . . . . . . . . .111, 137 set utilization cpu . . . . . . . . . . . . . . . . 58 show (bri) . . . . . . . . . . . . . . . . 119, 132 show (dial-pattern) . . . . . . . . . . . . 129, 133 show (ds1) . . . . . . . . . . . . . . . . 117, 134 show (incoming-routing) . . . . . . . . . . 130, 134 show (sig-group) . . . . . . . . . . . . . 128, 136 show (station) . . . . . . . . . . . . . . 113, 137 show (trunk-group) . . . . . . . . . . . . 126, 138 show announcement-file . . . . . . . . . . . . 178 show announcements-files . . . . . . . . . . . 176 show attendant . . . . . . . . . . . . . . . . . 135 show auth-file info . . . . . . . . . . . . 35, 38, 39 show auth-file status . . . . . . . . . . . . . . 39 show boot bank . . . . . . . . . . . . . . . . 61, 64 show bri . . . . . . . . . . . . . . . . . . . . 135 show cna testplug . . . . . . . . . . . . 222, 225 show date-format . . . . . . . . . . . . . . . . 135 show dial-pattern . . . . . . . . . . . . . . . . 135 show download announcement-file status . 176, 178 show download software status . . . . . . . . . 64 show download status . . . . . . . . . . . . 65, 66 show ds1 . . . . . . . . . . . . . . . . . . . . 135 show etr . . . . . . . . . . . . . . . . . . . . 160 show extension . . . . . . . . . . . . . . . . . 135 show fac . . . . . . . . . . . . . . . . . . . . 135 show faults . . . . . . . . . . . . . . . . . . 57, 58 show image version . . . . . . . . . . 57, 59, 61, 64 show incoming-routing . . . . . . . . . . . . . 135 show interfaces interface status . . . . . . . . . . . . . . . 219 show ip ssh . . . . . . . . . . . . . . . . . 40, 41 show ip telnet. . . . . . . . . . . . . . . . . . 46 show ip-codec-set . . . . . . . . . . . . . . . 135 show last-pim-update . . . . . . . . . . . . . . 135 show logging file condition. . . . . . . . . 144, 153 show logging file content . . . . . . . 143, 147, 153 show logging server condition . . . . . . . 142, 153 show logging session condition . . . . . . 146, 153 show login authentication . . . . . . . . . . . 38, 39 show max-ip-registration . . . . . . . . . . . . 135 show mediaserver . . . . . . . . . . . . . . . 56 show mg list_config . . . . . . . . . . . . . . 57, 59 show mgc . . . . . . . . . . . . . . . . 54, 57, 59 show mgc list . . . . . . . . . . . . . . . . . 54, 57 show mm . . . . . . . . . . . . . . . . . . . 57

show module . . . . . . . . . . . . . . . . 57, 59 show pim-lockout . . . . . . . . . . . . . . . 135 show port trap . . . . . . . . . . . . . . . . . 167 show protocol . . . . . . . . . . . . . . . . . . 46 show qos-rtcp . . . . . . . . . . . . . . . 156, 157 show radius authentication . . . . . . . . . . 43, 44 show recovery . . . . . . . . . . . . . . . 55, 57 show restart-log . . . . . . . . . . . . . . . 58, 59 show rtp-stat config . . . . . . . . . . . . 184, 218 show rtp-stat detailed . . . . . . . . . . . 191, 218 show rtp-stat sessions . . . . . . . . . . . 190, 218 show rtp-stat summary. . . . . . . . . . . 189, 218 show rtp-stat thresholds . . . . . . . . . . 181, 218 show rtp-stat traceroute . . . . . . . . . . 203, 218 show sig-group . . . . . . . . . . . . . . . . 135 show slot-config . . . . . . . . . . . . . . . . 135 show sls . . . . . . . . . . . . . . . . . . . 131 show snmp . . . . . . . . . . . 167, 169, 171, 188 show snmp engineID . . . . . . . . . . . 170, 171 show snmp group . . . . . . . . . . . . . 170, 171 show snmp retries . . . . . . . . . . . . . . . 170 show snmp user . . . . . . . . . . . . . . 170, 171 show snmp userToGroup . . . . . . . . . . . 170 show snmp usertogroup . . . . . . . . . . . . 171 show snmp view. . . . . . . . . . . . . . 170, 171 show station . . . . . . . . . . . . . . . . . 136 show sync timing . . . . . . . . . . . . . . . 229 show system . . . . . . . . . . . . . . 51, 58, 59 show tcp syn-cookies . . . . . . . . . . . . . . 49 show temp . . . . . . . . . . . . . . . . . 58, 59 show timeout . . . . . . . . . . . . . . . . . . 59 show trunk-group . . . . . . . . . . . . . . . 136 show upload announcement-file status . . . 177, 178 show upload auth-file status . . . . . . . . . 36, 39 show username . . . . . . . . . . . . . . . . . 38 show utilization . . . . . . . . . . . . . . . . . 59 show voltages . . . . . . . . . . . . . . . . 58, 59 shutdown CNA test plug . . . . . . . . . . . . . 222, 225 sig-group . . . . . . . . . . . . . . . 107, 127, 136 sls . . . . . . . . . . . . . . . . . . 107, 108, 131 snmp trap link-status . . . . . . . . . . . . . 168 snmp-server community . . . . . . . . . . . . 171 snmp-server dynamic-trap-manager . . 171, 172, 188 snmp-server enable notification . . . . . . . . 169 snmp-server enable notifications . . . . . . . . 167 snmp-server engineID . . . . . . . . . . . 170, 171 snmp-server group . . . . . . . . . . . . 169, 171 snmp-server host . . . . . . . . . . . 167, 169, 187 snmp-server informs . . . . . . . . . . . . . . 169 snmp-server remote-user . . . . . . . . . 170, 171 snmp-server user . . . . . . . . . . . 164, 169, 171 snmp-server view . . . . . . . . . . . 166, 170, 171 station . . . . . . . . . . . . . . . . 107, 111, 136 tcp syn-cookies . . . . . . . . . . . . . . . 48, 49

672 IG550 Integrated Gateway Administration and CLI Reference

Index

telnet . . . . . . . . . . . . . . . . . . . . . 46 test led . . . . . . . . . . . . . . . . . . . . 58, 59 test-rate-limit . . . . . . . . . . . . . . . 222, 225 trunk-group . . . . . . . . . . . . . . . . 107, 137 username . . . . . . . . . . . . . . . . . . . 33 Configuration defining an interface . . . . . . . . . . . . . . 51 dynamic trap manager . . . . . . . . . . . . . 171 installation and setup . . . . . . . . . . . . . . 23 managing configuration files . . . . . . . . . . . 65 MGC list . . . . . . . . . . . . . . . . . . . . 53 RTCP . . . . . . . . . . . . . . . . . . . . . 155 RTP . . . . . . . . . . . . . . . . . . . . . . 155 running configuration . . . . . . . . . . . . . . 25 saving configuration changes . . . . . . . . . . 25 startup configuration . . . . . . . . . . . . . . 25 using GUI applications . . . . . . . . . . . . 23, 25 using the CLI . . . . . . . . . . . . . . . . . . 24 Configuration file CLI commands . . . . . . . . . . . . . . . . . 66 Configuration files copy ftp startup-config . . . . . . . . . . . . . 276 copy running-config ftp . . . . . . . . . . . . . 277 copy running-config scp . . . . . . . . . . . . . 278 copy running-config startup-config . . . . . . . . 279 copy running-config tftp . . . . . . . . . . . . . 279 copy scp startup-config . . . . . . . . . . . . . 280 copy startup-config ftp . . . . . . . . . . . . . 281 copy startup-config scp . . . . . . . . . . . . . 282 copy startup-config tftp . . . . . . . . . . . . . 283 copy tftp startup-config . . . . . . . . . . . . . 284 erase startup-config . . . . . . . . . . . . . . . 284 nvram initialize . . . . . . . . . . . . . . . . . 285 show copy status . . . . . . . . . . . . . . . . 285 show download status . . . . . . . . . . . . . 286 show erase status . . . . . . . . . . . . . . . 287 show running-config . . . . . . . . . . . . . . 287 show startup-config . . . . . . . . . . . . . . . 288 show upload status . . . . . . . . . . . . . . . 289 Connectivity ping . . . . . . . . . . . . . . . . . . . . . . 290 Console port connecting console device . . . . . . . . . . . 29 Converged Network Analyzer, see CNA test plugs Counters clear counters . . . . . . . . . . . . . . . . . 291 clear ip traffic . . . . . . . . . . . . . . . . . . 292 show ip traffic. . . . . . . . . . . . . . . . . . 292 CSU loopbacks show csu loopbacks . . . . . . . . . . . . . . 294 show csu status . . . . . . . . . . . . . . . . 295

clear utilization cpu . . . . . . . . CLI commands . . . . . . . . . . set utilization cpu . . . . . . . . . show faults . . . . . . . . . . . . show mg list_config . . . . . . . . show mgc . . . . . . . . . . . . . show mm . . . . . . . . . . . . . show module . . . . . . . . . . . show recovery . . . . . . . . . . show restart-log . . . . . . . . . . show system . . . . . . . . . . . show timeout . . . . . . . . . . . show upload . . . . . . . . . . . show utilization . . . . . . . . . . test led . . . . . . . . . . . . . . viewing . . . . . . . . . . . . . . Diagnosing and monitoring the network . . . . Display banner login . . . . . . . . . . . banner post-login . . . . . . . . . clear screen . . . . . . . . . . . . hostname . . . . . . . . . . . . . line . . . . . . . . . . . . . . . . show banner login . . . . . . . . . show banner post-login . . . . . . terminal length . . . . . . . . . . terminal width . . . . . . . . . . . DNS resolver show protocol . . . . . . . . . . . Dynamic CAC show dynamic-cac . . . . . . . . . Dynamic trap manager clear dynamic-trap-manager . . . . CLI commands . . . . . . . . . . configuring . . . . . . . . . . . . snmp-server dynamic-trap-manager

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . .

297 299 299 300, 378 . . 301 . . 302 303, 380 . . 303 . . 304 . . 305 298, 305 . . 306 . . 307 . . . 57

. . . . .

. . . . .

296

. 58

. . . . . . 179 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307 . . 308 . . 308 309, 572 . . 310 . . . 311 . . . 311 . . 312 . . 312

. . . . . . 313 . . . . . . 315 . . . . . . . . . . . . . . . . . . . . . . . .
315 172 171 316

E
E1/T1 interfaces controller clock source . . . . . . . . . Emergency Transfer Relay see ETR Emergency Transfer Relay, see ETR Emergency transfer relay, see ETR Encrypting gateway secrets . . . . . ETR CLI commands . . . . . . . . . description . . . . . . . . . . . displaying status . . . . . . . . in SLS mode . . . . . . . . . . LED . . . . . . . . . . . . . . manual activation . . . . . . . .

. . . . . . . 318

. . . . . . . . 46 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
160 159 160 . 80 159 159

D
Device status

Issue 2 January 2008

673

Index

set etr . . . . . . . . setting state . . . . . show etr . . . . . . . trunk-to-port latchings .

. . . .

. . . .

. . . .

. . . .

. . . .

. . . .

. . . .

. . . .

. . . .

. . . .

. . . .

. . . .

. 319 . 159 . 320 . 159

I
ICMP errors ip icmp-errors . . . . . . . . . . . . . show ip icmp . . . . . . . . . . . . . Interface status CLI commands . . . . . . . . . . . . Interfaces defining . . . . . . . . . . . . . . . . displaying status . . . . . . . . . . . IP interface configuration interface Console . . . . . . . . . . . interface console . . . . . . . . . . . show ip interface . . . . . . . . . . . show ip interface brief . . . . . . . . . IP phone upgrades clear ip tftp-server statistics . . . . . . copy ftp phone-image . . . . . . . . . copy ftp phone-script . . . . . . . . . copy phone-script ftp . . . . . . . . . copy phone-script scp . . . . . . . . . copy phone-script tftp . . . . . . . . . copy scp phone-script . . . . . . . . . copy tftp phone-image . . . . . . . . . copy tftp phone-script . . . . . . . . . erase phone-image . . . . . . . . . . erase phone-script. . . . . . . . . . . ip tftp-server file-system size . . . . . . show application-memory . . . . . . . show download phone-image-file status show download phone-script-file status . show ip tftp-server files . . . . . . . . show ip tftp-server statistics . . . . . . show upload phone-script-file status . .

F
File transfer, see FTP or TFTP . . . . . . FIPS show system . . . . . . . . . . . . . Firmware CLI commands . . . . . . . . . . . . firmware bank defaults . . . . . . . . firmware banks . . . . . . . . . . . . load with ASB button . . . . . . . . . managing firmware banks . . . . . . . redundancy . . . . . . . . . . . . . upgrade overview . . . . . . . . . . . upgrading using FTP/TFTP . . . . . . uploading files from the gateway . . . . version control . . . . . . . . . . . . Firmware management copy ftp SW_imageA . . . . . . . . . copy ftp SW_imageB . . . . . . . . . copy tftp SW_imageA . . . . . . . . . copy tftp SW_imageB . . . . . . . . . set boot bank . . . . . . . . . . . . . show boot bank . . . . . . . . . . . . show download software status . . . . show image version . . . . . . . . . . Firmware, see Firmware management Fixed analog trunk port . . . . . . . . . . Fragmentation clear fragment . . . . . . . . . . . . fragment chain . . . . . . . . . . . . fragment size . . . . . . . . . . . . . fragment timeout . . . . . . . . . . . show fragment . . . . . . . . . . . . Frame relay encapsulation show interfaces . . . . . . . . . 332, FTP . . . . . . . . . . . . . . . . . . .

. . . . 337 . . . . 337 . . . . 219 . . . . . 51 . . . . 219 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


381 338 338 340

. . . . . 60 . . . . . 304 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
64 61 26 62 61 61 61 62 63 26

. 321 . 322 . 322 . 323 . 325 . 326 . 326 . 327

. . . . . 159 . . . . . . . . . . . . . . . . . . . . . 328 . 328 . 329 . 330 . 331

341, 590 . . 342 . . 343 . . 344 . . 345 . . 346 . . 346 . . 347 . . 348 . . 349 . . 349 350, 591 351, 592 . . 351 . . 352 . . 353 . . 354 . . 355

L
LEDs, ETR . . . . . . . . . . License file of CM ip license-server . . . . . . Link status show isdn bri link . . . . . show isdn link summary . . show isdn pri link . . . . . Listing files . . . . . . . . . . CLI commands . . . . . . Log file see Logging Log file, see Logging Logging clear logging cdr file content clear logging file . . . . . . clear logging server . . . . CLI commands . . . . . . configuring log file . . . . .

. . . . . . . . . . 159 . . . . . . . . . . 356 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
357 358 358 . 67 . 67

334, 387, 605 . . . . . 60

G
GRE tunneling show interfaces . . . . . . . . . 332, 334, 387, 605 GUI tools, configuring the system with . . . . . . . 23, 25

H
Help CLI . . . . . . . . . . . . . . . . . . . . . . 29 commands . . . . . . . . . . . . . . . . . . . 29

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

359 360 360 152 143

674 IG550 Integrated Gateway Administration and CLI Reference

Index

configuring session log . . . . . configuring Syslog server . . . . default severity levels . . . . . . defining filters . . . . . . . . . deleting log file . . . . . . . . . deleting Syslog server . . . . . disabling log file . . . . . . . . disabling session log . . . . . . disabling Syslog server . . . . . displaying log file contents. . . . displaying Syslog server status . enabling log file . . . . . . . . . enabling session log . . . . . . enabling Syslog server . . . . . filtering by application . . . . . . introduction. . . . . . . . . . . limiting Syslog access . . . . . . log file . . . . . . . . . . . . . log file example . . . . . . . . . log file filter contents . . . . . . log file message format . . . . . overview . . . . . . . . . . . . saving settings . . . . . . . . . session log . . . . . . . . . . . session log example . . . . . . session log message format . . . set logging file . . . . . . . . . set logging server . . . . . . . . set logging server access-level . set logging server condition . . . set logging server enable|disable set logging server facility . . . . set logging session . . . . . . . setting filters . . . . . . . . . . show dev log file . . . . . . . . show logging file condition. . . . show logging file content . . . . show logging server condition . . show logging session condition . sinks . . . . . . . . . . . . . . specifying Syslog output facility . Syslog default settings . . . . . Syslog server . . . . . . . . . . Syslog server example . . . . . Syslog server message format . . Logging session, see Logging Loopbacks, see CSU loopbacks

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. 145 . 140 . 148 . 147 . 143 . 141 . 143 . 145 . 141 . 143 . 142 . 143 . 145 . 140 . 149 . 139 . 141 . 139 . 151 . 147 . 145 . 139 . 139 139, 145 . . . 152 . . . 146 . . . 361 . . . 362 . . . 363 . . . 364 . . . 365 . . . 366 . . . 367 . . . 147 . . . 368 . . . 368 . . . 369 . . . 370 . . . 371 . . . 139 . . . 140 . . . 142 . . . 139 . . . 150 . . . 142

. . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . .

MCG CLI commands . . . . . . . . . . . . . . . . . 56 MCK (Master Configuration Key) . . . . . . . . . . 46 Media Gateway Controller, see MGC configuration MGC accessing . . . . . . . . . . . . . . . . . . . . 31 accessing the registered MGC . . . . . . . . . . 56 auto fallback to primary . . . . . . . . . . . . . 52 changing the list . . . . . . . . . . . . . . . . . 55 clearing the list . . . . . . . . . . . . . . . . . 55 displaying the list . . . . . . . . . . . . . . . . 54 running Avaya Communication Manager . . . . . 31 setting reset times . . . . . . . . . . . . . . . . 55 setting the list . . . . . . . . . . . . . . . . . . 53 MGC configuration clear mgc list . . . . . . . . . . . . . . . . . 373 session . . . . . . . . . . . . . . . . . . . . 374 set mediaserver . . . . . . . . . . . . . . . . 375 set mgc list . . . . . . . . . . . . . . . . . . 376 set reset-times . . . . . . . . . . . . . . . . 376 show mediaserver . . . . . . . . . . . . . . . 377 show mgc . . . . . . . . . . . . . . . . . 300, 378 show mgc list . . . . . . . . . . . . . . . . . 379 show recovery . . . . . . . . . . . . . . 303, 380 MGC list SLS entry . . . . . . . . . . . . . . . . . . . . 74 Modem connecting to USB port . . . . . . . . . . . . . 30 Modem configuration interface Console . . . . . . . . . . . . . . . 381 interface console . . . . . . . . . . . . . . . 338 Monitoring applications configuring . . . . . . . . . . . . . . . . . . 179 MSS notifications icmp in-echo-limit . . . . . . . . . . . . . . . 382

N
Network monitoring applications . . . . . . . . . . . . . . . . . . 179 NVRAM, see Configuration files

P
Packet sniffing ip capture-list ip-rule icmp . . . . . . . . . Password, see Users Passwords changing . . . . . . . . . . managing . . . . . . . . . . overview . . . . . . . . . . recovery password . . . . . Phones supported in SLS mode .

. . . . . 382, 384, 385 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


33 33 32 45 70

M
Master Configuration Key CLI commands . . . . . . . . . . . . . . . . . 49 configuring . . . . . . . . . . . . . . . . . . . 46 Master key configuration key config-key password-encryption . . . . . . . 372

Issue 2 January 2008

675

Index

PIM accessing . . . . . . . . . . . . . . . . . . . 31 description . . . . . . . . . . . . . . . . . . . 31 SLS configuration . . . . . . . . . . . . . . . . 88 Policy - access control lists ip access-control-list ip-rule icmp . . . . . . . . . . . . . . 382, 384, 385 Policy - QoS lists ip qos-list ip-rule icmp . . . . . . . . . . . . . . 382, 384, 385 Policy-based routing ip pbr-list icmp . . . . . . . . . . . . . . . 382, 384, 385 Port classification show port classification . . . . . . . . . . . . . 386 Ports analog line . . . . . . . . . . . . . . . . . . . 159 PPP connection . . . . . . . . . . . . . . . . . . . 30 PPP encapsulation show interfaces . . . . . . . . . 332, 334, 387, 605 PRI links, see Link status Privilege levels changing . . . . . . . . . . . . . . . . . . . . 33 description . . . . . . . . . . . . . . . . . . . 33 Provisioning and Installation Manager, see PIM

Q
QoS analyzing fault and clear trap output . CLI commands . . . . . . . . . . . configuration . . . . . . . . . . . . displaying parameters . . . . . . . . fault and clear traps . . . . . . . . . metrics for RTP statistics application . policy, see Policy queue sizes for VoIP traffic . . . . . resolving conflicts . . . . . . . . . . set qos bearer . . . . . . . . . . . set qos control . . . . . . . . . . . set qos signal. . . . . . . . . . . . show qos-rtcp . . . . . . . . . . . show voip-parameters . . . . . . . SNMP traps . . . . . . . . . . . . traps in messages file . . . . . . . . traps, viewing. . . . . . . . . . . . QoS, see RTP, RTCP, RSVP, WFVQ

. . . . . . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. 201 . 157 . 155 . 155 . 188 . 181

. 155 . 156 . 390 . 391 . 392 . 392 393, 600, 603 . . . . . 187 . . . . . 198 . . . . . 197

R
RADIUS authentication . . . . . . . . . . . . . . 32, 42 clear radius authentication server . . . . . . . . 394

set radius authentication . . . . . . . set radius authentication retry-number set radius authentication retry-time . . set radius authentication secret. . . . set radius authentication server . . . set radius authentication udp-port . . show radius authentication . . . . . . Recovery password . . . . . . . . . . . set terminal recovery password. . . . Remote services logins . . . . . . . . . Restoring gateway configuration show restore status . . . . . . . . . Router configuration commands . . . . . . . Routing table configuration traceroute . . . . . . . . . . . . . . RSA authentication . . . . . . . . . . . RSVP . . . . . . . . . . . . . . . . . show qos-rtcp . . . . . . . . . . . . RTCP . . . . . . . . . . . . . . . . . set qos rtcp . . . . . . . . . . . . . show qos-rtcp . . . . . . . . . . . . RTP configuring . . . . . . . . . . . . . overview . . . . . . . . . . . . . . statistics application functionality . . . viewing configuration thresholds . . . RTP MIB, see RTP statistics RTP session data. . . . . . . . . . . . RTP statistics CLI commands . . . . . . . . . . . rtp-stat clear . . . . . . . . . . . . rtp-stat event-threshold . . . . . . . rtp-stat fault . . . . . . . . . . . . . rtp-stat min-stat-win . . . . . . . . . rtp-stat qos-trap . . . . . . . . . . . rtp-stat qos-trap-rate-limit . . . . . . rtp-stat threshold . . . . . . . . . . rtp-stat-service . . . . . . . . . . . show rtp-stat config . . . . . . . . . show rtp-stat detailed . . . . . . . . show rtp-stat sessions . . . . . . . . show rtp-stat summary. . . . . . . . show rtp-stat thresholds . . . . . . . show rtp-stat traceroute . . . . . . . RTP statistics application configuration and output examples . . configuring . . . . . . . . . . . . . configuring additional trap destinations configuring fault and clear traps . . . configuring QoS traps . . . . . . . . configuring thresholds . . . . . . . . display session information . . . . . displaying VoIP engine RTP statistics . enabling . . . . . . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

. . . . . . . . . .

395 396 397 397 398 399 399 . 45 400 . 34

. . . 401, 594
40, 42, 44, 47

. . . . . . . . . . .

. . . . . . . . . . .

. . . . . . . . . . .

. . 402 . . . 40 . . 156 392, 405 . . 155 . . 404 392, 405 . . . . . . . .


155 179 179 181

. . . . . 179 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
217 406 407 408 409 410 . 411 412 412 415 416 417 420 421 422 204 180 187 188 187 183 191 189 184

676 IG550 Integrated Gateway Administration and CLI Reference

Index

enabling traps . . . . . . . . . . modifying the statistics window . . QoS metric thresholds . . . . . . QoS metrics . . . . . . . . . . . resetting . . . . . . . . . . . . . sample network . . . . . . . . . . setting QoS event thresholds . . . setting QoS indicator thresholds . . setting the trap rate limiter . . . . . statistics summary report output . . viewing configuration . . . . . . . viewing QoS traps in messages file

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. . . . . . . . . . . .

. 188 . 187 . 180 . 181 . 184 . 204 . 183 . 183 . 189 . 189 . 184 . 198

S
SAT sat . . . . . . . . . . . . . . . . . . . . . . . 424 Saving configuration changes commands . . . . . . 26 SCP . . . . . . . . . . . . . . . . . . . . . . . 41 transferring announcement files using . . . . . . 175 Security overview . . . . . . . . . . . . . . . . . . . . 32 special features . . . . . . . . . . . . . . . . . 44 Services port connecting console device . . . . . . . . . . . 29 Session log, see Logging Session logs, see Logging Setting synchronization, see Synchronization . . . . 227 SLS Avaya phones supported in SLS . . . . . . . . . 70 call processing not supported by SLS . . . . . . 72 call processing supported by SLS . . . . . . . . 71 capabilities . . . . . . . . . . . . . . . . . . . 69 capacities by gateway model . . . . . . . . . . 95 CDR log . . . . . . . . . . . . . . . . . . . . 81 CLI command hierarchy . . . . . . . . . . . . . 131 configuring . . . . . . . . . . . . . . . . . . . 82 configuring Avaya Communication Manager for SLS83 disabling . . . . . . . . . . . . . . . . . . . . 93 enabling . . . . . . . . . . . . . . . . . . . . 93 entry in MGC list . . . . . . . . . . . . . . . . 74 features . . . . . . . . . . . . . . . . . . . . 69 interaction with call transfer . . . . . . . . . . . . . . . . . 78 Direct Inward Dialing . . . . . . . . . . . . . 76 ETR . . . . . . . . . . . . . . . . . . . . 80 Hold feature . . . . . . . . . . . . . . . . . 77 multiple call appearances . . . . . . . . . . 76 shared administrative identity with softphone . 80 introduction. . . . . . . . . . . . . . . . . . . 69 logging . . . . . . . . . . . . . . . . . . . . . 81 manual CLI configuration administering BRI parameters . . . . . . . . 118 administering dial-pattern parameters . . . . . 128 administering DS1 parameters . . . . . . . . 113

administering incoming-routing parameters . 129 administering signaling-group parameters . . 127 administering station parameters . . . . . . . 111 administering trunk-group parameters . . . . 120 command sub-contexts . . . . . . . . . . . 107 commands hierarchy . . . . . . . . . . . . 131 instructions . . . . . . . . . . . . . . . . 108 introduction . . . . . . . . . . . . . . . . . 94 preparing SLS data set . . . . . . . . . . . . 94 prerequisites . . . . . . . . . . . . . . . . . 94 PIM configuration . . . . . . . . . . . . . . . . 88 preparing SLS data set . . . . . . . . . . . . . 94 analog stations data . . . . . . . . . . . . . 95 ARS dial patterns data . . . . . . . . . . . 105 DS1 trunks data . . . . . . . . . . . . . . 100 FAC data . . . . . . . . . . . . . . . . . 103 incoming call handling data . . . . . . . . . 106 IP stations data . . . . . . . . . . . . . . . 97 ISDN-BRI trunks data . . . . . . . . . . . 102 signaling groups data . . . . . . . . . . . . 102 system parameters data . . . . . . . . . . 104 provisioning data . . . . . . . . . . . . . . . . 72 states . . . . . . . . . . . . . . . . . . . . . . 74 registered . . . . . . . . . . . . . . . . . . 75 setup . . . . . . . . . . . . . . . . . . . . 74 teardown . . . . . . . . . . . . . . . . . . 75 unregistered . . . . . . . . . . . . . . . . . 74 supported functionality . . . . . . . . . . . . . . 71 SLS survivability set sls . . . . . . . . . . . . . . . . . . . . 425 show sls . . . . . . . . . . . . . . . . . . . 426 sls . . . . . . . . . . . . . . . . . . . . . . 424 bri . . . . . . . . . . . . . . . . . . . . . 427 set bearer-capability . . . . . . . . . 428, 462 set country-protocol . . . . . . . . . 429, 465 set directory-number-a . . . . . . . . . 431 set directory-number-b . . . . . . . . . 432 set endpoint-init . . . . . . . . . . . . . 432 set interface . . . . . . . . . . . . 433, 467 set interface-companding . . . . . . 434, 468 set layer1-stable . . . . . . . . . . . . 435 set name . . . . . . . . . 436, 469, 515, 542 set side . . . . . . . . . . . . . . . 437, 472 set spid-a . . . . . . . . . . . . . . . . 438 set spid-b . . . . . . . . . . . . . . . . 439 set tei-assignment. . . . . . . . . . . . 440 show . . . . . . . . . . . . . . . . . . 440 clear attendant . . . . . . . . . . . . . . . 442 clear bri . . . . . . . . . . . . . . . . . . 443 clear dial-pattern . . . . . . . . . . . . . . 443 clear ds1 . . . . . . . . . . . . . . . . . 444 clear extension . . . . . . . . . . . . . . . 445 clear fac . . . . . . . . . . . . . . . . . . 445 clear incoming-routing . . . . . . . . . . . 446 clear sig-group . . . . . . . . . . . . . . . 447 clear slot-config . . . . . . . . . . . . . . 448

Issue 2 January 2008

677

Index

clear station . . . . . . . . clear survivable-config . . . clear trunk-group . . . . . dial-pattern . . . . . . . . set delete-digits . . . . set deny . . . . . . . . set insert-digits . . . . . set max-length . . . . . set min-length . . . . . set tgnum . . . . . . . set type . . . . . . . . show . . . . . . . . . ds1 . . . . . . . . . . . . set bearer-capability . . set bit-rate . . . . . . . set channel-numbering . set connect . . . . . . set country-protocol . . set interface . . . . . . set interface-companding set long-timer . . . . . set name. . . . . . . . set protocol-version. . . set side . . . . . . . . set signaling-mode . . . show . . . . . . . . . incoming-routing . . . . . . set delete-digits . . . . set insert-digits . . . . . set length . . . . . . . set match-pattern . . . . show . . . . . . . . . set attendant . . . . . . . set date-format . . . . . . set fac . . . . . . . . . . set ip-codec-set . . . . . . set max-ip-registrations . . set pim-lockout . . . . . . set slot-config . . . . . . . show attendant . . . . . . show bri. . . . . . . . . . show date-format . . . . . show dial-pattern . . . . . show ds1 . . . . . . . . . show extension . . . . . . show fac . . . . . . . . . show incoming-routing . . . show ip-codec-set . . . . . show last-pim-update . . . show max-ip-registrations . show pim-lockout . . . . . show sig-group . . . . . . show slot-config . . . . . . show station. . . . . . . . show trunk-group . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . .

. . . . . . 449 . . . . . . 450 . . . . . . 450 . . . . . . 451 . . . . . . 452 . . . . . . 453 . . . . . . 453 . . . . . . 454 . . . . . . 455 . . . . . . 456 . . . . . . 457 . . . . . . 459 . . . . . . 460 . . . 428, 462 . . . . . . 463 . . . . . . 464 . . . . . . 464 . . . 429, 465 . . . 433, 467 . . . 434, 468 . . . . . . 469 436, 469, 515, 542 . . . . . . . . 470 . . . . . 437, 472 . . . . . . . . 473 . . . . . . . . 474 . . . . . . . . 476 . . . . . . . . 478 . . . . . . . . 479 . . . . . . . . 480 . . . . . . . . 481 . . . . . . . . 481 . . . . . . . . 482 . . . . . . . . 483 . . . . . . . . 484 . . . . . . . . 485 . . . . . . . . 485 . . . . . . . . 486 . . . . . . . . 487 . . . . . . . . 489 . . . . . . . . 489 . . . . . . . . 490 . . . . . . . . 491 . . . . . . . . 492 . . . . . . . . 493 . . . . . . . . 495 . . . . . . . . 495 . . . . . . . . 496 . . . . . . . . 497 . . . . . . . . 498 . . . . . . . . 498 . . . . . . . . 499 . . . . . . . . 500 . . . . . . . . 500 . . . . . . . . 502

. . . . . . . . . . . . . . . . . . . . .

sig-group . . . . . . . . . . add nfas-interface . . . . . remove nfas-interface . . . set associated-signaling . . set primary-dchannel . . . set trunk-group-chan-select show . . . . . . . . . . . station . . . . . . . . . . . . set cor . . . . . . . . . . set expansion-module . . . set name . . . . . . . . . set password . . . . . . . set port . . . . . . . . . . set swhook-flash . . . . . set trunk-destination . . . . set type . . . . . . . . . show . . . . . . . . . . . trunk-group . . . . . . . . . add port . . . . . . . . . clear tac . . . . . . . . . remove port. . . . . . . . set cbc . . . . . . . . . . set cbc-parameter . . . . . set cbc-service-feature . . set channel-preference . . set codeset-display . . . . set codeset-national . . . . set dial . . . . . . . . . . set digit-handling . . . . . set digits . . . . . . . . . set digit-treatment . . . . . set incoming-destination . . set incoming-dialtone . . . set japan-disconnect . . . set name . . . . . . . . . set numbering-format . . . set send-name . . . . . . set send-number . . . . . set supervision . . . . . . set tac . . . . . . . . . . set trunk-hunt . . . . . . . show . . . . . . . . . . .

. . . . . 504 . . . . . 505 . . . . . 506 . . . . . 507 . . . . . 508 . . . . . 509 . . . . . 510 . . . . . . 511 . . . . . 512 . . . . . 515 436, 469, 515, 542 . . . . . . . 516 . . . . . . . 517 . . . . . . . 518 . . . . . . . 519 . . . . . . . 520 . . . . . . . 521 . . . . . . . 523 . . . . . . . 527 . . . . . . . 529 . . . . . . . 530 . . . . . . . 531 . . . . . . . 532 . . . . . . . 533 . . . . . . . 534 . . . . . . . 534 . . . . . . . 535 . . . . . . . 536 . . . . . . . 537 . . . . . . . 538 . . . . . . . 539 . . . . . . . 540 . . . . . . . 540 . . . . . . . 541 436, 469, 515, 542 . . . . . . . 543 . . . . . . . 544 . . . . . . . 545 . . . . . . . 546 . . . . . . . 547 . . . . . . . 548 . . . . . . . 549 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
170 161 164 173 167 170 170 166 166 164 163 163

. . . . . . . . . .

. . . . . . . . . .

SNMP adding an OID to a view . . . . . . . . agent-manager communication methods changing user parameters . . . . . . . configuration examples . . . . . . . . configuring traps . . . . . . . . . . . creating a community . . . . . . . . . creating a remote user . . . . . . . . . creating OID lists . . . . . . . . . . . creating user groups . . . . . . . . . . creating users . . . . . . . . . . . . . default security name, read . . . . . . default security name, write . . . . . .

678 IG550 Integrated Gateway Administration and CLI Reference

Index

defining the SNMPv3 notification host . . . deleting an OID from a view . . . . . . . . disabling link-up/down notifications/traps . . displaying a list of views . . . . . . . . . . displaying group lists . . . . . . . . . . . displaying information . . . . . . . . . . . displaying the engine ID . . . . . . . . . . displaying user lists . . . . . . . . . . . . displaying users and group mapping . . . . enabling access . . . . . . . . . . . . . enabling frame relay traps . . . . . . . . . enabling link-up/down notifications/traps . . enabling link-up/down traps on an interface . enabling traps and notifications . . . . . . mapping user groups to views . . . . . . . overview . . . . . . . . . . . . . . . . . potential agent residences. . . . . . . . . predefined user groups . . . . . . . . . . QoS . . . . . . . . . . . . . . . . . . . removing a group . . . . . . . . . . . . . required information for creating views . . . setting a group . . . . . . . . . . . . . . setting dynamic trap manager parameters . setting the engine ID . . . . . . . . . . . user groups . . . . . . . . . . . . . . . user-based security model (USM) . . . . . USM security levels . . . . . . . . . . . . version 1 . . . . . . . . . . . . . . . . . version 2 . . . . . . . . . . . . . . . . . version 3 . . . . . . . . . . . . . . . . . versions . . . . . . . . . . . . . . . . . views . . . . . . . . . . . . . . . . . . SNMP access configuration CLI commands . . . . . . . . . . . . . . ip snmp . . . . . . . . . . . . . . . . . set snmp community . . . . . . . . . . . show snmp . . . . . . . . . . . . . . . . show snmp engineID . . . . . . . . . . . show snmp group . . . . . . . . . . . . . show snmp user . . . . . . . . . . . . . show snmp usertogroup . . . . . . . . . . show snmp view . . . . . . . . . . . . . snmp-server community . . . . . . . . . . snmp-server engineID . . . . . . . . . . snmp-server group . . . . . . . . . . . . snmp-server remote-user . . . . . . . . . snmp-server user . . . . . . . . . . . . . snmp-server view . . . . . . . . . . . . . SNMP trap configuration CLI commands . . . . . . . . . . . . . . set snmp trap enable|disable auth . . . . . show snmp . . . . . . . . . . . . . . . . snmp-server enable notifications . . . . . . snmp-server host . . . . . . . . . . . . . snmp-server informs . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. 167 . 170 . 167 . 170 . 170 . 167 . 170 . 170 . 170 . 169 . 167 . 167 . 168 . 167 . 165 . 161 . 161 . 165 . 187 . 169 . 166 . 169 . 171 . 170 . 165 . 164 . 164 . 163 . 163 . 163 . 162 . 166

. . . 170 . . . 551 . . . 552 552, 565 . . . 553 . . . 554 . . . 555 . . . 556 . . . 557 . . . 557 . . . 558 . . . 559 . . . 561 . . . 562 . . . 564 . . . 169 . . . 565 552, 565 . . . 566 . . . 567 . . . 570

Software management, see Firmware management Software, see Firmware . . . . . . . . . . . . . . . 26 SSH configuration . . . . . . . . . . . . . . . . . . 40 overview . . . . . . . . . . . . . . . . . . . . 40 SSH protocol clear ssh-client known-hosts . . . . . . . . . . 571 disconnect ssh . . . . . . . . . . . . . . . . 571 hostname . . . . . . . . . . . . . . . . . 309, 572 ip ssh . . . . . . . . . . . . . . . . . . . . . 573 show ip ssh . . . . . . . . . . . . . . . . . . 574 Standard Local Survivability, see SLS Standard Local Survivability, see SLS survivability Status of the device, see Device status Survivability auto fallback to primary MGC . . . . . . . . . . 52 configuring the MGC list . . . . . . . . . . . . . 53 connection preserving migration . . . . . . . . . 53 ELS . . . . . . . . . . . . . . . . . . . . . . 52 enhanced local survivability, see ELS . . . . . . . 52 MGC list . . . . . . . . . . . . . . . . . . . . 52 modem dial-backup . . . . . . . . . . . . . . . 53 options . . . . . . . . . . . . . . . . . . . . . 52 overview . . . . . . . . . . . . . . . . . . . . 52 setting reset times . . . . . . . . . . . . . . . . 55 SLS, see SLS SYN attacks protection, see SYN cookies SYN cookies attack notification . . . . . . . . . . . . . . . . 48 clearing counters . . . . . . . . . . . . . . . . 49 configuring . . . . . . . . . . . . . . . . . . . 48 introduction . . . . . . . . . . . . . . . . . . . 47 overview . . . . . . . . . . . . . . . . . . . . 47 statistics . . . . . . . . . . . . . . . . . . . . 49 strategies employed . . . . . . . . . . . . . . . 48 SYN flood attack protection, see SYN cookies Synchronization clear sync interface . . . . . . . . . . . . . . 575 CLI commands . . . . . . . . . . . . . . . . 229 disassociating specified primary or secondary clock source . . . . . . . . . . . . . . . . . . . 228 displaying synchronization timing . . . . . . . . 229 LED status . . . . . . . . . . . . . . . . . . 228 overview . . . . . . . . . . . . . . . . . . . 227 set sync interface . . . . . . . . . . . . . . . 576 set sync source . . . . . . . . . . . . . . . . 576 set sync switching . . . . . . . . . . . . . . . 577 setting the sync source . . . . . . . . . . . . 227 show sync timing . . . . . . . . . . . . . . . 578 toggling sync source switching . . . . . . . . . 228 SYN-cookies clear tcp syn-cookies counters . . . . . . . . . 579 show tcp syn-cookies . . . . . . . . . . . . . 579 tcp syn-cookies . . . . . . . . . . . . . . . . 581 Syslog files copy syslog-file ftp . . . . . . . . . . . . . . . 582

Issue 2 January 2008

679

Index

copy syslog-file scp . . . . . . copy syslog-file tftp . . . . . . show upload syslog-file status . Syslog server see Logging Syslog, see Logging System Access Terminal, see SAT System identification set system contact . . . . . . set system location . . . . . . set system name . . . . . . .

. . . . . . . . . 582 . . . . . . . . . 583 . . . . . . . . . 584

V
VAM . . . . . . . . . . . . . . . VMON, for troubleshooting QoS . . VoIP available transmission protocols campon-busyout voip-dsp . . . enabling queuing . . . . . . . overview . . . . . . . . . . . queue delay . . . . . . . . . . queue size . . . . . . . . . . reset voip-dsp . . . . . . . . . RSVP protocol . . . . . . . . show voip-dsp . . . . . . . . . show voip-parameters . . . . . VoIP QoS, see QoS VoIP testing busyout voip-dsp . . . . . . . release voip-dsp. . . . . . . . show voip-parameters . . . . . test voip-dsp . . . . . . . . .

. . . . . . . . 175 . . . . . . . . 179 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
155 597 155 155 155 155 598 156 599 600, 603

. . . . . . . . . 585 . . . . . . . . . 586 . . . . . . . . . 586

T
TCP/IP connection . . . . . . . . . . . . . . Telnet accessing gateway via . . . . . . . . . . enabling and disabling access . . . . . . . Telnet access ip telnet . . . . . . . . . . . . . . . . . ip telnet-client . . . . . . . . . . . . . . telnet . . . . . . . . . . . . . . . . . . Terminal display, see Display TFTP . . . . . . . . . . . . . . . . . . . . TFTP server clear ip tftp-server statistics . . . . . . . . IP phone upgrades, see IP phone upgrades ip tftp-server . . . . . . . . . . . . . . . ip tftp-server file-system size . . . . . . . show application-memory . . . . . . . . . Tools for monitoring. . . . . . . . . . . . . . . VMON . . . . . . . . . . . . . . . . . . TRK port see Fixed analog trunk port

. . . 30 . . . 30 . . . 45 . . . 587 . . . 588 . . . 589 . . . 60


341, 590

. . . . . . . . .

. . . . . . . . .

. . . . . 601 . . . . . 602 . 393, 600, 603 . . . . . 603

W
WAN configuration, verifying show interfaces . . . . . . . . . 332, 334, 387, 605

. . . 591 350, 591 351, 592 . . . 179 . . . 179

U
Upgrading firmware, see Firmware management USB mass storage device show restore status . . . . . . . . . . . . 401, 594 USB port configuring for modem use . . . . . . . . . . . 30 connecting modem . . . . . . . . . . . . . . . 30 User authentication . . . . . . . . . . . . . . . . 32 SSH . . . . . . . . . . . . . . . . . . . . . . 40 Usernames configuring . . . . . . . . . . . . . . . . . . . 33 managing . . . . . . . . . . . . . . . . . . . 33 overview . . . . . . . . . . . . . . . . . . . . 32 removing . . . . . . . . . . . . . . . . . . . . 33 Users show username . . . . . . . . . . . . . . . . 595 username . . . . . . . . . . . . . . . . 257, 596

680 IG550 Integrated Gateway Administration and CLI Reference

You might also like