Administration Guide And Cli Reference For The

Transcript

Administration Guide and CLI Reference for the Avaya IG550 Integrated Gateway 03-601883 Issue 1 February 2007 © 2007 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 Web sites 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, Avaya’s standard warranty language, as well as information regarding support for this product, while under warranty, is available through the following Web site: 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 Web site: http://www.avaya.com/support Contents Chapter 1: Configuration overview. . . . . . . . . . . . . . . . . . . . . 19 Configuration of J-series Services Router . . . . . . . . . . . . . . . . . . . . . . 19 Configuration using CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 PIM for configuration of TGM550 and some J-series Service Router functions . 21 Saving configuration changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Firmware version control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Chapter 2: Accessing the TGM550 Telephony Gateway Module and the J-Series Router . . . . . . . . . . . . . . . . . . . . 23 Accessing the CLI of the Juniper J-Series Services Router . . . . . . . . . . . . 23 Accessing the TGM550 CLI . . . . . . . . . . . . Logging into the CLI . . . . . . . . . . . . . . CLI help. . . . . . . . . . . . . . . . . . . . . Accessing the TGM550 CLI via local network Accessing CLI with a console device . . . . . . . . . 24 24 25 25 25 Accessing the CLI via modem . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing the TGM550 CLI via a USB modem . . . . . . . . . . . . . . . . . 26 26 Accessing PIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Accessing Avaya Communication Manager . . . . . . . . . . . . . . . . . . . . . 27 Managing login permissions . . . . . . . . Security overview . . . . . . . . . . . . Managing users and passwords . . . . Privilege level . . . . . . . . . . . . Configuring usernames . . . . . . . SSH protocol support . . . . . . . . . . SSH Configuration . . . . . . . . . . SCP protocol support . . . . . . . . . . SCP Configuration . . . . . . . . . . RADIUS authentication . . . . . . . . . Using RADIUS authentication. . . . Configuring RADIUS authentication Changing RADIUS parameters . . . Disabling RADIUS authentication. . Displaying RADIUS parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 28 28 29 29 29 30 30 30 31 31 31 32 32 32 Special security features . . . . . . . . . . . . . . Enabling and disabling recovery password . . Enabling and disabling telnet access . . . . . Managing gateway secrets . . . . . . . . . . . Configuring the Master Configuration Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 32 33 33 33 Issue 1 February 2007 3 Contents Enabling SYN cookies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring SYN cookies . . . . . . . . . . . . . . . . . . . . . . . . . . . Maintaining SYN cookies . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 35 35 Chapter 3: Basic device configuration . . . . . . . . . . . . . . . . . . . 37 Configuring the Media Server . . . . . . . . . . . . . . . . . . Survivability and migration options . . . . . . . . . . . . . Configuring the MGC list . . . . . . . . . . . . . . . . . . . Setting the TGM550 Telephony Gateway Module’s MGC Determining results . . . . . . . . . . . . . . . . . . . . Showing the current MGC list. . . . . . . . . . . . . . . Removing one or more MGCs. . . . . . . . . . . . . . . Setting reset times. . . . . . . . . . . . . . . . . . . . . . . Accessing the registered MGC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 38 39 39 40 40 40 41 41 Viewing the status of the device . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Software and Firmware Management . . . . . . . . . . . . . . . . . . File transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Software and firmware upgrades . . . . . . . . . . . . . . . . . . . Managing the firmware banks. . . . . . . . . . . . . . . . . . . Upgrading software and firmware using FTP/TFTP . . . . . . . Backing up and restoring configuration files . . . . . . . . . . . . Backing up/restoring a configuration file using FTP/TFTP/SCP Listing the files on the TGM550 Telephony Gateway Module . . . . . . . . . . . 43 44 44 44 45 46 46 47 Chapter 4: Configuring Standard Local Survivability (SLS) . . . . . . . 49 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . 4 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . 49 50 51 52 52 53 54 54 54 55 55 55 56 56 Contents 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 58 60 60 61 61 Configuring SLS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Communication Manager for SLS . . . . . . . . . . . . . Using PIM to manage SLS administration on the gateway . . . . . . . . . Enabling and disabling 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 . . . . . . . . . . . . . . . . . . . . . . Administering Trunk-group parameters . . . . . . . . . . . . . . . . . Administering signaling-group parameters . . . . . . . . . . . . . . . Administering dial-pattern parameters . . . . . . . . . . . . . . . . . . Administering incoming-routing parameters . . . . . . . . . . . . . . Up-converting SLS data to Release 4.0 . . . . . . . . . . . . . . . . . Down-converting Release 4.0 SLS data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 63 67 73 73 73 73 86 94 97 102 104 110 111 112 113 113 Chapter 5: Configuring logging . . . . . . . . . . . . . . . . . . . . . . 115 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 116 117 117 118 118 118 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. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 119 119 120 120 121 Issue 1 February 2007 5 Contents Configuring a session log. . . . . . . . . . . . . . . . . . Discontinuing the display of system messages . . Displaying how the session logging is configured Session logging message format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 121 122 122 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. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 123 124 124 124 126 127 127 Chapter 6: Configuring VoIP QoS . . . . . . . . . . . . . . . . . . . . . 129 Configuring RTP and RTCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Configuring QoS parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring RTCP QoS parameters . . . . . . . . . . . . . . . . . . . . . . . 130 131 RSVP parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Weighted Fair VoIP Queuing (WFVQ). . . . . . . . . . . . . . . . . . . . . . . . . Configuring Weighted Fair VoIP Queueing (WFVQ) . . . . . . . . . . . . . . . 131 132 Chapter 7: Configuring Emergency Transfer Relay (ETR) . . . . . . . . 133 Setting ETR state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Viewing ETR state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Chapter 8: Configuring SNMP . . . . . . . . . . . . . . . . . . . . . . . 135 Agent and manager communication . . . . . . . . . . . . . . . . . . . . . . . . . 135 SNMP versions. . . . . . . . . . . . SNMPv1. . . . . . . . . . . . . . SNMPv2c . . . . . . . . . . . . . SNMPv3. . . . . . . . . . . . . . Users . . . . . . . . . . . . . . . SNMP security levels . . . . SNMP-server user command Groups . . . . . . . . . . . . . . Creating an SNMPv3 group . Views . . . . . . . . . . . . . . . Creating an SNMPv3 view . . 136 137 137 137 138 138 138 139 140 140 141 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Contents Configuring SNMP traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notification types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 142 Configuring SNMP access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Configuring dynamic trap manager . . . . . . . . . . . . . . . . . . . . . . . . . 144 SNMP configuration examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Chapter 9: Transferring and managing announcement files . . . . . . . 147 Announcement file operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Chapter 10: Configuring monitoring applications. . . . . . . . . . . . . 151 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. . . . . . . . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . . . . . . . . . RTP statistics CLI commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 152 152 155 156 156 158 160 160 161 161 162 169 170 173 174 176 176 180 182 184 187 189 Reporting on interface status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 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 . . . . . . . . . . . . . . . . . . . . . . 191 192 192 192 193 194 Issue 1 February 2007 7 Contents Chapter 11: Setting synchronization . . . . . . . . . . . . . . . . . . . . 197 Synchronization status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying synchronization status . . . . . . . . . . . . . . . . . . . . . . . . 198 198 Chapter 12: User Levels and Contexts . . . . . . . . . . . . . . . . . . . 199 User Levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Contexts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command line prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Available contexts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 200 201 Chapter 13: CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . 203 About the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Logging in to the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Using the CLI. . . . . . . . . Using Help . . . . . . . . Using auto-complete . . Abbreviating commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 204 204 204 Alphabetical listing of CLI commands add nfas-interface . . . . . . . . . add port. . . . . . . . . . . . . . . Analog trunks . . . . . . . . . Digital trunks . . . . . . . . . . banner login . . . . . . . . . . . . banner post-login . . . . . . . . . bri . . . . . . . . . . . . . . . . . . busyout voip-dsp . . . . . . . . . clear bri . . . . . . . . . . . . . . . clear counters (interface) . . . . . clear counters (CNA test plugs) . clear dial-pattern . . . . . . . . . . clear ds1 . . . . . . . . . . . . . . clear dynamic-trap-manager . . . clear extension. . . . . . . . . . . clear fac . . . . . . . . . . . . . . clear fragment . . . . . . . . . . . clear incoming-routing . . . . . . clear ip tftp-server statistics . . . clear ip traffic . . . . . . . . . . . clear logging cdr file content . . . clear logging file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 205 206 206 207 208 209 210 212 212 213 214 214 215 215 216 217 217 218 219 219 220 220 8 IG550 Integrated Gateway Administration and CLI Reference Contents clear logging server . . . . . . . . . clear mgc list . . . . . . . . . . . . . clear radius authentication server . clear screen . . . . . . . . . . . . . clear sig-group . . . . . . . . . . . . clear slot-config . . . . . . . . . . . clear snmp trap . . . . . . . . . . . clear ssh-client known-hosts . . . . clear station . . . . . . . . . . . . . clear survivable-config . . . . . . . clear sync interface . . . . . . . . . clear tac . . . . . . . . . . . . . . . clear tcp syn-cookies counters . . . clear trunk-group . . . . . . . . . . clear utilization cpu . . . . . . . . . clock source . . . . . . . . . . . . . cna-testplug . . . . . . . . . . . . . cna-testplug-service . . . . . . . . . control-port. . . . . . . . . . . . . . copy announcement-file ftp . . . . . copy announcement-file scp . . . . copy auth-file ftp . . . . . . . . . . . copy auth-file scp . . . . . . . . . . copy auth-file tftp . . . . . . . . . . copy cdr-file ftp . . . . . . . . . . . copy cdr-file scp . . . . . . . . . . . copy cdr-file tftp . . . . . . . . . . . copy ftp announcement-file . . . . . copy ftp auth-file . . . . . . . . . . . copy ftp phone-image . . . . . . . . copy ftp phone-script . . . . . . . . copy ftp startup-config . . . . . . . copy ftp SW_imageA . . . . . . . . copy ftp SW_imageB . . . . . . . . copy phone-script ftp . . . . . . . . copy phone-script scp. . . . . . . . copy phone-script tftp . . . . . . . . copy running-config ftp . . . . . . . copy running-config scp . . . . . . copy running-config startup-config copy running-config tftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 222 223 224 224 225 225 226 227 228 228 229 229 230 231 231 232 233 233 234 235 236 237 237 238 239 239 240 241 242 243 244 245 246 247 248 249 250 251 252 252 Issue 1 February 2007 9 Contents copy scp announcement-file copy scp auth-file . . . . . . copy scp phone-script. . . . copy scp startup-config . . . copy startup-config ftp . . . copy startup-config scp . . . copy startup-config tftp . . . copy syslog-file ftp . . . . . copy syslog-file scp . . . . . copy syslog-file tftp . . . . . copy tftp auth-file . . . . . . copy tftp phone-image . . . copy tftp phone-script . . . . copy tftp startup-config . . . copy tftp SW_imageA . . . . copy tftp SW_imageB . . . . dial-pattern . . . . . . . . . . dir . . . . . . . . . . . . . . . disable link encryption . . . disable media encryption . . disconnect ssh. . . . . . . . ds1 . . . . . . . . . . . . . . erase announcement-file . . erase phone-image . . . . . erase phone-script. . . . . . erase startup-config . . . . . exit . . . . . . . . . . . . . . fragment chain . . . . . . . . fragment size. . . . . . . . . fragment timeout. . . . . . . hostname . . . . . . . . . . . icmp . . . . . . . . . . . . . icmp in-echo-limit . . . . . . incoming-routing . . . . . . interface Console . . . . . . ip icmp . . . . . . . . . . . . ip icmp redirect . . . . . . . ip icmp-errors . . . . . . . . ip license-server . . . . . . . ip snmp-server . . . . . . . . ip ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 254 255 256 257 258 259 260 260 261 262 263 264 265 265 266 267 269 270 270 271 271 273 274 274 275 275 276 276 277 278 279 280 281 282 283 283 284 284 285 286 Contents ip telnet . . . . . . . . . . . . . . . . . . . ip telnet-client . . . . . . . . . . . . . . . ip tftp-server . . . . . . . . . . . . . . . . ip tftp-server file-system size . . . . . . . key config-key password-encryption. . . line . . . . . . . . . . . . . . . . . . . . . login authentication . . . . . . . . . . . . login authentication local-craft-password login authentication response-time . . . login authentication services-login. . . . nvram initialize . . . . . . . . . . . . . . . ping . . . . . . . . . . . . . . . . . . . . . release voip-dsp . . . . . . . . . . . . . . remove nfas-interface . . . . . . . . . . . remove port . . . . . . . . . . . . . . . . rename announcement-file . . . . . . . . reset . . . . . . . . . . . . . . . . . . . . retstatus . . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . rtp-stat threshold . . . . . . . . . . . . . rtp-test-port . . . . . . . . . . . . . . . . sat. . . . . . . . . . . . . . . . . . . . . . scheduler . . . . . . . . . . . . . . . . . . session . . . . . . . . . . . . . . . . . . . set associated-signaling . . . . . . . . . set bearer-capability . . . . . . . . . . . . set bit-rate . . . . . . . . . . . . . . . . . set boot bank. . . . . . . . . . . . . . . . set channel-numbering . . . . . . . . . . set channel-preference . . . . . . . . . . set codeset-display . . . . . . . . . . . . set codeset-national . . . . . . . . . . . . set connect . . . . . . . . . . . . . . . . . set cor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 287 288 288 289 290 291 292 292 293 294 295 296 296 297 298 299 300 300 301 301 303 304 305 306 306 307 309 310 311 312 313 313 314 315 316 317 317 318 319 320 Issue 1 February 2007 11 Contents set country-protocol . . . . . . . . . set date-format . . . . . . . . . . . . set delete-digits . . . . . . . . . . . set delete-digits . . . . . . . . . . . set deny . . . . . . . . . . . . . . . set dial . . . . . . . . . . . . . . . . set digits . . . . . . . . . . . . . . . set digit-handling . . . . . . . . . . set digit-treatment . . . . . . . . . . set directory-number-a . . . . . . . set directory-number-b . . . . . . . set endpoint-init . . . . . . . . . . . set expansion-module . . . . . . . . set etr . . . . . . . . . . . . . . . . . set fac. . . . . . . . . . . . . . . . . set incoming-dialtone . . . . . . . . set incoming-destination . . . . . . set insert-digits (dial-pattern) . . . . set insert-digits (incoming-routing) set interface . . . . . . . . . . . . . set interface-companding . . . . . . set ip-codec-set . . . . . . . . . . . set japan-disconnect . . . . . . . . set layer1-stable . . . . . . . . . . . set length . . . . . . . . . . . . . . . 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 . . . . . . . . . set logout. . . . . . . . . . . . . . . set long-timer . . . . . . . . . . . . set match-pattern . . . . . . . . . . set max-ip-registrations . . . . . . . set max-length . . . . . . . . . . . . set mediaserver . . . . . . . . . . . set mgc list . . . . . . . . . . . . . . set min-length . . . . . . . . . . . . set name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322 323 324 325 326 326 327 328 328 329 330 331 331 332 333 334 335 337 338 339 340 341 342 342 343 343 345 345 346 348 349 350 351 352 352 353 354 355 356 357 357 Contents set numbering-format . . . . . . . . . . set password . . . . . . . . . . . . . . . set pim-lockout . . . . . . . . . . . . . set port . . . . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . set signaling-mode . . . . . . . . . . . set slot-config . . . . . . . . . . . . . . set snmp community . . . . . . . . . . set snmp retries . . . . . . . . . . . . . set spid-a . . . . . . . . . . . . . . . . . set spid-b . . . . . . . . . . . . . . . . . set supervision. . . . . . . . . . . . . . set survivable-call-engine . . . . . . . . set swhook-flash. . . . . . . . . . . . . set sync interface . . . . . . . . . . . . set sync source . . . . . . . . . . . . . set sync switching . . . . . . . . . . . . set system contact. . . . . . . . . . . . set system location . . . . . . . . . . . set system name . . . . . . . . . . . . . set tac. . . . . . . . . . . . . . . . . . . set tei-assignment . . . . . . . . . . . . set terminal recovery password . . . . set tgnum. . . . . . . . . . . . . . . . . set trunk-destination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359 360 360 361 362 362 364 365 365 367 368 369 370 370 371 372 372 373 374 375 376 377 378 379 380 380 381 382 383 383 384 385 386 387 388 389 390 391 392 392 393 Issue 1 February 2007 13 Contents set trunk-hunt . . . . . . . . . . . . . . . . set trunk-group-chan-select . . . . . . . . set type (station) . . . . . . . . . . . . . . . set type (dial-pattern) . . . . . . . . . . . . set utilization cpu . . . . . . . . . . . . . . show . . . . . . . . . . . . . . . . . . . . . show announcements files . . . . . . . . . show application-memory. . . . . . . . . . show auth-file info . . . . . . . . . . . . . . show backup status . . . . . . . . . . . . . show banner login . . . . . . . . . . . . . . show banner post-login . . . . . . . . . . . show bri . . . . . . . . . . . . . . . . . . . show boot bank . . . . . . . . . . . . . . . show cna testplug . . . . . . . . . . . . . . show copy status . . . . . . . . . . . . . . show csu loopbacks. . . . . . . . . . . . . show csu status . . . . . . . . . . . . . . . show date-format . . . . . . . . . . . . . . show dev log file . . . . . . . . . . . . . . . show dial-pattern . . . . . . . . . . . . . . show download announcement-file status show download auth-file status . . . . . . show download phone-image-file status. . show download phone-script-file status . . show download software status . . . . . . show download status . . . . . . . . . . . show ds1 . . . . . . . . . . . . . . . . . . . show dynamic-cac . . . . . . . . . . . . . . show erase status . . . . . . . . . . . . . . show etr . . . . . . . . . . . . . . . . . . . show extension . . . . . . . . . . . . . . . show fac . . . . . . . . . . . . . . . . . . . show faults . . . . . . . . . . . . . . . . . . show fragment . . . . . . . . . . . . . . . . show image version . . . . . . . . . . . . . show interfaces . . . . . . . . . . . . . . . show incoming-routing . . . . . . . . . . . show ip-codec-set . . . . . . . . . . . . . . show ip icmp . . . . . . . . . . . . . . . . . show ip interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394 395 395 396 398 399 406 407 408 408 409 410 410 411 412 414 415 416 417 418 418 419 420 421 422 423 424 424 425 426 426 427 428 429 430 430 431 434 435 435 436 Contents show ip interface brief. . . . . . show ip ssh . . . . . . . . . . . show ip tftp-server files . . . . . show ip tftp-server statistics . . show ip traffic . . . . . . . . . . show isdn bri link . . . . . . . . show isdn link summary . . . . show isdn pri link . . . . . . . . show last-pim-update . . . . . . show logging file condition . . . show logging file content . . . . show logging server condition . show logging session condition show login authentication. . . . show logout . . . . . . . . . . . show max-ip-registrations . . . show mediaserver . . . . . . . . show mg list_config . . . . . . . show mgc . . . . . . . . . . . . show mgc list . . . . . . . . . . show mm . . . . . . . . . . . . . show module . . . . . . . . . . . show pim-lockout . . . . . . . . show port classification . . . . . show protocol . . . . . . . . . . show qos-rtcp . . . . . . . . . . show radius authentication . . . show recovery . . . . . . . . . . show restart-log . . . . . . . . . show restore status . . . . . . . show rtp-stat config . . . . . . . show rtp-stat detailed . . . . . . show rtp-stat sessions . . . . . show rtp-stat summary . . . . . show rtp-stat thresholds . . . . show rtp-stat traceroute. . . . . show running-config . . . . . . show sig-group . . . . . . . . . show slot-config . . . . . . . . . show snmp . . . . . . . . . . . . show snmp engineID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438 439 440 441 442 444 444 445 446 446 447 448 449 450 450 451 451 452 453 454 455 456 457 458 459 460 461 462 462 463 464 465 466 468 469 470 472 473 474 474 475 Issue 1 February 2007 15 Contents show snmp group . . . . . . . . . . . . show snmp user . . . . . . . . . . . . . show snmp usertogroup . . . . . . . . show snmp view . . . . . . . . . . . . . show startup-config . . . . . . . . . . . show status . . . . . . . . . . . . . . . show station . . . . . . . . . . . . . . . show survivable-call-engine . . . . . . show sync timing . . . . . . . . . . . . show system . . . . . . . . . . . . . . . show tcp syn-cookies . . . . . . . . . . show timeout. . . . . . . . . . . . . . . show trunk-group . . . . . . . . . . . . show upload announcement-file status show upload auth-file status . . . . . . show upload cdr-file status . . . . . . . show upload phone-script-file status . show upload status . . . . . . . . . . . show upload syslog-file status . . . . . show username . . . . . . . . . . . . . show utilization . . . . . . . . . . . . . show voip-parameters. . . . . . . . . . shutdown (CNA test plugs) . . . . . . . sig-group . . . . . . . . . . . . . . . . . snmp-server community . . . . . . . . snmp-server dynamic-trap-manager . . snmp-server enable notifications. . . . snmp-server engineID . . . . . . . . . . snmp-server group . . . . . . . . . . . snmp-server host . . . . . . . . . . . . snmp-server informs . . . . . . . . . . snmp-server remote-user . . . . . . . . snmp-server user . . . . . . . . . . . . snmp-server view . . . . . . . . . . . . station . . . . . . . . . . . . . . . . . . survivable-call-engine . . . . . . . . . . tcp syn-cookies . . . . . . . . . . . . . tech . . . . . . . . . . . . . . . . . . . . telnet . . . . . . . . . . . . . . . . . . . terminal length . . . . . . . . . . . . . . terminal width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 477 478 479 479 480 482 483 484 484 485 487 488 490 491 492 493 494 494 495 496 497 498 498 499 500 501 501 502 504 507 508 509 511 512 513 514 515 516 516 517 Contents test led . . . . test voip-dsp . test-rate-limit . traceroute . . tree . . . . . . trunk-group. . username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518 518 519 520 522 523 526 Appendix A: Traps and MIBs . . . . . . . . . . . . . . . . . . . . . . . . 529 TGM550 Telephony Gateway Module traps . . . . . . . . . . . . . . . . . . . . . 529 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 . . . . . . . . . . . . . . . . . . . . . . . 539 540 541 542 543 544 547 547 548 549 554 Appendix B: Configuring the router’s modem interface for remote dial-in and dial backup . . . . . . . . . . . . . . . . . . . 555 USB Modem Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 555 Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556 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 . . . . . . . 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 557 557 557 560 562 564 565 565 566 567 568 570 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Issue 1 February 2007 17 Contents 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 . . . . . . . . . . . . . . . . . . . . . . . . . . 571 571 572 574 576 577 577 579 Configuring a personal computer for remote dial access through the router’s modem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 IG550 Integrated Gateway Administration and CLI Reference 589 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 J4350/J6350 Services Router or through the TGM550 console port) ● J4350/J6350 Services Router IP interface ● 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 4350 and 6350 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 1 February 2007 19 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 24. 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 203. 20 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 how to access PIM, see Accessing PIM on page 27. For instructions on configuring SLS, see Chapter 4: Configuring Standard Local Survivability (SLS) on page 49. 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. Use the copy running-config startup-config command 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 46. Issue 1 February 2007 21 Configuration overview 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 type the command 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 44. 22 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 574 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 router’s modem on page 580 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 1 February 2007 23 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 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 28. Note: Note: Disconnect a telnet session by typing +]. This is particularly useful if the normal telnet logout does not work. 24 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, type help ip, ip help, ? ip, or ip ?. If you type help or ? before or after a full command, the CLI displays the command’s syntax and parameters, and an example of the command. You must be in the command’s context in order to use the help command to display information about the command. In the following example, the user enters the context of the Vlan 1 interface 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 port (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. Issue 1 February 2007 25 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: Note: You can disconnect a telnet session by typing +]. This is particularly useful if the normal telnet logout does not work. 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 23). 2. At the Unix command line, type ssh , where is the ip address of the TGM550, and press Enter. Note: 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. 3. At the login prompt, type the user name and press Enter. 4. At the password prompt, type the password and press Enter. You are now logged-in. Note: Note: You can disconnect a telnet session by typing +]. 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 28. 26 IG550 Integrated Gateway Administration and CLI Reference Accessing PIM Accessing PIM The Provisioning and Installation Manager (PIM) provides the capability 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 PIM’s primary functions is to provision and configure Standard Local Survivability (SLS) on the TGM550. See Chapter 4: Configuring Standard Local Survivability (SLS) on page 49. 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 media server. There might be several media servers on your network that can control the TGM550 Telephony Gateway Module. Access Avaya Communication Manager on any media server that is a Media Gateway Controller (MGC) for the TGM550 Telephony Gateway Module. For more information, see Configuring the Media Server on page 37. 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 41. Issue 1 February 2007 27 Accessing the TGM550 Telephony Gateway Module and the J-Series Router 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 and username and a password. Each user is assigned a privilege level. The user’s 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. 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 24. ● When you connect a modem with dialup PPP. For more information, see Accessing the CLI via modem on page 26. 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. 28 IG550 Integrated Gateway Administration and CLI Reference Managing login permissions 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 203. 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. When you create a new user, you must define the user’s 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 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. Issue 1 February 2007 29 Accessing the TGM550 Telephony Gateway Module and the J-Series Router 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, use the show ip ssh command. SSH Configuration Use the ip ssh command to enable SSH authentication. Use the no form of this command to disable the SSH server which disconnects all active SSH sessions. By default, SSH is enabled. Use the crypto key generate dsa command to generate an SSH host key pair. Use the show ip ssh command to display SSH configuration information and information about any active SSH sessions. Use the disconnect ssh command to disconnect an existing SSH session. 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 29, 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 user name and password. With a Windows-based SSH server (WinSSHD), the user name 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 Use the clear ssh-client known-hosts command to clear the client’s list of SCP server fingerprints. Each SCP client maintains a list of server fingerprints. If a key changes, the client’s verification of the server’s fingerprint will fail, thereby preventing the client’s access to the SCP server. If this happens, you can use the clear ssh-client known-hosts command to erase the client’s server fingerprint list. This enables the client to access the server and begin to recreate its list of fingerprints with the SCP server’s new fingerprint. 30 IG550 Integrated Gateway Administration and CLI Reference Managing login permissions 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 web site at http://www.avaya.com/support, and perform a search for the document Avaya G700/ G350 RADIUS Configuration Overview. 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 with the following commands: Configuring RADIUS authentication 1. Use the set radius authentication enable command 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. For more information about these commands, see Chapter 13: CLI Commands on page 203 Issue 1 February 2007 31 Accessing the TGM550 Telephony Gateway Module and the J-Series Router 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 Use the set radius authentication disable command to disable RADIUS authentication on the TGM550 Telephony Gateway Module. Displaying RADIUS parameters Use the show radius authentication command. Shared secrets are not displayed. Special security features There are special security features that allow enabling and disabling of the recovery password, establishing of incoming and outgoing telnet connections, copying gateway configurations while keeping configuration secrets, and configuring of the SYN cookies for preventing SYN attacks. 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. 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. 32 IG550 Integrated Gateway Administration and CLI Reference Special security features Enabling and disabling telnet access You can enable and disable the TGM550 Telephony Gateway Module’s 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 Module’s ability to establish an incoming telnet connection. ● Use the ip telnet-client command 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 Module’s ability to establish an outgoing telnet connection. 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 generate an identical MCK (by using the same passphrase) in the target device before executing the copy operation. Note: Note: All gateways have the same default MCK. For security reasons, it is recommended to configure a new MCK immediately upon gateway installation. Configuring the Master Configuration Key 1. Type the key config-key password-encryption command, 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. Issue 1 February 2007 33 Accessing the TGM550 Telephony Gateway Module and the J-Series Router 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 retry. 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. SYN cookies SYN cookies protect against SYN attacks by employing the following strategies: ● Not maintaining any state at all 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 is instead 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. 34 IG550 Integrated Gateway Administration and CLI Reference Special security features ● 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 fooled into thinking all TCP ports are open. Configuring SYN cookies 1. Type the tcp syn-cookies command. 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 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. Maintaining SYN cookies Use the following commands to show and clear SYN cookies statistics: ● Use the show tcp syn-cookies command to show SYN cookies statistics. Note: For an example and explanation of SYN cookies statistics, see Chapter 13: CLI Commands on page 203. Note: ● Use the clear tcp syn-cookies counters command to clear the SYN cookies counters. Issue 1 February 2007 35 Accessing the TGM550 Telephony Gateway Module and the J-Series Router 36 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 host names 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 Media Server You can use a media 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 media server, you need the TGM550 Telephony Gateway Module’s serial number. You can find this serial number in one 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 1: Media servers supported by the TGM550 Telephony Gateway Module Media server Avaya S8300 Media Server Avaya S8400 Media Server Avaya S8500 Media Server Avaya S8700 Media Server Avaya S8710 Media Server Avaya S8720 Media Server Issue 1 February 2007 37 Basic device configuration Survivability and migration options Several options exist to minimize network disruption in the event that connectivity between the TGM550 Telephony Gateway Module and the media server or media gateway controller (MGC) is lost. ● Note: When SLS is enabled, the MGC list includes the SLS module as a fifth entry in the MGC list. For details about SLS, see Chapter 4: Configuring Standard Local Survivability (SLS) on page 49. Note: Note: 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 39. ● 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 27). Alternatively, it can be configured on an individual TGM550 Telephony Gateway Module using the CLI. For more information and instructions on configuring SLS, see Chapter 4: Configuring Standard Local Survivability (SLS) on page 49. ● Enhanced Local Survivability (ELS). ELS is available for both 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 MSG. By migrating the TGM550 Telephony Gateway Module to the MGC automatically, a fragmented network can be made whole more quickly, 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. 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. 38 IG550 Integrated Gateway Administration and CLI Reference Configuring the Media Server ● 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 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 Module’s MGC, and show the current MGC list used to determine the results. Setting the TGM550 Telephony Gateway Module’s MGC Use the set mgc list command to set the TGM550 Telephony Gateway Module’s 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 other MGCs on the list. Note: Note: If the MGC is an S8700, S8710, or S8720, the first server on the list will normally be the primary C-LAN board connected to the media 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 media 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 alternate C-LAN boards connected to the media server (S8400, S8500, or S8700-series media servers), an S8300 configured as an LSP, or the port enabled as the Ethernet processor port on an S8500 configured as an LSP. Issue 1 February 2007 39 Basic device configuration 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 Module’s 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. 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, use the clear mgc list command with no arguments. To change the TGM550 Telephony Gateway Module’s MGC list: 1. Use the clear mgc list command with no arguments to clear the MGC list. 2. Use the set mgc list command with a different set of IP addresses. Note: 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. 40 IG550 Integrated Gateway Administration and CLI Reference Configuring the Media Server When SLS is enabled, the MGC list includes the SLS module as a fifth entry on the MGC list. For details about SLS, see Chapter 4: Configuring Standard Local Survivability (SLS) on page 49. 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 time-out for the TGM550 Telephony Gateway Module’s search for the primary MGC and the other MGC’s 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 1 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 loss of connection 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. Use the show recovery command to show the status of MGC and ICC monitoring and recovery setup. Accessing the registered MGC To access the TGM550’s registered MGC through the Juniper J-series Service Router: 1. Enter session chassis. 2. At the prompt, log in to the router. Issue 1 February 2007 41 Basic device configuration 3. Enter one of the following: To open a connection to the MGC’s LINUX operating system, enter: root@acme% ssh "session mgc" To open a connection directly to the Avaya Communication Manager System Access Terminal (SAT) application in the MGC, enter: root@acme% ssh "session mgc sat" where is the IP address of the mgc. Viewing the status of the device To view the status of the TGM550 Telephony Gateway Module, use the following commands. For more information about these commands, see Chapter 13: CLI Commands on page 203. ● Use the show faults command to view information about currently active faults. ● Use the show mgc command to view information about the Media Gateway Controller with which the TGM550 Telephony Gateway Module is registered. For more information, see Configuring the Media Server on page 37. ● 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 42 IG550 Integrated Gateway Administration and CLI Reference Software and Firmware Management ● Use the show module command or the show mg list command 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 ● Use the show system command to display the serial number of the TGM550 Telephony Gateway Module, the TGM550 Telephony Gateway Module’s uptime, the firmware version number, MAC addresses, and other system information. ● Use the show restart-log command to view information about the last time that the TGM550 Telephony Gateway Module was reset. ● 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: ● Use the test led command to test the system ALM LED on the front panel of the TGM550 Telephony Gateway Module. The LED blinks for five seconds. Software and Firmware Management You can manage TGM550 Telephony Gateway Module software and firmware, either: ● Remotely, using an FTP, TFTP or SCP server Or ● Locally, using a USB mass storage device connected to the TGM550 Telephony Gateway Module USB port Issue 1 February 2007 43 Basic device configuration 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: 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. 44 IG550 Integrated Gateway Administration and CLI Reference Software and Firmware Management 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, type 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. 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 the 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 module command, followed by the module number of the module you want to upgrade, to upgrade the firmware on a media module from a TFTP 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. Issue 1 February 2007 45 Basic device configuration 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: Note: copy tftp tgm550.net 192.1.1.10 2 Note: 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. Note: 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 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 21. 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 33. 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. 46 IG550 Integrated Gateway Administration and CLI Reference Software and Firmware Management ● 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. ● 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 an FTP server. ● Use the copy startup-config ftp command to back up the startup configuration on the TGM550 Telephony Gateway Module to an FTP server. ● 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 TFTP server. 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. Issue 1 February 2007 47 Basic device configuration 48 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 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 62. 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 ● Contact closure feature ● 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 1 February 2007 49 Configuring Standard Local Survivability (SLS) Avaya phones supported in SLS Table 2: Avaya phones supported in SLS Analog IP 2500 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: Model name CLI interface name 9610 4606 9620 4610 9630 4620 9640 4620 9650 4620 50 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) but only the general trunk-identifying information. Emergency personnel will have a general location associated with the trunk (for example, a building address), but nothing more specific like the room or office number. Also, if a 911 call disconnects for any reason, emergency personnel cannot reliably call the originator back. A small business office’s address is sufficient from the perspective of emergency routing. ● Communication Manager Feature Access Codes for ARS, Contact Closure, 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 61) ● 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 64kbps transmission - E1 CAS: all 31 channels serve as trunks with full 64kbps transmission ● Centrex features Issue 1 February 2007 51 Configuring Standard Local Survivability (SLS) Call processing not supported by SLS ● Many small business customers employ custom calling features like 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 ● 3-party conferences ● Last Number Redial ● Call Forwarding-Busy/Don’t 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 dialplan routing administration data through SNMP. Alternatively, the provisioning may be entered manually via an SNMP MIB browser or via the local gateway’s CLI interface. These data sources and communication links are described in Figure 1. 52 IG550 Integrated Gateway Administration and CLI Reference Figure 1: Standard Local Survivability data sources and communication paths H.248 Control Link 1 Communication Manager 2 IP 3 H.248 Control Channel CCMS Channel MGM Channel Gateway CLI 6 5 4 Communication Manager Translations Provisioning and Installation Manager (PIM) cydscomm LAO 071106 7 Figure notes: 1. H.248 call signalling 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 63 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, then the data set in NVRAM remains unchanged. Issue 1 February 2007 53 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 67. 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 62. Entering SLS mode When SLS is enabled, the MGC list displays a fifth element called survivable-call-engine. 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 then searches the alternate MGC list (entries below the Transition Point), ending with survivable-call-engine, the last choice for the TGM550 Telephony Gateway Module. When the Link Recovery search settles on the survivable-call-engine 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 endpoint’s E.164 addresses and passwords), dial plan, and ARS routing. 3. Registration with the media gateway. 4. Creates the H.323 GateKeeper socket after successful registration. When Setup is complete, SLS transitions to the Registered state. 54 IG550 Integrated Gateway Administration and CLI Reference Registered state SLS can only process calls while it is in the Registered state in which it: 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 TGM550 Telephony Gateway Module administrator uses the set survivable-call-engine disable command from the TGM550 CLI or manual MIB browser using the SNMP read/write attribute avSurvAdminState. -or- ● 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 The SLS interacts differently with the various TGM550 Telephony Gateway Module features. Issue 1 February 2007 55 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 that reason, CPE (Customer Premise Equipment) utilizing DID trunk lines for inbound routing would utilize loop-start (for example) lines for outbound transmission. ● Wink - the DID signaling starts after the phone reverses battery polarity and sends the “wink” to the central office. An analog 2-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 phone system. With a standard loop-start line the power is supplied by the central office, and this is why damage can occur from connecting a loop-start PSTN trunk to the DID port. WARNING: 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: Note: ● 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. For example, if 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. 56 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 winking 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 sends the hold message to the server ● Flash button sends switchhook signal to the server ● Switchhook (receiver on/off hook) sends disconnect signal to the server Using the Hold button 1. Press the Hold button on the analog phone. 2. To return to the call, press the Hold button. Using the Flash button 1. Press the Flash button on the analog phone. You will hear a dial tone; the other party hears silence. 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 for Hold. At this point you can leave the call on Hold or transfer the call. Issue 1 February 2007 57 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 will hear dial tone. 2. Dial the Feature Access Code (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. You can do any of the following: ● Return to the call by dialing the FAC for Hold. The call is re-established. ● 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. ● 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 once each time you want to change calls. 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. ● Requires that the established call is 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) 58 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 will hear a dial tone; the other party hears silence. 2. Dial the third party’s number on your phone. 3. You can either: ● Wait for the third party to answer and announce the call and 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 was completed. Note: 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. 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 will hear a dial tone; the other party will hear silence. 2. Dial the third party’s 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 was completed. If the necessary call processing resources are not available, the transfer does not complete and the event is logged. Note: Note: Displays are not supported on analog phones unless they are supported locally by an analog phone. Issue 1 February 2007 59 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 41. 2. At the SAT, interface, type change station extension and press Enter 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. ● 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 3. Table 3: Emergency Transfer trunk-to-port latching Model Analog loop start trunks Analog station ports J4350/J6350 TGM550, port 2 TGM550, port 3 60 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 and 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 Issue 1 February 2007 61 Configuring Standard Local Survivability (SLS) An interpretation of the first entry in Figure 2 is: ● Date (02/18/2005) of log entry ● Time (10:46:35) of log entry ● CDR-Informational is the category (to aid sorting) ● 10:46 is the time that the call was placed ● 00:00 is the duration of the call in minutes and seconds or 99:99 if the duration is greater than 99 minutes. ● A is the condition code. Possible values are: - 7. Outgoing call - 9. Incoming call - A. Outgoing TAC call or emergency call - B. Used for contact closure ● 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 installed when the TGM550 Telephony Gateway Module is installed. However, for SLS to actually work, 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 63. ● Provisioning data from the PIM tool must be gathered from Avaya Communication Manager and delivered to the TGM550 Telephony Gateway Module using PIM. See Using PIM to manage SLS administration on the gateway on page 67 for instructions on gathering and delivering the provisioning data. 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 73. ● SLS must be enabled on the TGM550 Telephony Gateway Module. See Enabling and disabling SLS on page 73. 62 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 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 41. 2. At the SAT, type change node-names ip and press Enter to display the IP Node Names form. 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: Note: Set the name of the media gateway consistent with the Name field on the Media Gateway administration form in Communication Manager (add media-gateway) and with the name used in the set system name command (gateway CLI). 4. Type the IP address of the gateway in the IP Address field. 5. Submit the form. Issue 1 February 2007 63 Configuring Standard Local Survivability (SLS) 6. At the SAT, type change system-parameters mg-recovery-rule 1 and press Enter to display the System Parameters Media Gateway Automatic Recovery Rule form. 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: Note: This field value (immediately) is only one of the four (4) 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. 10. At the SAT, type change media-gateway 1 and press Enter to display the Media Gateway form. change media-gateway 1 Page 1 of 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 Module Type TGM550 TIM514 TIM510 TIM521 Registered: y FW Version/HW Vintage: 21.13.0 /0 IP Address: 135.9.41.150 Controller IP Address: 135.9.41.146 MAC Address: Site Data: Name ANA MM ANA MM DS1 MM BRI MM DSP Type FW/HW Version DAR1 1 0 Max Survivable IP Ext: 8 V9: 64 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS ● Name field (20 characters maximum) must match the administered name of the gateway (see Configuring the SLS data through the CLI on page 86, Step 2). ● Max Survivable IP Ext field only appears when the Type field is J4350 or J6350. The current maximum product limit enforced by the SLS gateway’s 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. 11. At the SAT, type change station extension and press Enter to display the Station form. change station 8003 Page 1 of 4 STATION Extension: 8003 Type: 4620 Port: IP Name: STATION OPTIONS Loss Group: 19 Speakerphone: 2-way Display Language? English Survivable GK Node Name: Survivable COR: internal Survivable Trunk Dest? y Lock Messages? n Security Code: Coverage Path 1: Coverage Path 2: Hunt-to Station: Personalized Ringing Pattern: Message Lamp Ext: Mute button enabled? Expansion Module? BCC: TN: COR: COS: 1 1 1 1 1 8003 y n Media Complex Ext: IP SoftPhone? N ● 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. Issue 1 February 2007 65 Configuring Standard Local Survivability (SLS) - 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. Note: This field is only for analog and IP station types. Note: 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: SLS / ARS page on page 68). ETR functionality and calls through the CO are permitted in this class. 3. Local: users can only dial these call types: ● locl (public-network local number call) ● op (operator) ● svc (service) ● hnpa (7-digit NANP call) 2. Toll: users can only dial these call types: ● fnpa (10-digit NANP call) ● natl (non-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. 66 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Survivable Trunk Dest? – enables stations to receive/not receive incoming trunk calls in survivable mode (default is yes). 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. ● 12. Submit the form. 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 PIM’s 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 73. PIM must be installed on and launched from the Avaya Network Management Console. For information about PIM, see Accessing PIM on page 27. 1. Ensure that the Network Management Console (NMC) has discovered the media gateway. 2. Before PIM’s automatic scheduled SLS updates will work as expected, set the device parameters for both the server and the gateway in the NMC: ● Note: Server: Communication Manager login and password Note: The server must be the first listing in NMC’s discovery output. If an ESS node is discovered and listed prior to the main server, the main server’s login/password will not permit access to the ESS node. ● Gateway: SNMPv1/v3 access parameters ● Gateway: NMC has discovered the gateway’s IP address 3. Verify that the Communication Manager has been configured for SLS as described in Configuring Communication Manager for SLS on page 63. 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. Issue 1 February 2007 67 Configuring Standard Local Survivability (SLS) 7. Proceed through the Device Profile Wizard to the SLS / ARS page (Figure 4: SLS / ARS page on page 68) and perform the following: a. Check the Enable the SLS feature on this device? box to enable SLS on the TGM550 Telephony Gateway Module. A cleared box means that SLS is disabled. b. Check the Perform scheduled SLS updates on this device? box to send the SLS administration data set to the gateway according to the settings on the SLS Update Schedule form (Figure 6: SLS Update Schedule page on page 71). Figure 4: SLS / ARS page ● 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: SLS ARS Entry page on page 69). - 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. 8. If this gateway has not been previously provisioned, click Add ARS Entry to open the ARS Entry page (Figure 5: SLS ARS Entry page on page 69). 68 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Figure 5: SLS ARS Entry page 9. Use the SLS ARS Entry page (Figure 5) to administer an Automatic Route Selection in SLS. Refer to (Table 4). Table 4: SLS ARS Entry page field options Field Description Dialed String Maximum 18 characters: only 0-9, '*' and 'X' or 'x' as a pre-string or mid-string replacement. 'X' cannot be at the end of a dialed string. Min Length 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. Max Length 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. Number of Deleted Digits The number of dialed digits to be deleted from the beginning of the dialed string. Default: 0. Inserted Digits The digit string to be inserted at the beginning of the dialed string. Default: 0. 1 of 2 Issue 1 February 2007 69 Configuring Standard Local Survivability (SLS) Table 4: SLS ARS Entry page field options (continued) Field Description Call Type Can be any 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 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. Permit / Deny 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: SLS / ARS page on page 68). ! Important: Important: SLS permits 911 calls, but the specific location information is not transmitted to the Public Service Answering Point (PSAP) but only the general trunk-identifying information. Emergency personnel will have a general location associated with the trunk (for example, a building address), but nothing more specific like the room or office number. Also, if a 911 call disconnects for any reason, emergency personnel cannot reliably call the originator back. 70 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 10. Use the SLS Update Schedule page (Figure 6) to administer up to six (6) SLS updates per day. Figure 6: SLS Update Schedule page a. Check the Enable SLS Updates box. b. Set as many as six (6) Daily Updates. Note: Note: The Daily Updates must be at least 4 hours apart. c. Click Submit. 11. Use the Backup/Restore page (Figure 7) to backup the PIM database backup schedule. Issue 1 February 2007 71 Configuring Standard Local Survivability (SLS) Figure 7: Backup/Restore page (PIM) Note: Note: Note: Step 11 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. 72 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Enabling and disabling SLS To enable SLS on the TGM550 Telephony Gateway Module, type the set survivable-call-engine enable command. The TGM550 Telephony Gateway Module responds with “Survivable Call Engine is enabled.” To disable SLS on the TGM550 Telephony Gateway Module, type the set survivable-call-engine disable command. The TGM550 Telephony Gateway Module responds with “Survivable Call Engine is disabled.” 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 ● Communication Manager Release 3.0 or later running on the host server ● PIM or configuration of the TGM550 Telephony Gateway Module through its CLI ● Registration of the TGM550 Telephony Gateway Module with Avaya Communication Manager ● SLS 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. Issue 1 February 2007 73 Configuring Standard Local Survivability (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 gateway’s 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: Gateway model IP stations J4350/J6350* † 100 Analog stations DCP stations Analog trunks BRI trunks DS1 trunks Maximum 120 trunks * 100 stations maximum (all types) † 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 41. Collecting analog stations data 1. At the SAT, type list media-gateway and press Enter to display a list of administered gateways. 2. Look for supported gateways in the Type field. 3. Once you know the media gateway of interest, match the gateway model with the analog station ports: Gateway model Media module (if applicable) Slot configuration J4350/J6350 TGM550 TIM514 Any of the six slots 74 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 4. At the SAT, type display port port-number, where port-number is the analog station port on the gateway, and press Enter. The system displays the extension number assigned to the port. 5. Once you know the extension, type display station extension and press Enter to display the Station form for this extension. 6. Gather the necessary information from Table 5. Table 5: Analog station form data to assemble for SLS Page* Field Name 1 Extension 1 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". 1 Type Only 2500 is the accepted type. 1 Survivable COR Class of Restriction while in SLS mode 1 Survivable Trunk Dest Trunk destination while in SLS mode 2 Switchhook Flash This field appears when Type is 2500. 1 Name This is the user’s name Notes * Page numbers might vary for your system. Collecting IP stations data 1. At the SAT, type list media-gateway and press Enter to display a list of administered gateways. 2. Look for supported gateways in the Type field. 3. Type display media-gateway and press Enter and read the reported IP address for this gateway. 4. Type list node-name ip 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 ip 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 5. 5. Type list station type type, where the type is any 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. Issue 1 February 2007 75 Configuring Standard Local Survivability (SLS) 6. 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 6. Table 6: IP station form data to assemble for SLS Page* Field Name 1 Extension 1 Port Should just be specified as slot = 0 and port = ff. 1 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. 1 Type 4601 4602 4602SW 4606 4610SWf 4612 4620 4620Sw 4621 4622 4624 4625 1 Survivable COR Class of Restriction while in SLS mode 1 Survivable Trunk Dest Trunk destination while in SLS mode 1 Expansion Module Determines if optional CA module is connected to this phone model 1 Name This is the user’s name Notes * Page numbers might vary for your system. Collecting trunk groups data 1. At the SAT, type list media-gateway and press Enter to display a list of administered gateways. 2. Look for supported gateways in the Type field. 3. Identify the analog loop-start trunk ports (same slot, but different port numbers on various models). 4. Identify the analog DID trunk ports (same slot, but different port numbers on various models) Refer to Table 22. 76 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 5. Identify the BRI trunk ports. Refer to Table 22. 6. Identify the digital DS1 trunk ports. Refer to Table 22. 7. Identify the modules and check for provisioned trunk ports. 8. At the SAT, type display port portid, where the portid is the analog 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 7. Table 7: Trunk group data to assemble for SLS Page* Field Name Notes 1 Group Type This field specifies the type of trunks associated with this trunk group. 1 Outgoing Dial Type 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 Trunk Group Number This value is used in the routing table. 1 TAC This value is only necessary if the Dial Access? field is set to y. If that field is set to n, this the TAC value is not pushed down to the media gateway. 4 Port There may be more than one port within a trunk group definition that pertains to a given media gateway. 1 Digit Treatment This only applies for DID analog trunks or for DS1 tie trunks. Note that this does not apply to DS1 PRI tie trunks. 1 Digits This field only has value when the Digit Treatment field is set to insert1, insert2, insert3, or insert4. 1 of 3 Issue 1 February 2007 77 Configuring Standard Local Survivability (SLS) Table 7: Trunk group data to assemble for SLS (continued) Page* Field Name Notes 1 Trunk Type Depends on trunk signaling type: Analog DID trunks Loop-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 1 Group Name Customer identification of trunk group 1 Codeset to Send Display Describes which Q.931 code-sets are allowed to send Display IEs 1 Codeset to Send National IEs Describes which Q.931 code-sets are allowed to send National supported IEs 2 Outgoing Channel ID Encoding Used for encoding Channel ID IE 1 Digit Handling (in/out) Defines overlap receiving and transmitting rules. 2 Network (Japan) Needs Connect Before Disconnect Send a CONNECT message before sending a DISCONNECT message if enabled. 2 Send Name Specifies whether name is to be shared with network 2 Send Calling Number Specifies whether number is to be shared with network 2 of 3 78 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Table 7: Trunk group data to assemble for SLS (continued) Page* Field Name Notes 2 Incoming Calling Number - Format Specifies how to fill the Calling Party Number and Called Party Number IEs 1 Incoming Destination Sets a destination station for routing incoming trunk group calls 1 Trunk Hunt Determines the method in which the survivable-call-engine selects an available trunk from the trunk group pool. 6 Sig Grp Specifies the Signaling Group Number that is the manager of this ISDN trunk member. 3 of 3 * Page numbers might vary for your system. Collecting DS1 trunks data 1. At the SAT, type display ds1 location and press Enter to display the DS1 administration for a particular circuit pack location. 2. Gather DS1 information according to Table 8 for each DS1 facility. Table 8: DS1 circuit pack data to assemble for SLS Page* Field Name Notes 1 Name Descriptive name often of the Service Provider or destination of the DS1 facility 1 Bit-Rate Selects the maximum transmission rate of the DS1 facility 1 Signaling Mode Selects the signaling method deployed on the given DS1 facility 1 Channel Numbering 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 1 Connect Specifies what is connected at the far-end of the DS1 facility 1 Interface Determines glare handling 1 of 2 Issue 1 February 2007 79 Configuring Standard Local Survivability (SLS) Table 8: DS1 circuit pack data to assemble for SLS (continued) Page* Field Name Notes 1 Side Specifies QSIG glare handling when the ‘interface’ field is set to ‘peerslave.’ 1 Country Protocol Specifies the Layer 3 signaling protocol used by the country-specific service provider 1 Protocol Version Used in countries whose public networks allow multiple Layer-3 signaling protocols for ISDN PRI service 1 DCP/Analog Bearer Capability Sets the Information Transfer capability in the Bearer Capability IE of the SETUP message 1 Interface Companding Specifies the companding mode used by the far-end switch. 1 ITN-C7 Long Timers Specifies whether the duration of Q.931 timers (T302 and T302) is to be extended. This is only required for Russian telecom applications and if Signaling Mode = isdn-pri. 2 of 2 * 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. Collecting signaling groups data Collect the information from the Communication Manager Signaling Group form (Table 9) for ISDN-PRI administration only: Table 9: ISDN-PRI administration data to assemble for SLS Page* Field Name Notes 1 Trunk Group for Channel Selection Trunk group reference number association with trunk group table 1 Associated Signaling Specifies whether the D-channel is physically associated in the DS1 facility. The ‘enabled’ setting is when there is a D-channel present. 1 Primary D-channel Specifies the gateway port ID where the D-channel is located. For the gateways, the first component is the 3 digit gateway number, followed next by a ‘v’, followed by the slot number, followed by 24 (T1) or 16 (E1). 1 of 2 80 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Table 9: ISDN-PRI administration data to assemble for SLS (continued) Page* Field Name Notes 1 Trunk Board This is needed only if the ‘Associated Signaling’ is administered as ‘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 next by a ‘v’, followed by one numeric character for the slot number. 1 Interface Id This is needed only if the ‘Associated Signaling’ is administered as ‘no’. Specifies the channel of the DS1 circuit that carries the D-channel for ISDN signaling. This is an integer from ‘0’ through ‘31’. 2 of 2 * Page numbers might vary for your system. Collecting administered ISDN-BRI trunks data 1. At the SAT, type display bri-trunk-board location and press Enter to display the DS1 administration for a particular circuit pack location. 2. Gather ISDN-BRI administration information in Table 10 for each location. Table 10: ISDN-BRI administration data to assemble for SLS Page* Field Name Notes 1 Name Descriptive name often of the Service Provider or destination of BRI facility 1 Interface Determines glare handling 1 Side QSIG glare handling, when the interface field is peerSlave 1 Country Protocol Specifies the Layer 3 signaling protocol used by the country-specific service provider 1 DCP/Analog Bearer Capability Sets the Information Transfer capability in the Bearer Capability IE of the SETUP message 2 Companding Mode Specifies the companding mode used by the far end switch. 1 TEI LAPD address assignment for TEI field. 2 Directory Number A Channel B1’s directory number 2 Directory Number B Channel B2’s directory number 1 of 2 Issue 1 February 2007 81 Configuring Standard Local Survivability (SLS) Table 10: ISDN-BRI administration data to assemble for SLS (continued) Page* Field Name Notes 2 SPID-A Service Profile Identifier required for Country Code (USA) 2 SPID-B Service Profile Identifier required for Country Code (USA) 2 Endpt Init Determines whether the far end supports endpoint initialization 1 Layer 1 Stable 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, type display system-parameters customer-options and press Enter 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), then at the SAT type display feature-access-codes and press Enter and gather the FAC information listed in Table 11. 3. Look up the location of the gateway, as follows: a. At the SAT type list media-gateway and press Enter to get the gateway’s number. b. At the SAT type display media gateway number, where number is the gateway number you obtained in Step a. This provides you with the location field value. ● If the gateway has an administered location, at the SAT type display locations number, where number is the administered location number. If there is an ARS entry for the given location, then you must use this value (and only this value) in the SLS data set. ● If there is no administered location, then at the SAT type display feature-access-codes and press Enter and gather the FAC information listed in Table 11. 82 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Table 11: Feature Access Codes to assemble for SLS Page Field Name Notes 1 Contact Closure Open Code Used to open a contact closure relay. 1 Contact Closure Close Code Used to close a contact closure relay. 1 Contact Closure Pulse Code Used to pulse a contact closure relay. 1 Auto Route Selection (ARS) Access Code1 Specifies the 1st access code for ARS table routing. 1 Auto Route Selection (ARS) Access Code2 Specifies the 2nd access code for ARS table routing. 1-16 ARS FAC 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). 1 CAS Remote Hold/ Answer Hold-Unhold Access Code 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 “un-hold” states. Collecting System parameters data 1. At the SAT, type list media-gateway and press Enter 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, type display ip-network-region n, where n is the gateway’s administered IP-Network-Region. Read the Codec-set field value from the IP Network Region form. 5. At the SAT, type 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 12). Note: Note: SLS only supports G.711 mu/A-law. 6. At the SAT, type display system-parameters features and press Enter 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 12). Issue 1 February 2007 83 Configuring Standard Local Survivability (SLS) 8. At the SAT, type display media-gateway n, where n is the administered number of the media gateway of interest, and press Enter to display the Media Gateway form. 9. Read the Max Survivable IP Ext field value (summarized in Table 12). Table 12: General system parameters data to assemble for SLS CM Form Page Field Name Notes Ip-codec-set All All fields 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 System-parameter features 10 Date Format on Terminals Applies to 64xx terminals, and to 46xx IP terminals Media Gateway 1 Max Survivable IP Ext Maximum IP phone registrations allowed 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. Then: 1. At the SAT, type list route-pattern trunk-group n, where n is an administered trunk group, and press Enter 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 13): a. No Deleted Digits b. Inserted Digits 84 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 3. At the SAT, type list ars analysis and press Enter 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 13): a. Min b. Max c. Dialed String Table 13: ARS Dial Patterns for SLS CM Form Page Field Name Notes Route-Pattern 1 No. Del Digits Specifies the number of dialed digits to be deleted from the beginning of the dialed string. Default = 0 Route-Pattern 1 Inserted Digits Specifies the digit string to be inserted at the beginning of the dialed string. Default = 0 ARS Analysis 1 Dialed String Dial string entry that is used to match a pattern within the user-dialed number ARS Analysis 1 Min Minimum length of the user-dialed number that the SLS call engine collects to match to the dialed-string. Default = length of the specified Dialed-string element. ARS Analysis 1 Max Maximum length of the user-dialed number that the SLS call engine collects to match to the dialed-string. Default = length of the Dialed-String element. 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. Then: 1. At the SAT, type display inc-call-handling-trmt trunk-group n, where n is an administered trunk group, and press Enter. 2. For each entry, read the values of the following fields (see Table 14): a. Called Number b. Called Length c. Del d. Insert Issue 1 February 2007 85 Configuring Standard Local Survivability (SLS) Table 14: Incoming call handling data to gather for SLS CM Form Page Field Name Notes Incoming Call Handling Treatment 1 Called Number Dial string entry that is used to match a pattern on inbound trunk calls. Incoming Call Handling Treatment 1 Called Len Maximum length of the user-dialed number that the SLS call engine collects to match to the dialed string. Default = minimum length is defined to be equal to the length of the dialed string. Incoming Call Handling Treatment 1 Del Specifies the number of dialed digits to be deleted from the beginning of the string. Default = 0. Incoming Call Handling Treatment 1 Insert Specifies the digit string to be inserted at the beginning of the dialed string. Default = 0. Trunk Group 1 Digit Handling (In/Out) Defines the overlap receiving rules. Needed to set the “mode” field in the IncomingRouting table. Default = enbloc. Configuring the SLS data through the CLI The command line interface (CLI) has a root-level context of survivable-call-engine for administering the SLS data set. After you type survivable-call-engine at the CLI prompt and press Enter, the prompt changes to indicate that you are in the survivable-call-engine context. Once in this context, seven additional sub-contexts provide for station and trunk administration to minimize the need to type in a long command string. ● station context that is invoked by typing station extension class and pressing Enter to enter a second-level subcontext for administering stations. ● trunk-group context that is invoked by typing trunk-group tgnum group-type and pressing Enter to enter the second-level subcontext for administering trunk groups. ● ds1 context that is invoked by typing ds1 port-address and pressing Enter to enter the second-level subcontext for administering DS1 trunks. ● sig-group context that is invoked by typing sig-group sgnum and pressing Enter to enter the second-level subcontext for administering signaling groups. ● bri context that is invoked by typing bri port-address and pressing Enter to enter the second-level subcontext for administering ISDN BRI links. 86 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS ● dial-pattern context that is invoked by typing dial-pattern dialed-string and pressing Enter to enter the second-level subcontext for administering dial pattern strings. ● incoming-routing context that is invoked by typing incoming-routing tgnum mode pattern length and pressing Enter to enter the second-level subcontext for administering incoming routing. Type exit to leave the second-level sub-contexts and return to the (super-survivable-call-engine)# context. Table 15 provides a complete hierarchical listing of all SLS CLI commands. Table 15: SLS CLI command hierarchy Root Level Commands First Level Context (survivable commands) Second Level Context survivable-call-engine show last-pim-update set pim-lockout show pim-lockout set max-ip-registrations show max-ip-registrations set date-format show date-format set ip-codec-set show ip-codec-set set fac clear fac show fac set slot-config clear slot-config show slot-config 1 of 6 Issue 1 February 2007 87 Configuring Standard Local Survivability (SLS) Table 15: SLS CLI command hierarchy (continued) Root Level Commands First Level Context (survivable commands) Second Level Context station[] set type set port set cor set trunk-destination set password set expansion-module set swhook-flash set name show clear station show station clear extension show extension 2 of 6 88 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Table 15: SLS CLI command hierarchy (continued) Root Level Commands First Level Context (survivable commands) Second Level Context Trunk-group [] set dial set tac clear tac add port remove port set supervision set digit-treatment set digits set name set codeset-display set codeset-national set channel-preference set digit-handling set japan-disconnect set send-name set send-number set numbering-format set incoming-destination set incoming-dialtone set r2mfc-signaling set trunk-hunt show clear trunk-group show trunk-group 3 of 6 Issue 1 February 2007 89 Configuring Standard Local Survivability (SLS) Table 15: SLS CLI command hierarchy (continued) Root Level Commands First Level Context (survivable commands) Second Level Context ds1 set name set bit-rate set signaling-mode set channel-numbering set connect set interface set side set country-protocol set protocol-version set bearer-capability set interface-companding set long-timer show clear ds1 show ds1 sig-group set trunk-group-chan-select set associated-signaling set primary-dchannel add nfas-interface remove nfas-interface show clear sig-group show sig-group 4 of 6 90 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Table 15: SLS CLI command hierarchy (continued) Root Level Commands First Level Context (survivable commands) Second Level Context bri set name set interface set side set country-protocol set bearer-capability set interface-companding set tei-assignment set directory-number-a set directory-number-b set spid-a set spid-b set endpoint-init set layer1-stable show clear bri show bri dial-pattern set min-length set max-length set type set deny set tgnum set delete-digits set insert-digits show clear dial-pattern show dial-pattern Incoming-routing [] set match-pattern set length set delete-digits set insert-digits show clear incoming-routing 5 of 6 Issue 1 February 2007 91 Configuring Standard Local Survivability (SLS) Table 15: SLS CLI command hierarchy (continued) Root Level Commands First Level Context (survivable commands) Second Level Context show incoming-routing set survivable-call-engine show survivable-call-engine copy running-config startup-config clear survivable-config 6 of 6 Creating the SLS administration data set on the media gateway 1. Log on to the gateway. 2. To administer the name, type set system name , where name is typed inside quotes (""). To remove the administered name, type set system name and press Enter; then rename the gateway with the set system name command. Note: Note: The gateway’s administered name must match the name in the Communication Manager administration. 3. At the gateway command prompt, type survivable-call-engine and press Enter to begin entering SLS data. The command line prompt changes to (super-survivable-call-engine)# to indicate that you are in SLS data entry mode. Typing exit ends the SLS data entry mode session, and the command line prompt returns to its original state. 4. Type 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, use the set max-ip-registrations n command, where n is between 1-100. ! Important: Important: Since the VOIP resources on the gateway are limited, adjusting the maximum IP registrations above the default value can result in system performance problems. 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. 92 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 8. Administer the slot configuration information by typing 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 16 for a list of Media Modules supporting SLS). Table 16: Media Modules supporting SLS Media Module Description Permitted Slots TGM550 Central processing and resources, plus two analog trunk ports and two analog station ports. v1 (recommended), v2, v3, v4, v5, v6 TIM510 One T1/E1 trunk port. v1, v2, v3, v4, v5, v6 TIM514 Four analog trunk ports and four analog station/DID ports. v1, v2, v3, v4, v5, v6 TIM521 Four BRI trunk ports. v1, v2, v3, v4, v5, v6 9. Administer the station information as described in Administering Station parameters on page 94. 10. Administer DS1 trunks as required. Refer to Administering DS1 parameters on page 97. 11. Administer BRI links as required. Refer to Administering BRI parameters on page 102. 12. Administer the trunk groups as described in Administering Trunk-group parameters on page 104. Note that you can add members to the trunk group only after you administer the signaling group information. 13. Administer the signaling groups as described in Administering signaling-group parameters on page 110. 14. Administer ARS dial patterns for outgoing calls as described in Administering dial-pattern parameters on page 111. 15. Administer digit treatment for incoming routed calls as described in Administering incoming-routing parameters on page 112. 16. Administer the Feature Access Codes (FACs) by typing set fac feature fac, where feature is any of the following: ● ars1 ● ars2 ● hold ● contact-open ● contact-close Issue 1 February 2007 93 Configuring Standard Local Survivability (SLS) ● contact-pulse 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 Note: ● set fac ars2 *9 ● set fac contact-close 8 Note: The "*" and "#" characters are not available on rotary-dial, analog phones. 17. At the gateway command prompt, type exit to leave the survivable-call-engine context. The gateway command prompt reverts to that of the original login. 18. At the gateway command prompt, type set survivable-call-engine enable to enable SLS on the gateway. 19. At the gateway command prompt, type copy running-config startup-config to save the changes. Administering Station parameters 1. At the gateway command prompt, type station extension class and press Enter to enter a second-level subcontext 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 to indicate that you are in the station context for SLS administration. Typing 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, type clear extension extension at the command line interface. Type exit to leave the second-level station context to return to the (super-survivable-call-engine)# context. Example ● station 1234567 ip administers an IP phone with the extension "1234567". 94 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 2. Depending on the class (analog, or ip in Step 1), type set type model, where model is a value from Table 17. Table 17: Class values in SLS station context analog ip analog2500* 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. 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), type set port module-port for this station, where module-port is a value in Table 18. Note: 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. Issue 1 February 2007 95 Configuring Standard Local Survivability (SLS) Table 18: Module-port values in SLS station configuration mode Gateway Media module Analog station ports* J4350 J6350 TGM550 3, 4 TGM514 5, 6, 7, 8 DCP * You cannot select these modules/ports if they are already assigned as DID trunks. 4. Type set cor cor to set the class of restriction (COR) for this extension, where cor is any 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: Inherited Class of Restriction (COR) permissions on page 66 for the hierarchical relationship among the COR permissions. 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, type set trunk-destination yes. 6. If this is an IP phone (set in Step 1), type set password password, where password is between 4 and 8 digits in length, to administer a password. Note: Note: Passwords are not required for analog phones. Example ● 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, type set expansion-module yes. 96 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 8. For analog phones (set in Step 1) that you want SLS to recognize the switchhook flash signal that offers subsequent transfer features, type set swhook-flash yes. 9. Type 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. Type show to check the station administration of the station being programmed. The report lists the station parameters: Extension --------49139 Note: Type Port Cor ----------ip4620 IPaddr local ip station registered Trunk-Des Exp-Mod Flash --------------------y n at address ‘aaa.bbb.ccc.ddd’ Password -------******** Note: For currently-registered IP phones or IP Softphones, the IP address is displayed. 11. Type exit to leave the station context in SLS. Administering DS1 parameters 1. Type ds1 slot-address, where slot-address is any permitted port. The command line prompt changes to super-survivable-call-engine/ ds1-. If you want to remove the ds1 trunk from the SLS administration, type exit to leave the second-level ds1 context to return to the (super-survivable-call-engine)# context, and then type clear ds1 slot-address. 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. Type 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. Type 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). Issue 1 February 2007 97 Configuring Standard Local Survivability (SLS) 4. Type set signaling-mode mode-type to set the signaling mode for the DS1 facility, where mode-type is any of the following values: ● cas: Out-of-band signaling for E1 service, yielding thirty 64kbps B-channels for voice transmission. ● robbed bit: In-band signaling for T1 service, yielding twenty-four 56kbps B-channels for voice transmission. ● isdnpri: 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 5. Type channel-numbering method to select the channel-numbering method for B-channels on an E1 interface, where method is any of the following values: ● seq: Sequential codes of B-channels 1-30 in the ISDN Channel Identification IE. ● tslot: Timeslot method 6. Type set connect far-end to specify the equipment at the far-end of the DS1 link, where far-end is any 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), type set interface glare-mode to specify the glare-handling convention. glare-mode can be any 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. 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), type set side side to specify the glare mode: either a or b. 98 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 9. If the DS1 link is employed with ISDN, type set country-protocol country-code to specify the ISDN Layer-3 country protocol type, where country-code is any of the following values (see Table 19): Table 19: ISDN Layer-3 country codes Country Code Country 1 United States (AT&T mode, also known as 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 1 of 2 Issue 1 February 2007 99 Configuring Standard Local Survivability (SLS) Table 19: ISDN Layer-3 country codes (continued) 24 Nordic countries 25 South Africa etsi ETSI (no use of RESTART message) qsig QSIG 2 of 2 10. For countries whose public networks allow for multiple ISDN Layer-3 country protocols for ISDN Primary Rate service, type set protocol-version option to specify the mode (see Table 20). Make sure that the protocol version matches the country specified in set country-protocol (step 9). Table 20: ISDN Layer-3 country protocols for ISDN Primary Rate service Country code Description Possible Values Country 1 (United States) AT&T mode (also known as 5ESS) National ISDN-1 Nortel mode (also known as DMS) Telecordia (NI-2) a b c d Country 2 (Australia) Australia National PRI ETSI invalid invalid a b c d Country 10 (United Kingdom) DASS ETSI invalid invalid a b c d Country 12 (France) French National PRI ETSI invalid invalid a b c d 1 of 2 100 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Table 20: ISDN Layer-3 country protocols for ISDN Primary Rate service (continued) Country code Description Possible Values Country 13 (Germany) German National PRI ETSI invalid invalid a b c d ETSI Full message set, including RESTART No RESTART message invalid invalid a b c d 2 of 2 11. If the DS1 link is employed with ISDN, type set bearer-cability bearer to set the Information Transfer Rate field of the Bearer Capability IE, where bearer is any of the following values: ● 3khz: 3.1kHz audio encoding ● speech: Speech encoding 12. Type 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 any of the following values: ● alaw: A-law companding ● ulaw: U-law companding 13. Type 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 14. Type show to check the DS1 administration. The report lists the DS1 parameters: 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. Type exit to leave the DS1 context in SLS. Issue 1 February 2007 101 Configuring Standard Local Survivability (SLS) Administering BRI parameters 1. Type bri slot-address, where slot-address is any permitted port. The command line prompt changes to sls-bri . If you want to remove the BRI link from the SLS administration, type exit to leave the second-level bri context to return to the (super-survivable-call-engine)# context, and then type clear bri slot-address. 2. Type set name name command 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. Type set interface glare-mode to specify the glare-handling convention. glare-mode can be any 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), type set side side to specify the glare mode: either a or b. 5. If the BRI link is employed with ISDN, type set country-protocol country-code to specify the ISDN Layer-3 country protocol type, where country-code is any the values listed in Table 19. 6. If the BRI link is employed with ISDN, type set bearer-cability bearer to set the Information Transfer Rate field of the Bearer Capability IE, where bearer is any of the following values: ● 3khz: 3.1kHz audio encoding ● speech: Speech encoding 7. Type set interface-companding type to set the far-end companding method, where type is any of the following values: ● alaw: A-law companding ● ulaw: U-law companding 102 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 8. If the BRI link is employed with ISDN, type set tei-assignment tei to select the method by which the Layer 2 (LAPD) protocol obtains its Terminal Endpoint Identification (TEI) address. tei is any of the following values: ● auto: TEI is assigned by the network provider ● zero: TEI is fixed 9. Type 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. Type 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. Type set spid-a number to assign a SPID to the B1 channel of the BRI link. 12. Type set spid-b number to assign a SPID to the B2 channel of the BRI link. Note: 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, type 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, type set layer1-stable {yes | no} to determine whether or not to keep the physical layer active (stable) between calls. Some European countries, France, for example, require that the physical layer is deactivated when there is no active call. 15. Type show to check the BRI administration. The report lists the BRI parameters: Name = BRI-SLS1 BRI Interface ----------v401 user 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 16. Type exit to leave the BRI context in SLS. Issue 1 February 2007 103 Configuring Standard Local Survivability (SLS) Administering Trunk-group parameters 1. Type trunk-group tgnum group-type, where tgnum is any number between 1-2000. group-type can be any 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-survivable-call-engine/ trunk-group-. If you want to remove the trunk group from the SLS administration, type exit to leave the second-level trunk-group context to return to the (super-survivable-call-engine)# context, and then type 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 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 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 J4350/J6350 media gateway models. The maximum number of ports allowed per interface module is defined in Table 21. Table 21: J4350 and J6350 SLS group type assignments Group type Media module Number of ports/channels Description loop-start ground-start TGM550 2 1, 2 did TGM550 2 3, 4 1 of 2 104 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Table 21: J4350 and J6350 SLS group type assignments (continued) Group type Media module Number of ports/channels Description loop-start ground-start TIM514 4 1, 2, 3, 4 did TIM514 4 5, 6, 7, 8 bri TIM521 8 t1-isdn TIM510 23 D-channel is associated with this facility (FAS). t1-isdn TIM510 24 D-channel is not associated with this facility (NFAS), and the DS1’s signaling-mode is set to isdnext. t1-isdn TIM510 30 D-channel is associated with this facility (FAS). e1-isdn TIM510 31 D-channel is not associated with this facility (NFAS), and the DS1’s signaling-mode is set to isdnext. t1-inband TIM510 24 e1-inband TIM510 30 2 of 2 Example ● trunk-group 1 loop-start establishes an analog loop-start trunk group number 1. 2. Type 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. Type set tac tac, where tac is a 1-4 digit numeric value (plus initial "#" and "*" on all but rotary dial phones) for this trunk’s 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 1 February 2007 105 Configuring Standard Local Survivability (SLS) 4. Type add port module port sig-group to specify the media module port that is compatible with the device and/or media module (see Table 22 for J4350/J6350 analog trunks and Table 23 for 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: Note: 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 22: Media Module-port values in SLS trunk-group context for the TGM550 (Analog Trunks) Group Type Media Module Number of Ports/ Channels Description loop-start ground-start TGM550 2 1,2 did TGM550 2 3,4 loop-start ground-start TIM514 4 1,2,3,4 did TIM514 4 5,6,7,8 Table 23: Trunk port values in SLS trunk-group context for the TGM550 (Digital Trunks) Group Type Media Module Number of Ports/Channels bri TIM521 8 t1-isdn MM510 23(FAS) 24(NFAS) e1-isdn MM510 30(FAS) 31(NFAS) t1-inband MM510 24 e1-inband MM510 30 106 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 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, type 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), type set supervision sup-type to set the incoming signaling supervision mode, where sup-type can be any 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 tie trunk group, type set digit-treatment digit-treat, where digit-treat is any of the following values: ● blank (use this value to prevent any absorb or insert digit treatment from being applied) ● absorb1 ● absorb2 ● absorb3 ● absorb4 ● absorb5 ● insert1 ● insert2 ● insert3 ● insert4 Issue 1 February 2007 107 Configuring Standard Local Survivability (SLS) 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, type set digits digits to define the inserted digit string, where digits is the number of digits. Note: Note: 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. 9. Type 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, type 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, type 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, type set channel-preference type to define how the Channel Identification IE field is encoded, where type can be one of the following: ● 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. 13. For ISDN trunks, type 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, type set japan-disconnect yes | no to specify whether to perform a disconnect sequence (CONNECT message followed by a DISCONNECT message). 15. For ISDN trunks, type set send-name method to define whether or not the calling, connected, called, or busy party’s 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.’ 108 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Note: Note: For this release, specify method as no since sending a Calling Party Name is a future feature. 16. For ISDN trunks, type set send-number method to define whether or not the calling, connected, called, or busy party’s administered number is sent to the network on outgoing or incoming calls. method can be any of the following: Note: ● 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: For this release, specify method as no since sending a Calling Party Number is a future feature. 17. For ISDN trunks, type 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 any of the following: Note: ● 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. 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 to be consistent with the numbering plan of the PSTN service provider. 18. For non-ISDN digital trunks, analog loop-start and analog ground-start trunks, type set incoming-destination extension to identify an extension to receive an incoming trunk call, for example, an attendant or a voice response/recording system. 19. For non-ISDN digital trunks, type 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, type 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 any 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. Issue 1 February 2007 109 Configuring Standard Local Survivability (SLS) 21. Type show to check the trunk-group administration. The report lists the trunk-group parameters. 22. Type exit to leave the trunk-group context in SLS. Administering signaling-group parameters 1. Type sig-group sgnum, where sgnum is any number 1-650. The command line prompt changes to sls-sig-group . If you want to remove the signaling group from the SLS administration, type exit to leave the second-level sig-group context to return to the (super-survivable-call-engine)# context, and then type clear sig-group sgnum. 2. Type 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. Type 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 three-digit gateway identifier (for example, 005), a two-character slot identifier (for example, v4), or a two-digit circuit number (24 for T1-ISDN, 16 for E1-ISDN). 4. If your trunk is provisioned without a D-channel for signaling, type set associated-signaling no to use Non-Facility Associated Signaling (NFAS). Note: Note: NFAS is available for ISDN-PRI DS1 circuits only. - If you are using NFAS, type add nfas-interface gateway module interface-id, where gateway is the three-digit gateway identifier, module is the two-character slot identifier, and interface-id is the DS1 circuit number associated with the NFAS group. The interface-id value is received from the network service provider. 5. Type show to check the signaling groups administration. The report lists the signaling groups parameters: Sig-group Tg-Select Assoc-Sig Prime-Dchan Nfas-Modules/Nfas-Id --------- --------- --------- ----------- ------------------------------------10 98 yes 005v424 - 6. Type exit to leave the sig-group context in SLS. 110 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS Administering dial-pattern parameters 1. Type dial-pattern dialed-string, where dialed-string is a dial pattern to be used on outgoing calls. The command line prompt changes to super-survivable-call-engine/ dial-pattern . If you want to remove the incoming routing treatment from the SLS administration, type exit to leave the second-level dial-pattern context to return to the (super-survivable-call-engine)# context, and then type clear dial-pattern dialed-string. 2. Type 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: Note: ● 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. Note: Each level of call includes the previous level’s dialing privileges. For example, locl has the calling privileges of iop, intl, etc. See Figure 3: Inherited Class of Restriction (COR) permissions on page 66 for an illustration of the relationship between the various dial types and the COR permissions. 3. Type set min-length length to define the minimum length of the dialed string. 4. Type 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. 5. Type set tgnum tgnum to designate a trunk-group for which this dialed string is assigned. 6. Type set deny no to permit stations to originate outgoing trunk calls. 7. At the command-line type set insert-digits digits to define the number of digits to insert into a dialed string, if required. Issue 1 February 2007 111 Configuring Standard Local Survivability (SLS) 8. Type set delete-digits digits to define the number of digits to be deleted from a dialed string, if required. Note: Note: You may either insert or delete digits, but not both. 9. Type show to check the outbound dial-pattern string administration. The report lists the dial-pattern parameters: 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. Type 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 gateway’s dial plan. 1. Type incoming-routing tgnum mode, where tgnum is an existing ISDN trunk group number and mode is the protocol used for receiving incoming digits and can have a value of enbloc or overlap. The command line prompt changes to sls-incoming-routing . If you want to remove the incoming routing treatment from the SLS administration, type exit to leave the second-level incoming-routing context to return to the (super-survivable-call-engine)# context, and then type clear internal-routing tgnum mode. 2. Type set match-pattern pattern to define the beginning digit pattern of an incoming alphanumeric dial string to be matched against. 3. Type set length length to define the length of the dialed string. 4. If the mode is set to enbloc, you must: ● Type set delete-digits digits to define the number of digits to be deleted from a dialed string. ● Type set insert-digits digits to define the number of digits to be inserted at the beginning of a dialed string. 112 IG550 Integrated Gateway Administration and CLI Reference Configuring SLS 5. (Optional) If the mode is set to overlap, you may configure one of the following options (but not both): ● Type set delete-digits digits to define the number of digits to be deleted from a dialed string. Or ● Type 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. Type exit to leave the incoming-routing context in SLS. 7. Type show to check the incoming-routing administration. The report lists the incoming-routing parameters for all dial patterns that have been administered: Match_pattern ------------234 235 Length -----7 7 Del --3 3 Insert-digits ------------5381000 5381001 Mode -----enbloc enbloc tgnum ----98 99 Up-converting SLS data to Release 4.0 In order to re-use an SLS administration data set from an earlier release, you must convert it to Release 4.0 compatibility. 1. Type copy ftp running-config and press Enter to restore the Release 3.x translation file on the gateway. 2. Reset the gateway. 3. Type copy running-config startup-config and press Enter. A gateway application reconstructs the CLI commands to use the Release 4.0 command contexts and subcommand formats and saves the results in a new translation file. Down-converting Release 4.0 SLS data If you have a Release 4.0 SLS administration data set in which stations are administered with station numbers greater than 7 digits, and you wish to apply that data set to Release 3.1-level firmware on a gateway, you must re-administer the stations with extension numbers not exceeding 7 digits. Issue 1 February 2007 113 Configuring Standard Local Survivability (SLS) 114 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 24: Logging sinks Sink Description Syslog 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. Log file Logging data is saved in the flash memory. These compressed, cyclic files serve as the system logging database. Session Logging messages are sent to the terminal screen: ● 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. 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 using the copy running-config startup-config command 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 123). 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 user-level no higher than the user’s privileges. For example, a user with read-only privileges will not see entered commands having 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 1 February 2007 115 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 typing the set logging server command, followed by the IP address of the server. TGM550-001(super)# set logging server 147.2.3.66 Done! 2. Enable the Syslog server by typing the set logging server enable command, 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. 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. 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) ntp (NTP Subsystem) lpr (Printing) 116 IG550 Integrated Gateway Administration and CLI Reference Configuring a Syslog server 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. 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 123). Disabling Syslog servers Type the set logging server disable command, followed by the IP address of the Syslog server. 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. Type the clear logging server command followed by the IP address of the Syslog server you want to delete. TGM550-001(super)# clear logging server 147.2.3.66 Done! Issue 1 February 2007 117 Configuring logging Displaying the status of the Syslog server Type the show logging server condition command, 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 shown, 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. 118 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. Type the set logging file enable command. 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 123). Disabling logging system messages to a log file Type the set logging file disable command. TGM550-001(super)# set logging file disable Done! Deleting current log file and opening an empty log file Type the clear logging file command. TGM550-001(super)# clear logging file Done! Issue 1 February 2007 119 Configuring logging Displaying log file messages Type the show logging file content command. Note that the user enabling the log will only see entered commands with user-level no higher than the user’s privileges. For example, a user with read-only privileges will not see entered commands having read-write user level. 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 Type the show logging file condition command. TGM550-001(super)# show logging file condition ****************************************************** *** Message logging configuration of FILE sink *** Sink Is Enabled Sink default severity: Informational 120 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/9 01/18/2005,10:49:03:SWITCHFABRIC-Notification: Port Connection Lost on Module 10 port 8 was cleared 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. Type the set logging session enable command. 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 123). Discontinuing the display of system messages To discontinue the display of system messages to the terminal screen, type the set logging session disable command. TGM550-001(super)# set logging session disable Done! Issue 1 February 2007 121 Configuring logging Displaying how the session logging is configured Type the show logging session condition command. This command displays whether session logging is enabled or disabled, and lists all filters defined for session logging. 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 following format: 01/18/2005,10:49:03:SWITCHFABRIC-Notification: Port Connection Lost on Module 10 port 8 was cleared 01/18/2005,10:55:09:CLI-Notification: root: set port disable 10/9 Each message provides the following information: Note: ● The date and time (if available) ● The logging application ● The severity level ● The message text Note: The user enabling the log will only see entered commands with a user-level no higher than the user’s own privileges. For example, a user with read-write privileges will not see entered commands having admin user level. 122 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 for message output for each application. Messages pertaining to the specified applications, that have a severity stronger than or equal to the defined threshold, are sent to the specified sink. Messages with a severity 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, type set logging server condition application severity ip address. ● To create a filter for messages sent to a log file, type set logging file condition application severity. ● To create a filter for messages sent to a session log on a terminal screen, type set logging session condition application severity. where: ● application - application for which to view messages (use all to specify all applications). For the list of applications see Applications to be filtered on page 124. ● severity - 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 124. ● ip address - the IP address of the Syslog server. 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 file session 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. For example, to display the 50 most recent messages from the QoS application with a severity level of critical or higher, type show logging file content critical qos 50. TGM550-001(super)# show logging file content critical qos 50 Issue 1 February 2007 123 Configuring logging Severity levels Table 25: Severity levels Severity level Code Description emergency 0 System is unusable alert 1 Immediate action required critical 2 Critical condition error 3 Error condition warning 4 Warning condition notification 5 Normal but significant condition informational 6 Informational message only debugging 7 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 Applications to be filtered Filters can be defined for any application listed in Table 26: Logging applications. Table 26: Logging applications Application Description boot System startup failures cascade Stack CASCADE mechanism cdr Call Detail Recording. Registers the active calls in SLS mode. cli CLI 1 of 3 124 IG550 Integrated Gateway Administration and CLI Reference Configuring logging filters Table 26: Logging applications (continued) Application Description aan Application Assurance Networking. CNA test plugs report to AAN. config Configuration changes console Serial modem messages dhcpc DHCP client package dhcps DHCP server package dialer Dialer interface messages dnsc DNS client package fan Cooling system filesys File system problem (flash) ids IDS events, specifically a SYN attack heuristic employed by the SYN cookies feature ipsec VPN IPSEC package isakmp VPN IKE package lag Link Aggregation package poe Power over Ethernet policy Policy package ppp PPP protocol pppoe PPP over Ethernet qos QoS messages router Core routing system failures rtp-stat RTP MIB statistics saa RTR-probes messages security Secure logging (authentication failure) snmp SNMP agent stp Spanning tree package (TGM550 only) supply Power supply system 2 of 3 Issue 1 February 2007 125 Configuring logging Table 26: Logging applications (continued) Application Description switchfabric Switch fabric failures system Operating system failures tftp Internal TFTP server threshold RMON alarms tracker Object tracker messages usb-modem USB modem messages vlan VLAN package voice Voice failures wan WAN plugged-in expansion 3 of 3 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 ● filter restricts receipt of messages from all applications to those less severe than error TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# Done! TGM550-001(super)# Done! 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 126 IG550 Integrated Gateway Administration and CLI Reference Configuring logging filters 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 receipt of messages from the boot application to those with severity informational or more severe, and messages from the cascade application to those with severity 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! 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 error or stronger for all other applications. The user therefore sets the default severity 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 Issue 1 February 2007 127 Configuring logging 128 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 129. 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. Issue 1 February 2007 129 Configuring VoIP QoS Configuring QoS parameters The TGM550 Telephony Gateway Module uses MGCP (H248) protocol for call signalling and call routing information. Use the following commands to configure QoS for signalling and VoIP traffic. ● 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 locally on the TGM550 Telephony Gateway Module, or remote in which case the values are obtained from the TGM550 Telephony Gateway Module’s registered MGC. ● Use the set qos signal command to provide the means to set up QoS parameters for MGCP (H248) communication with the MGC. ● Use the voip-queue-delay command to set the maximum queue delay for which to estimate the high priority queue size necessary to meet the queuing delay for a specific VoIP codec. To determine the queue size you currently have, use the show queueing command. ● Use the show qos 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 203. 130 IG550 Integrated Gateway Administration and CLI Reference RSVP parameters Configuring 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 5 sec.), 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. Weighted Fair VoIP Queuing (WFVQ) Weighted Fair VoIP Queuing (WFVQ) combines weighted fair queuing (WFQ) for data streams and priority VoIP queuing to provide the real-time response time that is required for VoIP. WFQ is applied to data streams to provide fair bandwidth distribution among different data streams, with faster response times for shorter packets that are typical for interactive applications such as telnet. Priority VoIP queuing is applied to VoIP bearer and signaling traffic. WFVQ is the default queuing mode for all Serial interfaces for which frame-relay traffic-shaping is not enabled, and all Fast Ethernet interfaces for which traffic-shaping is enabled. It is also the only queueing mode available on a per-PVC basis for serial interfaces when frame relay traffic shaping is enabled. Issue 1 February 2007 131 Configuring VoIP QoS Configuring Weighted Fair VoIP Queueing (WFVQ) ● Use the voip-queue-delay command to set the maximum query delay. To determine the queue size you currently have, use the show queueing command. ● Use the fair-queue-limit command to specify the maximum number of packets that can be queued in the weighted fair queue. The upper and lower limits of this command depend on the amount of bandwidth configured for the interface. Note: This command should generally be used only for troubleshooting. Note: Note: ● Use either the voip-queue or the priority-queue command in interface context to disable WFVQ on an interface, by enabling another queuing mode. ● Use the fair-voip-queue command in interface context to re-enable WFVQ on an interface. WFVQ is the recommended queuing mode for interfaces. Note: There is no no form of the fair-voip-queue command. If you enter the command no fair-voip-queue, it will actually enable WFVQ if WFVQ is not already enabled. 132 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. The ETR closes the tip/ring contacts between TGM550 trunk port 2 and TGM550 line port 3. ! 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. CAUTION: 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 failed connection to the MGC. You can activate and deactivate ETR manually via the CLI. ● To activate ETR manually in the TGM550, use the following command: set etr 3 manual-on ● To activate ETR manually in the TGM550, use the following command: set etr 7 manual-on Issue 1 February 2007 133 Configuring Emergency Transfer Relay (ETR) Generally, you should only use this command for testing. The manual-on option activates the connection between the analog trunk port (3/1 in the TGM550, 7/1 in the TGM550) and the first analog line port (3/2 in the TGM550, 7/2 in the TGM550). The other analog line port (3/3 in the TGM550, 7/3 in the TGM550) will also be disabled. ● To deactivate ETR manually in the TGM550, use the following command: set etr 3 manual-off ● 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. ● To restore ETR to automatic activation in the TGM550, use the following command: set etr 3 auto ● 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 wither automatically or manually. The relay call will be terminated only when ETR is deactivated manually. Note: Viewing ETR state You can use the show etr command to display ETR information. This information includes the following: ● ETR setting (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) 134 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 – a get action. 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 — a get-next action. 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. Issue 1 February 2007 135 Configuring SNMP ● Retrieve a number of values — a get-bulk action. The get-bulk operation 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. Note: Get-bulk is not supported in SNMPv1. Note: ● Change a configuration on the agent — a set action. 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. ● An agent can send an unsolicited message to the manager at any time if a significant, predetermined event takes place on the agent. This message is called a notification. 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 529. Note: SNMP versions There are currently three versions of SNMP: ● SNMPv1 ● SNMPv2c ● SNMPv3 The TGM550 Telephony Gateway Module supports all three of these versions. The implementation of SNMPv3 on the TGM550 Telephony Gateway Module is backwards compatible. An agent that supports SNMPv3 will also support SNMPv1 and SNMPv2c. The TGM550 Telephony Gateway Module supports users for all three of these versions, but only supports the SNMPv3 mechanism for sending traps. Thus, the set snmp trap command is not supported in the TGM550, although the set snmp trap enable auth|frame-relay command is supported. 136 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 agent’s 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 agent’s 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 user name 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 1 February 2007 137 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 uses can access SNMPv3 at the same time. SNMP security levels ● NoAuthNoPriv — This is the lowest level of SNMPv3 security. No Message Authentication Code (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: ● Username — A string of up to 32 characters representing the name of the user. ● Groupname — A string of up to 32 characters representing the name of the group with which the user is associated. ● SecurityModel — The SNMP version functionality that the user is authorized to use. Possible values are: v1 (SNMPv1), v2c (SNMPv2c), and v3 (SNMPv3). ● Authentication Protocol — The authentication protocol to use. Possible values are: noAuth (no authentication), md5 (HMAC MD5), and sha (HMAC SHA-1). ● Authentication Password — A string of between 8 and 64 characters specifying the user’s authentication password. The authentication password is transformed using the authentication protocol and the SNMP engine ID to create an authentication key. ● Privacy Protocol — The privacy protocol to use. Possible values are: No privacy, DES privacy. ● Privacy Password — A string of between 8 and 64 characters specifying the user’s privacy password. 138 IG550 Integrated Gateway Administration and CLI Reference SNMP versions 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. 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 mode and level with which the user is communicating with the TGM550 Telephony Gateway Module. Within a group, the following combinations of security mode and level can be mapped to views: ● SNMPv1 — Anyone with a valid SNMPv1 community name. ● SNMPv2c — Anyone with a valid SNMPv2c community name. ● NoAuthNoPriv — An SNMPv3 user using the NoAuthNoPriv security level. ● AuthNoPriv — An SNMPv3 user using the AuthNoPriv security level. ● AuthPriv — An SNMPv3 user using the AuthPriv security level. If views are not defined for all security modes and levels, a user can access the highest level view below the user’s 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 27: Pre-configured SNMP groups Group Name Security Model Security Level Read View Name Write View Name Trap View Name ReadCommG v1 1 (noAuthNoPriv) snmpv1View snmpv1View ReadCommG v2 1 (noAuthNoPriv) snmpv1View snmpv1View WriteCommG v1 2 (noAuth) snmpv1 WriteView snmpv1 WriteView snmpv1 WriteView WriteCommG v2c 2 (noAuth) snmpv1 WriteView snmpv1 WriteView snmpv1 WriteView v3ReadWriteG v3 (USM) 2 (noAuth) v3configview v3configview v3configview v3ReadOnlyG v3 (USM) 2 (noAuth) v3configview v3configview 1 of 2 Issue 1 February 2007 139 Configuring SNMP Table 27: Pre-configured SNMP groups (continued) Group Name Security Model Security Level Read View Name Write View Name Trap View Name initial v3 (USM) 1 (noAuthNoPriv) restricted restricted restricted v3AdminViewG v3 (USM) 3 (AuthPriv) iso iso iso 2 of 2 Creating an SNMPv3 group To create an SNMPv3 group, the following information must be provided: ● GroupName — A 32-character string representing the name of the group. ● SNMPv1 — The name of the view for anyone communicating with the device via SNMPv1. ● SNMPv2c — The name of the view for anyone communicating with the device via SNMPv2c. ● NoAuthNoPriv — The name of the view for SNMPv3 NoAuthNoPriv users. ● AuthNoPriv — The name of the view for SNMPv3 AuthNoPriv users. ● AuthPriv — The name of the view for SNMPv3 AuthPriv 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 Module’s 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 539. 140 IG550 Integrated Gateway Administration and CLI Reference Configuring SNMP traps 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. 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: ● Use the snmp-server enable notifications command to enable SNMP traps and notifications. Use the no form of this command to disable SNMP traps and notifications. ● Use the set port trap command to enable and disable link-up and link-down notifications and traps. ● Use the set snmp trap enable/disable auth command to enable and disable authentication failure traps for all managers. ● Use the set snmp trap enable frame-relay command to enable frame relay traps for all managers. ● Use the show snmp command 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 SNMPv3 notification host. Use the no form of this command to remove an SNMPv3 notification host and to remove notification filter groups from a specific host. You can define the following parameters with this command: - type — Determines whether to send traps or informs to the recipient. The default is traps. - version — Determines the SNMP security model (v1, v2c, v3). If the security model is v1, you must add the v1 community string to use in notifications. If you select v3, you must also specify the authentication method. Options are: ● auth — authentication without encryption Issue 1 February 2007 141 Configuring SNMP ● noauth — no authentication ● priv — authentication with encryption - community string — The v1 community string to use in notifications. - user name — The v3 user name to use in notifications. - udp port — Optional. A keyword and variable that specify which UDP port of the target host to use as the destination UDP port when sending a notification to this manager. The default is 162. - notification type — The type of traps to be sent. For a list of possible notification types, see Notification types on page 142. Note: There is no default value for the notification type parameter. Thus, you must enter a value in order to send traps. Note: ● Use the snmp trap link-status command to enable Link Up and Link Down traps on an interface. You must use this command from an interface context. ● Use the no snmp trap link-status command to disable Link Up and Link Down traps on an interface. You must use this command from an interface context. Notification types There are various types of SNMP traps that can be sent. You can modify the type of trap by setting the notification type parameter 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 142 IG550 Integrated Gateway Administration and CLI Reference Configuring SNMP access ● 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 Configuring SNMP access ● Use the ip snmp enable 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. ● Use the snmp-server community command 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. ● 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. Use the no form of this command to delete an SNMPv3 view. ● Use the show snmp view command to display a list of SNMPv3 views. ● Use the show snmp userToGroup command to display a table of SNMPv3 users and the groups to which they are mapped. Issue 1 February 2007 143 Configuring SNMP ● Use the show snmp engineID command to display the SNMPv3 engine ID. ● Use the show snmp group command to display a list of SNMPv3 groups. ● Use the show snmp user command to display a list of SNMPv3 users. ● Use the show snmp command to display a list of SNMP notification receivers. Note: You need an Admin privilege level to use the SNMP commands. Note: 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 can not be removed. Note: Use the snmp-server dynamic-trap-manager command to specify the parameters of the dynamic trap manager feature. You can configure the following parameters: ● type — Determines whether to send traps or informs to the recipient. The default is traps. ● version — Determines the SNMP security model (v1, v2c). If the security model is v1, you must add the v1 community string to use in notifications. ● udp port — Optional. A keyword and variable that specify which UDP port of the target host to use. ● notification type — The type of traps to be sent. To send all types of traps, set this parameter to all. This is the default. For a list of possible notification types, see Notification types on page 142. 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 144 IG550 Integrated Gateway Administration and CLI Reference SNMP configuration examples SNMP configuration examples The following example adds an SNMPv1 trap receiver (TGM550 only): TGM550-001(super)# set snmp trap 192.36.44.18 SNMP trap receiver added. The following example disables all traps for an SNMPv1 trap receiver (TGM550 only): TGM550-001(super)# set snmp trap 192.36.44.18 disable all SNMP all traps disabled. The following example enables config traps for an SNMPv1 trap receiver (TGM550 only): TGM550-001(super)# set snmp trap 192.36.44.18 enable config SNMP config trap enabled. The following example displays SNMP information: TGM550-001(super)# show snmp Authentication trap enabled Community-Access Community-String ------------------------------read-only public read-write public trap public Trap-Rec-Address Traps Enabled ------------------------------192.36.44.18 config The following example deletes an SNMPv1 trap receiver: TGM550-001(super)# clear snmp trap 192.36.44.18 SNMP trap receiver deleted. The following example creates a read-only user: TGM550-001# snmp-server user joseph v3 ReadOnlyG v3 auth md5 katmandu priv des56 ktamatan The following example creates a read-write user: TGM550-001# snmp-server user johnny v3 ReadWriteG v3 auth md5 katmandu priv des56 ktamatan Issue 1 February 2007 145 Configuring SNMP The following example creates an admin user: TGM550-001# snmp-server user johnny v3 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. The following example sets the SNMPv1 trap community: TGM550-001(super)# set snmp community trap trap SNMP trap community string set 146 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. The recording, storage, and playing of announcement files are 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 Avaya Voice Announcement Manager (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. TGM550-001(super)# copy announcement-file scp local_announcement2.wav 192.168.49.10 c:\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. TGM550-001(super)# copy scp announcement-file c:\temp\ announcement_file1.wav 192.168.49.10 Issue 1 February 2007 147 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. TGM550-001(super)# copy announcement-file ftp local_announcement2.wav 192.168.49.10 c:\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. TGM550-001(super)# copy ftp announcement-file c:\temp\ 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. 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. 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. 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 148 IG550 Integrated Gateway Administration and CLI Reference Announcement file operations ● Display the status of a download process of announcement files from the remote SCP server, using the show download announcement-file status command. 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 Issue 1 February 2007 149 Transferring and managing announcement files 150 IG550 Integrated Gateway Administration and CLI Reference Chapter 10: Configuring monitoring applications The TGM550 Telephony Gateway Module provide 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 to 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 Module’s 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: Note: The gateway performs traceroutes whenever RTP statistics is enabled. 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 1 February 2007 151 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. 152 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”. For information about configuring the RTCP interval (RTCP report period), see Administrator Guide for Avaya Communication Manager, 03-300509. The RTCP interval is typically 5 to 8 seconds. Thresholds types Note: ● 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. Viewing the configured thresholds 1. Use the show rtp-stat thresholds CLI command. 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 1 February 2007 153 Configuring monitoring applications Table 28 describes the QoS metrics on which thresholds are configured, and the time at which each metric is evaluated. Table 28: QoS metrics Metric Description Evaluation time codec loss The percentage of time the codec plays fill frames due to lack of valid RTP frames. Possible causes include jitter and packet loss. Every RTCP interval. average-codec-loss The average codec loss measurement since the beginning of the RTP stream. At the end of the session. codec-rtt 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. Each time an RTCP packet is received. echo-return-loss The echo cancellation loss on the TDM bus. Every RTCP interval. loss 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. Every RTCP interval. average-loss The average packet loss evaluation since the beginning of the RTP stream. At the end of the session. remote-loss The network loss according to the remote RTP receiver. The device learns of the remote packet loss from received RTCP messages. Each time an RTCP packet is received. average-remote-loss The average remote network loss measurement since the beginning of the RTP stream. At the end of the session. rtt The network RTT. This metric does not include internal delay. The device learns of the RTT from RTCP messages. Each time an RTCP packet is received. local jitter Variation in delay of packet delivery to the local peer. Every RTCP interval. 1 of 2 154 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics Table 28: QoS metrics (continued) Metric Description Evaluation time remote-jitter Variation in delay of packet delivery to the remote peer. The device learns of the remote jitter from RTCP messages. Each time an RTCP packet is received. SSRC changes The number of times the RTP SSRC field in received RTP packets has changed. Every RTCP interval. 2 of 2 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 152. For a description of each metric, see Table 28: QoS metrics on page 154. 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 threshold command to set thresholds on QoS indicators. For example: TGM550-001(super)# rtp-stat threshold 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 1 February 2007 155 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. Use the rtp-stat-service command. 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. Use the rtp-stat clear command. For example: TGM550-001# 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. 156 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics 1. Use the show rtp-stat config command. 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 29 describes the output of the show rtp-stat config command. Table 29: RTP statistics application configuration Name Description RTP Statistic Status of the RTP statistics application. Possible values: ● Enabled. The application is enabled. ● Disabled. The application is disabled. QoS Trap 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 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. Fault The QoS fault trap boundary. That is, the minimum number of active sessions with QoS faults that triggers a QoS fault trap. Clear 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 Rate Limiter: 1 of 2 Issue 1 February 2007 157 Configuring monitoring applications Table 29: RTP statistics application configuration (continued) Name Description Token Interval 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. Bucket Size 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. Session Table: Size The maximum number of RTP session entries held in the session table in the gateway RAM. Reserved 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. Min Stat Win 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 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. Enabling QoS traps 1. View the RTP statistic thresholds and modify their configurations as necessary. See Viewing RTP statistics thresholds on page 152 and Configuring RTP statistics thresholds on page 155. 158 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics 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 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, use the show snmp command. 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 144. 4. Use the rtp-stat qos-trap command to enable the traps, if not enabled already. For example: TGM550-001# rtp-stat qos-trap The RTP statistics QoS trap is enabled QoS traps are now enabled. Issue 1 February 2007 159 Configuring monitoring applications 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: 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. 1. 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 would be sent if and when one active RTP session has QoS problems. A QoS clear trap would then be sent if and when the number of active RTP sessions with QoS problems reduces to 0. 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. 1. 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. 160 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics 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). 1. Use the show rtp-stat summary command. 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 Table 30 describes the fields in the summary report. Table 30: RTP statistics summary reports output Field Description Total QoS traps 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. QoS traps Drop 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. Qos Fault/QoS Clear 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 160. Engine ID The ID of the VoIP engine. Since the TGM550 has one VoIP engine, one line appears in the table. Description Description of the VoIP engine. 1 of 2 Issue 1 February 2007 161 Configuring monitoring applications Table 30: RTP statistics summary reports output (continued) Field Description Uptime 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. Active Sessions The number of active sessions / number of active sessions with QoS problems. Total Sessions The total number of sessions / number of sessions that had QoS problems. Mean Duration The mean RTP session duration (calculated only for terminated calls). Tx TTL The IP TTL (Time To Live) field for transmitted RTP packets. 2 of 2 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. 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. 162 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics 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: [email protected] 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 1 February 2007 163 Configuring monitoring applications Table 31 describes the fields in the show rtp-stat detailed command output according to the numbered labels in the example. Table 31: Detailed CLI output per RTP session Field Label Description From the CLI example Session-ID 1 An arbitrary index number for the session in the session table. Session-ID: 35 Status 2 The status of the session. Possible values: ● Active. The session is still open. ● Terminated. The session is finished. Status: Terminated QOS 3 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. QOS: Faulted EngineId 4 The ID of the VoIP engine. The TGM550 has one VoIP engine. EngineId: 0 Start-Time 5 The date of the RTP session. 2004-10-20 6 The start time of the RTP session. Start-Time: 2004-10-20,11:09:07 End-Time 7 The end time of the RTP session. End-Time: 2004-10-20,11:13:40 Duration 8 The duration of the RTP session. Duration: 00:04:33 CName 9 format: gwt@. CName: [email protected] 1 of 6 164 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics Table 31: Detailed CLI output per RTP session (continued) Field Label Description From the CLI example Phone 10 The local extension number and conference ID in format :. 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). Phone: 69:2011 Local-Address 11 The PMI. The number after the colon is the UDP port number. Local-Address: 135.8.118.252:2061 Remote-Address 13 The remote VoIP engine, gateway PMI or IP phone address. The number after the colon is the UDP port number. Remote-Address: 135.8.76.107:2061 12, 14 SSRC ID. The number in parentheses is the number of observed SSRC changes during the session. SSRC 2989801899 (0) 15 The number of times the application has sampled the VoIP engine (RTP receiver) statistics. Samples: 5415 (5 sec) 16 The sampling interval. Samples: 54 (5 sec)16 17 The codec used for the session. G723 18 The RTP packet size, in bytes. 62B 19 The RTP packet interval, in ms. 30mS Samples Codec: 2 of 6 Issue 1 February 2007 165 Configuring monitoring applications Table 31: Detailed CLI output per RTP session (continued) Field Label Description From the CLI example 20 The encryption method. Off 21 The received silence suppression method. Silence-suppression (Tx/Rx) Disabled21/ Not-Supported 22 The transmitted silence suppression method. Silence-suppression (Tx/Rx) Disabled/ Not-Supported22 Play-Time 23 The overall time the codec played valid received frames. Play-Time 272.610sec Codec Loss codec-loss% 24 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. Loss 0.0%24 #1 #codec-loss-events 25 The codec loss event counter. Loss 0.0% #125 Avg-Loss 26 The average of all codec loss values sampled during the session. Avg-Loss 0.1% RTT rtt ms 27 The last sampling of codec round trip time, in ms. Codec round trip time is the round-trip delay experienced by the user, including internal delay. This value is not 100% accurate since remote internal delays are not always known. RTT 741mS27 #38, #rtt-events 28 The codec round trip time event counter. RTT 741mS #3828, Avg-RTT 29 The average of all codec round trip time values sampled during the session. Avg-RTT 570mS Jbuf-under/ overruns 30 The estimated percentage contribution of jitter-buffer underruns to the average codec loss. JBuf-under/overruns 0.1%30/0.0%, 31 The estimated percentage contribution of jitter-buffer overruns to the average codec loss. JBuf-under/overruns 0.1%/0.0%31, 32 The last jitter buffer delay. Jbuf-Delay 22mS Silence suppression (Tx/ Rx) Jbuf-delay 3 of 6 166 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics Table 31: Detailed CLI output per RTP session (continued) Field Label Description From the CLI example Max-Jbuf-Delay 33 The maximum jitter buffer delay during the session. Max-Jbuf-Delay 60mS Packets 34 The total number of received packets. Packets 9236 Loss loss% 35 The last sampled value of network RTP packet loss. Loss 0.0%35 #0 #loss-events 36 The network RTP packet loss event counter. Loss 0.0% #036 Avg-loss 37 The average of all network RTP packet loss values during the session. Avg-Loss 0.0% RTT rtt ms 38 The network round trip time (RTT). The RTT is calculated upon RTCP packet reception. RTT 604mS38 #38 #rtt-events 39 The network RTT event counter. RTT 604mS #3839 Avg-RTT 40 The average of all network RTT values during the session. Avg-RTT 376mS Jitter jitter ms 41 The network jitter at the RTP receiver. Combined with long RTT, a large jitter value may indicate WAN congestion. Jitter 0mS41 #0 #jitter-event 42 The RTP receiver network jitter event counter. Jitter 0mS #042 Avg-Jitter 43 The average of all network jitter values during the session. Avg-Jitter 0mS TTL (last/min/max) 44 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. TTL(last/min/max) 63/63/63 Duplicates 45 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 Layer2/ Ethernet topology (for example, loops). Duplicates 0 Received RTP: 4 of 6 Issue 1 February 2007 167 Configuring monitoring applications Table 31: Detailed CLI output per RTP session (continued) Field Label Description From the CLI example Seq-Fall 46 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. Seq-Fall 0 DSCP 47 The last received DSCP value of the RTP packets. DSCP 46 L2Pri 48 The last received L2 priority value of an RTP packet (usually IEEE802.1p). L2Pri 12 RTCP 49 The total number of received RTCP packets. RTCP 54 VLAN 50 The VLAN-ID on which the RTP packets are transmitted. VLAN 1 DSCP 51 The DSCP of RTP packets. DSCP 184 L2Pri 52 The Layer 2 priority of transmitted RTP packets (usually 802.1p). L2Pri 6 RTCP 53 The total number of transmitted RTCP packets. RTCP 62 Transmitted-RTP: 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. Loss 0.0%54 #0 #rem-loss-ev 55 The number of samples that were over the rem-loss threshold. Loss 0.0% #055 Avg-Loss 56 The average network loss experienced by the remote RTP receiver. Avg-Loss 0.0% Jitter rem-jitter 57 The network jitter experienced by the remote RTP receiver. Jitter 0mS57 #0 #rem-jitter-ev 58 The number of samples that were over the remote jitter threshold. Jitter 0mS #058 5 of 6 168 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics Table 31: Detailed CLI output per RTP session (continued) Field Label Description From the CLI example Avg-jitter 59 The average remote jitter. Avg-Jitter 0mS Loss loss dbm 60 The echo cancellation loss on the TDM bus. A high value (that is, a low absolute value) may indicate impairment of DCP terminals. Loss 45dB60 #1 #loss-ev 61 A counter that increments each time the echo-cancellation loss is sampled below its threshold. Loss 45dB #161 Len 62 The last echo-cancellation tail length used for this session. Len 32mS Status 63 The current (last) RSVP reservation state at the end of the session. Status Disabled Failures 64 The total number of reservation failures during the session. Failures 0 Echo cancellation: 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 1 February 2007 169 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: [email protected], 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 32 describes the fields in the QoS trap according to the numbered labels in the example. Table 32: QoS Trap output fields Label Description From the trap example 1 The date on which the trap was received. Oct 20 2 The time at which the trap was received. 11:13:40 3 The IP address of the local MGP. 135.8.118.252 1 of 4 170 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics Table 32: QoS Trap output fields (continued) Label Description From the trap example 4 The gateway up time. sysUpTime.0 = Timeticks: (43147723) 4 days, 23:51:17.23 5 The trap name, which indicates that this is a QoS trap. snmpTrapOID.0 = OID: av RtpQoSTrap 6 The local gateway PMI. avRtpSessionLocAddrV4.0 = IpAddress: 135.8.118.252 7 The remote VoIP engine, gateway PMI or IP phone address. avRtpSessionRemAddrV4.0 = IpAddress: 135.8.76.107 8 The duration of the RTP session. Duration: 00:04:33 9 format: gwt@. avRtpSessionCname.0 = STRING: [email protected] 10 The local extension number and conference ID in format :. 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). avRtpSessionPhone.0 = STRING: 69:2011 11 An arbitrary index number for the session in the session table. avRtpSessionDebugStr.0 = STRING: Id{35} 12 The total number of sent traps since the application was enabled. Traps{2411/0} 13 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. Traps{24/012} 14 The number of times the application sampled the VoIP engine (RTP receiver) statistics. Stats{S 54 2 of 4 Issue 1 February 2007 171 Configuring monitoring applications Table 32: QoS Trap output fields (continued) Label Description From the trap example 15 The total number of received RTCP packets. Stats{S 54 RTCP 5414 RX 9236} 16 The total number of received RTP packets. Stats{S 54 RTCP 54 RX 923615} 17 The codec used for the session. g723 18 The codec packet size, in bytes. 62B 19 The encryption method. encryptionOff 20 The received silence suppression method. SSup disabled19/disabled 21 The transmitted silence suppression method. SSup disabled/disabled20 22 The average of all codec loss values sampled during the session. Loss 0.1%21 #1 23 The codec loss event counter. Loss 0.1% #122 24 The average of all codec round trip time values sampled during the session. RTT 570mS23 #38 25 The codec round trip time event counter. RTT 570mS #3824 26 The percentage contribution of jitter-buffer underruns to the average codec loss. Jbuf 0.1%25/0.0% 27 The percentage contribution of jitter-buffer overruns to the average codec loss. Jbuf 0.1%/0.0%26 28 The average of all network RTP packet loss values sampled during the session. Loss 0.0%27 #0 29 The network RTP packet loss event counter. Loss 0.0% #028 30 The average of all network RTT values during the session. RTT 376mS29 #38 31 The network RTT event counter. RTT 376mS #3830 32 The network jitter at the RTP receiver. Jtr #0 33 The minimum and maximum TTL values sampled in the session. TTL 63-63 34 A counter that increments each time two consecutive RTP packets with the sample RTP sequence number are received. Dup 0 3 of 4 172 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics Table 32: QoS Trap output fields (continued) Label Description From the trap example 35 A counter that increments each time an RTP packet with a sequence number less than the last known sequence is received. Fall 0 36 The average network loss experienced by the remote RTP receiver. Rem{Loss 0.0%35 #0 Jtr #0} 37 A counter that increments each time the remote loss is sampled over its threshold. Rem{Loss 0.0% #036 Jtr #0} 38 A counter that increments each time the network jitter experienced by the remote RTP receiver is sampled over its threshold. Rem{Loss 0.0% #0 Jtr #037} 39 The echo cancellation loss on the TDM bus. A high value (that is, a low absolute value) may indicate impairment of DCP terminals. 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 1 February 2007 173 Configuring monitoring applications Table 33 describes the fields in the QoS fault and clear traps according to the numbered labels on the example above. Table 33: QoS fault and clear trap output fields Label Description From the QoS fault trap example From the QoS clear trap example 1 The date on which the trap was received. Oct 20 Oct 20 2 The time at which the trap was received. 11:10:54 11:13:40 3 The gateway uptime. sysUpTime.0 = Timeticks: (43131114) 4 days, 23:48:31.14 sysUpTime.0 = Timeticks: (43147723) 4 days, 23:51:17.23 4 The trap name. Indicates that this is a QoS fault trap or a QoS clear trap. snmpTrapOID.0 = OID: avRtpQoSFault snmpTrapOID.0 = OID: avRtpQoSClear 5 The QoS fault trap boundary. That is, the number of active sessions with QoS faults that causes a QoS fault trap to be sent. avRtpQoSFaultTh.0 = INTEGER: 1 avRtpQoSFaultTh.0 = INTEGER: 1 6 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. avRtpQoSClearTh.0 = INTEGER: 0 avRtpQoSClearTh.0 = INTEGER: 0 Viewing automatic traceroute results The VoIP engine automatically performs UDP traceroutes whenever the RTP statistics application is enabled. 174 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics 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 5 seconds. 1. 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 rtp-statistics session index 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 34: RTP traceroute results output Field Description Session ID The RTP statistics index for the RTP session From The IP address of the TGM550 To The IP address of the session destination (in this case, a destination within the specified subnet) At The time the traceroute is performed TTL The hop count and TTL field value of probe packets HOP ADDRESS The hop IP address DELAY 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 1 February 2007 175 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 TGM550 Telephony Gateway Module-001. Extensions 2002 and 2101 are connected to the remote gateway TGM550 Telephony Gateway Module-002. Figure 9: Four telephones in a sample network 176 IG550 Integrated Gateway Administration and CLI Reference Configuring and analyzing RTP statistics At the site of the local gateway “TGM550 Telephony Gateway Module-001”, 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 1 February 2007 177 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 threshold codec-loss 6.0 threshold average-codec-loss 0.0 threshold codec-rtt 700 threshold echo-return-loss 5 threshold loss 6.0 threshold remote-loss 6.0 threshold average-loss 0.0 threshold average-remote-loss 0.0 threshold jitter 70 threshold remote-jitter 70 threshold 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 178 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 1 February 2007 179 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. Figure 10: Remote call from analog to IP phone 180 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. 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: [email protected] 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 1 February 2007 181 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. The call is finished at 00:59:19. Figure 11: Local call from analog to IP phone 182 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: Destination -----------30.30.30.2 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: [email protected] 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 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 1 February 2007 183 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 176. 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. 184 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: [email protected] 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 1 February 2007 185 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: [email protected] 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 186 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 1 February 2007 187 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: [email protected] 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: [email protected] 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) 188 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]. RTP statistics CLI commands Table 35: RTP statistics application CLI commands Command Description rtp-stat clear Reset the RTP statistics application rtp-stat event-threshold Set a QoS event-threshold for RTP streams rtp-stat fault Configure the RTP statistics application to send QoS fault and/or clear traps rtp-stat min-stat-win Set the RTP statistics minimum statistic window rtp-stat qos-trap Configures 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 rtp-stat threshold Sets thresholds for the RTP statistics applications 1 of 2 Issue 1 February 2007 189 Configuring monitoring applications Table 35: RTP statistics application CLI commands (continued) Command Description rtp-stat qos-trap-rate-limit Configures the QoS trap rate limiter rtp-stat-service Enables the RTP statistics application show rtp-stat sessions Displays RTP sessions QoS statistics show rtp-stat config Displays the RTP statistics application configuration show rtp-stat detailed Displays a detailed QoS log for a specific RTP session show rtp-stat summary Displays a summary of the RTP statistics show rtp-stat thresholds Displays the configured RTP statistic thresholds show snmp Displays SNMP trap configuration, including trap destinations snmp-server dynamic-trap-manager Specifies the parameters of the dynamic trap manager feature snmp-server host Configures an SNMP trap destination. 2 of 2 190 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. 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 203. 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. Issue 1 February 2007 191 Configuring monitoring applications 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, the schedulers distribute test plug registration parameters among themselves, and so, 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 isn’t successful. 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: ● 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 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 TTL (time-to-live) 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. 192 IG550 Integrated Gateway Administration and CLI Reference Configuring and monitoring CNA test plugs ● 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 36: Default UDP port values UDP Port Default value Control port 8889 RTP echo port 8888 RTP test port 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. 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 test plug 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. Issue 1 February 2007 193 Configuring monitoring applications 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 test plug context. From the general context, you can use the show cna testplug command to display the test plug configuration. 6. From the general context, use the cna-testplug-service command 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 access. 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. 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. 194 IG550 Integrated Gateway Administration and CLI Reference Configuring and monitoring CNA test plugs //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: v(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 Last Test: none Test Count Failed -------------------traceroute 0 0 rtp 0 0 ping 0 0 tcpconnect 0 0 merge 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 Done! Cancelled --------0 0 0 0 0 1 Issue 1 February 2007 195 Configuring monitoring applications //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 196 IG550 Integrated Gateway Administration and CLI Reference Cancelled --------0 0 0 0 0 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. Use the set sync interface command to define a potential stratum clock source (T1/E1 Media Module, ISDN-BRI), where: Note: ● 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. 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: Note: Setting the source to secondary overrides normal failover, generates a trap, and asserts a fault. Thus, it is not recommended to set the clock source to secondary except for testing purposes. 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 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 Issue 1 February 2007 197 Setting synchronization 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 Media Server. 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. - 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. Displaying synchronization status Use the show sync timing command 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. 198 IG550 Integrated Gateway Administration and CLI Reference User Levels 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 Access Description User read-only User level is a general access level used to display system parameter values. This level complies with the Read Only restrictions level. Privileged read-write Privileged level is used to access configuration options. This level complies with the Read and Write restrictions level. Supervisor admin Supervisor level is used for highly secured operations, such as adding a new user account, and showing the PPP chap secret. Services admin Services includes the craft and dadmin logins and other remote services logins. 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. Issue 1 February 2007 199 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. 200 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 37: List of CLI Contexts Context Description CLI prompt (Log in as User) Root Read Only context > (Log in as Privileged User) Root Read Write context # (Log in as Supervisor) Root Admin context (super)# Interface Console Configuring the Console interface (if:Console)# Banner login For editing a text message that appears before users login (login)# Banner post login For editing a text message that appears after users login (post-login)# survivable-call-engine Configure Standard Local Survivability (SLS) on the TGM550 Media Gateway (survivable-call-engine) survivable-call-engine/ station Configure SLS stations (sls-station ) survivable-call-engine/ trunk-group Configure SLS trunks (sls-trunk-group-) survivable-call-engine/ ds1 Configure SLS DS1 parameters (sls-ds1-) survivable-call-engine/ sig-group Configure SLS signaling-group parameters (sls-sig-group ) survivable-call-engine/ bri Configure SLS BRI parameters (sls-bri ) survivable-call-engine/ dial-pattern Configure SLS dial-pattern parameters (sls-dial-pattern ) survivable-call-engine/ incoming-routing Configure SLS incoming-routing parameters (sls-incoming-routing ) Issue 1 February 2007 201 User Levels and Contexts 202 IG550 Integrated Gateway Administration and CLI Reference About the CLI 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 200. This chapter lists all the CLI commands for the TGM550 Telephony Gateway Module. Logging in to the CLI To login to the CLI, you need a username and n 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: Note: At the first login using root, the TGM550 prompts for a change of the password. 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 199. Issue 1 February 2007 203 CLI Commands 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, the system displays a list of commands matching those letters. 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 204 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Alphabetical listing of CLI commands 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 Standard Local Survivability (SLS). 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 add nfas-interface { [interface-id]} Parameters Parameter Description Possible Values gateway 3-digit gateway number (for example, 005) module 2-character slot number (for example, v4). This number identifies a port on an already-provisioned DS1 board module (see add port). interface-id 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. Default Value 0-31 User level read-write Context survivable-call-engine > sig-group Example TGM550-001(sls-sig-group 100)# add nfas-interface 005v5 0 Issue 1 February 2007 205 CLI Commands add port Use the add port command to administer the virtual integrated port appropriate for Standard Local Survivability (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: Note: The sig-group argument is only necessary for Digital trunks. Parameters Parameter Description Possible Values module port The virtual integrated port assignment for this group-type. See either ● Analog trunks ● Digital trunks sig-group Specifies the signaling group associated with the management of this trunk member. Number between 1- 650 Default Value Analog trunks See Table 1: TGM550 SLS analog port assignments on page 207 (99 trunks per trunk group) Note: 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. 206 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 following ports should be discouraged from being used as DID ports (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). The integrated port 3 is discouraged from being used as DID: Note: Table 1: TGM550 SLS analog port assignments Group type Trunk type Media module Number of ports/channels Description CO loop-start ground-start TGM550 2 1, 2 did wink-start immediate-start TGM550 2 3, 4 CAMA (911) CAMA TIM514 2 1, 2 CO loop-start ground-start TIM514 4 1, 2, 3, 4 did wink-start immediate-start TIM514 4 5, 6, 7, 8 CAMA (911) CAMA TIM514 4 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-)# add port v304 Digital trunks ● TGM550: 99 trunks per trunk group (see Table 2: J4350 and J6350 SLS digital port assignments on page 208). The number of ISDN channels depends on whether the signaling D-channel is associated with this facility (FAS) or not (NFAS). Issue 1 February 2007 207 CLI Commands 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 2: J4350 and J6350 SLS digital port assignments Group type Media module Number of ports/ channels bri TIM 521 8 t1isdn MM510 23 (FAS) 24 (NFAS)* e1isdn MM510 30 (FAS) 31 (NFAS)* t1inband MM510 24 e1inband MM510 30 * The DS1’s signaling-mode field is set to isdnext. User level read-write Context survivable-call-engine > trunk-group 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 displays before the user is prompted for the login name. To enter text for the login banner, refer to the command line on page 290. Note: Note: Before creating a new banner, delete the current banner using the no banner login command. 208 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax [no] banner login User level admin 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 displays 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 290. Note: Note: Before creating a new banner, delete the current banner using the no banner post-login command. 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)# Issue 1 February 2007 209 CLI Commands bri Use the bri command within the survivable-call-engine context to enter a second-level subcontext for administering ISDN Basic Rate Interface (BRI) for Standard Local Survivability (SLS). After issuing this command, the prompt changes to sls-bri . Type exit to leave the bri context, which returns you to the survivable-call-engine context. Syntax bri slot-address Parameters Parameter Description slot-address The physical module address on the gateway as described in Table 3: ● Note: Possible Values Default Value V401, V402, V417, V418 Note: The BRI slot address must agree with the slot assignment administration (see set slot-config on page 378). Table 3: J4350 and J6350 slot and board matrix for SLS J4350/J6350 Media Module Description Permitted slots SLS configured? TIM521 Four (4) BRI trunk ports (8 trunks) v1, v2, v3, v4, v5, v6 Yes User level read-write Context survivable-call-engine > bri Example TGM550-001(super-survivable-call-engine)# bri v401 TGM550-001(sls-bri 401)# 210 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Sub-commands The following commands are available once you are inside the survivable-call-engine >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 Additional SLS commands clear bri, set survivable-call-engine, show bri, show survivable-call-engine, survivable-call-engine Issue 1 February 2007 211 CLI Commands busyout voip-dsp Use the busyout voip-dsp command to put the VoIP engine in busyout (not available) state for a Bit Transfer Rate test. Note: Note: Status changes made during the test create SNMP traps. Syntax busyout voip-dsp [[/]] User level read-write Context general clear bri Use the clear bri command to delete the administration for a given BRI channel in Standard Local Survivability (SLS). Syntax clear bri slot-address Parameters Parameter Description slot-address The administered slot address User level read-write Context survivable-call-engine 212 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Example TGM550-001(super-survivable-call-engine)# clear bri v401 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 Description interface_ type The type of interface interface_ identifier The interface number. The format varies depending on the value of interface_type: For Serial: module/port:channel-group For LoopBack: Loopback number Possible Values Default Value For Serial(USP): 2/1 For Serial (DS1): module/port: 2/1 channel-group: E1: 0-30 T1: 0-23 For Loopback: 1-99 User level read-write Context general Example To clear counters on DS1 module 3, channel group 20: TGM550-001(super)# clear counters 3/20 Issue 1 February 2007 213 CLI Commands 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 Example To clear CNA test plug counters: TGM550-001(cna-testplug 1)# clear counters 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 Parameters Parameter Description Possible Values dialed-string Specifies the dialed string pattern Any defined dial string pattern. Use show dial-pattern to display defined values. User level read-write 214 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# 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 Standard Local Survivability (SLS). Syntax clear ds1 slot-address Note: Note: See ds1 for valid slot address values. User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# clear ds1 v4 clear dynamic-trap-manager Use the clear dynamic-trap-manager command to remove administration of the dynamic trap manager. Syntax clear dynamic-trap-manager User level read-write Issue 1 February 2007 215 CLI Commands Context snmp-server dynamic-trap-manager Example TGM550-001(super-survivable-call-engine)# clear dynamic-trap-manager Related commands snmp-server dynamic-trap-manager 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: Note: It is preferable to use the clear station command, which is equivalent to the clear extension command. Syntax clear extension extnum Parameters Parameter Description Possible Values extnum Specifies the extension number to delete 1-13 digit number User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# clear extension 1234 Extension 1234 was removed. 216 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands clear fac Use the clear fac command to delete an administered Feature Access Code for Standard Local Survivability (SLS). Syntax clear fac feature Parameters Parameter Description Possible Values feature The type of feature for which the FAC code applies. ars1 ars2 hold contact-open contact-close contact-pulse Default Value User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# clear fac contact-open Done! clear fragment Use the clear fragment command to clear the fragment database and restore its default values. Note: Note: No IP reassembly is performed on packets in transit through the router. Syntax clear fragment Issue 1 February 2007 217 CLI Commands User level read-write Context general 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 Standard Local Survivability (SLS). This removes administration from the incoming-routing subcontext. Syntax clear incoming-routing tgnum mode [pattern length] Parameters Parameter Description Possible Values tgnum ISDN (t1isdn or e1isdn) trunk group number 1-2000 mode Protocol for receiving incoming digits: All digits in SETUP message Not all digits available in the SETUP message; some digits delivered in subsequent INFO message enbloc overlap pattern Incoming alphanumeric string of 1-16 characters length Numeric string of 1-21 digits 0-9 User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# clear incoming-routing 99 enbloc 218 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands 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 clear ip traffic Use the clear ip traffic command to clear the IP counters. Syntax clear ip traffic User level read-only Context general Issue 1 February 2007 219 CLI Commands 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 Related commands 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 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 220 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description ip_address The IP address of the Syslog server hostname The name of the Syslog server host Possible Values Default Value User level read-write 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 Issue 1 February 2007 221 CLI Commands 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 Description ipaddress1 The IP address of a call controller Possible Values Default Value User level read-only Context general 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 222 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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} Parameters Parameter Description primary Keyword specifying to clear the primary RADIUS server secondary 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 Issue 1 February 2007 223 CLI Commands clear screen Use the clear screen command to clear the current terminal display. Syntax clear screen User level read-only Context general clear sig-group Use the clear sig-group command to delete the administration for a given ISDN signaling group in Standard Local Survivability (SLS). Syntax clear sig-group sgnum Parameters Parameter Description Possible Values sgnum Signaling group number 1-650 User Level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# clear sig-group 99 224 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands clear slot-config Use the clear slot-config command to delete the slot configuration administration in the media gateway for Standard Local Survivability (SLS). Syntax clear slot-config slot-number Parameters Note: Parameter Description Possible Values Default Value slot-number Identifies the slot number Table 5: J4350 and J6350 slot and board matrix for SLS on page 378. 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 Context survivable-call-engine Example TGM550-001 (super-survivable-call-engine)# clear slot-config v1 clear snmp trap Use the clear snmp trap command to clear an entry from the SNMP trap receiver table. Syntax clear snmp trap {rcvr_addr|all} Issue 1 February 2007 225 CLI Commands Parameters Parameter Description rcvr_addr The IP address of the trap receiver (the SNMP management station) to remove all Keyword used to clear all entries in the SNMP trap receiver table Possible Values Default Value User level read-write Context general Example To remove the SNMP trap server with IP address 192.122.173.82 from the table: TGM550-001(super)# clear snmp trap 192.122.173.82 SNMP trap receiver deleted. 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 TGM550-001(super)# clear ssh-client known-hosts 226 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description Possible Values extension Specifies the extension number to delete 1-13 digit number Default Value User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# clear station 1234 Station 1234 was removed. Issue 1 February 2007 227 CLI Commands clear survivable-config Use the clear survset contact-clivable-config command to set the SLS parameters to their default values. Syntax clear survivable-config User level read-write Context general Example TGM550-001(super-survivable-call-engine)# clear survivable-config Survivable-call-engine configuration is cleared clear sync interface Use the clear sync interface command to disassociate a previously specified interface as the primary or secondary clock synchronization source. Note: Note: The primary interface must be disassociated before the secondary interface is disassociated. Syntax clear sync interface {primary | secondary} Parameters Parameter Description primary Keyword specifying the primary clock synchronization source secondary Keyword specifying the secondary clock synchronization source 228 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands 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 clear tac Use the clear tac command to remove a trunk access code (TAC) assignment from a trunk group in Standard Local Survivability (SLS). The set tac command establishes the TAC assignment to the trunk group. Syntax clear tac User level read-write Context survivable-call-engine/trunk-group Example TGM550-001 (sls-trunk-group-<200>)# clear tac Done! 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 Issue 1 February 2007 229 CLI Commands User level read-only Context general Examples TGM550-001(super)# clear tcp syn-cookies counters clear trunk-group Use the clear trunk-group command to delete a trunk group entry from the Standard Local Survivability (SLS) data set. Note: Note: The trunk group must have already been administered with the trunk-group command before this command will work. Syntax clear trunk-group tgnum Parameters Parameter Description Possible Values tgnum Specifies the trunk group to delete. 1-2000 Default Value User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# clear trunk-group 13 Trunk group 13 was removed. 230 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands clear utilization cpu Use the clear utilization cpu command to disable CPU utilization measurements. Syntax clear utilization cpu module Parameters Parameter Description module 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 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 Issue 1 February 2007 231 CLI Commands Parameters Parameter Description line Keyword that specifies to use an external clock internal Keyword that specifies to synchronize to the internal clock Possible Values Default Value User level read-write Context Interface: Controller Example To specify that controller number 5 uses an external clock: TGM550-001(controller:5/1)# clock source external 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)# 232 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 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. 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 default control port. Syntax control-port port no control port Parameters Parameter Description Possible Values Default Value port The UDP port number to be used as the control port 1-65535 8888 Issue 1 February 2007 233 CLI Commands 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 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 Description source-filename The name of the announcement file in the TGM550 Telephony Gateway Module announcement directory. If the file name includes spaces, use quotes. ip The IP address of the remote FTP server. destination-filename The destination file name, including full path, if a name change is required. If the file name includes spaces, use quotes. User level read-write 234 IG550 Integrated Gateway Administration and CLI Reference Possible Values up to 32 characters for the file name Default Value Alphabetical listing of CLI commands Context general Example To upload the file 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 Description source-filename The file name of the announcement file in the TGM550 announcement directory. If the file name includes spaces, use quotes. ip The IP address of the remote SCP server. destination-filename The destination file name, including full path, if a name change is required. If the file name includes spaces, use quotes. Possible Values Default Value Up to 32 characters, not including the path User level read-write Context general Issue 1 February 2007 235 CLI Commands Example To upload the file “announcement1.wav” from the announcements directory to a remote SCP server with IP address 192.168.49.10: TGM550-001(super)# copy announcement-file scp announcement1.wav 192.168.49.10 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 To upload the file “local announcement2.wav” to a remote SCP server with IP address 192.168.49.10, store it in c:\, and name it “remote announcement2.wav”. TGM550-001(super)# copy announcement-file scp “local announcement2.wav” 192.168.49.10 “c:\remote announcement2.wav” 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 Description Possible Values filename File name with full path string ip IP address of the host 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 236 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Parameters Parameter Description Possible Values filename File name with full path string ip IP address of the host 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 Issue 1 February 2007 237 CLI Commands Parameters Parameter Description Possible Values filename File name with full path string ip IP address of the host 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 tftp auth-pass 192.168.49.10 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 Description Possible Values filename File name with full path string ip IP address of the host IP address User level admin Context general 238 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands 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 Parameters Parameter Description Possible Values filename File name with full path string ip IP address of the host 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 Issue 1 February 2007 239 CLI Commands Parameters Parameter Description Possible Values filename File name with full path string ip IP address of the host 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 tftp cdr1 192.168.49.10 TGM550-001TGM550-001Relate Commands copy ftp announcement-file Use the copy ftp announcement-file command to download a file from an FTP server to the gateway’s 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 Description filename The file name on the FTP server ip The IP address of the FTP server destination -filename The file name in the gateway’s announcement directory 240 IG550 Integrated Gateway Administration and CLI Reference Possible Values string of up to 32 characters Default Value Alphabetical listing of CLI commands User level read-write Context general Example To download the announcement_file2.wav file from the FTP server at IP address 192.168.49.10 and save it in the gateway’s 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: 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 Description filename The name of the authentication file, including the full path ip The IP address of the host Possible Values Default Value User level read-write Issue 1 February 2007 241 CLI Commands Example 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. 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. Note: Note: 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 Description filename The name of the image file, including the full path ip The IP address of the host User level read-write 242 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Example 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 ... 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. Note: Note: 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 Description filename The name of the configuration file, including the full path ip The IP address of the host Possible Values Default Value User level read-write Context general Example TGM550-001# copy ftp phone-scriptA 46xxupgrade.txt 192.168.49.10 Confirmation - do you want to continue (Y/N)? y Username: anonymous Issue 1 February 2007 243 CLI Commands Password: Beginning download operation ... This operation may take up to 20 seconds. Please refrain from any other operation during this time. 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: Note: After you download the configuration file, the new configuration is not active until you reset the device. Syntax copy ftp startup-config filename ip Parameters Parameter Description filename The file name on the FTP server ip 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 244 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description filename File name on the FTP server ip 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 1 February 2007 245 CLI Commands 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 Description filename File name on the FTP server ip 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: 246 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description filename The name of the configuration file, including the full path ip The IP address of the host Possible Values Default Value User level read-write Context general Example 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. Issue 1 February 2007 247 CLI Commands 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 Description filename The name of the configuration file, including the full path ip The IP address of the host Possible Values Default Value User level read-write Context general Example 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. 248 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description filename The name of the configuration file, including the full path ip The IP address of the host Possible Values Default Value User level read-write Context general Example TGM550-001(super)# copy phone-scriptA tftp 46xxupgrade.txt 192.168.49.10 Issue 1 February 2007 249 CLI Commands 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: 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. Syntax copy running-config ftp filename ip Parameters Parameter Description filename File name to create on the FTP server ip IP address of the FTP server Possible Values Default Value User level read-write Context general Example To upload the current configuration to the TGM550.cfg file 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: 250 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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: 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. Syntax copy running-config scp filename ip Parameters Parameter Description filename File name to create on the SCP server ip IP address of the SCP server Possible Values Default Value User level read-write Context general Example TGM550-001(super)# copy running-config scp c:\config_files\router1.cfg 192.168.49.10 Username: dan Password: Issue 1 February 2007 251 CLI Commands 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: Note: Station passwords are stored in a special area of NVRAM to prevent them from being uploaded or downloaded through non-secure protocols. 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: 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. Syntax copy running-config tftp filename ip 252 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description filename Name of file to create on TFTP server ip IP address of TFTP server Possible Values Default Value User level read-write Context general Example To upload the current configuration to the TGM550.cfg file 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 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 Description Possible Values source-filename The filename of the announcement file on the Voice Announcements Manager host with the full path. If the file name includes spaces, use quotes. Default Value Issue 1 February 2007 253 CLI Commands Parameter Description ip The IP address of the Voice Announcements Manager host. destination-filename The destination filename, if a name change is required. If the file name includes spaces, use quotes. Possible Values Default Value User level read-write Context general Example To download the file “announcement_file1.wav” from the Voice Announcements Manager on host 192.168.49.10: TGM550-001(super)# copy scp announcement-file c:\temp\ announcement_file1.wav 192.168.49.10 To download the file “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 To download the file “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” 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 254 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description filename The name of the authentication file, including the full path ip The IP address of the host Possible Values Default Value User level admin Example 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. 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 Parameters Parameter Description filename The name of the configuration file, including the full path. ip The IP address of the host. Possible Values Default Value Issue 1 February 2007 255 CLI Commands User level read-write Context general Example 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 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: 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. Syntax copy scp startup-config filename ip Parameters Parameter Description filename Name of file to create on SCP server ip IP address of SCP server User level read-write 256 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Context general Example 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: 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. Syntax copy startup-config ftp filename ip Parameters Parameter Description filename Name of file to create on the FTP server ip IP address of the FTP server Possible Values Default Value User level read-write Context general Example To upload the current configuration to the TGM550.cfg file on the FTP server at IP address 135.64.10.33: TGM550-001(super)# copy startup-config ftp TGM550.cfg 135.64.10.33 Issue 1 February 2007 257 CLI Commands 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: 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. Syntax copy startup-config scp filename ip Parameters Parameter Description filename Name of file to create on the SCP server ip IP address of the SCP server Possible Values Default Value User level read-write Context general Example To upload the current configuration to the router1.cfg file 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 258 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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: 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. Syntax copy startup-config tftp filename ip Parameters Parameter Description filename Name of file to create on TFTP server ip IP address of TFTP server Possible Values Default Value User level read-write Context general Example To upload the current configuration to the TGM550.cfg file 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 1 February 2007 259 CLI Commands 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 Description Possible Values filename File name with full path string ip IP address of the host 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 Parameters Parameter Description Possible Values filename File name with full path string ip IP address of the host IP address 260 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands 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 Description Possible Values filename File name with full path string ip IP address of the host 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 tftp syslog1 192.168.49.10 Issue 1 February 2007 261 CLI Commands 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 Description filename The name of the authentication file, including the full path ip The IP address of the host Possible Values Default Value User level admin Example 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. 262 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Parameters Parameter Description filename The name of the configuration file, including the full path ip The IP address of the host Possible Values Default Value User level read-write Context general Example TGM550-001(super)# copy tftp phone-imageA c:\IpphoneRelease\ 4602sape1_8.bin 192.168.49.10 Issue 1 February 2007 263 CLI Commands 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 Description filename The name of the configuration file, including the full path ip The IP address of the host Possible Values Default Value User level read-write Context general Example TGM550-001(super)# copy tftp phone-scriptA file1.txt 135.64.100.205 Confirmation - do you want to continue (Y/N)? y 264 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description filename The file name, including the full path ip 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 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, an additional TFTP server is not required. Issue 1 February 2007 265 CLI Commands Syntax copy tftp SW_imageA filename ip Parameters Parameter Description filename The file name, including the full path ip 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, an additional TFTP server is not required. Syntax copy tftp SW_imageB filename ip 266 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description filename The file name, including the full path ip IP address of the host Possible Values Default Value 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. Relate Commands dial-pattern Use the dial-pattern command within the survivable-call-engine context to enter a second-level subcontext for administering ARS dial patterns for Standard Local Survivability (SLS). After issuing this command, the prompt changes to sls-dial-pattern . Type exit to leave the dial-pattern context, which returns you to the survivable-call-engine context. Syntax dial-pattern dialed string Issue 1 February 2007 267 CLI Commands Parameters Parameter Description Possible Values dialed string Maximum 18 characters 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. Maximum of 31 patterns Default Value User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# dial-pattern 91 TGM550-001(sls-dial-pattern 91)# Sub-commands The following commands are available once you are inside the survivable-call-engine >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 Additional SLS commands clear dial-pattern, set survivable-call-engine, show dial-pattern, show survivable-call-engine, survivable-call-engine 268 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 | file-system [directory]} Parameters Parameter Description Possible Values module_number Displays downloaded files for the specified module only Default Value User level read-write Context general Example To display a list of downloaded files: TGM550-001(super)# dir M# -1 3 4 9 9 9 10 10 10 10 10 10 10 10 10 ver num -------5 17 2 N/A N/A N/A N/A N/A 24.6.0 24.8.0 21.12.0 N/A N/A N/A N/A file ---TIM510 TIM514 TIM521 hi.wav hi1.wav hi2.wav startup-config running-config TGM550-A TGM550-B TGM550-Booter phone-ScriptA phone-ScriptB phone-ScriptC phone-ScriptD file type ---------SW RT Image SW RT Image SW RT Image Annc files Annc files Annc files Startup Conf Running Conf SW RT Image SW Component SW BootImage Phone Script Phone Script Phone Script Phone Script file location ------------Nv-Ram Nv-Ram Nv-Ram Nv-Ram Nv-Ram Nv-Ram Nv-Ram Ram Flash Bank A Flash Bank B Nv-Ram Nv-Ram Nv-Ram Nv-Ram Nv-Ram file description ---------------TIM510 - image TIM514 - image TIM521 - image Announcement files Announcement files Announcement files Startup Config Running Config Software Image Bank A Software Image Bank B Booter Image N/A 46xxupgrade.scr N/A N/A Issue 1 February 2007 269 CLI Commands disable link encryption Use the disable link encryption command to disable H.248 signalling encryption. Syntax disable link encryption User level admin Context general Example To disable H.248 signalling encryption: TGM550-001(super)# disable link encryption disable media encryption Use the disable media encryption command to disable Avaya media encryption (SRTP, AEA, RTP/AES). Syntax disable media encryption User level admin Context general Example To disable Avaya media encryption: TGM550-001(super)# disable media encryption 270 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands disconnect ssh Use the disconnect ssh command to disconnect an existing SSH session. Syntax disconnect ssh session_id Parameters Parameter Description Possible Values session_id The number of the SSH session to disconnect Default Value User level admin Context general ds1 Use the ds1 command within the survivable-call-engine context to enter a second-level subcontext for administering DS1 trunks for Standard Local Survivability (SLS). After issuing this command, the prompt changes to sls-ds1-. Type exit to leave the DS1 context, which returns you to the survivable-call-engine context. Syntax ds1 slot-address Parameters Parameter slot-address Description ● Possible Values Default Value The physical module address on the gateway, as described in Table 4: Issue 1 February 2007 271 CLI Commands Note: Note: The DS1 port address must agree with the slot assignment administration (see set slot-config on page 378). Table 4: J4350 and J6350 slot and board matrix for SLS J4350/J6350 Media Module Description Permitted slots SLS configured? TIM510 One T1/E1 trunk port v1, v2, v3, v4, v5, v6 Yes User level read-write Context survivable-call-engine > ds1 Example TGM550-001 (super-survivable-call-engine)# ds1 v4 TGM550-001 (sls-ds1-)# Sub-commands The following commands are available once you are inside the survivable-call-engine > 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 272 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands DS1 sub-commands set side set signaling-mode show Additional SLS commands clear ds1, set survivable-call-engine, show ds1, show survivable-call-engine, survivable-call-engine 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 Description source-filename The name of the announcement file to delete Possible Values Default Value User level read-write Context general Example TGM550-001# erase announcement-file local_announcement1.wav Issue 1 February 2007 273 CLI Commands 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 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 Context general Example TGM550-001(super)# erase phone-scriptA Beginning erase operation .... Done! 274 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 294. Syntax erase startup-config User level read-write Context general 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-survivable-call-engine)# exit TGM550-001(super)# Issue 1 February 2007 275 CLI Commands 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: Note: No IP reassembly is performed on packets in transit through the router. Syntax fragment chain chain_limit no fragment chain Parameters Parameter Description Possible Values Default Value chain_ limit The maximum number of fragments that can comprise a single IP packet 2-2048 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: Note: No IP reassembly is performed on packets in transit through the router. 276 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax fragment size database_limit no fragment size Parameters Parameter Description Possible Values Default Value database_ limit The maximum number of packets undergoing re-assembly at any given time 0-200 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: Note: No IP reassembly of packets in transit through the router is performed. Syntax fragment timeout timeout no fragment timeout Issue 1 February 2007 277 CLI Commands Parameters Parameter Description Possible Values Default Value timeout The maximum number of seconds to reassemble an IP packet 5-120 10 User level read-write Context general Example To set the maximum time to reassemble packets to be 30 seconds: TGM550-001(super)# fragment timeout 30 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 Description Possible Values Default Value hostname_ string The hostname a string of up to 20 characters TGM550 278 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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' To reset the CLI prompt to the default: GTW-HQ-001(super)# no hostname TGM550-001(super)# icmp Use the icmp command to specify that the current rule applies to a specific type of ICMP packet. Use the no form of this command to specify that the rule applies to all packets except those of the specified ICMP type. Note: Note: The icmp command also sets the IP protocol to ICMP. Syntax [no] icmp {name | {icmp_type icmp_code}} Parameters Parameter Description Possible Values Default Value name Specify that the rule applies to this ICMP name icmp_type Specify that the rule applies to this icmp type For an ip-rule: 0-256 For a QoS rule: 0-65535 icmp_code Specify that the rule applies to this icmp code For an ip-rule: 0-256 For a QoS rule: 0-65535 Issue 1 February 2007 279 CLI Commands 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 Example To specify that rule 33 applies to any ICMP packet type except type 1 code 2: TGM550-001(ACL 333/ip rule 33)# no icmp 1 2 To specify that rule 27 applies to ICMP error-reply packets: TGM550-001(ACL 333/ip rule 27)# icmp Echo-Reply 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 the limit to its default value. Syntax icmp in-echo-limit size Parameters Parameter Description Possible Values size The number of echo requests 1-10000 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 280 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands incoming-routing Use the incoming-routing command within the survivable-call-engine context to enter a second-level subcontext for administering digit-treatment for incoming routed calls in Standard Local Survivability (SLS). After issuing this command, the prompt changes to sls-incoming-routing . Type exit to leave the incoming-routing context, which returns you to the survivable-call-engine context. Syntax incoming-routing tgnum mode [pattern length] Parameters Parameter Description Possible Values tgnum ISDN (t1isdn or e1isdn) trunk group number 1-2000 mode Protocol for receiving incoming digits: All digits in SETUP message Not all digits available in the SETUP message; some digits delivered in subsequent INFO message enbloc* overlap† pattern‡ Incoming alphanumeric string of 1-16 characters length Numeric string of 1-21 digits Default Value 0-9 * Each entry must be an enbloc match-pattern entry. If you administer the mode as enbloc, you must also use the set insert-digits (dial-pattern) command to administer the inserted 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 survivable-call-engine Example TGM550-001(super-survivable-call-engine)# incoming-routing 99 enbloc TGM550-001(super-sls-incoming-routing 99)# Issue 1 February 2007 281 CLI Commands Sub-commands The following commands are available once you are inside the survivable-call-engine >incoming-routing context: Incoming-routing sub-commands set delete-digits set insert-digits (dial-pattern) set length set match-pattern show Additional SLS commands clear incoming-routing, set survivable-call-engine, show incoming-routing, show survivable-call-engine, survivable-call-engine 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: Note: This mode is used for services logins only. 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)# 282 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands ip icmp Use the ip icmp command to enable ICMP services. Use the no form of the command to disable ICMP services. Syntax ip icmp [echo] no ip icmp Parameters Parameter Description echo Enables ICMP only for echo packets and destination unreachable packets Possible Values Default Value User level read-write Context general ip icmp redirect Use the ip icmp redirect command to enable the ICMP redirect service. If the ICMP service is down, the command fails and returns an error message. Use the no form of the command to disable the ICMP redirect service. Syntax [no] ip icmp redirect Issue 1 February 2007 283 CLI Commands 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 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 Media 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: Note: There must be at least one H.248 media gateway (G700, G250, G350, or IG550) for each LSP in the main server’s network. Only one LSP or primary controller can use the serial number of a media gateway for license verification. Syntax ip license-server User level read-only Context general 284 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Example To enable the serial number assignment to an LSP: TGM550-001(super)# ip license-server ip snmp-server Use the ip snmp-server 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-server [volatile] no ip snmp-server Parameters Parameter Description volatile Specifies that the SNMP agent is only enabled temporarily, until the system is reset Possible Values Default Value User level admin Context general Example TGM550-001(ACL 330)(super)# ip snmp-server volatile Issue 1 February 2007 285 CLI Commands 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: Note: 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. Syntax [no] ip ssh User level admin Context general 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: Note: 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 459). 286 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax ip telnet [port port_number] no ip telnet Parameters Parameter Description port Keyword that changes the default port of the Telnet server port_number The number of the new port for the Telnet server Possible Values Default Value 1-65535 23 User level admin Context genera 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: Note: 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 459). Syntax [no] ip telnet-client User level admin Context general Issue 1 February 2007 287 CLI Commands 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 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: 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. Syntax [no] ip tftp-server file-system-size size Parameters Parameter Description Possible Values Default Value size The TFTP server total fie size in Kb 256-19456 18560 288 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands User level read-write Context general Example 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 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: Note: Note: Note: 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 gateway’s 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. Syntax key config-key password-encryption master-key-passphrase Issue 1 February 2007 289 CLI Commands Parameters Parameter Description Possible Values master-key-phrase The phrase used to generate the gateway’s Master Key, used for encrypting gateway secrets A string of 13-64 printable ASCII characters Default Value User level admin Context general Example TGM550(super)# key config-key password-encryption o;3qfhSE&Ydfl\ line Use the line command to add a line to the current banner message. Syntax line number [string] Parameters Note: Parameter Description Possible Values number The line number to add the specified text 1-24 string The text to display on the specified line Default Value Note: To define a string that includes spaces, enclose the entire string in quotation marks (for example, “New York”). User level admin 290 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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” login authentication Use the login authentication 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 to its default value. Use the no login authentication attempt command to return the lockout attempt threshold to its default value. Note: Note: As soon as you use the login authentication command, the new lockout settings immediately override previous settings, for all user accounts. Syntax [no] login authentication [lockout time | attempt count] Parameters Parameter Description Possible Values Default Value time The lockout time, in seconds. 30-3600 0 disables the timeout function 180 count The number of successive failed login attempts before account lockout is enforced. 1-10 0 disables the timeout function 3 User level admin Context general Issue 1 February 2007 291 CLI Commands 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 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: Note: ● 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. 292 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax [no] login authentication response-time time Parameters Parameter Description Possible Values Default Value time The authentication response time period, in seconds, before timing out a connection 30-3600 0 disables the timeout function 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: Note: By default, Avaya Services login access is enabled as soon as the Authentication File is downloaded to the gateway. Syntax [no] login authentication services-login User level admin Issue 1 February 2007 293 CLI Commands Context general Example To disable Avaya Services login: TGM550-001(super)# no login authentication services-login 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 275). ! 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. 294 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description Possible Values Default Value host The IP address of the target system interval The number of seconds between successive ICMP packets 1-256 1 size The size, in bytes, of the packet sent when pinging 22-65500 50 timeout The timeout in seconds 1-10 source_address IP address from which to send the ICMP packets User level read-only Context general Example To send test 50-byte packets to IP address 192.168.49.1 from IP address 192.168.49.4 every three seconds, timing out after five seconds: TGM550-001(super)# ping 192.168.49.1 3 50 5 192.168.49.4 Issue 1 February 2007 295 CLI Commands release voip-dsp Use the release voip-dsp command to end a BTR test on the VoIP engine. Note: Note: Note: Status changes that occur during the test create SNMP traps. Note: View the results of the most recent BTR test with the show mm command (refer to show mm on page 455). Syntax release voip-dsp User level read-write Context general remove nfas-interface Use the remove nfas-interface command to remove a member from a NFAS-managed DS1 group in Standard Local Survivability (SLS). This command removes the add nfas-interface gateway and module administration. 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 296 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values gateway 3-digit gateway number (for example, 005) module 2-character slot number (for example, v4). This number identifies a port on an already-provisioned DS1 board module (see add port). Default Value User level read-write Context survivable-call-engine > sig-group Example TGM550-001(sls-sig-group 100)# remove nfas-interface 005v5 remove port Use the remove port command to remove the virtual integrated port assignment from a trunk group in Standard Local Survivability (SLS). The port assignment is administered with the add port command. Syntax remove port module port Parameters Parameter Description Possible Values module port The virtual integrated port assignment for this group-type See the add port command for port values. Default Value User level read-write Issue 1 February 2007 297 CLI Commands Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# remove port v301 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 Parameters Parameter Description source-filename The name of the announcement file to be renamed. destination-filename 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_local_announcement1.wav“ to “to_local_announcement1.wav.“ TGM550-001# rename announcement-file from_local_announcement1.wav to_local_announcement1.wav 298 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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: Note: Note: 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: 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. Syntax reset [module module_number | voip | chassis] Parameters Parameter Description module Keyword indicating to reset a module module_number The module to reset voip Keyword indicating to reset the VoIP engine chassis 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 Issue 1 February 2007 299 CLI Commands retstatus Use the retstatus command to show whether or not the last CLI command you performed was successful. Syntax retstatus 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 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 Description Possible Values Default Value port The UDP port number to be used as the RTP echo port number 1-65535 8888 300 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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-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 TGM550-001(super)# rtp-stat clear 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 threshold is 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 customer’s actual experience of QoS problems during the stream. Issue 1 February 2007 301 CLI Commands 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 Description all Sets all event thresholds to the specified number codec-loss Sets the event threshold for the codec-loss metric codec-rtt Sets the event threshold for the codec-rtt metric echo-return-loss Sets the event threshold for the echo-return-loss metric loss Sets the event threshold for the loss metric remote-loss Sets the event threshold for the remote-loss metric rtt Sets the event threshold for the rtt metric jitter Sets the event threshold for the jitter metric remote-jitter Sets the event threshold for the remote-jitter metric ssrc-change Sets the event threshold for the ssrc-change metric num The number of events User level read-write 302 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Context General Example To set rtp-stat event-thresholds: 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 Parameters Parameter Description Possible Values Default Value fault The fault trap boundary. If the number of active sessions with QoS faults reaches the fault trap boundary, a QoS fault trap is sent. 1-100 3 clear 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. 0-99 User level read-write Context General Issue 1 February 2007 303 CLI Commands Example To set fault/clear trap boundary: 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 Parameters Parameter Description Possible Values packets The minimum number of observed RTP sequence increments for which the application evaluates packet loss 10-1000 User Level read-write Example To set the minimum statistic window to 50: TGM550-001(super)# rtp-stat min-stat-win 50 304 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands 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 Example To enable QoS traps: TGM550-001(super)# rtp-stat qos-trap The RTP statistics QoS trap is enabled To disable QoS traps: TGM550-001(super)# no rtp-stat qos-trap The RTP statistics QoS trap is disabled. Issue 1 February 2007 305 CLI Commands 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 Description Possible Values Default Value token-interval The interval, in hundredths of seconds, between additions of a token to the bucket 10-100000 1000 bucket-size The maximum number of tokens stored in the bucket 1-1000 5 User Level read-write Context General Example TGM550-001(super)# rtp-stat qos-trap-rate-limit 10 50 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 306 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands User Level Admin Context General Example To enable the RTP statistics application: TGM550-001 (super)# rtp-stat-service The RTP statistics service is enabled. To disable the RTP statistics application: TGM550-001 (super)# no rtp-stat-service The RTP statistics service is disabled. 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 301. Syntax rtp-stat threshold {codec-loss|average-codec-loss|loss|average-loss|remote-loss|average-r emote-loss} percentage rtp-stat threshold {codec-rtt|rtt|jitter|remote-jitter} milliseconds rtp-stat threshold echo-return-loss dbm no rtp-stat threshold {all|codec-loss|average-codec-loss|codec-rtt|echo-return-loss|loss|ave rage-loss|remote-loss|average-remote-loss|rtt|jitter|remote-loss|echoreturn-loss} Issue 1 February 2007 307 CLI Commands Parameters Parameter Description codec-loss The percentage of time the codec plays fill frames due to lack of valid RTP frames. Possible causes include jitter and packet loss. average-codec-loss The average codec loss measurement since the beginning of the RTP stream. loss 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. average-loss The average packet loss evaluation since the beginning of the RTP stream. remote-loss The network loss according to the remote RTP receiver. The device learns of the remote packet loss from received RTCP messages. average-remote-loss The average remote network loss measurement since the beginning of the RTP stream. Possible Values 0.0-100.0 percentage codec-rtt 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. rtt The network RTT. This metric does not include internal delay. The device learns of the RTT from RTCP messages. 308 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands Parameter Description Possible Values jitter Variation in delay of packet delivery to the local peer. remote-jitter Variation in delay of packet delivery to the remote peer. The device learns of the remote jitter from RTCP messages. 0-5000 milliseconds echo-return-loss The echo cancellation loss on the TDM bus. 0-100 db all Default Value Clears all configured thresholds. 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 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 default UDP port for RTP tests. Syntax rtp-test-port port no rtp-test-port Issue 1 February 2007 309 CLI Commands Parameters Parameter Description Possible Values Default Value port The UDP port number to be used as the RTP test port 1-65535 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 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 312 for more information. The Media Server must configure the SAT port to 5023. Syntax sat User level read-only Context general 310 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands scheduler Use the scheduler command to add a scheduler’s 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 Parameters Parameter Description Possible Values index An index in the scheduler list. Scheduler 1 is the first scheduler attempted by the test plug for registration. 1-5 scheduler-address The IP address of a scheduler. port The TCP registration port number. 1-65535 Default Value 8888 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 Issue 1 February 2007 311 CLI Commands 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: Note: For session mgc sat to access the Media Server SAT terminal, the SAT port must be configured to 5023 on the Media Server. For session mgc and session icc, the Media Server should allow access to the Telnet port (23). Syntax session {mgc [sat] | chassis} Parameters Parameter Description mgc Keyword for accessing the LINUX shell login sat Keyword for accessing the SAT login chassis Keyword for accessing the Juniper Services Router CLI Possible Values User level read-only Context general Example To establish a session with the active Media Gateway Controller: TGM550-001(super)# session mgc To establish a session with the Juniper Services Router: TGM550-001(super)# session chassis 312 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands set associated-signaling Use the set associated-signaling command to specify whether the D-channel is physically present in the DS1 interface in Standard Local Survivability (SLS). Note: 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. Syntax set associated-signaling {yes | no} Parameters Parameter Description Default Value yes The D-channel is present in the same DS1 interface. no Use Non-Facility Associated Signaling (NFAS). X User level read-write Context survivable-call-engine > sig-group Example TGM550-001(sls-sig-group 100)# set associated-signaling yes set bearer-capability Use the set bearer-capability command to set the Information Transfer Rate field of the Bearer Capability IE in Standard Local Survivability (SLS). Syntax set bearer-cability bearer Issue 1 February 2007 313 CLI Commands Parameters Parameter Description Possible Values Default Value bearer 3.1kHz audio encoding Speech encoding 3khz speech speech User level read-write Context survivable-call-engine > ds1 bri Example TGM550-001 (sls-ds1-)# set bearer-capability speech TGM550-001 (sls-bri-)# set bearer-capability speech Related DS1 commands clear ds1, 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, set survivable-call-engine, show, show ds1, show survivable-call-engine, survivable-call-engine Related BRI commands bri, clear bri, 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 survivable-call-engine, set tei-assignment, show bri, show, show survivable-call-engine, survivable-call-engine set bit-rate Use the set bit-rate command to set the maximum transmission rate for the DS1 facility in Standard Local Survivability (SLS). Note: 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. 314 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax set bit-rate rate Parameters Parameter Description Possible Values Default Value rate Sets the transmission rate at 1.544 Mbps (T1) Sets the transmission rate at 2.048 Mbps (E1) 1544 2048 1544 User level read-write Context survivable-call-engine > ds1 Example TGM550-001 (sls-ds1-)# set bit-rate 2048 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 Description Possible Values value Boot bank name bank-a - set the boot bank to A bank-b - set the boot bank to B Default Value User level read-write Issue 1 February 2007 315 CLI Commands 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 set channel-numbering Use the set channel-numbering command to select the channel-numbering method for B-channels on an E1 interface in Standard Local Survivability (SLS). Syntax set channel-numbering method Parameters Parameter Description Possible Values Default Value method Sequential codes of B-channels 1-30 in the ISDN Channel Identification IE. Timeslot method. seq tslot User level read-write Context survivable-call-engine > ds1 Example TGM550-001 (sls-ds1-)# set channel-numbering seq 316 IG550 Integrated Gateway Administration and CLI Reference tslot Alphabetical listing of CLI commands set channel-preference Use the set channel-preference command to define how the Channel Identification IE field is encoded in Standard Local Survivability (SLS). Syntax set channel-preference type Parameters Parameter Description Possible Values Default Value type The central office must have the ability to grant a call on this channel or reject the call attempt. exclusive preferred The central office might offer the call request on another available channel. preferred User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# 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 Standard Local Survivability (SLS). Syntax set codeset-display codeset Issue 1 February 2007 317 CLI Commands Parameters Parameter Description Possible Values Default Value codeset The Q.931 codeset that sends display information to the user phone. codeset0 codeset6 codeset7 codeset6 User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# 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 Standard Local Survivability (SLS). Syntax set codeset-national codeset Parameters Parameter Description Possible Values Default Value codeset The Q.931 codeset that sends National IE display information to the user phone. codeset6 codeset7 codeset6 Note: Note: This value depends on the local central office switch. 318 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set codeset-national codeset6 set connect Use the set connect command to specify the equipment at the far-end of the DS1 link in Standard Local Survivability (SLS). Syntax set connect far-end Parameters Parameter Description Possible Values Default Value far-end Data application (computer or server) Terminal equipment (video multiplexer) Central office Private communication system (another pbx) host lineside network pbx network User level read-write Context survivable-call-engine > ds1 Example TGM550-001 (sls-ds1-)# set connect network Issue 1 February 2007 319 CLI Commands set cor Use the set cor command to administer the class-of-restriction values for each station that uses Standard Local Survivability (SLS). Syntax set cor cor Parameters Parameter Description Possible Values* cor The class of restriction for a station user’s dialing. emergency internal local toll unrestricted Default Value * 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.” 320 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands The following figure illustrates the relationship between the set cor value and the set type (dial-pattern) value (configured in dial-pattern context). Make sure to synchronize your choice of station cor and dial-plan type. Station Dial-Plan Emergency intra-switch calls (default) local (public-network local number call), operator, service, or hnpa (7-digit NANP call) Emergency Internal Local fnpa (10-digit NANP call) or (1 + 10-digit NAMP) or natl (non-NANP call) International, or IOP (International op) (In-Country) Toll Unrestricted and ETR User level read-write Context survivable-call-engine > station Example TGM550-001 (sls-station )# set cor unrestricted Issue 1 February 2007 321 CLI Commands set country-protocol Use the set country-protocol command to specify the ISDN Layer-3 country protocol type in Standard Local Survivability (SLS). Syntax set country-protocol country-code Parameters Parameter Description Possible Values Default Value country-code 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 Greece China Hong Kong Thailand Macedonia Poland Brazil Nordic countries South Africa ETSI (no use of RESTART message) QSIG 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 User level read-write 322 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context survivable-call-engine > ds1 bri Example TGM550-001 (sls-ds1-)# set country-protocol 2 Related DS1 commands clear ds1, set bearer-capability, set bit-rate, set channel-numbering, set connect, set interface, set interface-companding, set long-timer, set name, set protocol-version, set side, set signaling-mode, set survivable-call-engine, show, show ds1, show survivable-call-engine, survivable-call-engine Related BRI commands bri, clear bri, set bearer-capability, 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 survivable-call-engine, set tei-assignment, show bri, show, show survivable-call-engine, survivable-call-engine 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 survivable-call-engine Example TGM550-001(super-survivable-call-engine)# set date-format dd/mm/yy Date Format is dd/mm/yy Issue 1 February 2007 323 CLI Commands 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 Standard Local Survivability (SLS). Syntax set delete-digits del-number Parameters Parameter Description Possible Values Default Value del-number The number of digits to delete from the beginning of the dialed string. 0-9 0 User level read-write Context survivable-call-engine > dial-pattern Example TGM550-001(sls-dial-pattern )# set delete-digits 1 324 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Standard Local Survivability (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 Description Possible Values Default Value count 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. 0-9 0 User level read-write Context survivable-call-engine > incoming-routing Example TGM550-001(super-sls-incoming-routing )# set delete-digits 1 Issue 1 February 2007 325 CLI Commands set deny Use the set deny command to permit or deny access to an outbound trunk in Standard Local Survivability (SLS). Syntax set deny {yes | no} Note: Note: The default value is yes (access denied). User level read-write Context survivable-call-engine > dial-pattern Example To prevent a station from originating an outgoing analog loop-start trunk call: TGM550-001(sls-dial-pattern )# set deny yes Done! set dial Use the set dial command to define the method for sending outbound digits in Standard Local Survivability (SLS). Syntax set dial dial-type Parameters Parameter Description Possible Values Default Value dial-type The method to send digits toward the outbound trunk. rotary dtmf dtmf 326 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-<200>)# set dial dtmf 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 Standard Local Survivability (SLS). Note: Note: You must have executed the set digit-treatment command before this command will work. Syntax set digits digits Parameters Parameter Description Possible Values* digits The inserted dial string that is added to the start of the received DID incoming dial string. 0-9 plus * and # "" (removes digits) 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 survivable-call-engine > trunk-group Issue 1 February 2007 327 CLI Commands Examples TGM550-001 (sls-trunk-group-)# set digits 538 TGM550-001 (sls-trunk-group-)# set digits blank set digit-handling Use the set digit-handling command to define how the inbound/outbound calls handle the transmission/reception of the dialed pattern in Standard Local Survivability (SLS). Syntax set digit-handling method Parameters Parameter Description Possible Values Default Value method Enbloc requires sending the entire collected digit string in one block. Overlap sends the digits one at a time as they are collected. enbloc-enbloc enbloc-overlap overlap-enbloc overlap-overlap enbloc-enbloc User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set digit-handling enbloc-enbloc 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 Standard Local Survivability (SLS). Syntax set digit-treatment digit-treat 328 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values Default Value digit-treat The incoming digit treatment for analog DID trunks only. blank (removes digit treatment) absorb1 absorb2 absorb3 absorb4 absorb5 insert1 insert2 insert3 insert4 blank User level read-write Context survivable-call-engine > trunk-group Examples TGM550-001 (sls-trunk-group-)# set digit-treatment absorb 1 TGM550-001 (sls-trunk-group-)# set digit-treatment blank 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 Standard Local Survivability (SLS). ! Important: Important: This number must be identical to the provisioned number that the network provider has assigned to this circuit. Syntax set directory-number-a number Issue 1 February 2007 329 CLI Commands Parameters Parameter Description Possible Values number String of 1-10 digits describing the directory number to the B1 channel of the BRI interface. 0-9 Default Value User level read-write Context survivable-call-engine > bri Example TGM550-001(sls-bri )# set directory-number-a 3035381000 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 Standard Local Survivability (SLS). ! Important: Important: This number must be identical to the provisioned number that the network provider has assigned to this circuit. Syntax set directory-number-b number Parameters Parameter Description Possible Values number String of 1-10 digits describing the directory number to the B2 channel of the BRI interface. 0-9 User level read-write 330 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands Context survivable-call-engine > bri Example TGM550-001(sls-bri )# 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 Standard Local Survivability (SLS). Syntax set endpoint-init {yes | no} Note: Note: The default for this command is no. User level read-write Context survivable-call-engine > bri Example TGM550-001(sls-bri )# set endpoint-init no set expansion-module Use the set expansion-module command to administer a DCP or IP station for an expansion module in Standard Local Survivability (SLS). Syntax set expansion-module {yes | no} Issue 1 February 2007 331 CLI Commands Parameters Parameter Description yes This station can have an expansion module no This station cannot have an expansion module Possible Values Default Value X User level read-write Context survivable-call-engine > station Example TGM550-001 (sls-station )# set expansion-module yes 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: Note: 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. Syntax set etr module {auto | manual-on | manual-off} 332 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values module Module number 1-7 auto Allow the gateway to control ETR mode automatically manual-on Set ETR mode to on manual-off Set ETR mode to off Default Value User level read-write Context general Example To specify that the gateway will control ETR mode automatically on module 7: TGM550-001(super)# set etr 7 auto set fac Use the set fac command to administer the Feature Access Code for Standard Local Survivability (SLS). Note: 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. Syntax set fac feature fac Issue 1 February 2007 333 CLI Commands Parameters Parameter Description Possible Values feature The type of feature for which the FAC code applies. ars1 ars2 hold contact-open contact-close contact-pulse fac The unique, 4-digit dial-string identifier that specifies the feature. 0-9 plus “*” and “#” as leading characters only. Note: Note: Rotary-dial, analog phones do not support “*” and “#.” Default Value User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# set fac ars1 *88 Done! set incoming-dialtone Use the set incoming-dialtone command to provide a dial tone in response to far-end trunk group seizures in Standard Local Survivability (SLS): Note: Note: This command only applies to digital DS1 trunks set up for inband signaling. 334 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax set incoming-dialtone yes | no Note: ● Set this command to yes to provide a dial tone. ● Set this command to no for trunks that are not sending digits, for example, an incoming call on a loop-start central office trunk. Note: The default is no. User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set incoming-dialtone no set incoming-destination Use the set incoming-destination command to identify an extension to receive an incoming trunk call, for example, an attendant or a voice response/recording system in Standard Local Survivability (SLS). Note: Note: This command only applies to non-ISDN digital, analog loop-start, and analog ground-start trunks. Syntax set incoming-destination extension Issue 1 February 2007 335 CLI Commands Parameters Parameter Description extension 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 survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set incoming-destination 5381000 336 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands set insert-digits (dial-pattern) Use the set insert-digits command to specify the number of digits to be inserted at the beginning of the dialed string for an outbound call in Standard Local Survivability (SLS). Syntax set insert-digits digits Parameters Parameter Description Possible Values Default Value digits The number of digits to insert at the beginning of the dialed string. The number of digits is in the range 0-36. " " (no digits inserted) 0-9 plus ’*’ and ’#’ "" User level read-write Context survivable-call-engine > dial-pattern Examples ● To insert the digits "9719" to the dialed string: TGM550-001(super-sls-incoming-routing )# set insert-digits 9719 ● To remove the digit-treatment (removes data administered with set insert-digits (dial-pattern)): TGM550-001(super-sls-incoming-routing )# set insert-digits "" Issue 1 February 2007 337 CLI Commands 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 Standard Local Survivability (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 Description Possible Values Default Value digits 0-16 digits/special characters to insert at the beginning of the dialed string. " " (no digits inserted) 0-9 plus ’*’ and ’#’ "" User level read-write Context survivable-call-engine > incoming-routing Examples ● To insert the digits "9719" to the dialed string: TGM550-001(sls-dial-pattern )# set insert-digits 9719 ● To remove the digit-treatment (removes data administered with set insert-digits (incoming-routing)): TGM550-001(sls-dial-pattern )# set insert-digits "" Related commands clear incoming-routing, incoming-routing, set delete-digits, set length, set match-pattern, set survivable-call-engine, show, show incoming-routing, show survivable-call-engine, survivable-call-engine 338 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands set interface Use the set interface command to specify the glare-handling convention for a DS1 or BRI link in Standard Local Survivability (SLS). This command also determines the polarity of the ISDN Layer 2 (LAPD) protocol operation. Note: 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. Syntax set interface glare-mode Parameters Parameter Description glare-mode Non-QSIG calls: ● If the gateway is connected to a host computer and encounters glare, it overrides the far-end. ● If the gateway is connected to a public network and encounters glare, it releases the circuit. QSIG calls: ● SLS overrides the other end when glare occurs. ● SLS releases the circuit when glare occurs. Possible Values Default Value user network user peerMaster peerSlave User level read-write Context survivable-call-engine > ds1 bri Example TGM550-001 (sls-ds1-)# set interface network Issue 1 February 2007 339 CLI Commands Related DS1 commands clear ds1, set bearer-capability, set bit-rate, set channel-numbering, set connect, set country-protocol, set interface-companding, set long-timer, set name, set protocol-version, set side, set signaling-mode, set survivable-call-engine, show, show ds1, show survivable-call-engine, survivable-call-engine Related BRI commands bri, clear bri, set bearer-capability, set country-protocol, set directory-number-a, set directory-number-b, set endpoint-init, set interface-companding, set layer1-stable, set name, set side, set spid-a, set spid-b, set survivable-call-engine, set tei-assignment, show, show bri, show survivable-call-engine, survivable-call-engine 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 Description Possible Values Default Value type A-law companding U-law companding alaw ulaw ulaw User level read-write Context survivable-call-engine > ds1 bri Example TGM550-001 (sls-ds1-)# set interface-companding alaw TGM550-001 (sls-bri-)# set interface-companding alaw 340 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Related DS1 commands clear ds1, set bearer-capability, set bit-rate, set channel-numbering, set connect, set country-protocol, set interface, set long-timer, set name, set protocol-version, set side, set signaling-mode, set survivable-call-engine, show, show ds1, show survivable-call-engine, survivable-call-engine Related BRI commands bri, clear bri, set bearer-capability, set country-protocol, set directory-number-a, set directory-number-b, set endpoint-init, set interface, set layer1-stable, set name, set side, set spid-a, set spid-b, set survivable-call-engine, set tei-assignment, show bri, show, show survivable-call-engine, survivable-call-engine set ip-codec-set Use the set ip-codec-set command to configure an IP codec set within the SLS data set. Note: Note: When you use this command, silence is set to no, and the frame size is set to 20 mSec Syntax set ip-codec-set codec Parameters Parameter Description Possible Values codec Codec type g.711mu g.711a Default Value User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# set ip-codec-set g.711mu IP codec g.711mu is set Issue 1 February 2007 341 CLI Commands set japan-disconnect Use the set japan-disconnect command to perform a disconnect sequence (CONNECT message followed by a DISCONNECT message) in Standard Local Survivability (SLS). Syntax set japan-disconnect yes | no Note: Note: The default is no. User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set japan-disconnect no set layer1-stable Use the set layer1-stable command to determine whether or not to keep the physical layer active (stable) between calls in Standard Local Survivability (SLS). Some European countries, France, for example, require that the physical layer is deactivated when there is no active call. Note: Note: This command is valid only for a BRI circuit employed with ISDN Syntax set layer1-stable {yes | no} Note: Note: The default for this command is yes. User level read-write 342 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context survivable-call-engine > bri Example TGM550-001(sls-bri )# set layer1-stable no set length Use the set length command to specify the length of the dialed string in Standard Local Survivability (SLS). Syntax set length length Parameters Parameter Description Possible Values length Numeric value 1-21 digits in length 0-9 Default Value User level read-write Context survivable-call-engine > incoming-routing Example TGM550-001(super-sls-incoming-routing )# set length 7 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 | condition {all | MsgFacility} {none | severity}} Issue 1 February 2007 343 CLI Commands Parameters Parameter Description enable Enable logging to the file sink disable Disable logging to the file sink condition Define a filter rule for logging all Apply the filter condition to all MsgFacilities MsgFacility Apply the filter condition to a specific MsgFacility none Do not log messages to the file sink severity 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. Possible Values Default Value boot, snmp, cdr, voice, cli, filesys, cna_tp, config, tftp, console, threshold, 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 344 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description ip_address The IP address of the Syslog server Possible Values Default Value 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} Issue 1 February 2007 345 CLI Commands Parameters Parameter Description Possible Values Default Value read-only, read-write, admin admission_ level ip_address The IP address of the Syslog server hostname The name of the Syslog server host 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 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 346 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description all Apply this filter to all message facility systems MsgFacility Apply this filter to messages produced by a specific system none Do not log any messages severity Only log messages whose severity level is equal to or more severe than the specified level (0 is the highest severity, 7 the lowest) ip_address The IP address of the Syslog server Possible Values Default Value boot, snmp, cdr, voice, cli, filesys, cna_tp, config, tftp, console, threshold, 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 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 Issue 1 February 2007 347 CLI Commands set logging server enable/disable Use the set logging server enable/disable command to enable or disable a specific Syslog server. Syntax set logging server {enable | disable} ip_address Parameters Parameter Description enable Enable logging for the Syslog server disable Disable logging for the Syslog server ip_address The IP address of the Syslog server Possible Values 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 348 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands 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 Description Possible Values Default Value facility The facility used in Syslog reports 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) ip_address The IP address of the Syslog server User level read-write Context general Example To specify that messages for the specified Syslog server be sent to the mail output facility: TGM550-001(super)# set logging server facility mail 168.12.1.15 Issue 1 February 2007 349 CLI Commands 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 Description enable Enable logging to the console session disable Disable logging to the console session condition Define a filter rule for logging all Apply the filter condition to all MsgFacilities MsgFacility Apply the filter condition to a specific MsgFacility none Do not log messages to the console session severity Only log messages whose severity level is equal to or more severe than the specified level (0 is the highest severity, 7 the lowest) Possible Values Default Value boot, snmp, cdr, voice, cli, filesys, cna_tp, config, tftp, console, threshold, 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 350 IG550 Integrated Gateway Administration and CLI Reference 6 Alphabetical listing of CLI commands 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 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 Description Possible Values Default Value timeout Number of minutes until the system automatically disconnects an idle session. Setting the value to 0 disables the automatic disconnection of idle sessions. 0-99 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 To disable the automatic disconnection of idle sessions: TGM550-001(super)# set logout 0 Issue 1 February 2007 351 CLI Commands set long-timer Use the set long-timer command to increase the duration of the T303 (call establishment) timer in Standard Local Survivability (SLS). Syntax set long-timer yes | no Note: Note: The default is no. Parameters Parameter Description yes The T303 timer is extended from 4 seconds to 13 seconds. no The T303 timer remains at 4 seconds. User level read-write Context survivable-call-engine > ds1 Example TGM550-001 (sls-ds1-)# set long-timer yes 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 Standard Local Survivability (SLS). Syntax set match-pattern pattern 352 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values pattern Incoming alphanumeric string of 1-16 characters Default Value User level read-write Context survivable-call-engine > incoming-routing Example TGM550-001(super-sls-incoming-routing )# set match-pattern 234 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 Parameters Parameter Description Possible Values Default Value number Maximum number of IP registrations: 1-100 75 ● User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# set max-ip-registrations 10 Maximum IP Registrations is set to 10 Issue 1 February 2007 353 CLI Commands set max-length Use the set max-length command to establish the maximum length of the dialed string in Standard Local Survivability (SLS). Syntax set max-length length Parameters Parameter Description Possible Values Default Value length A numeric value equal to the maximum dialed-string value (see dial-pattern). 0-9 The number of digits set by the dial-pattern command. User level read-write Context survivable-call-engine > dial-pattern Example TGM550-001(sls-dial-pattern )# set max-length 10 354 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands set mediaserver Use the set mediaserver command to set media server management ports. Syntax set mediaserver ip_address1 ip_address2 port name Parameters Parameter Description ip_address1 Controller IP address used for registration ip_address2 Management interface IP address port Service port number name Service type Possible Values Default Value telnet, sat User level read-write Context general Example To set media 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 1 February 2007 355 CLI Commands 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: Note: The set mgc list command appends the new controllers to the existing list of controllers, if any. Syntax set mgc list {ipaddress1,…} Parameters Parameter Description ipaddress1 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 356 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands set min-length Use the set min-length command to establish the minimum length of the dialed string in Standard Local Survivability (SLS). Note: 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. Syntax set min-length length Parameters Parameter Description Possible Values Default Value length 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. 0-9 The number of digits set by the dial-pattern command. User level read-write Context survivable-call-engine > dial-pattern Example TGM550-001(sls-dial-pattern )# set min-length 7 set name Use the set name command to identify the user name for a station, a trunk group, a DS1, or ISDN facility in Standard Local Survivability (SLS). Syntax set name name Issue 1 February 2007 357 CLI Commands Parameters Parameter Description Possible Values name 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 User level read-write Context survivable-call-engine > station trunk-group ds1 bri Examples TGM550-001 TGM550-001 TGM550-001 TGM550-001 (sls-station-)# (sls-trunk-group-)# (sls-ds1-)# (sls-bri-)# set set set set name name name name Joe Smith Willow Street 2 Willow Street 2 Willow Street 2 358 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands set numbering-format Use the set numbering-format command 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. Note: Note: This command only applies to ISDN trunks and Syntax set numbering-format type Parameters Parameter Description Possible Values Default Value type Both the Numbering Plan Indicator and Type of Number are unknown. The Numbering Plan Indicator meets the E.164 standard and the Type of Number is national. unknown public public User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set numbering-format public Issue 1 February 2007 359 CLI Commands set password Use the set password command to administer a station password in Standard Local Survivability (SLS). Syntax set password password Parameters Parameter Description password A 4-8 digit numeric password. Possible Values Default Value User level read-write Context survivable-call-engine > station Example TGM550-001 (sls-station )# set password 12345 set pim-lockout Use the set pim-lockout command to prevent Provisioning and Installation Manager (PIM) updates while you are working on SLS administration or the gateway. Syntax set pim-lockout {yes | no} User level read-write Context survivable-call-engine 360 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Example TGM550-001(super-survivable-call-engine)# set pim-lockout yes set port Use the set port command to administer the virtual integrated port on a station for Standard Local Survivability (SLS). Syntax set port module-port Parameters Parameter Description Possible Values Default Value module-port The virtual integrated port assignment for the TGM50. Depends on class administered with the set type (station) command; see below Assign a port from this list: Gateway Media module Analog station ports* J4350 J6350 TGM550 3, 4 TGM514 5, 6, 7, 8 DCP IP No port assignments required * These ports cannot be previously assigned as DID trunks. User level read-write Context survivable-call-engine > station Example TGM550-001 (sls-station-)# set port v305 Issue 1 February 2007 361 CLI Commands set primary-dchannel Use the set primary-dchannel command to identify the D-channel number in Standard Local Survivability (SLS). Syntax set primary-dchannel circuit-number Parameters Parameter Description circuit-number 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 Context survivable-call-engine > sig-group Example TGM550-001(sls-sig-group 100)# set primary-dchannel 005v424 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 Standard Local Survivability (SLS). Note: Note: This command is only valid for a DS1 circuit employed with ISDN Syntax set protocol-version option 362 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Country code* Description Possible Values Default Value option Country 1 (United States) AT&T mode (also known as 5ESS) National ISDN-1 Nortel mode (also known as DMS) Telecordia (NI-2) a b c d a Country 2 (Australia) Australia National PRI ETSI invalid invalid a b c d a Country 10 (United Kingdom) DASS ETSI invalid invalid a b c d a Country 12 (France) French National PRI ETSI invalid invalid a b c d a Country 13 (Germany) German National PRI ETSI invalid invalid a b c d a ETSI Full message set, including RESTART No RESTART message invalid invalid a b c d a * The combination of the country and protocol version must match (see set country-protocol). User level read-write Context survivable-call-engine > ds1 Example TGM550-001 (sls-ds1-)# set protocol-version a Issue 1 February 2007 363 CLI Commands 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 365). Syntax set qos bearer {bbedscp | efdscp | 802p | rtpmin | rtpmax} value Parameters Parameter Description Possible Values Default Value bbedscp Keyword specifying that the following value is the BBE differentiated services code point 0-63 43 efdscp Keyword specifying that the following value is the EF differentiated services code point 0-63 46 802p Keyword specifying that the following value is the 802 priority value 0-7 6 rtpmin 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. 2048-65406 2048 rtpmax 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. 2177-65535 65535 value A value for the specified keyword User level read-write Context general Example To set the BBE differentiated services code point to 43: TGM550-001(super)# set qos bearer bbedscp 43 364 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description local Keyword that specifies to configure QoS values via the CLI remote 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 set qos rsvp 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 or disabled, refresh rate in seconds, failure retry yes or no, and service profile, guaranteed-service or controlled load service. Note: Note: The set qos rsvp command will not take effect unless QoS source setup is local. Issue 1 February 2007 365 CLI Commands Syntax set qos rsvp {enable | disable} | {refresh secs} | {failure {retry | noretry}} | {profile {guaranteed | controlled}} Parameters Parameter Description Possible Values Default Value The refresh time in seconds 1-99 15 enable disable refresh secs retry noretry guaranteed controlled User level read-write Context general Example To set the refresh rate to 15 seconds: TGM550-001(super)# set qos rsvp refresh 15 To specify no retry upon failure: TGM550-001(super)# set qos rsvp failure noretry To specify controlled load service: TGM550-001(super)# set qos rsvp profile controlled To enable RSVP: TGM550-001(super)# set qos rsvp enable 366 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description Possible Values Default Value enable Keyword that specifies to enable RTCP reporting capability disable Keyword that specifies to disable RTCP reporting capability ip-address The IP address of the monitor seconds The reporting period in seconds 5-30 5 portno The listening port number 1-65535 5005 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 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 Issue 1 February 2007 367 CLI Commands 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 Description dscp Keyword that specifies to setup DSCP parameters 802p Keyword that specifies to setup 802.1Q parameters value Parameter value Possible Values Default Value For dscp: 0-63 For 802p: 0-7 For dscp: 34 For 802p: 7 User level read-write Context general Example To set up DSCP parameter 43: TGM550-001(super)# set qos signal dscp 43 368 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands set radius authentication Use the set radius authentication command to enable or disable RADIUS authentication. Syntax set radius authentication {enable | disable} Parameters Parameter Description enable Keyword specifying to enable RADIUS authentication disable Keyword specifying to disable RADIUS authentication (default) Possible Values Default Value User level read-write Context general Example To enable RADIUS authentication: TGM550-001(super)# set radius authentication enable Issue 1 February 2007 369 CLI Commands 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 Description Possible Values number The number of times to resend an access request if there is no response 1–65535 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 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 370 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values seconds The time in seconds to wait before resending an access request 1–65535 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 Description string The text password Possible Values Default Value User level admin Context general Issue 1 February 2007 371 CLI Commands 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 Description ip_addr IP address of RADIUS authentication server primary Keyword that specifies to set the primary authentication server (default) secondary 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 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. 372 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax set radius authentication udp-port number Parameters Parameter Description number 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 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 } Parameters Parameter Description total-search Set the total search timer primary-search Set the primary search timer minutes Number of minutes transition-point Set the entry point value Possible Values Default Value 1-60 total-search: 30 primary-search: 1 1-4 1 Issue 1 February 2007 373 CLI Commands User level read-write Context general Example To set the primary search timer to 20 minutes: TGM550-001(super)# set reset-times primary-search 20 set send-name Use the set send-name command to define whether or not the calling, connected, called, or busy party’s administered name is sent to the network on outgoing or incoming calls in Standard Local Survivability (SLS). This command only applies to ISDN trunks.Syntax set send-name method Parameters Parameter Description Possible Values Default Value method The name is sent to the network for incoming or outgoing calls. The name is not sent to the network for incoming or outgoing calls. The name is sent to the network as ’Presentation restricted.’ yes no Note: 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. User level read-write 374 IG550 Integrated Gateway Administration and CLI Reference no restricted Alphabetical listing of CLI commands Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set send-name yes set send-number Use the set send-number command to define whether or not the calling, connected, called, or busy party’s administered number is sent to the network on outgoing or incoming calls in Standard Local Survivability (SLS). This command only applies to ISDN trunks.Syntax set send-number method Parameters Parameter Description Possible Values Default Value method The number is sent to the network for incoming or outgoing calls. The number is not sent to the network for incoming or outgoing calls. The number is sent to the network as ’Presentation restricted.’ yes yes no restricted User level read-write Context survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-)# set send-number yes Issue 1 February 2007 375 CLI Commands 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 Standard Local Survivability (SLS). Note: Note: This command is only valid for ISDN Syntax set side side Parameters Parameter Description Possible Values Default Value side Glare mode a b a User level read-write Context survivable-call-engine > ds1 bri Examples TGM550-001 (sls-ds1-)# set side a TGM550-001 (sls-bri-)# set side a Related DS1 commands clear 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 signaling-mode, set survivable-call-engine, show, show ds1, show survivable-call-engine, survivable-call-engine Related BRI commands bri, clear 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 spid-a, set spid-b, set survivable-call-engine, set tei-assignment, show, show bri, show survivable-call-engine, survivable-call-engine 376 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands set signaling-mode Use the set signaling-mode command to set the signaling mode for the DS1 facility in Standard Local Survivability (SLS). Note: Note: This command is only valid for DS1If 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. Syntax set signaling-mode mode-type Parameters Parameter Description Possible Values Default Value mode-type Out-of-band signaling for E1 service, yielding thirty 64kbps B-channels for voice transmission. cas idsnpri In-band signaling for T1 service, yielding twenty-four 56kbps B-channels for voice transmission. robbedbit Use this setting for either T1 or E1 ISDN Primary Rate service (supports both FAS and NFAS). idsnpri 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 isdnext User level read-write Context survivable-call-engine > ds1 Example TGM550-001 (sls-ds1-)# set signaling-mode isdnpri Issue 1 February 2007 377 CLI Commands set slot-config Use the set slot-config command to define the slot and the board type in the media gateway for Standard Local Survivability (SLS). Syntax set slot-config slot-number board-type Parameters Parameter Description slot-number Identifies the slot number board-type Defines the allowable board type Possible Values Default Value Table 5: J4350 and J6350 slot and board matrix for SLS on page 378 Table 5: J4350 and J6350 slot and board matrix for SLS J4350/J6350 Media Module Description Permitted slots SLS configured? TGM550 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). v1 (recommended), v2, v3, v4, v5, v6 Yes TIM510 One T1/E1 trunk port v1, v2, v3, v4, v5, v6 Yes TIM514 Four analog trunk ports and four analog station/DID ports v1, v2, v3, v4, v5, v6 Yes TIM521 Four BRI trunk ports (8 trunks) v1, v2, v3, v4, v5, v6 Yes User level read-write Context survivable-call-engine 378 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Example TGM550-001 (super-survivable-call-engine)# set slot-config v1 MM720 set snmp community Use the set snmp community command to set or modify the media gateway’s SNMP community strings. Syntax set snmp community read-only | read-write | trap [community_string] Parameters Parameter Description Possible Values read-only Keyword specifying the read-only access level read-write Keyword specifying the read-write access level trap Keyword specifying an SNMP trap community_string Specifies the name of the SNMP community. If no community string is specified, the community string configured for that access type is cleared. 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 Issue 1 February 2007 379 CLI Commands set snmp retries Use the set snmp retries command to set the number of times to attempt to communicate with a particular node. Syntax set snmp retries number Parameters Parameter Description Possible Values number The number of retry attempts to make 1-100000 Default Value User level read-write Context general Example To set the system to make 100 retry attempts: TGM550-001(super)# set snmp retries 100 set spid-a Use the set spid-a command to assign a Service Profile Identifier (SPID) to a North American BRI trunk in Standard Local Survivability (SLS). The trunk circuit cannot be placed in service unless the SPID initialization is successful. Syntax set spid-a spid-number 380 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values spid-number String of 1-14 digits describing the SPID (Service Profile Identifier) to the circuit. 0-9 Default Value User level read-write Context survivable-call-engine > bri Example TGM550-001(sls-bri )# 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 Standard Local Survivability (SLS). The trunk circuit cannot be placed in service unless the SPID initialization is successful. Syntax set spid-b spid-number Parameters Parameter Description Possible Values spid-number String of 1-14 digits describing the SPID (Service Profile Identifier) to the circuit. 0-9 Default Value User level read-write Context survivable-call-engine > bri Issue 1 February 2007 381 CLI Commands Example TGM550-001(sls-bri )# set spid-b 30353810041111 set supervision Use the set supervision command to define the incoming signaling supervision mode for analog DID trunks or DS1 tie trunks only in Standard Local Survivability (SLS). Syntax set supervision sup-type Parameters Group type Description Possible sup-type Values Default Value analog-did The incoming signaling supervision mode for analog DID trunks. immediate wink wink t1inband e1inband Signaling supervision for the non-ISDN digital trunks*. loop-start ground-start wink-wink wink-immediate wink-auto immediate-immediate auto-auto auto-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 Context survivable-call-engine > trunk-group Examples TGM550-001 (sls-trunk-group-)# set supervision wink TGM550-001 (sls-trunk-group-)# set supervision wink-wink 382 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands set survivable-call-engine Use the set survivable-call-engine command to enable or disable Standard Local Survivability (SLS). Note: Note: If the survivable call engine is currently running, you can issue this command to stop the SLS from operating. Syntax set survivable-call-engine {enable | disable} Parameters Parameter Description enable disable Enable SLS Disable SLS Possible Values Default Value User level read-write Context general Example TGM550-001(super-survivable-call-engine)# set survivable-call-engine enable Survivable Call Engine is enabled set swhook-flash Use the set swhook-flash command to enable Standard Local Survivability (SLS) to recognize the switchhook flash signal from a particular analog station and to provide subsequent transfer service. Note: Note: This command is valid only when the station type is analog2500. Syntax set swhook-flash {yes | no} Issue 1 February 2007 383 CLI Commands Parameters Parameter Description Possible Values Default Value yes SLS recognizes the switchhook signal and transfers the call. X (analog phones only) no SLS does not recognize the switchhook signal and transfers the call. X (IP and DCP phones only) User level read-write Context survivable-call-engine > station Example TGM550-001 (sls-station )# set swhook-flash yes 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 Description primary Keyword that specifies normal failover secondary Keyword that specifies to override normal failover, generate a trap, and assert a fault 384 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Parameter Description mmID The Media Module ID number of a stratum clock source, of the form “vn” where “n” is the slot number portID Port or port range for an ISDN clock source candidate Possible Values Default Value 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} Parameters Parameter Description primary Keyword specifying to set the primary clock source to be active secondary Keyword specifying to set the secondary clock source to be active, and the primary clock source on standby local Keyword specifying to set the local clock to be active Possible Values Default Value Issue 1 February 2007 385 CLI Commands 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 sync source switching. Syntax set sync switching {enable | disable} Parameters Parameter Description enable Enable automatic sync source switching disable Disable automatic sync source switching User level read-write Context general Example To enable sync source switching: TGM550-001(super)# set sync switching enable 386 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands 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 Description string 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 descriptive contact of the system to “Larry Williams” TGM550-001# set system contact “Larry Williams” *** Set system contact *** system contact set Issue 1 February 2007 387 CLI Commands 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 Description string The location name string should be typed inside double quotes. The location is cleared if you leave this field blank. User level read-write Context general Example To set the descriptive location of the system to “tech-support”: TGM550-001# set system location “tech-support” *** Set system location *** system location set 388 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands set system name Use the set system name command to specify the name of the media gateway system. Note: 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). Syntax set system name [string] Parameters Parameter Description Possible Values string The system name string should be typed inside quotes. The name is cleared if you leave this field blank. Default Value User level read-write Context general Examples To set the descriptive name of the system to “TGM550-HQ”: TGM550-001(super)# set system name “TGM550-HQ” *** Set system name *** system name set Issue 1 February 2007 389 CLI Commands set tac Use the set tac command to administer the trunk-access codes for Standard Local Survivability (SLS). You must issue this command before the trunk group is enabled in the SLS database. Syntax set tac tac Parameters Parameter Description Possible Values tac Unique dial string identifies the trunk group (circumvents normal Automatic Route System dial string analysis). * 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 survivable-call-engine > trunk-group Example TGM550-001 (sls-trunk-group-<200>)# set tac 88 390 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Standard Local Survivability (SLS). Note: Note: This command is valid only for a BRI circuit employed with ISDN Syntax set tei-assignment tei Parameters Parameter Description Possible Values Default Value tei TEI is assigned by the network provider. TEI is fixed. auto zero auto User level read-write Context survivable-call-engine > bri Example TGM550-001(sls-bri )# set tei-assignment auto Issue 1 February 2007 391 CLI Commands set terminal recovery password Use the set terminal recovery password command to enable or disable the recovery password. Note: Note: This command can only be issued via the console port (not via a modem port). Syntax set terminal recovery password action Parameters Parameter Description Possible Values action The state of the recovery password enable, disable Default Value User level admin Context general Example To disable the recovery password: TGM550-001(super)# set terminal recovery password disable set tgnum Use the set tgnum command to designate the trunk-group number in Standard Local Survivability (SLS). Syntax set tgnum tgnum 392 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values tgnum The trunk group number 1-2000 Default Value User level read-write Context survivable-call-engine > dial-pattern Example TGM550-001(sls-dial-pattern )# set tgnum 99 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 queuing in Standard Local Survivability (SLS). Note: Note: This command does not apply to analog DID trunks. Syntax set trunk-destination {yes | no} Parameters Parameter Description yes This extension can receive incoming analog loop-start trunk calls as part of the station pool which is available in a circular queuing fashion across the first available idle station no This extension cannot receive incoming analog loop-start trunk calls as part of the station pool which is available Possible Values Default Value Issue 1 February 2007 393 CLI Commands User level read-write Context survivable-call-engine > station Example TGM550-001 (sls-station )# set trunk-destination yes 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 Standard Local Survivability (SLS). Syntax set trunk-hunt type Parameters Parameter Description Possible Values Default Value type A linear search from the lowest to the highest numbered available channels. ascend 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. cyclical A linear search from the highest to the lowest numbered available channels. descend User level read-write Context survivable-call-engine > trunk-group 394 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Example TGM550-001 (sls-trunk-group-)# set trunk-hunt cyclical 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 Standard Local Survivability (SLS). Syntax set trunk-group-chan-select tgnum Parameters Parameter Description Possible Values tgnum Trunk group number 1-2000 Default Value User level read-write Context survivable-call-engine > sig-group Example TGM550-001(sls-sig-group 100)# set trunk-group-chan-select 99 set type (station) Use the set type command to administer specific phone models for Standard Local Survivability (SLS). Syntax set type model Issue 1 February 2007 395 CLI Commands Parameters Parameter Description Possible Values Default Value model Model type Analog IP analog 2500 ip4601 ip4602 ip4602sw ip4606 ip4610sw ip4612 ip4620 ip4620sw ip4624 ip4621 ip4622 ip4625 User level read-write Context survivable-call-engine > station Example TGM550-001 (sls-station )# set type ip4625 set type (dial-pattern) Use the set type command to administer the type of outbound call in Standard Local Survivability (SLS). The SLS call-engine uses the dial pattern as part of its ARS routing for outbound trunk calls. Syntax set type dial-type 396 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values dial-type Emergency call 10-digit North American Numbering Plan (NANP) call 7-digit NANP call Public-network international number call International operator call Public-network local number call Non-NANP call Operator assisted call Service call emer fnpa hnpa intl iop locl natl op svc Default Value The following figure illustrates the relationship between the dial-type value and the set cor value (configured in station context). Make sure to synchronize your choice of station cor and dial-plan type. Station Dial-Plan Emergency intra-switch calls (default) local (public-network local number call), operator, service, or hnpa (7-digit NANP call) Emergency Internal Local fnpa (10-digit NANP call) or (1 + 10-digit NAMP) or natl (non-NANP call) International, or IOP (International op) (In-Country) Toll Unrestricted and ETR User level read-write Issue 1 February 2007 397 CLI Commands Context survivable-call-engine > dial-pattern Example TGM550-001(sls-dial-pattern )# set type locl set utilization cpu Use the set utilization cpu command to enable CPU utilization measurements. Syntax set utilization cpu module Parameters Parameter Description module Number of the module User level read-write Context general Example To enable CPU utilization measurements on module 10: TGM550-001# set utilization cpu 10 CPU utilization is set on module 10 398 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands show Use the show command to list all of the subcontext parameters for Standard Local Survivability (SLS). The command works in the following second-level subcontexts under the survivable-call-engine context: ● station ● trunk-group ● ds1 ● sig-group ● bri ● dial-pattern ● incoming-routing Syntax show User level read-write Context survivable-call-engine > station trunk-group ds1 sig-group bri dial-pattern incoming-routing Examples ● In the station context: TGM550-001 (sls-station )# 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. Issue 1 February 2007 399 CLI Commands Output fields - station context ● Field Description Extension The extension number of the phone (1-13 digits). Type The telephone model. Port The module/port location. Cor Class of restriction assigned to the station, which determines the range of dialling 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. Trk-Des Whether or not to permit the station to receive incoming analog loop-start trunk calls in circular queuing. Exp-Mod 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. In the trunk-group context there are two examples. - The first example shows four BRI trunks assigned to one trunk-group: 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 Supervision Treat Insert ------------------- ------- ------ Digit Handling --------------enbloc-enbloc Japan Discon -----no Send Name ---yes Send Number -----yes Number Format -----public Trunk Hunt -------ascend - The second example shows twelve ports assigned as T1inband signalling: Group Type Dial Tac Supervision Treat Insert ----- ---------- ------ ---- ------------------- ------- -----1 t1inband dtmf *96 wink/immediate - 400 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Output fields - trunk-group context ● DS1 Field Description Group The trunk group index. Type The trunk group type. Possible values: ● loop-start (analog loopstart) ● did (analog DID) Dial The method for sending outbound digits. Possible values: ● rotary ● dtmf Tac The trunk-access code - a unique dial string that identifies the trunk group. Ports The virtual integrated port assignment. Supervision The incoming signaling supervision mode for analog DID trunks only. Possible values: ● immediate ● wink Treat The incoming digit treatment for analog DID trunks only. Insert The dial string that is added to the start of the received DID incoming dial string. Incoming Dest The extension to receive an incoming trunk call. Incoming-Dial Whether a dial tone is set in response to far-end trunk group seizures. Trunk-Hunt The trunk-hunting search within a facility in an ISDN trunk group or through a non-ISDN digital trunk group. Possible value: ● ascend ● cyclical ● descend In the ds1 context: Name = ‘Willow Steet 2’ Rate Signaling Channel Connect Interface Side Protocol Ver Bearer Cmpd Ltm Issue 1 February 2007 401 CLI Commands ---- ---- --------- ------- ------- --------- ---- -------- --- ------ ---- --v4 1544 isdnpri seq network user a country1 a speech ulaw no Output fields - ds1 context Field Description DS1 The physical module address on the gateway. Rate The maximum transmission rate for the DS1 facility. Possible values: ● 1.544 Mbps (T1) ● 2.048 Mbps (E1) Signaling The signaling mode for the DS1 facility. Possible values: ● cas ● robbedbit ● idsnpri ● isdnext Channel 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) Connect 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) Interface 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) Side 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 Protocol The ISDN Layer-3 country protocol type. 1 of 2 402 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Field Description Ver The protocol version, for countries whose public networks allow for multiple ISDN Layer-3 country protocols for ISDN Primary Rate service. Bearer The Information Transfer Rate field of the Bearer Capability IE. Possible values: ● 3khz (3.1kHz audio encoding) ● speech (speech encoding) Cmpd The far-end companding method. Possible values: ● alaw (A-law companding) ● ulaw (U-law companding) Ltm 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) 2 of 2 ● In the sig-group context: Sig-group Tg-Select Assoc-Sig Prime-Dchan Nfas-Modules/Nfas-Id --------- --------- --------- ----------- ------------------------------------10 98 yes 005v424 - Output fields - sig-group context Field Description Sig-group Signaling group number Tg-Select 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. Assoc-Sig Whether the D-channel is physically present in the DS1 interface. Prime-Dchan The D-channel number. Nfas-Modules / Nfas-Id The DS1 modules that are controlled by the primary D-channel. The DS1 circuit number that is associated with the NFAS group. Issue 1 February 2007 403 CLI Commands ● In the bri context: 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 - bri context Field Description BRI The physical module address. Interface 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) Sid 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 Country The ISDN Layer-3 country protocol type. Bearer The Information Transfer Rate field of the Bearer Capability IE. Possible values: ● 3khz (3.1kHz audio encoding) ● speech (speech encoding) Compand The far-end companding method. Possible values: ● alaw (A-law companding) ● ulaw (U-law companding) TEI 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) Endpt-Init Whether or not the far-end supports endpoint initialization. 1 of 2 404 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Field Description Layer1-Stable Whether or not to keep the physical layer active (stable) between calls. Dir-NumberA The directory number to the B1 channel of the BRI interface. Dir-NumberB The directory number to the B2 channel of the BRI interface. Spid-A The Service Profile Identifier (SPID) to a North American BRI trunk. Spid-B The Service Profile Identifier (SPID) to a North American BRI trunk. 2 of 2 ● In the dial-pattern context: Dialed-String/Deny Min/Max Type Trunk Delete/Insert Length Group Digits ------------------ ------- ---- ----- -----------------------------------95381000/n 9/9 locl 2 1/303 Output fields - dial-pattern context Field Description Dialed-String/Deny The administered ARS dial string and whether the call should be permitted (no) or denied (yes). Min/Max Length The minimum and maximum number of digits in the dial string. Type 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 Trunk group The trunk-group number. Delete/Insert Digits The number of digits to add or remove from a dialed string Issue 1 February 2007 405 CLI Commands ● In the incoming-routing context: Match-pattern Length Del Insert-Digits Mode tgnum ------------------ ------ --- ------------------ ------- ----234 7 3 5381000 enbloc 99 Output fields - incoming-routing context Field Description Match-pattern The beginning digit pattern of the incoming alphanumeric dial string to be matched. Length The length of the dialed string. Del The number of digits to be deleted from the beginning of the dialed string for an inbound trunk call. Insert-Digits The number of digits to be inserted from the beginning of the dialed string for an inbound trunk call. Mode 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} tgnum The ISDN (t1isdn or e1isdn) trunk group number. 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 Description brief Displays less detail 406 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands User level Read only Context general 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 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 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 Issue 1 February 2007 407 CLI Commands Example TGM550-001(super)# show application-memory Application ---------------------------------------Sniffer (capture buffer-size) TFTP (ip tftp-server file-system-size) ---------------------------------------Total used memory Total free memory Memory(KB) Allocated Configured --------------------1024 1024 18560 18560 --------------------19584 19584 896 896 Total memory (fixed) 20480 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 TGM550-001(super)# show login authentication Authentication File (AF) information: AF-ID :7000012345 Date/time : 15:02:27 27-SEP-2005 Major release : 4 show backup status Use the show backup status command to display status information regarding the restoration of a configuration file. 408 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 show banner login Use the show banner login command to display the banner that is displayed before the login prompt. Syntax show banner login User level admin Context general Example To display the banner that will be displayed before the login prompt: TGM550-001(super)# show banner login Welcome to TGM550 Media Gateway FW version 0.11.0 Issue 1 February 2007 409 CLI Commands show banner post-login Use the show banner post-login command to display the banner displayed after a user logs in successfully. Syntax show banner post-login User level admin Context general Example To display the banner that will be shown 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 show bri Use the show bri command to list the administered BRI parameters for Standard Local Survivability (SLS). Syntax show bri list Parameters Parameter Description Possible Values Default Value list Lists all administered BRI channels. Lists only the parameters for a single BRI circuit. all port-address all User level read-write 410 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context survivable-call-engine Example 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 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 Issue 1 February 2007 411 CLI Commands 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 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 412 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Output fields Name Description test plug 1 is... The status of the test plug service. Possible values are: test-plug status ● 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. 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 The IP address of the test plug interface. bind to PMI States that the PMI is the test plug’s IP address. ID The MAC address of the TGM550, used to identify the test plug. Scheduler list The list of up to five IP addresses of schedulers with which the test plug can attempt to register. Ports: Issue 1 February 2007 413 CLI Commands Name Description Control The control port number. The UDP port on which the CNA test plug listens for test requests from the current scheduler. RTP-test The UDP port from which the CNA test plug send RTP streams to another test plug when running an RTP test. RTP-echo 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. Test rate limiter The configuration of the CNA test rate limiter. Last Test 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 The results of the last test run. Test The types of tests. Count The number of tests of each type that was run since the test plug was up. Failed The number of tests of each type that failed. Cancelled The number of tests of each type that was cancelled. 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 User level read-write 414 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context general Example To display the status of the current copy operation: TGM550-001(super)# show copy status Module #10 =========== Module Source file Destination file Host Running state Failure display Last warning : : : : : : : 10 startup-config running-config Idle (null) No-warning 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 Description mmID The Media Module ID Possible Values Default Value User level read-only Context general Issue 1 February 2007 415 CLI Commands Example To view the state of loopbacks on Module v2: TGM550-001(super)#show csu loopbacks v2 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 Description mmID 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:ON00F:OFF EER:OFFL00PD:OFF 416 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands AIS:OFFPDV:OFF LOF:OFFYEL:ON E1 version of csu status: CSU NETWORK INTERFACE STATUS -----------------------------------------------------------------LOS:ON00F:OFF EER:OFFL00PD:OFF AIS:OFFPDV:OFF LOF:OFFLMA:OFF RMA:OFFLCM:ON Output fields Name Description LOS Loss of signal OOF Out of frame EER Excessive error rate LOF Loss of frame AIS Alarm indication signal YEL Yellow PDV Pulse density violation (same as BPV) LOOPD Looped LMA Local multiframe alignment RMA Remote multiframe alignment LCM Loss of CRC multiframe 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 Issue 1 February 2007 417 CLI Commands Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show date-format Date Format is mm/dd/yy show dev log file Use the show dev log file command to display the encrypted device’s log file. Syntax show dev log file User level read-write Context general 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 Description Possible Values Default Value list Lists all administered dial patterns Lists only the parameters for a specific dialed string List starts with the specific dialed string + “n” entries all dialed-string all 418 IG550 Integrated Gateway Administration and CLI Reference dialed-string + n Alphabetical listing of CLI commands User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show dial-pattern all Dialed-String/Deny Min/Max Type Trunk Delete/Insert Length Group Digits ------------------ ------- ---- ----- -----------------------------------95381000/n 9/9 locl 2 1/303 95350000/n 9/9 locl 3 1/720 Output fields Field Description Dialed-String/Deny The administered ARS dial string and whether the call should be permitted (no) or denied (yes). Min/Max Length The minimum and maximum number of digits in the dial string. Type 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. Delete/Insert Digits The number of digits to add or remove from a dialed string 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. Issue 1 February 2007 419 CLI Commands Syntax show download announcement-file status User level read-only Context general Example In the following 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 the following 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 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 Context general 420 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Example TGM550-001(super)# show download auth-file status Module #10 =========== Module Source file Destination file Host Running state Failure display Last warning Bytes Downloaded : : : : : : : : 10 AF-7000003277-060926-211040.xml auth-file 149.49.71.50 Idle (null) No-warning 1242 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 Example TGM550-001(super)# show download phone-image-file status Module #10 =========== Module Source file Destination file Host Running state Failure display Last warning Bytes Downloaded : : : : : : : : 10 start phone-ImageA 135.64.102.64 Idle (null) No-warning 7825 Issue 1 February 2007 421 CLI Commands 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 ● 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 Module #10 =========== Module Source file Destination file Host Running state Failure display Last warning Bytes Downloaded download phone-script-file status : : : : : : : : 10 /home/p46xx-script phone-ScriptA 135.64.103.116 Idle (null) No-warning 27 422 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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] Parameters Parameter Description Possible Values module_number The number of the module for which to display information 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 Issue 1 February 2007 423 CLI Commands 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 Description Possible Values module_number The number of the module for which to display information 1-10 Default Value User level read-only Context general Example To display the status of a configuration file download for module 10: TGM550-001(super)# show download status 10 show ds1 Use the show ds1 command to list the administered DS1 parameters for Standard Local Survivability (SLS). Syntax show ds1 list 424 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values Default Value list Lists all administered DS1 channels. Lists only the parameters for a single DS1 channel. all port-address all User level read-write Context survivable-call-engine Example 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 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 Issue 1 February 2007 425 CLI Commands Example TGM550-001(super)# show dynamic-cac Current RBBL : 256 kbps event : 0 Days, 1:21:00 Last event BBL : 256 kbps 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 etr Use the show etr command to view the status of Emergency Transfer Relay (ETR) mode. Note: Note: In ETR mode, the TRK and LINE 1 ports are connected. All other telephone ports stop operating. Syntax show etr User level read-only Context general 426 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 show extension Use the show extension command to display extension-specific SLS data parameters. Note: Note: It is preferable to use the show station command. Syntax show extension list Parameters Parameter Description Possible Values list Lists all administered extensions Lists only the numbered extension Lists the numbered extension + “n” entries all extension extension + n Default Value User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show extension list 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 ****** Issue 1 February 2007 427 CLI Commands 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 Description Extension The extension number of the phone (1-13 digits). Type The station type. Port The module/port location. Cor The Class of Restriction. Possible classes include: ● emergency ● internal ● local ● toll ● unrestricted Trunk-Des Indicates whether to permit (y) or deny (n) the call. Exp-Mod 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. Password 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. show fac Use the show fac command to list the administered Feature Access Codes for Standard Local Survivability (SLS). Syntax show fac User level read-write 428 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show fac Feature Access Code ------------- ----------contact-pulse *84 contact-close *85 contact-open *86 hold *87 ars1 *88 ars2 *89 Done! 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 Issue 1 February 2007 429 CLI Commands show fragment Use the show fragment command to display information about IP packets that are passing from or to the router. Note: Note: No IP reassembly is performed on packets in transit through the router. 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 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 430 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context general Example To display the current software versions: TGM550-001(super)# show image version Bank ----------A (current) B Version ------26.23.0 26.22.0 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 1 February 2007 431 CLI Commands Parameters Parameter Description Possible Values interface_type The type of interface DIaler, FastEthernet, Serial, Vlan, Loopback, Console, Tunnel, USB 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 For FastEthernet: 10/2 For Serial(USP): 2/1 For Serial (DS1): module/port: 2/1 channel-group: E1: 0-30 T1: 0-23 For VLAN: 1-3071 For Loopback: 1-99 For Tunnel: 1-50 For Dialer: 1 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 432 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands 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 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 Issue 1 February 2007 433 CLI Commands 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 incoming-routing Use the show incoming-routing command to show all of the administered dial patterns in Standard Local Survivability (SLS). Syntax show incoming-routing list Parameters Parameter Description Possible Values list Lists all administered dial patterns Lists the dial pattern parameters for a single trunk group Lists the dial pattern parameters starting with a specific trunk group for a total of "n" entries. all tgnum tgnum +n User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show incoming-routing Match-pattern Length Del Insert-Digits Mode tgnum ------------------ ------ --- ------------------ ------- ----234 7 3 5381000 enbloc 99 235 7 3 5381001 enbloc 98 434 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands show ip-codec-set Use the show ip-codec-set command to list the codec set entries for Standard Local Survivability (SLS). Syntax show ip codec-set User level read-only Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show ip-codec-set Ip codec g.711 mu, priority 1, frames 2 Output fields Field Description IP codec The administered codec type (g.711mu or g.711a) Priority The numeric priority of the codec. SLS supports a single priority level (designated as "priority 1"). Frames 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 ip icmp Use the show ip icmp command to display the status of ICMP error messages. Syntax show ip icmp User level read-only Issue 1 February 2007 435 CLI Commands Context general Example To display ICMP error message status: TGM550-001(super)# show ip icmp ICMP error messages status is ENABLE 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] Parameters Note: Parameter Description interface_name The name of the interface whose information you want to display ip_interface The name of the IP interface whose information you want to display ip_address The IP address of the interface whose information you want to display Possible Values Default Value string (1-32 chars) 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 436 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Examples 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 will appear: Internet address will be negotiated using IPCP, or Address determined by IPCP. If DHCP client was configured on the interface, the following will appear: Internet address will be negotiated using DHCP, or Address determined by DHCP. Header compression output fields If header compression was enabled on the interface, one of the following header compression status messages appears: Status message Meaning RTP/IP header compression is enabled and not compressing RTP header compression was enabled on this interface, but is not actively compressing. This can be caused by failure to negotiate. RTP /IP header compression is Enabled and compressing RTP header compression was enabled on this interface, and is functioning properly. RTP /IP header compression is disabled RTP header compression is disabled (default). TCP/IP header compression is enabled and not compressing VJ header compression was enabled on this interface, but is not actively compressing. This can be caused by failure to negotiate. TCP/IP header compression is Enabled and compressing Header compression was enabled on this interface, and is functioning properly. TCP/IP header compression is disabled VJ header compression is disabled (default). Issue 1 February 2007 437 CLI Commands 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 Note: Parameter Description interface_name The name of the interface whose information you want to display ip_interface The name of the IP interface whose information you want to display ip_address The IP address of the interface whose information you want to display Possible Values Default Value string (1-32 chars) 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 Examples In the following 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 438 IG550 Integrated Gateway Administration and CLI Reference Status -----------up Alphabetical listing of CLI commands 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 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 Description Max Sessions The maximum number of concurrent sessions Key type The type of SSH key (always DSA) and the key length Listen Port The SSH server listening port (always 22) Ciphers List List of supported ciphers Session Session ID of each currently active session Version The version of the SSH protocol used by the session Encryption The encryption method used by the session Username The name of the user that initiated the session IP/Port The IP address and port number of the client Issue 1 February 2007 439 CLI Commands 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 TGM550-001(super)# File ---------46xxupgrade.txt 46xxsettings.txt 4602dbte1_8.bin 4602dape1_8.bin show ip tftp-server files Bank Location ------------- ---------phone-scriptA Nv-Ram phone-scriptB Nv-Ram phone-imageA Ram phone-imageD Ram Nv-Ram: Total bytes used: Total bytes free: Total bytes capacity (fixed): Ram: Total Total Total Total bytes bytes bytes bytes 20480 110592 131072 used: 3166208 free: 2076672 capacity (Allocated) 3166208 capacity (Configured)5242880 440 IG550 Integrated Gateway Administration and CLI Reference Size (bytes) -------------4096 16384 1048576 2097152 Alphabetical listing of CLI commands 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: 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. Syntax show ip tftp-server statistics User level read only Context general Example To display TFTP server statistics: TGM550-001(super)# show ip tftp-server statistics Counter Value ----------------------------------------------File downloads (OK) 0 File download Timeouts 0 Total TFTP server errors 0 Non defined TFTP errors 0 File not found errors 0 Access violation errors 0 Illegal TFTP operation errors 0 Output fields Name Description File downloads (OK) The number of successful downloads File download Timeouts The number of timeouts that occurred during download operations Total TFTP server errors The total number of download/upload errors Issue 1 February 2007 441 CLI Commands Name Description Non defined TFTP errors The number of undefined errors File not found errors The number of file not found errors Access violation 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 Illegal TFTP operation errors The number of illegal TFTP operation errors show ip traffic Use the show ip traffic command to display IP counters information. Syntax show ip traffic [protocol_type] Parameters Parameter Description Possible Values protocol_type The type of IP protocol for which to display information arp, bootp-dhcp, icmp, ip, ospf 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 442 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands 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: 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 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 Sent: 0 total ARP statistics: Received: 5394 requests, 2 replies Sent: 36 requests, 16 replies (0 proxy) DHCP statistics: Issue 1 February 2007 443 CLI Commands Requests: 0 , Replies: 0 BOOTP statistics: Requests: 0 , Replies: 0 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 Description Possible Values mmID The Media Module ID 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 LOCATION TYPE LINK ID --------- ------- ---------v1 NO LINK N/A bri link 1 DLCI SIDE STATE ---------- ----- -----------N/A N/A N/A show isdn link summary Use the show isdn link summary command to view a summary of all ISDN links. Syntax show isdn link summary 444 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description mmID The Media Module ID Possible Values Default Value User level read-only Context general Issue 1 February 2007 445 CLI Commands 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 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. Syntax show last-pim-update User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show last-pim-update Last PIM update occured at 15:47:0 on 2/28/2005 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 446 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context general 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 Facility ! 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. Syntax show logging file content [severity] [all|Msgfacility] [number] Parameters Parameter Description severity Minimal severity of messages to be displayed all Keyword specifying to display messages from all facilities Msgfacility Display messages from this facility only number Maximum number of messages to display Possible Values Default Value User level read-only Issue 1 February 2007 447 CLI Commands Context general 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: = super, Protocol CLI-Notification: root: exit root: exit root: ip Unauthorized Access from IP address = 0.0.0.0, User = 23 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 Description ip_address The IP address of the Syslog server hostname The name of the Syslog server host User level read-only Context general 448 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands 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 Facility ------------System Severity Override ----------------------Critical Syslog server 222.222.222.222 Logging: enabled Logging severity: Debug Facility ------------Kernel Severity Override ----------------------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 ------------System Severity Override ----------------------Critical Issue 1 February 2007 449 CLI Commands 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 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 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 450 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Example To display the timeout value: TGM550-001(super)# show logout CLI timeout is 15 minutes 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 survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show max-ip-registrations Maximum IP Registrations is 12 show mediaserver Use the show mediaserver command to show media server configuration information. Syntax show mediaserver User level read-only Context general Issue 1 February 2007 451 CLI Commands Example To display media 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 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 456. Syntax show mg list_config User level read-only Context general Example To display the list of installed equipment: TGM550-001(super)# show mg list_config SLOT ---v0 v1 v2 v3 v4 v5 v6 TYPE CODE SUFFIX ------ ------ -----TGM550 A -- Not Installed --- Not Installed --- Not Installed --- Not Installed --- Not Installed --- Not Installed -- HW VINTAGE ---------0 FW VINTAGE ----------26.21.0(A) 452 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 -- Issue 1 February 2007 453 CLI Commands show mgc list Use the show mgc list command to display the list of available Media Gateway Controllers and their IP addresses. On the TGM550, 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: survivable-call-engine If SLS is disabled, the following message appears at the end of the MGC list: survivable-call-engine 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 -The following example shows output for the show mgc list command in the TGM550: TGM550-001(super)# show mgc list CONFIGURED MGC HOST --------------------135.8.48.220 135.34.54.2 149.49.70.230 -- Not Available -survivable-call-engine 454 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Output fields Field Description CONFIGURED MGC HOST 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--) is not used on the TGM550. ● The fifth element is either: - survivable-call-engine — SLS is enabled. - survivable-call-engine disabled — SLS is disabled. 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 Description mmID The Media Module ID number Possible Values Default Value User level read-only Context general Issue 1 February 2007 455 CLI Commands Example To display information about media module 7: TGM550-001(super)# show mm 7 MEDIA MODULE DESCRIPTION: v7 ------------------------------------------------Uptime(d,h:m:s): Type : Description : Serial Number : HW Vintage : HW Suffix : FW Version : No. of ports : Faults : 0, 00:23:19 Voice (Initializing) N/A N/A N/A N/A N/A 0 No Fault Messages show module Use the show module command to view information about a Media Module. To view information about all Media Modules, do not specify a Media Module. Syntax show module [mmID] Parameters Parameter Description mmID The Media Module ID User level read-only Context general 456 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Example To show information about media module 3: TGM550-001(super)# show module v3 SLOT TYPE CODE SUFFIX HW VINTAGE FW VINTAGE ---- -------- ---------- ------ ---------- ----------- v3 Analog A 0 N/A SUFFIX HW VINTAGE FW VINTAGE (on-board) To show information about all media modules: SLOT TYPE CODE ---- -------- ---------- ------ ---------- ----------- v0 TGM550 A 0 26.21.0(A) v1 Analog TIM514 A 0 0 v2 E1T1 TIM510 A 2 0 v3 Analog (on-board) A 0 N/A v4 BRI TIM521 A 0 0 v5 -- Not Installed -- v6 -- Not Installed -- 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 survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show pim-lockout PIM lockout = yes Issue 1 February 2007 457 CLI Commands show port classification Use the show port classification command to display a port’s classification. If no port is specified, information for all ports is displayed. Syntax show port classification [module/[port]] Parameters Parameter Description module Number of the module port Number of the port on the module. You can also specify a range of ports separated by a dash, for example, 4/5-13 for ports 5 to 13 on module 4. User level read-only Context general Example To display information for port 8 of module 4 on the TGM550: TGM550-001(super)# show port classification 4/8 Port Port Classification ------ --------------------4/8 regular 458 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands 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] Parameters Parameter Description Possible Values ssh Keyword indicating to display the status of the ssh protocol telnet-client Keyword indicating to display the status of the telnet-client protocol ssh-client Keyword indicating to display the status of the ssh-client protocol snmp Keyword indicating to display the status of the SNMP protocol telnet Keyword indicating to display the status of the telnet protocol scp Keyword indicating to display the status of the scp protocol recovery-password Keyword indicating to display the status of the recovery-password protocol ftp-client Keyword indicating to display the status of the ftp-client protocol tftp Keyword indicating to display the status of the tftp protocol Default Value User level admin Context general Issue 1 February 2007 459 CLI Commands 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 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 and RTCP information: TGM550-001(super)# show qos-rtcp PARAMETERS IN EFFECT: -- Downloaded -QOS PARAMETERS -------------------Signal 802 Priority: Signal DSCP : Bearer 802 Priority: Bearer BBE DSCP : LOCALLY SET --------------7 34 6 43 460 IG550 Integrated Gateway Administration and CLI Reference DOWNLOADED --------------0 0 6 43 Alphabetical listing of CLI commands Bearer EF DSCP Minimum RTP Port Maximum RTP Port : : : 46 3 65535 46 2048 65535 RSVP PARAMETERS -------------------State : Retry on Failure : Retry Delay(secs) : Service Profile : LOCALLY SET --------------Enabled Yes 15 Guaranteed DOWNLOADED --------------Disabled Yes 15 Guaranteed 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 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 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 Issue 1 February 2007 461 CLI Commands 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 462 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 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 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 1 February 2007 463 CLI Commands 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 current 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 151. 464 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 Description session-id The index of a specific RTP session 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: [email protected] 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 Issue 1 February 2007 465 CLI Commands 0mS #0, Avg-Jitter 0mS, TTL(last/min/max) 63/63/63, Duplicates 0, Seq-Fall 0, DS 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 151. 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. 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 Description active Displays only active sessions active-events Displays only active sessions experiencing bad QoS conditions history Displays only terminated sessions events Displays only terminated sessions that experienced bad QoS conditions destination-ip Displays only sessions to this destination subnet remote-subnet The destination subnet 466 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Parameter Description Possible Values remote-subnet-mask The destination subnet mask host Displays only sessions to this specific address rem-addr The specific IP address last Displays only the last N entries in the history last-N The number of entries in the history to display Default Value User level read only Context General 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 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 Issue 1 February 2007 467 CLI Commands 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 * * * * * * * 2004-10-18,11:54:01 2004-10-18,11:54:02 2004-10-18,13:43:18 2004-10-18,13:56:57 2004-10-19,17:24:00 2004-10-19,17:29:06 2004-10-20,10:51:36 2004-10-20,10:53:42 2004-10-20,10:58:21 2004-10-20,11:08:40 2004-10-20,11:09:07 11:55:27 11:55:27 13:54:53 08:40:39 17:28:10 09:04:04 10:59:07 10:57:36 10:59:06 - G723 G729 G723 G723 G711A G723 G729 G723 G723 G729 G723 135.8.76.13 135.8.76.62 135.8.76.107 135.8.76.107 135.8.76.107 135.8.76.107 135.8.76.64 135.8.76.107 135.8.76.107 135.8.76.64 135.8.76.107 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 00032 00033 00034 00035 Note: * * * 2004-10-20,10:51:36 10:59:07 G729 2004-10-20,10:53:42 10:57:36 G723 2004-10-20,10:58:21 10:59:06 G723 2004-10-20,11:08:40 - G729 2004-10-20,11:09:07 - G723 135.8.76.64 135.8.76.107 135.8.76.107 135.8.76.64 135.8.76.107 Note: For an explanation of the output fields, see the explanations in Chapter 10: Configuring monitoring applications on page 151. 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 The following summary shows two active sessions, one with QoS problems (35): TGM550-001(super)# show rtp-stat summary Total QoS traps: 23 QoS traps Drop : 0 468 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Qos Fault Engine ID Description --- -------------000 internal Note: Uptime ----------04,18:15:15 Active Session ------2/1 Total Session ------35/24 Mean Duration -------01:04:44 Tx TTL ---64 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 151. 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 Threshold ------------6.0% 3.0% 700mS 0dB 6.0% 3.0% 6.0% 3.0% 500mS 50mS Event Threshold ----------------1 N/A 1 1 1 N/A 1 N/A 1 1 Issue 1 February 2007 469 CLI Commands Remote Jitter SSRC Changes Note: 50mS N/A 1 1 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 151. 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 Description session-id The index of a specific RTP statistics session remote-subnet The remote subnet address remote-subnetmask The remote subnet mask last Display only the last N entries in the history last-N The number of entries in the history to display User level read only Context general 470 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Example To display the automatic session traceroute result, filtered by subnet address: 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 --1 2 3 4 HOP ADDRESS --------------123.21.11.1 212.201.233.102 213.21.51.12 10.2.4.15 DELAY -------2ms 65ms 110ms 175ms Session ID: 1234 From: 123.21.11.5, To: 10.2.4.5, At: 2004-12-26,13:30:15 TTL --1 2 3 4 HOP ADDRESS --------------123.21.11.1 212.201.233.102 213.21.51.12 10.2.4.5 DELAY -------2ms 65ms 110ms 145ms Output fields: Field Description Session ID The RTP statistics index for the RTP session From The IP address of the TGM550 To The IP address of the session destination (in this case, a destination within the specified subnet) At The time the traceroute is performed TTL The hop count and TTL field value of probe packets HOP ADDRESS The hop IP address DELAY 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 1 February 2007 471 CLI Commands show running-config Use the show running-config command to display the TGM550’s current configuration. Syntax show running-config User level read-only Context general 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 ! 472 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands show sig-group Use the show sig-group command to list all administered signaling groups in Standard Local Survivability (SLS). Syntax show sig-group list Parameters Parameter Description Possible Values Default Value list Lists all administered signaling groups. Lists only the specified signaling group. all sgnum all User Level read-write Context survivable-call-engine Example This example shows a trunk group (98) administered on a DS1 module located in slot v4. The signaling group that manages this DS1 service is numbered ’10.’ There are two additional DS1 facilities located in slot v5 and slot v6 that share an NFAS managed group. The D-channel is in the DS1 module located in slot v5 for this NFAS group. The signaling group that manages these two DS1s is numbered ’12.’ All of the trunk members are contained in a single trunk group numbered ’100.’ TGM550-001(super-survivable-call-engine)# 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 1 February 2007 473 CLI Commands show slot-config Use the show slot-config command to list the slot and board administration in the media gateway for Standard Local Survivability (SLS). Syntax show slot-config User level read-write Context survivable-call-engine Examples TGM550-001 (super-survivable-call-engine)# show slot-config Slot ---v1: v2: v3: v4: v5: v6: Note: SLS-Configured Board-type -------------tim521 tim510 tim514 Inserted Board-type ----------tim521 tim510 tim514 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 snmp Use the show snmp command to display SNMP configuration information. Syntax show snmp User level read-only 474 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Context general Example 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 Timeout: 3 seconds SNMP Rec-Addr Mode Level Notificatio Trap/ l n Inform 129.22.22.22 v1 noaut all trap UDP port: 162 h DM 129.11.33.44 v2c noaut all inform UDP port: 162 h User Name ReadCommN WriteComm N 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 1 February 2007 475 CLI Commands 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. Syntax show snmp group User level admin Context general Example TGM550-001(super)# show snmp group Group Name: defaultROgroup Context: Security Model: v1 Security Level: noauth Context Match: exact Read View: defaultUserView Write View: Notify View: defaultUserView Group Name: defaultROgroup Context: Security Model: v2c Security Level: noauth Context Match: exact Read View: defaultUserView Write View: Notify View: defaultUserView 476 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands show snmp user Use the show snmp user command to display configuration information for the specified SNMP user. Syntax show snmp user username [remote EngineID] Parameters Parameter Description Possible Values username The username of the user whose information you wish to display remote EngineID The engine ID of the remote user Default Value User level admin Context general Example TGM550-001(super)# show snmp user 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 1 February 2007 477 CLI Commands 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 Description username The SNMPv3 username User level admin Context general Example 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 478 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands show snmp view Use the show snmp view command to display configuration information for all SNMP views. Syntax show snmp view User level admin Context general Example TGM550-001(super)# show snmp view View Name: iso Subtree Oid: 1 Subtree Mask: View Type: include Storage Type: nonVolatile Status: active 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 Issue 1 February 2007 479 CLI Commands 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/ 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 status Use the show status command to display the status of the current file copy process to or from the device. Syntax show {download | upload} {software [mmID] | config} status 480 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description download Keyword specifying that the download status is displayed upload Keyword specifying that the upload status is displayed software Keyword specifying that software download or upload information is displayed mmId The Media Module ID number config 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 Last Warning: (null) Progress: [0/0]0% Issue 1 February 2007 481 CLI Commands show station Use the show station command to display extension-specific SLS data parameters. Syntax show station list Parameters Parameter Description Possible Values list Lists all administered extensions Lists only the numbered extension Lists the numbered extension + “n” entries all extension extension + n Default Value all User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show station list Extension Type Port Cor Trk-Des Exp-Mod Flash Passwd --------- --------------- ------- ----- -----49138 ip4620 xxx.xxx.xxx.xxx unrestr yes no - ****** 49139 ip4610sw xxx.xxx.xxx.xxx unrestr yes yes - ****** 49140 analog2500 v305 internal yes - yes ****** Name = Joe Smith 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 Description Extension The extension number of the phone (1-13 digits). Type The station type. 1 of 2 482 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Field Description Port The module/port location. Cor The Class of Restriction. Possible classes include: ● emergency ● internal ● local ● toll ● unrestricted Trunk-Des Indicates whether to permit (yes) or deny (no) the call. Exp-Mod 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. Password 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 survivable-call-engine Use the show survivable-call-engine command to display SLS status (enabled or disabled). Syntax show survivable-call-engine User level read-write Context general Example TGM550-001(super)# show survivable-call-engine Survivable Call Engine is enabled. Issue 1 February 2007 483 CLI Commands 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 SOURCE --------Primary Secondary Local MM ------------------- v0 Active Source: v0 STATUS ----------------------Not Configured Not Configured Active FAILURE ----------- None Sync Source Switching: Enabled show system Use the show system command to display information about the device. Syntax show system User level read-only Context general 484 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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 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 User level read-only Context general Example TGM550-001(super)# show tcp syn-cookies Status: Enabled Statistics: SYN rcvd 10 Connections established local address remote address 9 state Last access (sec) Issue 1 February 2007 485 CLI Commands --------------------- -------------------- -------------- ---------------- 192.113.241.201:60342 111.211.131.1:80 IN_PROGRESS 1 192.113.241.201:23 221.2.11.11:432 ESTABLISHED 1200 192.113.241.201:23 121.192.171.121:7311 CLOSING 10 Output fields Field Description Status The operational status of the TCP SYN cookies defense mechanism: Enabled or Disabled SYN rcvd The total number of TCP SYN packets received since the last time the counters were reset Connections established The total number of connections that were established since the last time the counters were reset local address The local IP address and port of the connection remote address The remote IP address and port of the connection state The state of the connection: ● IN_PROGRESS — connection is in progress ● ESTABLISHED — connection is established ● CLOSING — connection is closing Last access The seconds elapsed since the last time a packet was received on the connection from either side Field Description Connections closed normally The total number of connections closed in the normal manner, using FIN and ACK from both sides Connections closed on RST The total number of connections closed on RST from either side Total discards The total number of discarded packets ACK for SYN verification failed The number of packets discarded due to 3rd ACK verification failure FIN out-of-sync The number of packets in which the FIN sequence number was out of the receive window ACK for FIN out-of-sync The number of packets in which FIN was previously received but its ACK ack number didn't match the FIN's sequence number 486 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Field Description RST out-of-sync The number of packets in which RST was received but its sequence number did not match Active sessions The total number of active inbound sessions SYN-SENT The number of sessions that received a valid 3rd ACK from remote peer, and sent SYN to the local peer ESTABLISHED The number of established sessions FIN-WAIT-IN The number of sessions in which FIN was sent by the local peer FIN_WAIT_OUT The number of sessions in which FIN was sent by the remote peer FINT_WAIT_INOUT The number of sessions in which FIN was sent by the remote peer and the local peer, but no corresponding ACK has yet been received from either or both sides 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 Issue 1 February 2007 487 CLI Commands show trunk-group Use the show trunk-group command to display trunk group administration in Standard Local Survivability (SLS). Syntax show trunk-group list Parameters Parameter Description Possible Values Default Value list Lists all administered trunk groups. Lists only the numbered trunk group. Lists the numbered trunk group + “n” entries. all trunk-group extension + n all User level read-only Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# show trunk-group all Group Type Dial Tac Ports Supervision Treat Insert ----- ------- --- ----- ----------- ---------1 loop-start dtmf 99 v301 2 did dtmf 88 v305 wink insert3 538 Output fields Field Description Group The trunk group number (1-2000). Type The trunk group type (loop-start, did). Dial The dial type (rotary or dtmf). 488 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Field Description Tac The trunk access code (1 to 4 digits). "#" and "*" are valid entries and are only allowed as the first character of the TAC. Port The virtual integrated port assignment. Supervision Incoming signaling supervision mode (immediate, wink). Treat The digit treatment (blank, absorb 1-5, insert 1-4). Insert The digits to insert in the dial string. Codeset Display The Q.931 codeset that sends display information to the user phone (codeset0, codeset6, codeset7). Codeset National The Q.931 codeset that sends National IE display information to the user phone (codeset6, codeset7). Channel Preference Defines how the Channel Identification IE field is encoded (exclusive, preferred). Digit Handling Defines how the inbound/outbound calls handle the transmission/reception of the dialed pattern (enbloc-enbloc, enbloc-overlap, overlap-enbloc, overlap-overlap). Japan Discon Whether to perform a disconnect sequence (CONNECT message followed by a DISCONNECT message). Send Name Whether the calling, connected, called, or busy party’s administered name is sent to the network on outgoing or incoming calls (yes, no, restricted). Send Number Whether the calling, connected, called, or busy party’s administered number is sent to the network on outgoing or incoming calls (yes, no, restricted). Format Number 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). Trunk Hunt The trunk-hunting search within a facility in an ISDN trunk group or through a non-ISDN digital trunk group (ascend, cyclical, descend). Issue 1 February 2007 489 CLI Commands 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 Example In the following example, an upload command has been issued and the upload succeeds: TGM550-001(super)# show upload announcement-file status Module #9 =========== Module Source file Destination file Host Running state Failure display Last warning =========== : : : : : : : 9 hellosource.wav d:\hellodestination.wav 135.64.102.64 Idle (null) No-warning In the following example, an upload command has been issued, but the upload fails: TGM550-001(super)# show upload announcement-file status Module #9 =========== Module Source file Destination file Host Running state Failure display Last warning =========== : : : : : : : 9 hellosource.wav d:\hellodestination.wav 135.64.102.64 Idle SCP- Permission denied No-warning 490 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands In the following 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. 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 In the following example, an upload command has been issued and the upload succeeds: TGM550-001(super)# Show upload auth-file status Module #10 =========== Module Source file Destination file Host Running state Failure display Last warning : : : : : : : 10 auth-file 444 135.64.102.114 Idle (null) No-warning In the following example, an upload command has been issued, but the upload fails: TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Running state : Show upload auth-file status 10 auth-file. d:\zion\run.cfg 135.64.102.39 Idle Issue 1 February 2007 491 CLI Commands Failure display Last warning : SCP - Permission denied : No-warning In the following 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. 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 In the following example, an upload command has been issued and the upload succeeds: TGM550-001(super)# Show upload cfr-file status Module #10 =========== Module Source file Destination file Host Running state Failure display Last warning : : : : : : : 10 cdr file 444 135.64.102.114 Idle (null) No-warning In the following example, an upload command has been issued, but the upload fails: TGM550-001(super)# Module #10 =========== Module : Source file : Destination file : Host : Show upload cdr-file status 10 cdr file. d:\zion\run.cfg 135.64.102.39 492 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Running state Failure display Last warning : Idle : SCP - Permission denied : No-warning In the following 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. 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 ● 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. ============================== If an upload has been performed: TGM550-001(super)# show upload phone-script-file status Module #10 =========== Module : 10 Source file : phone-ScriptB Destination file : 444 Host : 135.64.102.114 Running state : Idle Failure display : (null) Last warning : No-warning Issue 1 February 2007 493 CLI Commands show upload status Use the show upload status command to display status information regarding the upload of a configuration file for a specific module or for all modules. Syntax show upload status [module_number] Parameters Parameter Description Possible Values module_number The module number for which to display upload information 0-10 Default Value User level read-only Context general 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. 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 494 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands User level read-only Context general Example In the following 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 the following 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 In the following 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. Related Commands show username Use the show username command to display local user accounts. Syntax show username Issue 1 February 2007 495 CLI Commands User level admin Context general Example To display all the defined user accounts: TGM550-001(super)# show username User account ----------root gkohll readwrite password -------***** ***** ***** access-type -----------admin read-only read-write 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 Description module Module to display Possible Values User level read-write Context general 496 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands Example To display utilization information for all modules: TGM550-001(super)# show utilization Mod CPU CPU RAM RAM --10 5sec -----4% 60sec ----4% used(%) Total(Kb) ------- ---------21% 105313 Kb 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 Issue 1 February 2007 497 CLI Commands 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 sig-group Use the sig-group command within the survivable-call-engine context to enter a second-level subcontext for administering signaling groups for Standard Local Survivability (SLS). After issuing this command, the prompt changes to sls-sig-group . Type exit to leave the sig-group context, which returns you to the survivable-call-engine context. Syntax sig-group sgnum Parameters Parameter Description Possible Values sgnum Signaling group number* 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. 498 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# 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 Related SLS commands clear sig-group, set survivable-call-engine, show sig-group, show survivable-call-engine, survivable-call-engine snmp-server community Use the snmp-server community command to enable 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 User level admin Issue 1 February 2007 499 CLI Commands Context general Example TGM550-001(super)# snmp-server community 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} [udp-port port] [notification_type_list] no snmp-server dynamic-trap-manager notification_type_list Parameters Parameter Description traps Specifies that the dynamic trap manager sends messages without requesting acknowledgement. This is the default. informs Specifies that the dynamic trap manager sends messages requiring acknowledgement. v1 Specifies that the dynamic trap manager uses SNMP v1 functionality. This is the default. v2c Specifies that the dynamic trap manager uses SNMP v2c functionality. community The community string for accessing SNMP services. port The udp port of the SNMP host. notification_ type_list The specific types of messages that the dynamic trap manager sends. Use this list to filter the messages controlled by the dynamic trap manager. 500 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value all Alphabetical listing of CLI commands User Level admin Context general Example TGM550-001(super)# snmp-server dynamic-trap-manager 10.1.2.4 traps v2c public all 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: Note: This command overrides the enabling of individual notifications using the snmp-server host command. Syntax [no] snmp-server enable notifications User level admin Context general Example TGM550-001(super)# snmp-server enable notifications 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: Note: The SNMP Engine ID must be unique for all devices on the network. Issue 1 February 2007 501 CLI Commands Note: Note: 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. Syntax snmp-server engineID engineID no snmp-server engineID Parameters Parameter Description engineID 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 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: 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. 502 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Syntax snmp-server group groupname {v1|v2c|v3 {auth|noauth|priv}} [read readviewname] [write writeviewname] [notify notifyviewname] no snmp-server group groupname [v1|v2c|v3 {noauth|auth|priv}] Parameters Parameter Description Possible Values groupname A character string of at most 32 characters specifying the group name v1 The group is limited to SNMP v1 functionality v2c The group is limited to SNMP v2c functionality v3 The group has full SNMP v3 functionality (this is the default) auth The group authenticates packets noauth The group does not authenticate packets (this is the default) priv The group authenticates and encrypts packets readviewname A character string of at most 64 characters 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. writeviewname A character string of at most 64 characters 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. notifyviewname A character string of at most 64 characters 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. Default Value Issue 1 February 2007 503 CLI Commands User level admin Context general Example TGM550-001(super)# snmp-server group 12groupRO v3 auth read view1 notify view2 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: Note: If you use the no snmp-server host command without a notification type list, all notification types are disabled. Syntax snmp-server host {host_address | hostname} {traps | informs} {{{v1 | v2c} community} | {v3 [auth | noauth | priv] user}} [udp-port port] [notification-type-list] no snmp-server host host_address [{traps|informs} notification-type-list] Parameters Parameter Description host_address The IP address of the SNMP host. hostname A character string no longer than 32 characters, specifying the hostname of the SNMP host. traps Send traps to this host (messages not requiring acknowledgement). This is the default. Possible Values 504 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands Parameter Description informs Send informs to this host (messages requiring acknowledgement). v1 Use SNMP v1 functionality with this host. v2c Use SNMP v2c functionality with this host. community The community string to use to connect to the specified host (for v1 or v2c). v3 Use SNMP v3 functionality with this host. auth Authenticate messages to this host. noauth Do not authenticate messages to this host (this is the default). priv Authenticate and encrypt messages to this host. user The username to use for authentication on the specified host. port Which port of the target host to use. Possible Values Default Value 162 Issue 1 February 2007 505 CLI Commands Parameter Description Possible Values Default Value notification -type-list List of notification types that are enabled for this host. Use the no form of the command to disable specific notification types. The default is none. 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 User level admin Context general 506 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Example 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] [timeout timeout] [pending pending] Parameters Parameter Description Possible Values Default Value retries The maximum number of times to resend an inform message 3 timeout The number of seconds to wait for an acknowledgement before resending an inform message 3 pending The maximum allowable number of inform messages that can be waiting for acknowledgement at any given time. When the maximum is reached, the oldest pending inform messages are discarded. 25 User level admin Context general Example TGM550-001(super)# snmp-server informs retries 5 timeout 3 Issue 1 February 2007 507 CLI Commands 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 SNMPEngineID groupname {v1|v2c|v3} [auth {md5|sha} auth-password [priv des56 priv-password]] no snmp-server remote-user username [groupname {v1|v2c|v3}] Parameters Parameter Description username A character string no longer than 32 characters, specifying the username of this user SNMPEngineID The remote device Engine ID for this user groupname A character string no longer than 32 characters, specifying the groupname this user is associated with v1 The user is authorized for SNMP v1 functionality in the specified group v2c The user is authorized for SNMP v2c functionality in the specified group v3 The user is authorized for SNMP v3 functionality in the specified group auth md5 Use the MAC-MD5-96 authentication protocol sha Use the HMAC-SHA-96 authentication protocol auth-password 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. 508 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands Parameter Description Possible Values Default Value priv des56 priv-password A character string no longer than 64 characters specifying the privacy password. The minimum length is 8 characters. User level admin Context general Example TGM550-001(super)# snmp-server remote-user john 00:02:00:81:00:d0:00:4c:18:00 L2Group 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]] [volatile] no snmp-server user username [groupname {v1|v2c|v3}]] Issue 1 February 2007 509 CLI Commands Parameters Parameter Description username A character string no longer than 32 characters, specifying the username of this user groupname A character string no longer than 32 characters, specifying the groupname this user is associated with v1 The user is authorized for SNMP v1 functionality in the specified group v2c The user is authorized for SNMP v2c functionality in the specified group v3 The user is authorized for SNMP v3 functionality in the specified group md5 Use the MAC-MD5-96 authentication protocol sha Use the HMAC-SHA-96 authentication protocol auth-password A character string between 8 and 64 characters specifying the authentication password. An authentication password is required if the auth keyword is used. The minimum length is 8 characters. priv-password A character string between 8 and 64 characters specifying the privacy password. The minimum length is 8 characters. volatile Specifies that the user configurations are only set temporarily, until the system is reset. After reset, the user settings return to their previous values. Possible Values Default Value User level admin Context general Example TGM550-001(super)# snmp-server user john L2Group v3 auth md5 katmandu priv des56 uktanatan 510 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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. A 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. Syntax snmp-server view viewname oidtree {included|excluded} no snmp-server view viewname [oidtree] Parameters Parameter Description viewname The name of the view oidtree The subtree to be included in or excluded from this view. Oidtree 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. included Keyword indicating that the view includes the specified subtree (this is the default). excluded Keyword indicating that the view excludes the specified subtree. Possible Values Default Value User level admin Context general Example TGM550-001(super)# snmp-server view internet 1.3.6.1 included Issue 1 February 2007 511 CLI Commands station Use the station command within the survivable-call-engine context to enter a second-level subcontext for administering stations for Standard Local Survivability (SLS). After issuing this command, the prompt changes to sls-station . Type exit to leave the station context, which returns you to the survivable-call-engine context. Syntax station extension [class] Parameters Parameter Description Possible Values extension A 1-13 digit unique numeric string “0” through “9”; an extension can begin with the digit “0”. class Station class. Note that 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. analog dcp ip User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# station 23456 analog TGM550-001(super-sls-station )# 512 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands Sub-commands Depending on the class of station, the following sub-commands are available: Command set cor Analog X set expansion-module set name X set password DCP IP X X X X X X X X set port X X set swhook-flash X set trunk-destination X X X set type (station) X X X show X X X Additional SLS commands set survivable-call-engine, show, show survivable-call-engine, survivable-call-engine survivable-call-engine Use the survivable-call-engine command to enter the survivable-call-engine context. In this context, you can administer the Standard Local Survivability (SLS) data set from the TGM550 CLI. Type exit to leave the survivable-call-engine context. Several second-level subcontexts within the survivable-call-engine context help SLS administration. While in the survivable-call-engine context type these commands to enter the respective subcontexts: ● station to enter the station context ● trunk-group [group-type] to enter the trunk-group context ● ds1 to enter the ds1 context ● sig-group to enter the sig-group context ● bri to enter the bri context ● dial-pattern to enter the dial-pattern context ● incoming-routing tgnum mode [pattern length] to enter the incoming-routing context Issue 1 February 2007 513 CLI Commands ! Important: Important: If you issue this command on a TGM550with insufficient memory, the survivable-call-engine command aborts and entry into the survivable-call-engine context is denied. Syntax survivable-call-engine User level read-write Context global Example TGM550-001(super)# survivable-call-engine TGM550-001(super-survivable-call-engine)# 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: Note: 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. Syntax [no] tcp syn-cookies User level read-write Context general 514 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands 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. tech Use the tech command to enter tech mode, where additional tech-related commands are available. Note: Note: This command is reserved for service personnel use only. Syntax tech User level tech Context general Example To enter tech mode: TGM550-001(super)# tech Password: TGM550-001(tech)# Issue 1 February 2007 515 CLI Commands telnet Use the telnet command to initiate a login session via Telnet to a network host. Syntax telnet ipaddress [port_number] Parameters Parameter Description ipaddress The Telnet IP address port_number The Telnet port number Possible Values Default Value 23 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 terminal length Use the terminal length command to set the length of the terminal display in characters. Syntax terminal length [lines] 516 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Parameters Parameter Description Possible Values Default Value lines The number of lines in the terminal display none - Displays the current length. 3-200 - Sets the new screen length to the 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] Parameters Parameter Description Possible Values Default Value characters The number of characters in the width of the terminal display none - Displays the current width. 10-200 - Sets the new screen width to the value. User level read-only Issue 1 February 2007 517 CLI Commands Context general Example To limit the display to a width of 6 characters: TGM550-001(super)# terminal width 6 test led Use the test led command to run a test of the device’s LED operation. Syntax test led User level read-only Context general Example To run a test of the device’s LED operation: TGM550-001(super)# test led The Box level ALM, CPU and MDM LEDs should be BLINKING for 5 seconds each. 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 212, and release voip-dsp on page 296. Note: Note: Note: If you do not run the busyout voip-dsp command before the test voip-dsp command, only non-disruptive tests will run. Note: Status changes during the test create SNMP traps. 518 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands Note: Note: To view the results of the most recent BTR test, refer to show mm on page 455. Syntax test voip-dsp 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 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 Description Possible Values Default Value maxTests The maximum number of tests allowed in an interval. Zero means no limit. 0-10000 60 interval The rate limiter interval, in seconds. 1-1000 10 Issue 1 February 2007 519 CLI Commands 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 traceroute Use the traceroute command to trace the route packets are taking to a particular host by displaying the hops along the path. Note: 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. 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 Description host The destination host of the traceroute probes, specified as an IP address or host name ip_addr The local IP address of the traceroute probes count The number of times each TTL value is repeated for a traceroute 520 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value The outbound interface address 1-5 3 Alphabetical listing of CLI commands Parameter Description Possible Values Default Value dest-port The destination port of the first probe sent 1,02465,535 33,434 increment An integer that determines by how much the destination port is incremented for each probe sent, starting from base port 0-254 1 source-port The source port of the traceroute probes 1,02465,535 33,434 timeout The duration, in milliseconds, that traceroute waits for a response for each probe sent, until it gives up and marks this probe as unreachable 10ms120sec in milliseconds 2 seconds in milliseconds dscp The value of the DS field of the traceroute probes 0-63 0 next-hop-if -name The interface name of the next hop next-hop-ip -addr The IP address of the next hop max-ttl Do not probe over this TTL value 1-50 30 size The L4 payload length, in bytes 8-4,088 40 protocol The protocol type of the traceroute probes ICMP, UDP UDP includetunnel-hops Keyword that specifies that traceroute display the route taken by the probes as they traverse locally terminated tunnels (such as GRE, ESP) set-df-bit Keyword that specifies to set the Don't-Fragment field of the traceroute probes User level read-only Context general Issue 1 February 2007 521 CLI Commands 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. 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 Description depth The level of depth at which to display the list of CLI commands 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 522 IG550 Integrated Gateway Administration and CLI Reference Possible Values Default Value Alphabetical listing of CLI commands > banner banner > banner banner --type q login login > line post-login post-login > line to quit or space key to continue-- trunk-group Use the trunk-group command within the survivable call engine context to enter a second-level subcontext for administering trunks for Standard Local Survivability (SLS). After issuing this command, the prompt changes to sls-trunk-group-. Type exit to leave the trunk-group context, which returns you to the survivable-call-engine context. Syntax trunk-group tgnum [group-type] Parameters Parameter Description Possible Values tgnum The required trunk group number. 1-2000 group-type The trunk group type. This argument is required to enter the trunk-group context. See the following for capacities by group type: ● J4350 and J6350: Table 6 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 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. Issue 1 February 2007 523 CLI Commands 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 built-in ports on the TGM550 family members and by the slot-configuration assignment for the TGM550. The maximum number of ports allowed per interface module is defined in Table 6,. Table 6: J4350 and J6350 SLS group type assignments Note: Group type Media module Number of ports/channels Description loop-start ground-start TGM550 2 1, 2 did TGM550 2 3, 4 loop-start ground-start TIM514 4 1, 2, 3, 4 did TIM514 4 5, 6, 7, 8 bri TIM521 8 t1isdn TIM510 23 D-channel is associated with this facility (FAS). t1isdn TIM510 24 D-channel is not associated with this facility (NFAS), and the DS1’s signaling-mode is set to isdnext. t1isdn TIM510 30 D-channel is associated with this facility (FAS). e1isdn TIM510 31 D-channel is not associated with this facility (NFAS), and the DS1’s signaling-mode is set to isdnext. t1inband TIM510 24 e1inband TIM510 30 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 following ports are not recommended as DID ports (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). For the following models, the Integrated port is recommended not to be used as DID: - J4350/6350: Integrated port 3 524 IG550 Integrated Gateway Administration and CLI Reference Alphabetical listing of CLI commands User level read-write Context survivable-call-engine Example TGM550-001(super-survivable-call-engine)# 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 ground-start, loop-start did t1isdn, e1isdn, bri e1inband, t1inband add port X X X X clear tac X X X X remove port X X X X set channel-preference X set codeset-display X set codeset-national X set dial X set digits X X X X X set digit-handling X set digit-treatment set incoming-destination X X X X set incoming-dialtone X set japan-disconnect set name X X X set numbering-format X set send-name X set send-number X X Issue 1 February 2007 525 CLI Commands Command ground-start, loop-start set supervision did t1isdn, e1isdn, bri e1inband, t1inband X X set tac X set trunk-hunts X show X X X X X X X X Additional SLS commands clear trunk-group, set survivable-call-engine, show survivable-call-engine, show trunk-group survivable-call-engine 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: Note: For security reasons, you should change the root password immediately. Syntax username name [password passwd | asg-secret secret] access-type access_type no username name Parameters Parameter Description Possible Values name New user name or dadmin minimum four character string passwd User’s password minimum eight character string 526 IG550 Integrated Gateway Administration and CLI Reference Default Value Alphabetical listing of CLI commands Parameter Description Possible Values Default Value secret ASG secret key of a dadmin user 32 hexadecimal characters access_type Access type definition read-only, read-write, admin Note: A dadmin user and a root user must be assigned an admin access type. User level admin Context general Examples ● 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. ● 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. ● To change the password of the root user: TGM550-001(super)# username root password mysecret access-type admin User account modified. 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”. Issue 1 February 2007 527 CLI Commands 528 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 Name Msg Facility Severity Description / Resolution snmpTraps 1 coldStart Boot Warning The entity is reinitializing itself in such a way as to potentially cause the alteration of either the agent’s configuration or the entity’s implementation. This trap is always enabled. snmpTraps 2 warmStart Boot Warning The entity is reinitializing itself in such a way as to keep both the agent’s configuration and the entity’s implementation intact. This trap is always enabled. snmpTraps 5 authenticFailure Security Notification The protocol is not properly authenticated. avayaG350 68 lntUnAuthorizedAccessEvent Notification An attempt has been made to logon to the device with an invalid userid/password. LannetTraps IntConfigChangeEvent Notification A security configuration change occurred. LannetTraps IntAccountLockoutEvent Notification A userid/password was locked out. secMng avMSSDenialOfService Notification The MSS notification sent on DoS attack. secMng avConfigurationEncKeyMismatchFaul t Notification Encryption keys mismatch error. Configuration download operation is aborted. secMng avConfigurationMasterKeyChange Notification Configuration Master key was changed. 1 of 10 Issue 1 February 2007 529 Traps and MIBs Enterprise Trap ID Name Msg Facility Severity Description / Resolution avEntTraps 22 avEntAmbientHiThresholdTempFlt Temp 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 23 avEntAmbientHiThresholdTempOk Temp Notification The ambient temperature in the device has returned to the acceptable range. avEntTraps 24 avEntAmbientLoThresholdTempFlt Temp Error The ambient temperature in the device is below the acceptable temperature range. avEntTraps 25 avEntAmbientLoThresholdTempOk Temp Notification The ambient temperature in the device has returned to the acceptable range. avLoad avDownloadBegun Notification The device has begun download operation. avLoad avDownloadSuccess Notification The device has completed successful download operation 2 of 10 530 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module traps Enterprise Trap ID Name Msg Facility Severity Description / Resolution avLoad avDownloadFault Notification The download operation was failed. avLoad avUploadBegun Notification The device has begun download operation. avLoad avUploadSuccess Notification The device has completed successful download operation. avLoad avUploadFault Notification The download operation was failed. avSurv avSurvEnabled Notification The survivable local server application has been administratively enabled. avSurv avSurvDisabled Notification The survivable local server application has been administratively disabled. avSurv avSurvActive Notification The survivable local server application is now the call controller and is processing calls. avSurv avSurvInactive Notification The survivable local server application has stopped processing calls. Another processor, either an LSP or a main server, is now processing calls. avEntTraps avRtpQoSTrap Notification The RTP sessionhas terminated with bad QoS. avEntTraps avRtpQoSFault Notification More than the allowable number of streams suffer from bad QoS. avEntTraps avRtpQoSClear Notification The RTP QOS fault condition has ended. avEntTraps cigTftpServerDownloadFailureTrap Notification TFTP client failed to download file from gateway TFTP server. avEntTraps cigTftpServersUploadFailureTrap Notification TFTP client failed to upload file to gateway TFTP server. 3 of 10 Issue 1 February 2007 531 Traps and MIBs Enterprise Trap ID Name Msg Facility Severity Description / Resolution cmgTrapTypes 30 cmgSyncSignalFault Voice 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 Media 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 31 cmgSyncSignalClear Voice Notification The synchronization signal has been regained. cmgTrapTypes 32 cmgVoipHardwareFault Voice Warning A DSP complex serving the VoIP engines has failed. 4 of 10 532 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module traps Enterprise Trap ID Name Msg Facility Severity Description / Resolution cmgTrapTypes 33 cmgVoipHardwareClear Voice Warning The DSP complex serving the VoIP engines has returned to normal functioning. cmgTrapTypes 34 cmgSyncSignalWarn Voice Error Synchronization signal lost. cmgTrapTypes 35 cmgSyncWarnClear Voice Notification Synchronization signal normal. cmgTrapTypes 36 cmgSyncSignalExcess Voice Notification The synchronization signal source (primary or secondary) is experiencing excessive failures in a short period of time causing excessive switching to an alternate source. cmgTrapTypes 37 cmgSyncExcessClear Voice Notification Synchronization signal source which was causing excessive switching due to excessive failures is now normal. cmgTrapTypes 50 cmgModuleRemove Voice Notification A media module has been removed. cmgTrapTypes 52 cmgModuleInsertFault Voice Alert The insertion sequence for a media module has failed. cmgTrapTypes 53 cmgModuleInsertSuccess Voice Notification A media module has been inserted. cmgTrapTypes cmgMgBusyout Voice Notification An administrator has moved a media module or port to the busy-out state. cmgTrapTypes cmgMgRelease Voice Notification An administrator has moved a media module or port from the busy-out state back into service. cmgTrapTypes cmgUnsupportedMmEnrolement Voice Notification The event is sent when a module is inserted to a slot where it can be identified but not supported due to hardware limitations. cmgTrapTypes 57 cmgDataModuleAwohConflict Voice Error 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. cmgTrapTypes 73 cmgRegistrationSuccess Voice Notification The Media Gateway has successfully registered with a Media Controller. cmgTrapTypes 74 cmgMgManualReset Voice Error The Media Gateway is beginning a user-requested reset operation. cmgTrapTypes 75 cmgModuleManualReset Voice Error A media module is beginning a user-requested reset operation. 5 of 10 Issue 1 February 2007 533 Traps and MIBs Enterprise Trap ID Name Msg Facility Severity Description / Resolution cmgTrapTypes 102 cmgPrimaryControllerFault Voice 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 Media Server or the Media 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. cmgTrapTypes 104 cmgNoControllerFault Voice Error 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 CLI’s 'configure' mode, use a set mgc list command with the correct IP address. cmgTrapTypes 105 cmgnoControllerClear Voice The cmgNoControllerFault trap has been cleared. 6 of 10 534 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module traps Enterprise Trap ID Name Msg Facility Severity Description / Resolution cmgTrapTypes 106 cmgRegistrationFault Voice 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 Media Server CLAN or the Media Server IP addresses. 2. If needed, correct this in the CLI’s '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 Media Server CLAN or the Media 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 customer’s 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 1 February 2007 535 Traps and MIBs Enterprise Trap ID Name Msg Facility Severity Description / Resolution cmgTrapTypes 114 cmgMgAutoReset Voice 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 Gateway’s 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 536 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module traps Enterprise Trap ID Name Msg Facility Severity Description / Resolution cmgTrapTypes 116 cmgModuleAutoReset Voice 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 117 cmgModuleAutoResetClear Voice Notification cmgTrapTypes 118 cmgModulePostFault Voice Warning cmgTrapTypes 119 cmgModulePostClear Voice Notification A media module failed its power-on start-up test. 9 of 10 Issue 1 February 2007 537 Traps and MIBs Enterprise Trap ID Name Msg Facility Severity cmgTrapTypes 124 cmgVoipOccFault Voice Notification cmgTrapTypes 125 cmgVoipOccClear Voice Information al cmgTrapTypes 128 cmgVoipAutoReset Voice Warning Description / Resolution 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 538 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module MIB files TGM550 Telephony Gateway Module MIB files MIB File MIB Module Supported by TGM550 Telephony Gateway Module Load.MIB LOAD-MIB RFC1315-MIB.my RFC1315-MIB ENTITY-MIB.my ENTITY-MIB IP-FORWARD-MIB.my IP-FORWARD-MIB UTILIZATION-MANAGEMENT-MIB.my UTILIZATION-MANAGEMENT-MIB ENTITY-SENSOR-MIB.my ENTITY-SENSOR-MIB RSTP-MIB.my RSTP-MIB APPLIC-MIB.MY APPLIC-MIB DS1-MIB.my DS1-MIB RFC1213-MIB.my RFC1213-MIB AVAYA-ENTITY-MIB.MY AVAYA-ENTITY-MIB Rnd.MIB RND-MIB CROUTE-MIB.MY CROUTE-MIB IF-MIB.my IF-MIB DS0BUNDLE-MIB.my DS0BUNDLE-MIB RFC1406-MIB.my RFC1406-MIB DS0-MIB.my DS0-MIB CONFIG-MIB.MY CONFIG-MIB G700-MG-MIB.MY G700-MG-MIB FRAME-RELAY-DTE-MIB.my FRAME-RELAY-DTE-MIB IP-MIB.my IP-MIB Load12.MIB LOAD-MIB SNMPv2-MIB.my SNMPv2-MIB 1 of 2 Issue 1 February 2007 539 Traps and MIBs MIB File MIB Module Supported by TGM550 Telephony Gateway Module USM-MIB.my USM-MIB VACM-MIB.my 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 OID genOpModuleId 1.3.6.1.4.1.1751.2.53.1.2.1.1 genOpIndex 1.3.6.1.4.1.1751.2.53.1.2.1.2 genOpRunningState 1.3.6.1.4.1.1751.2.53.1.2.1.3 genOpSourceIndex 1.3.6.1.4.1.1751.2.53.1.2.1.4 genOpDestIndex 1.3.6.1.4.1.1751.2.53.1.2.1.5 genOpServerIP 1.3.6.1.4.1.1751.2.53.1.2.1.6 genOpUserName 1.3.6.1.4.1.1751.2.53.1.2.1.7 genOpPassword 1.3.6.1.4.1.1751.2.53.1.2.1.8 genOpProtocolType 1.3.6.1.4.1.1751.2.53.1.2.1.9 genOpFileName 1.3.6.1.4.1.1751.2.53.1.2.1.10 genOpRunningStateDisplay 1.3.6.1.4.1.1751.2.53.1.2.1.11 genOpLastFailureIndex 1.3.6.1.4.1.1751.2.53.1.2.1.12 genOpLastFailureDisplay 1.3.6.1.4.1.1751.2.53.1.2.1.13 genOpLastWarningDisplay 1.3.6.1.4.1.1751.2.53.1.2.1.14 genOpErrorLogIndex 1.3.6.1.4.1.1751.2.53.1.2.1.15 genOpResetSupported 1.3.6.1.4.1.1751.2.53.1.2.1.16 genOpEnableReset 1.3.6.1.4.1.1751.2.53.1.2.1.17 1 of 2 540 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module MIB files Object OID genOpNextBootImageIndex 1.3.6.1.4.1.1751.2.53.1.2.1.18 genOpLastBootImageIndex 1.3.6.1.4.1.1751.2.53.1.2.1.19 genOpFileSystemType 1.3.6.1.4.1.1751.2.53.1.2.1.20 genOpReportSpecificFlags 1.3.6.1.4.1.1751.2.53.1.2.1.21 genOpOctetsReceived 1.3.6.1.4.1.1751.2.53.1.2.1.22 genAppFileId 1.3.6.1.4.1.1751.2.53.2.1.1.1 genAppFileName 1.3.6.1.4.1.1751.2.53.2.1.1.2 genAppFileType 1.3.6.‘1.4.1.1751.2.53.2.1.1.3 genAppFileDescription 1.3.6.1.4.1.1751.2.53.2.1.1.4 genAppFileSize 1.3.6.1.4.1.1751.2.53.2.1.1.5 genAppFileVersionNumber 1.3.6.1.4.1.1751.2.53.2.1.1.6 genAppFileLocation 1.3.6.1.4.1.1751.2.53.2.1.1.7 genAppFileDateStamp 1.3.6.1.4.1.1751.2.53.2.1.1.8 genAppFileRowStatus 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 OID entPhysicalDescr 1.3.6.1.2.1.47.1.1.1.1.2 entPhysicalVendorType 1.3.6.1.2.1.47.1.1.1.1.3 entPhysicalContainedIn 1.3.6.1.2.1.47.1.1.1.1.4 entPhysicalClass 1.3.6.1.2.1.47.1.1.1.1.5 entPhysicalParentRelPos 1.3.6.1.2.1.47.1.1.1.1.6 1 of 2 Issue 1 February 2007 541 Traps and MIBs Object OID entPhysicalName 1.3.6.1.2.1.47.1.1.1.1.7 entPhysicalHardwareRev 1.3.6.1.2.1.47.1.1.1.1.8 entPhysicalFirmwareRev 1.3.6.1.2.1.47.1.1.1.1.9 entPhysicalSoftwareRev 1.3.6.1.2.1.47.1.1.1.1.10 entPhysicalSerialNum 1.3.6.1.2.1.47.1.1.1.1.11 entPhysicalMfgName 1.3.6.1.2.1.47.1.1.1.1.12 entPhysicalModelName 1.3.6.1.2.1.47.1.1.1.1.13 entPhysicalAlias 1.3.6.1.2.1.47.1.1.1.1.14 entPhysicalAssetID 1.3.6.1.2.1.47.1.1.1.1.15 entPhysicalIsFRU 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 OID genCpuIndex 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.1 genCpuUtilizationEnableMonitoring 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.2 genCpuUtilizationEnableEventGeneration 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.3 genCpuUtilizationHighThreshold 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.4 genCpuAverageUtilization 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.5 genCpuCurrentUtilization 1.3.6.1.4.1.6889.2.1.11.1.1.1.1.6 genMemUtilizationTotalRAM 1.3.6.1.4.1.6889.2.1.11.1.2.1 genMemUtilizationOperationalImage 1.3.6.1.4.1.6889.2.1.11.1.2.2 genMemUtilizationDynAllocMemUsed 1.3.6.1.4.1.6889.2.1.11.1.2.3.1 1 of 2 542 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module MIB files Object OID genMemUtilizationDynAllocMemMaxUsed 1.3.6.1.4.1.6889.2.1.11.1.2.3.2 genMemUtilizationDynAllocMemAvailable 1.3.6.1.4.1.6889.2.1.11.1.2.3.3 genMemUtilizationAllocationFailures 1.3.6.1.4.1.6889.2.1.11.1.2.4 genMemUtilizationID 1.3.6.1.4.1.6889.2.1.11.1.2.6.1.1 genMemUtilizationPhyRam 1.3.6.1.4.1.6889.2.1.11.1.2.6.1.2 genMemUtilizationPercentUsed 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 OID entPhySensorType 1.3.6.1.2.1.99.1.1.1.1 entPhySensorScale 1.3.6.1.2.1.99.1.1.1.2 entPhySensorPrecision 1.3.6.1.2.1.99.1.1.1.3 entPhySensorValue 1.3.6.1.2.1.99.1.1.1.4 entPhySensorOperStatus 1.3.6.1.2.1.99.1.1.1.5 entPhySensorUnitsDisplay 1.3.6.1.2.1.99.1.1.1.6 entPhySensorValueTimeStamp 1.3.6.1.2.1.99.1.1.1.7 entPhySensorValueUpdateRate 1.3.6.1.2.1.99.1.1.1.8 Issue 1 February 2007 543 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: Note: The "if" items are reported on the VoIP interface only. Object OID ifNumber 1.3.6.1.2.1.2.1 ifIndex 1.3.6.1.2.1.2.2.1.1 ifDescr 1.3.6.1.2.1.2.2.1.2 ifType 1.3.6.1.2.1.2.2.1.3 ifMtu 1.3.6.1.2.1.2.2.1.4 ifSpeed 1.3.6.1.2.1.2.2.1.5 ifPhysAddress 1.3.6.1.2.1.2.2.1.6 ifAdminStatus 1.3.6.1.2.1.2.2.1.7 ifOperStatus 1.3.6.1.2.1.2.2.1.8 ifLastChange 1.3.6.1.2.1.2.2.1.9 ifInOctets 1.3.6.1.2.1.2.2.1.10 ifInUcastPkts 1.3.6.1.2.1.2.2.1.11 ifInNUcastPkts 1.3.6.1.2.1.2.2.1.12 ifInDiscards 1.3.6.1.2.1.2.2.1.13 ifInErrors 1.3.6.1.2.1.2.2.1.14 ifInUnknownProtos 1.3.6.1.2.1.2.2.1.15 ifOutOctets 1.3.6.1.2.1.2.2.1.16 ifOutUcastPkts 1.3.6.1.2.1.2.2.1.17 ifOutNUcastPkts 1.3.6.1.2.1.2.2.1.18 ifOutDiscards 1.3.6.1.2.1.2.2.1.19 ifOutErrors 1.3.6.1.2.1.2.2.1.20 1 of 3 544 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module MIB files Object OID ifOutQLen 1.3.6.1.2.1.2.2.1.21 ifSpecific 1.3.6.1.2.1.2.2.1.22 ipForwarding 1.3.6.1.2.1.4.1 ipDefaultTTL 1.3.6.1.2.1.4.2 ipInReceives 1.3.6.1.2.1.4.3 ipInHdrErrors 1.3.6.1.2.1.4.4 ipInAddrErrors 1.3.6.1.2.1.4.5 ipForwDatagrams 1.3.6.1.2.1.4.6 ipInUnknownProtos 1.3.6.1.2.1.4.7 ipInDelivers 1.3.6.1.2.1.4.9 ipOutDiscards 1.3.6.1.2.1.4.11 ipOutNoRoutes 1.3.6.1.2.1.4.12 ipReasmTimeout 1.3.6.1.2.1.4.13 ipReasmReqds 1.3.6.1.2.1.4.14 ipReasmOKs 1.3.6.1.2.1.4.15 ipReasmFails 1.3.6.1.2.1.4.16 ipFragOKs 1.3.6.1.2.1.4.17 ipFragFails 1.3.6.1.2.1.4.18 ipFragCreates 1.3.6.1.2.1.4.19 ipAdEntAddr 1.3.6.1.2.1.4.20.1.1 ipAdEntIfIndex 1.3.6.1.2.1.4.20.1.2 ipAdEntNetMask 1.3.6.1.2.1.4.20.1.3 ipAdEntBcastAddr 1.3.6.1.2.1.4.20.1.4 ipAdEntReasmMaxSize 1.3.6.1.2.1.4.20.1.5 snmpInPkts 1.3.6.1.2.1.11.1 snmpOutPkts 1.3.6.1.2.1.11.2 2 of 3 Issue 1 February 2007 545 Traps and MIBs Object OID snmpInBadVersions 1.3.6.1.2.1.11.3 snmpInBadCommunityNames 1.3.6.1.2.1.11.4 snmpInBadCommunityUses 1.3.6.1.2.1.11.5 snmpInASNParseErrs 1.3.6.1.2.1.11.6 snmpInTooBigs 1.3.6.1.2.1.11.8 snmpInNoSuchNames 1.3.6.1.2.1.11.9 snmpInBadValues 1.3.6.1.2.1.11.10 snmpInReadOnlys 1.3.6.1.2.1.11.11 snmpInGenErrs 1.3.6.1.2.1.11.12 snmpInTotalReqVars 1.3.6.1.2.1.11.13 snmpInTotalSetVars 1.3.6.1.2.1.11.14 snmpInGetRequests 1.3.6.1.2.1.11.15 snmpInGetNexts 1.3.6.1.2.1.11.16 snmpInSetRequests 1.3.6.1.2.1.11.17 snmpInGetResponses 1.3.6.1.2.1.11.18 snmpInTraps 1.3.6.1.2.1.11.19 snmpOutTooBigs 1.3.6.1.2.1.11.20 snmpOutNoSuchNames 1.3.6.1.2.1.11.21 snmpOutBadValues 1.3.6.1.2.1.11.22 snmpOutGenErrs 1.3.6.1.2.1.11.24 snmpOutGetRequests 1.3.6.1.2.1.11.25 snmpOutGetNexts 1.3.6.1.2.1.11.26 snmpOutSetRequests 1.3.6.1.2.1.11.27 snmpOutGetResponses 1.3.6.1.2.1.11.28 snmpOutTraps 1.3.6.1.2.1.11.29 snmpEnableAuthenTraps 1.3.6.1.2.1.11.30 3 of 3 546 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: Note: This list applies only to temperature sensor information. Object OID avEntPhySensorHiShutdown 1.3.6.1.4.1.6889.2.1.99.1.1.1 avEntPhySensorHiWarning 1.3.6.1.4.1.6889.2.1.99.1.1.2 avEntPhySensorHiWarningClear 1.3.6.1.4.1.6889.2.1.99.1.1.3 avEntPhySensorLoWarningClear 1.3.6.1.4.1.6889.2.1.99.1.1.4 avEntPhySensorLoWarning 1.3.6.1.4.1.6889.2.1.99.1.1.5 avEntPhySensorLoShutdown 1.3.6.1.4.1.6889.2.1.99.1.1.6 avEntPhySensorEventSupportMask 1.3.6.1.4.1.6889.2.1.99.1.1.7 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: Note: Items are reported for the VoIP interface only. Object OID ifName 1.3.6.1.2.1.31.1.1.1.1 ifInMulticastPkts 1.3.6.1.2.1.31.1.1.1.2 ifInBroadcastPkts 1.3.6.1.2.1.31.1.1.1.3 ifOutMulticastPkts 1.3.6.1.2.1.31.1.1.1.4 ifOutBroadcastPkts 1.3.6.1.2.1.31.1.1.1.5 ifHCInOctets 1.3.6.1.2.1.31.1.1.1.6 1 of 2 Issue 1 February 2007 547 Traps and MIBs Object OID ifHCInUcastPkts 1.3.6.1.2.1.31.1.1.1.7 ifHCInMulticastPkts 1.3.6.1.2.1.31.1.1.1.8 ifHCInBroadcastPkts 1.3.6.1.2.1.31.1.1.1.9 ifHCOutOctets 1.3.6.1.2.1.31.1.1.1.10 ifHCOutUcastPkts 1.3.6.1.2.1.31.1.1.1.11 ifHCOutMulticastPkts 1.3.6.1.2.1.31.1.1.1.12 ifHCOutBroadcastPkts 1.3.6.1.2.1.31.1.1.1.13 ifLinkUpDownTrapEnable 1.3.6.1.2.1.31.1.1.1.14 ifHighSpeed 1.3.6.1.2.1.31.1.1.1.15 ifPromiscuousMode 1.3.6.1.2.1.31.1.1.1.16 ifConnectorPresent 1.3.6.1.2.1.31.1.1.1.17 ifAlias 1.3.6.1.2.1.31.1.1.1.18 ifCounterDiscontinuityTime 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: Note: All items apply to the TGM550 Gateway Module’s slot number. Object OID chNumberOfSlots 1.3.6.1.4.1.81.7.2 chReset 1.3.6.1.4.1.81.7.7 chGroupList 1.3.6.1.4.1.81.7.18 genGroupId 1.3.6.1.4.1.81.8.1.1.1 1 of 2 548 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module MIB files Object OID genGroupSWVersion 1.3.6.1.4.1.81.8.1.1.2 genGroupType 1.3.6.1.4.1.81.8.1.1.4 genGroupDescr 1.3.6.1.4.1.81.8.1.1.5 genGroupNumberOfPorts 1.3.6.1.4.1.81.8.1.1.6 genGroupReset 1.3.6.1.4.1.81.8.1.1.8 genGroupConfigurationSymbol 1.3.6.1.4.1.81.8.1.1.21 genGroupFaultMask 1.3.6.1.4.1.81.8.1.1.36 genGroupTypeName 1.3.6.1.4.1.81.8.1.1.37 genGroupAgentSlot 1.3.6.1.4.1.81.8.1.1.38 genGroupMngType 1.3.6.1.4.1.81.8.1.1.39 genGroupNumberOfInterfaces 1.3.6.1.4.1.81.8.1.1.41 genGroupLogFileClear 1.3.6.1.4.1.81.8.1.1.47 genGroupBootVersion 1.3.6.1.4.1.81.8.1.1.48 genGroupSerialNumber 1.3.6.1.4.1.81.8.1.1.50 genGroupFips140Ready 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 OID cmgHWType 1.3.6.1.4.1.6889.2.9.1.1.1 cmgModelNumber 1.3.6.1.4.1.6889.2.9.1.1.2 cmgDescription 1.3.6.1.4.1.6889.2.9.1.1.3 cmgSerialNumber 1.3.6.1.4.1.6889.2.9.1.1.4 1 of 5 Issue 1 February 2007 549 Traps and MIBs Object OID cmgHWVintage 1.3.6.1.4.1.6889.2.9.1.1.5 cmgHWSuffix 1.3.6.1.4.1.6889.2.9.1.1.6 cmgStackPosition 1.3.6.1.4.1.6889.2.9.1.1.7 cmgModuleList 1.3.6.1.4.1.6889.2.9.1.1.8 cmgReset 1.3.6.1.4.1.6889.2.9.1.1.9 cmgHardwareFaultMask 1.3.6.1.4.1.6889.2.9.1.1.10.12 cmgHardwareStatusMask 1.3.6.1.4.1.6889.2.9.1.1.10.13 cmgModuleSlot 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.1 cmgModuleType 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.2 cmgModuleDescription 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.3 cmgModuleName 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.4 cmgModuleSerialNumber 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.5 cmgModuleHWVintage 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.6 cmgModuleHWSuffix 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.7 cmgModuleFWVersion 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.8 cmgModuleNumberOfPorts 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.9 cmgModuleFaultMask 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.10 cmgModuleStatusMask 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.11 cmgModuleReset 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.12 cmgModuleNumberOfChannels 1.3.6.1.4.1.6889.2.9.1.1.11.1.1.13 cmgGatewayNumber 1.3.6.1.4.1.6889.2.9.1.2.1.1 cmgMACAddress (for TGM550) 1.3.6.1.4.1.6889.2.9.1.2.1.2 cmgFWVersion 1.3.6.1.4.1.6889.2.9.1.2.1.3 cmgCurrentIpAddress (for TGM550) 1.3.6.1.4.1.6889.2.9.1.2.1.4 cmgMgpFaultMask 1.3.6.1.4.1.6889.2.9.1.2.1.15 cmgQosControl 1.3.6.1.4.1.6889.2.9.1.2.2.1 cmgRemoteSigDscp 1.3.6.1.4.1.6889.2.9.1.2.2.2 2 of 5 550 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module MIB files Object OID cmgRemoteSig802Priority (always value 0) 1.3.6.1.4.1.6889.2.9.1.2.2.3 cmgLocalSigDscp 1.3.6.1.4.1.6889.2.9.1.2.2.4 cmgLocalSig802Priority (always value 0) 1.3.6.1.4.1.6889.2.9.1.2.2.5 cmgStatic802Vlan (always value 0) 1.3.6.1.4.1.6889.2.9.1.2.2.6 cmgCurrent802Vlan (always value 0) 1.3.6.1.4.1.6889.2.9.1.2.2.7 cmgPrimaryClockSource 1.3.6.1.4.1.6889.2.9.1.2.3.1 cmgSecondaryClockSource 1.3.6.1.4.1.6889.2.9.1.2.3.2 cmgActiveClockSource 1.3.6.1.4.1.6889.2.9.1.2.3.3 cmgRegistrationState 1.3.6.1.4.1.6889.2.9.1.3.1 cmgActiveControllerAddress 1.3.6.1.4.1.6889.2.9.1.3.2 cmgH248LinkStatus 1.3.6.1.4.1.6889.2.9.1.3.3 cmgH248LinkErrorCode 1.3.6.1.4.1.6889.2.9.1.3.4 cmgUseDhcpForMgcList (always value 2) 1.3.6.1.4.1.6889.2.9.1.3.5 cmgStaticControllerHosts 1.3.6.1.4.1.6889.2.9.1.3.6 cmgDhcpControllerHosts 1.3.6.1.4.1.6889.2.9.1.3.7 cmgPrimarySearchTime cmgTotalSearchTime cmgTransitionPoint cmgVoipEngineUseDhcp 1.3.6.1.4.1.6889.2.9.1.4.1 cmgVoipQosControl 1.3.6.1.4.1.6889.2.9.1.4.2 cmgVoipRemoteBbeDscp 1.3.6.1.4.1.6889.2.9.1.4.3.1.1 cmgVoipRemoteEfDscp 1.3.6.1.4.1.6889.2.9.1.4.3.1.2 cmgVoipRemote802Priority (always value 0) 1.3.6.1.4.1.6889.2.9.1.4.3.1.3 cmgVoipRemoteMinRtpPort 1.3.6.1.4.1.6889.2.9.1.4.3.1.4 cmgVoipRemoteMaxRtpPort 1.3.6.1.4.1.6889.2.9.1.4.3.1.5 cmgVoipRemoteRtcpEnabled 1.3.6.1.4.1.6889.2.9.1.4.3.2.1 3 of 5 Issue 1 February 2007 551 Traps and MIBs Object OID cmgVoipRemoteRtcpMonitorIpAddress 1.3.6.1.4.1.6889.2.9.1.4.3.2.2 cmgVoipRemoteRtcpMonitorPort 1.3.6.1.4.1.6889.2.9.1.4.3.2.3 cmgVoipRemoteRtcpReportPeriod 1.3.6.1.4.1.6889.2.9.1.4.3.2.4 cmgVoipRemoteRsvpEnabled 1.3.6.1.4.1.6889.2.9.1.4.3.3.1 cmgVoipRemoteRetryOnFailure 1.3.6.1.4.1.6889.2.9.1.4.3.3.2 cmgVoipRemoteRetryDelay 1.3.6.1.4.1.6889.2.9.1.4.3.3.3 cmgVoipRemoteRsvpProfile 1.3.6.1.4.1.6889.2.9.1.4.3.3.4 cmgVoipLocalBbeDscp 1.3.6.1.4.1.6889.2.9.1.4.4.1.1 cmgVoipLocalEfDscp 1.3.6.1.4.1.6889.2.9.1.4.4.1.2 cmgVoipLocal802Priority (always value 0) 1.3.6.1.4.1.6889.2.9.1.4.4.1.3 cmgVoipLocalMinRtpPort 1.3.6.1.4.1.6889.2.9.1.4.4.1.4 cmgVoipLocalMaxRtpPort 1.3.6.1.4.1.6889.2.9.1.4.4.1.5 cmgVoipLocalRtcpEnabled 1.3.6.1.4.1.6889.2.9.1.4.4.2.1 cmgVoipLocalRtcpMonitorIpAddress 1.3.6.1.4.1.6889.2.9.1.4.4.2.2 cmgVoipLocalRtcpMonitorPort 1.3.6.1.4.1.6889.2.9.1.4.4.2.3 cmgVoipLocalRtcpReportPeriod 1.3.6.1.4.1.6889.2.9.1.4.4.2.4 cmgVoipLocalRsvpEnabled 1.3.6.1.4.1.6889.2.9.1.4.4.3.1 cmgVoipLocalRetryOnFailure 1.3.6.1.4.1.6889.2.9.1.4.4.3.2 cmgVoipLocalRetryDelay 1.3.6.1.4.1.6889.2.9.1.4.4.3.3 cmgVoipLocalRsvpProfile 1.3.6.1.4.1.6889.2.9.1.4.4.3.4 cmgVoipSlot (always value 10 for the TGM550 DSP module) 1.3.6.1.4.1.6889.2.9.1.4.5.1.1 cmgVoipMACAddress (always value 0) 1.3.6.1.4.1.6889.2.9.1.4.5.1.2 cmgVoipStaticIpAddress (for the TGM550) 1.3.6.1.4.1.6889.2.9.1.4.5.1.3 cmgVoipCurrentIpAddress (for the TGM550) 1.3.6.1.4.1.6889.2.9.1.4.5.1.4 cmgVoipJitterBufferSize (always value 2560, for maximum jitter buffer of 320 ms.) 1.3.6.1.4.1.6889.2.9.1.4.5.1.5 4 of 5 552 IG550 Integrated Gateway Administration and CLI Reference TGM550 Telephony Gateway Module MIB files Object OID cmgVoipTotalChannels 1.3.6.1.4.1.6889.2.9.1.4.5.1.6 cmgVoipChannelsInUse 1.3.6.1.4.1.6889.2.9.1.4.5.1.7 cmgVoipAverageOccupancy 1.3.6.1.4.1.6889.2.9.1.4.5.1.8 cmgVoipHyperactivity 1.3.6.1.4.1.6889.2.9.1.4.5.1.9 cmgVoipAdminState 1.3.6.1.4.1.6889.2.9.1.4.5.1.10 cmgVoipDspFWVersion 1.3.6.1.4.1.6889.2.9.1.4.5.1.11 cmgVoipDspStatus 1.3.6.1.4.1.6889.2.9.1.4.5.1.12 cmgVoipEngineReset 1.3.6.1.4.1.6889.2.9.1.4.5.1.13 cmgVoipFaultMask 1.3.6.1.4.1.6889.2.9.1.4.5.1.14 cmgTrapManagerAddress cmgTrapManagerControl cmgTrapManagerMask cmgTrapManagerRowStatus cmgEtrModule 1.3.6.1.4.1.6889.2.9.1.7.1.1.1 cmgEtrAdminState 1.3.6.1.4.1.6889.2.9.1.7.1.1.2 cmgEtrNumberOfPairs 1.3.6.1.4.1.6889.2.9.1.7.1.1.3 cmgEtrStatus 1.3.6.1.4.1.6889.2.9.1.7.1.1.4 cmgEtrCurrentLoopDetect 1.3.6.1.4.1.6889.2.9.1.7.1.1.5 cmgDynCacStatus 1.3.6.1.4.1.6889.2.9.1.8.1 cmgDynCacRBBL 1.3.6.1.4.1.6889.2.9.1.8.2 cmgDynCacLastUpdate 1.3.6.1.4.1.6889.2.9.1.8.3 5 of 5 Issue 1 February 2007 553 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 OID sysDescr 1.3.6.1.2.1.1.1 sysObjectID 1.3.6.1.2.1.1.2 sysUpTime 1.3.6.1.2.1.1.3 sysContact (value set by J-series router) 1.3.6.1.2.1.1.4 sysName (value set by J-series router) 1.3.6.1.2.1.1.5 sysLocation (value set by J-series router) 1.3.6.1.2.1.1.6 sysServices 1.3.6.1.2.1.1.7 554 IG550 Integrated Gateway Administration and CLI Reference Appendix B: Configuring the router’s 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: Note: 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. 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 1 February 2007 555 Configuring the router’s 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. 556 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: 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: 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 577. 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 557 ● Configuring a Dialer Interface on page 560 ● Configuring Dial Backup on page 562 ● Configuring Dial-In on page 574 ● Configuring CHAP on Dialer Interfaces (Optional) on page 576 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 1: Adding a USB modem interface on page 558. 3. Go on to Configuring a Dialer Interface on page 560. Issue 1 February 2007 557 Configuring the router’s modem interface for remote dial-in and dial backup Addding a USB modem interface Table 1: Adding a USB modem interface Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Configure or Edit. ● Create the new interface umd0 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. From the [edit] hierarchy level, enter edit interfaces umd0. 1 of 2 558 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 1: Adding a USB modem interface (continued) Task J-Web Configuration Editor CLI Configuration Editor Configure dialer options: 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. ● 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. ● 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 560. ● 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. ● 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. ● From the [edit interfaces umd0] hierarchy, enter set dialer-options pool usb-modem-dialer-poo l priority 25 From the [edit interfaces umd0] hierarchy, enter set modem-options init-command-string "ATS0=2\n". 2 of 2 Issue 1 February 2007 559 Configuring the router’s 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 2: Adding a Dialer Interface to a Services Router Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Configure or Edit. ● Create the new interface — for example, dl0. Adding a description can differentiate between different dialer interfaces — for example, USB-modem-backup. 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. 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. 1. In the Encapsulation column, next to the new interface, click Edit. 2. From the Encapsulation list, select ppp. ● Enter set encapsulation ppp. Create the logical unit 0. You can set the logical unit to 0 only. 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. From the [edit] hierarchy level, enter edit interfaces 1 of 3 560 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 2: Adding a Dialer Interface to a Services Router (continued) Task J-Web Configuration Editor CLI Configuration Editor 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. 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. 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 1 February 2007 561 Configuring the router’s modem interface for remote dial-in and dial backup Table 2: Adding a Dialer Interface to a Services Router (continued) Task J-Web Configuration Editor CLI Configuration Editor Configure the telephone number of the remote destination to call if the primary interface goes down — for example, 5551212. 1. Next to Dial string, click Add new entry. 2. In the Dial string box, type 5551212. 3. Click OK. ● Enter set dial-string 5551212 Configure source and destination IP addresses for the dialer interface — for example, 172.20.10.2 and 172.20.10.1. 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. ● 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 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. ● ● 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. 562 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Figure 1: 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 564. ● 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 566. For more information about configuring firewall filters, see Configuring a Dialer Filter for Dial-on-Demand Routing Backup on page 565. For more information about configuring dialer watch, see Configuring Dialer Watch on page 571. ● 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 574. Issue 1 February 2007 563 Configuring the router’s 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 3: Configuring an Interface for USB Modem Dial Backup on page 564. 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 565. For more information about configuring firewall filters, seeConfiguring a Firewall Filter for Dial-on-Demand Routing Backup on page 567. For more information about configuring dialer watch, see Configuring Dialer Watch on page 571. Table 3: Configuring an Interface for USB Modem Dial Backup Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. ● 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. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. Configure the backup dialer interface — for instance, dl0.0. 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. ● Enter set backup-options interface dl0.0 564 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 565 ● Applying the Dial-on-Demand Firewall Filter to the Dialer Interface on page 570 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 4: Configuring a Dialer Filter for Interesting Packets on page 565. 3. Go on to Applying the Dial-on-Demand Dialer Filter to the Dialer Interface on page 566. Table 4: Configuring a Dialer Filter for Interesting Packets Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Firewall level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Firewall, click Edit. From the [edit] hierarchy level, enter edit firewall Configure the dialer filter name — for example, interesting-traffic. 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. Enter edit family inet Then enter edit dialer-filter interesting-traffic 1 of 2 Issue 1 February 2007 565 Configuring the router’s modem interface for remote dial-in and dial backup Table 4: Configuring a Dialer Filter for Interesting Packets (continued) Task J-Web Configuration Editor CLI Configuration Editor 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. 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. ● Configure the then part of the dialer filter to discard telnet traffic between the TGM550 and the MGC. 1. Next to Then, click Configure. 2. From the Designation list, select Note. 3. Click OK. ● ● ● 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. 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 567. 3. When you are finished configuring the router, commit the configuration. 566 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 5: Applying the Dialer Filter to the Dialer Interface Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. ● From the [edit] hierarchy level, enter edit interfaces dl0 unit 0 Select the dialer interface to apply the filter — for example, dl0. 1. In the Interface name column, click dl0. 2. Under Unit, in the Mtu column, click Edit. Apply the dialer filter to the dialer interface. 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 565, as the dialer-filter. 4. Click OK. ● 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 568 ● Applying the Dial-on-Demand Firewall Filter to the Dialer Interface on page 570 Issue 1 February 2007 567 Configuring the router’s 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 568. 3. Go on to Applying the Dial-on-Demand Firewall Filter to the Dialer Interface on page 570. Table 6: Configuring a Firewall Filter Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Firewall level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Firewall, click Edit. ● Configure the firewall filter name — for example, no-voip-traffic. 3. Next to Filter, click Add new entry. 4. In the Filter name box, type no-voip-traffic. Enter edit filter no-voip-traffic. From the [edit] hierarchy level, enter edit firewall. 1 of 2 568 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 6: Configuring a Firewall Filter (continued) Task J-Web Configuration Editor CLI Configuration Editor 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. 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. ● 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. 1. Next to Then, click Configure. 2. In the Count box, type voip-counter. 3. From the Designation list, select Discard. 4. Click OK. ● ● ● ● ● ● 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 Enter set then count voip-counter Enter set then discard 2 of 2 Issue 1 February 2007 569 Configuring the router’s 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 7: Applying the Dial-on-Demand Firewall Filter to the Dialer Interface Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. ● From the [edit] hierarchy level, enter edit interfaces dl0 unit 0 Select the dialer interface to apply the filter — for example, dl0. 1. In the Interface name column, click dl0. 2. Under Unit, in the Mtu column, click Edit. Apply the firewall filter to the dialer interface. 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 565, as the firewall filter. 5. Click OK. ● Enter edit family inet filter Enter set output no-voip-traffic 570 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 571. 3. Go on to Configuring the USB Modem Interface for Dialer Watch on page 572. Table 8: Adding a Dialer Watch Interface Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy. 1. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. 2. Next to Interfaces, click Edit. 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. 1. Under Interface name, select dl0. 2. In the Description box, type dialer-watch. Enter edit dl0 Enter set description dialer-watch 1 of 2 Issue 1 February 2007 571 Configuring the router’s modem interface for remote dial-in and dial backup Table 8: Adding a Dialer Watch Interface (continued) Task J-Web Configuration Editor CLI Configuration Editor On a logical interface — for example, 0 — configure the list of routes for dialer watch — for example, 200.200.201.1/32. 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. 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. 1. In the Pool box, type 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 9: Configuring an USB Modem Interface for Dialer Watch on page 573. 3. If you are finished configuring the router, commit the configuration. 572 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 9: Configuring an USB Modem Interface for Dialer Watch Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy, and select the USB modem physical interface umd0. 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. 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 8: Adding a Dialer Watch Interface on page 571, is used when configuring the USB modem interface. 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. Issue 1 February 2007 573 Configuring the router’s 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 10: Configuring the Dialer Interface for Dial-In Task J-Web Configuration Editor CLI Configuration Editor Navigate to the Interfaces level in the configuration hierarchy, and select a dialer interface — for example, dl0. 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. From the [edit] hierarchy level, enter edit interfaces dl0 1 of 2 574 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 10: Configuring the Dialer Interface for Dial-In (continued) Task J-Web Configuration Editor CLI Configuration Editor 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. 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. ● ● ● Enter edit unit 0 Enter edit dialer-options Enter set incoming-map caller 4085551515 2 of 2 Issue 1 February 2007 575 Configuring the router’s 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 11: Configuring CHAP on Dialer Interfaces on page 576. 3. If you are finished configuring the router, commit the configuration. Table 11: Configuring CHAP on Dialer Interfaces Task J-Web Configuration Editor CLI Configuration Editor 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. 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. 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 576 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 11: Configuring CHAP on Dialer Interfaces (continued) Task J-Web Configuration Editor CLI Configuration Editor Navigate to the appropriate dialer interface level in the configuration hierarchy — for example, dl0 unit 0. 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. 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. 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. 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 577 ● Resetting USB Modems on page 579 Configuring the USB Modem Initialization String Note: Note: 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 12: Modem Commands in Default Initialization String on page 578 describes the modem commands in the default initialization string. For more information on these commands, refer to the documentation for your modem. Issue 1 February 2007 577 Configuring the router’s modem interface for remote dial-in and dial backup Table 12: Modem Commands in Default Initialization String Modem Command Description AT Attention. Informs the modem that a command follows it. S7=45 Waits 45 seconds for a carrier before aborting the call. S0=0 Disables auto answer. V1 Displays result codes as words. &C1 Disables reset on loss of carrier. E0 Disables echo of commands issued to the modem in the local terminal. Q0 Enables result codes. &Q8 Enables Microcom Networking Protocol (MNP) error control mode. %C0 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: 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. 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 13: Configuring the USB Modem Initialization String on page 579. 3. If you are finished configuring the router, commit the configuration. 578 IG550 Integrated Gateway Administration and CLI Reference Connecting the USB Modem to the Services Router's USB Port Table 13: Configuring the USB Modem Initialization String Task J-Web Configuration Editor Navigate to the Interfaces level in the configuration hierarchy. 4. In the J-Web interface, select Configuration>Edit Configuration>View and Edit. CLI Configuration Editor From the [edit] hierarchy level, enter edit interfaces umd0 5. Next to Interfaces, click Configure or Edit. 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. 6. Next to Modem options, click Configure. 7. In the Init command string box, type "AT S0=2 L2 " From the [edit interfaces umd0] hierarchy, enter set modem-options init-command-string "AT S0=2 L2" 8. Click OK. 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 1 February 2007 579 Configuring the router’s modem interface for remote dial-in and dial backup Configuring a personal computer for remote dial access through the router’s 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: 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. 580 IG550 Integrated Gateway Administration and CLI Reference Configuring a personal computer for remote dial access through the router’s 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 modem’s 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 1 February 2007 581 Configuring the router’s 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. 582 IG550 Integrated Gateway Administration and CLI Reference Configuring a personal computer for remote dial access through the router’s 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 1 February 2007 583 Configuring the router’s 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 sofware 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. 584 IG550 Integrated Gateway Administration and CLI Reference Configuring a personal computer for remote dial access through the router’s modem 17. Click the Properties button. The Internet Protocol (TCP/IP) Properties window appears. 18. Select the Obtain an IP address automatically option. Issue 1 February 2007 585 Configuring the router’s 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. 586 IG550 Integrated Gateway Administration and CLI Reference Configuring a personal computer for remote dial access through the router’s 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 computer’s Internet connection field is not selected. 26. Click OK. The settings for the modem PPP connection are complete. Issue 1 February 2007 587 Configuring the router’s modem interface for remote dial-in and dial backup 588 IG550 Integrated Gateway Administration and CLI Reference Index Index A Accessing Avaya Communication Manager . . . . . CLI . . . . . . . . . . . . . . . . . . MGC . . . . . . . . . . . . . . . . . . PIM . . . . . . . . . . . . . . . . . . via modem . . . . . . . . . . . . . . . Announcement files 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 login authentication . . . . . . . . . . . login authentication local-craft-password . login authentication response-time . . . . login authentication services-login . . . . show auth-file info . . . . . . . . . . . show auth-file status . . . . . . . . . . show login authentication . . . . . . . . username . . . . . . . . . . . . . . . Authentication file copy auth-file ftp . . . . . . . . . . . . copy auth-file scp . . . . . . . . . . . . copy auth-file tftp . . . . . . . . . . . . copy ftp auth-file . . . . . . . . . . . . copy scp auth-file . . . . . . . . . . . . copy tftp auth-file . . . . . . . . . . . . show auth-file info . . . . . . . . . . . show auth-file status . . . . . . . . . . show upload auth-file status . . . . . . . Auto Fallback in SLS . . . . . . . . . . . . Avaya Communication Manager accessing . . . . . . . . . . . . . . . configuring for SLS . . . . . . . . . . . functions . . . . . . . . . . . . . . . . Avaya Site Administration . . . . . . . . . Avaya Voice Announcement Manager (VAM) B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 . 235 . 240 . 253 . 273 . 147 . 298 . 406 . 419 . 490 . . . . . . . . . . . . . . . . . . . . . . . . . 291 . 292 . 292 . 293 . 408 . 420 . 450 . 526 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 . 237 . 237 . 241 . 254 . 262 . 408 . 420 . 491 . 49 . . . . . . . . . . . . . . . . 27 . 63 . 27 . 27 . 147 27 23 27 27 26 Backup service . . . . . . . . . . . . . . . . . . 133 BRI links, see Link status 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 . . . . . . . . . . . . . . . set logout . . . . . . . . . . . . . show logout . . . . . . . . . . . . CNA test plugs clear counters . . . . . . . . . . . cna-testplug . . . . . . . . . . . . cna-testplug-service . . . . . . . . configuration example . . . . . . . configuring for registration . . . . . control-port . . . . . . . . . . . . functionality . . . . . . . . . . . . overview . . . . . . . . . . . . . rtp-echo-port . . . . . . . . . . . rtp-test-port . . . . . . . . . . . . scheduler . . . . . . . . . . . . . show cna testplug . . . . . . . . . shutdown . . . . . . . . . . . . . test-rate-limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 239 239 492 . 61 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275 299 351 450 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 232 233 194 193 233 192 191 300 309 . 311 412 498 519 Issue 1 February 2007 25 26 25 26 23 47 46 44 25 23 45 20 42 589 Index Codec . . . . . . . . . . . . . . . . Commands clear logging file . . . . . . . . . clear logging server . . . . . . . . clear mgc list . . . . . . . . . . . clear ssh-client known-hosts . . . . clear tcp syn-cookies counters . . . cna-testplug . . . . . . . . . . . cna-testplug-service . . . . . . . control-port . . . . . . . . . . . . copy announcement-file ftp . . . . copy announcement-file scp . . . . copy ftp announcement-file . . . . copy ftp EW_archive . . . . . . . copy ftp startup-config . . . . . . copy ftp SW_imageA . . . . . . . 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 startup-config . . . . . . copy startup-config ftp . . . . . . copy startup-config scp . . . . . . copy startup-config tftp . . . . . . copy tftp EW_archive . . . . . . . copy tftp startup-config . . . . . . copy tftp SW_imageA . . . . . . . copy tftp SW_imageB . . . . . . . create SNMPv3 user . . . . . . . crypto key generate dsa . . . . . . dir . . . . . . . . . . . . . . . . disconnect ssh . . . . . . . . . . erase announcement-file . . . . . fair-queue-limit . . . . . . . . . . fair-voip-queue . . . . . . . . . . help . . . . . . . . . . . . . . . interface . . . . . . . . . . . . . ip rtp port-range . . . . . . . . . ip snmp enable . . . . . . . . . . ip ssh . . . . . . . . . . . . . . ip telnet . . . . . . . . . . . . . ip telnet client. . . . . . . . . . . key config-key password-encryption no snmp trap link-status . . . . . . no username . . . . . . . . . . . priority-queue. . . . . . . . . . . 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 . . . . . . . . . . . . . . . . 130 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 . 117 . 40 . 30 . 35 . 193 . 194 . 194 . 147 . 147 . 148 . 45 . 46 . 45 . 45 . 47 . 47 . 45 . 47 . 147 . 46 . 47 . 47 . 47 . 45 . 46 . 45 . 45 . 143 . 30 . 47 . 30 . 148 . 132 . 131 . 25 . 37 . 129 . 143 . 30 . 33 . 33 . 33 . 142 . 29 . 131 . 148 . 194 156, 189 155, 189 160, 189 158, 189 159, 189 Commands, (continued) rtp-stat qos-trap-rate-limit . . . . . . . . rtp-stat service . . . . . . . . . . . . . rtp-stat threshold . . . . . . . . . . . . rtp-stat-service . . . . . . . . . . . . . rtp-test-port . . . . . . . . . . . . . . . scheduler . . . . . . . . . . . . . . . . session mgc . . . . . . . . . . . . . . set boot bank . . . . . . . . . . . . . . set etr . . . . . . . . . . . . . . . . . set logging file disable . . . . . . . . . . set logging file enable . . . . . . . . . . set logging server . . . . . . . . . . . . set logging server access-level . . . . . . set logging server disable . . . . . . . . set logging server enable . . . . . . . . set logging server facility . . . . . . . . . set logging session disable . . . . . . . . set logging session enable . . . . . . . . set mgc list . . . . . . . . . . . . . . . set port trap . . . . . . . . . . . . . . . set qos bearer . . . . . . . . . . . . . . set qos control . . . . . . . . . . . . . set qos rsvp . . . . . . . . . . . . . . . set qos rtcp . . . . . . . . . . . . . . . set qos signal . . . . . . . . . . . . . . set radius authentication disable . . . . . set radius authentication enable . . . . . 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 primary-search . . . . . . set reset-times total-search . . . . . . . set reset-times transition-point . . . . . . set snmp community . . . . . . . . . . . set snmp trap disable auth . . . . . . . . set snmp trap enable auth . . . . . . . . set snmp trap enable frame-relay . . . . . set sync source . . . . . . . . . . . . . set terminal recovery password. . . . . . set utilization cpu . . . . . . . . . . . . show announcements-files . . . . . . . . show boot bank . . . . . . . . . . . . . show cna testplug . . . . . . . . . . . . show download announcement-file status . show faults . . . . . . . . . . . . . . . show interfaces . . . . . . . . . . . . . show ip ssh . . . . . . . . . . . . . . . show logging file content . . . . . . . . . show logging server condition . . . . . . show mg list. . . . . . . . . . . . . . . show mgc . . . . . . . . . . . . . . . . show mm . . . . . . . . . . . . . . . . 590 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160, 190 . . 190 155, 189 . . 156 . . 194 . . 193 . . . 42 . . . 45 . . 133 . . . 119 . . . 119 . . . 116 . . . 117 . . . 117 . . . 116 . . . 116 . . 121 . . 121 . 39, 40 . . 141 . . 130 . . 130 . . 131 . . 131 . . 130 . . . 32 . . . 31 . . . 32 . . . 32 . . . 31 . . . 31 . . . 32 . . . 41 . . . 41 . . . 41 . . 143 . . 141 . . 141 . . 141 . . 197 . . . 32 . . . 43 . . 148 . . . 45 . . 194 . . 148 . . . 42 . . 191 . . . 30 . . . 119 . . . 118 . . . 42 . 40, 42 . . . 42 Index Commands, (continued) show mm v2 . . . . . . . . . . . . . show module . . . . . . . . . . . . . show module v2 . . . . . . . . . . . show qos . . . . . . . . . . . . . . . show qos-rtcp . . . . . . . . . . . . show queueing command . . . . . . . show radius authentication . . . . . . show recovery . . . . . . . . . . . . show restart-log . . . . . . . . . . . show rtp-stat config . . . . . . . . . . show rtp-stat detailed . . . . . . . . . show rtp-stat sessions . . . . . . . . show rtp-stat snmp . . . . . . . . . . show rtp-stat summary . . . . . . . . show rtp-stat thresholds . . . . . . . . show snmp . . . . . . . . . . . . . . show snmp engineID . . . . . . . . . show snmp group . . . . . . . . . . . show snmp user . . . . . . . . . . . show snmp userToGroup . . . . . . . show snmp view . . . . . . . . . . . show sync timing . . . . . . . . . . . show system . . . . . . . . . . . . . show tcp syn-cookies . . . . . . . . . show temp . . . . . . . . . . . . . . show upload announcement-file status . shutdown . . . . . . . . . . . . . . snmp trap link-status . . . . . . . . . snmp-server dynamic-trap-manager . . snmp-server enable notifications . . . . snmp-server engineID . . . . . . . . snmp-server group . . . . . . . . . . snmp-server host . . . . . . . . . . . snmp-server remote-user . . . . . . . snmp-server user . . . . . . . . . . . snmp-server view . . . . . . . . . . . tcp syn-cookies . . . . . . . . . . . . test led . . . . . . . . . . . . . . . . test-rate-limit . . . . . . . . . . . . . username . . . . . . . . . . . . . . voip-queue . . . . . . . . . . . . . . voip-queue-delay . . . . . . . . . . . Configuration defining an interface . . . . . . . . . dynamic trap manager . . . . . . . . installation and setup . . . . . . . . . managing configuration files . . . . . . MGC list . . . . . . . . . . . . . . . RTCP . . . . . . . . . . . . . . . . RTP . . . . . . . . . . . . . . . . . running configuration . . . . . . . . . saving configuration changes . . . . . startup configuration . . . . . . . . . using GUI applications . . . . . . . . using the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 . 42 . 42 . 130 . 131 . 130 . 32 . 41 . 43 . 190 162, 190 162, 190 . . . 190 161, 190 153, 190 141, 144, 159 . . . . . 143 . . . . . 144 . . . . . 144 . . . . . 143 . . . . . 143 . . . . . 198 . . . . 37, 43 . . . . . 35 . . . . . 43 . . . . . 149 . . . . . 194 . . . . . 142 144, 159, 190 . . . . . 141 . . . . . 143 . . . . . 143 141, 159, 190 . . . . . 143 . . 138, 143 . . 140, 143 . . . . . 35 . . . . . 43 . . . . . 194 . . . . . 29 . . 130, 131 . . 130, 132 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 . . 144 . . 19 . . 46 . . 39 . . 129 . . 129 . . 21 . . 21 . . 21 . 19, 21 . . 20 Configuration files copy ftp startup-config . . . . . . . . . . . . copy running-config ftp. . . . . . . . . . . . copy running-config scp . . . . . . . . . . . copy running-config startup-config . . . . . . copy running-config tftp . . . . . . . . . . . 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 logging file condition . . . . . . . . . . show running-config . . . . . . . . . . . . . show startup-config . . . . . . . . . . . . . Connectivity ping . . . . . . . . . . . . . . . . . . . . Console port connecting console device . . . . . . . . . . Converged Network Analyzer, see CNA test plugs CSU loopbacks show csu loopbacks . . . . . . . . . . . . . show csu status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 250 251 252 252 257 258 259 265 275 294 414 424 426 446 472 479 . 295 . . 25 . 415 . 416 D Device status set utilization cpu . . . . . show faults . . . . . . . . show mg list_config . . . . show mgc . . . . . . . . . show mm . . . . . . . . . show module . . . . . . . show recovery . . . . . . show restart-log . . . . . . show status . . . . . . . . show system . . . . . . . show timeout . . . . . . . show utilization . . . . . . test led . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398 429 452 453 455 456 462 462 480 484 487 496 518 . . . . . . . . . . 151 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Issue 1 February 2007 208 209 224 278 290 409 410 516 517 591 Index Dynamic CAC show dynamic-cac . . . . . . . . . . . . . . . 425 Dynamic trap manager snmp-server dynamic-trap-manager . . . . . . . 500 . . . . . . . . 231 Fragmentation clear fragment . . . . . fragment chain . . . . fragment size . . . . . fragment timeout . . . show fragment . . . . Frame relay encapsulation show interfaces . . . . FTP . . . . . . . . . . . . . . . . . . . 33 G E E1/T1 interfaces clock source . . . . . . . . . . Emergency Transfer Relay, see ETR Emergency transfer relay, see ETR Encrypting gateway secrets. . . . . ETR deactivating . . . . . . . . . . description . . . . . . . . . . . displaying status . . . . . . . . in SLS mode . . . . . . . . . . LED . . . . . . . . . . . . . . manual activation . . . . . . . . set etr . . . . . . . . . . . . . setting state . . . . . . . . . . show etr . . . . . . . . . . . . trunk-to-port latchings in TGM550 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217 276 276 277 430 . . . . . . . . . . . . 431 . . . . . . . . . . . . . 44 GUI tools, configuring the system with . . . . . . 19, 21 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 . 133 . 134 . 60 . 133 . 133 . 332 . 133 . 426 . 133 F Fair VoIP queue . . . . . . . . . . . File transfer, see FTP or TFTP . . . . FIPS show system . . . . . . . . . . . Firmware firmware bank defaults . . . . . . firmware banks . . . . . . . . . . load with ASB button . . . . . . . managing firmware banks . . . . . redundancy . . . . . . . . . . . upgrade overview . . . . . . . . . upgrading using FTP/TFTP . . . . version control . . . . . . . . . . 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 . . . . . . . . Firmware, see Firmware management Fixed analog trunk port . . . . . . . . . . . . . . . 131 . . . . . . . 44 . . . . . . . 484 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 . 246 . 265 . 266 . 269 . 315 . 411 . 423 . 430 44 22 45 44 44 44 45 22 . . . . . . . 133 H Help CLI . . . . . . . . . . . . . . . . . . . . . . . 25 commands . . . . . . . . . . . . . . . . . . . 25 I ICMP errors ip icmp-errors . . . . . . . . . . . . . show ip icmp . . . . . . . . . . . . . Interfaces defining . . . . . . . . . . . . . . . . displaying status . . . . . . . . . . . IP interface configuration interface Console . . . . . . . . . . . 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 . . 592 IG550 Integrated Gateway Administration and CLI Reference . . . . 284 . . . . 435 . . . . . 37 . . . . 191 . . . . 282 . . . . 438 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 242 243 247 248 249 255 263 264 274 274 288 407 421 422 440 441 493 Index K key config-key password-encryption . . . . . . . . . 289 L LEDs, ETR . . . . . . . . . . . . Link status show isdn bri link . . . . . . . . show isdn link summary . . . . . show isdn pri link . . . . . . . . Log file see Logging Log file, see Logging Logging clear logging file . . . . . . . . clear logging server . . . . . . . configuring log file . . . . . . . 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 . . . . . . . . . . . . . . . . . . 133 . . . . . . . . 444 . . . . . . . . 444 . . . . . . . . 445 Logging, (continued) 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447 448 449 . 115 . 116 . 118 . 115 126 . 118 M . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219, 220 . . . 221 . . . 119 . . . 121 . . . 116 . . . 124 . . . 123 . . . 119 . . . 117 . . . 119 . . . 121 . . . 117 . . . 119 . . . 118 . . . 119 . . . 121 . . . 116 . . . 124 . . . 115 . . . 117 . . . 115 . . . 127 . . . 123 . . . 121 . . . 115 . . . 115 115, 121 . . . 127 . . . 122 . . . 343 . . . 345 . . . 345 . . . 346 . . . 348 . . . 349 . . . 350 . . . 123 Master Configuration Key configuring . . . . . . . . . . . . . . . . . MCK (Master Configuration Key) . . . . . . . . Media Gateway Controller, see MGC configuration MGC accessing . . . . . . . . . . . . . . . . . . accessing the registered MGC . . . . . . . . auto fallback to primary . . . . . . . . . . . changing the list . . . . . . . . . . . . . . . clearing the lost . . . . . . . . . . . . . . . displaying the list . . . . . . . . . . . . . . running Avaya Communication Manager . . . setting reset times . . . . . . . . . . . . . . setting the list . . . . . . . . . . . . . . . . MGC configuration clear mgc list . . . . . . . . . . . . . . . . session . . . . . . . . . . . . . . . . . . . set mediaserver . . . . . . . . . . . . . . . set mgc list . . . . . . . . . . . . . . . . . set reset-times . . . . . . . . . . . . . . . show mediaserver . . . . . . . . . . . . . . show mgc . . . . . . . . . . . . . . . . . . show mgc list . . . . . . . . . . . . . . . . MGC list SLS entry . . . . . . . . . . . . . . . . . . Modem configuration interface Console . . . . . . . . . . . . . . Monitoring applications configuring . . . . . . . . . . . . . . . . . . . 33 . . 33 . . . . . . . . . . . . . . . . . . . . . . . . . . 222 312 355 356 373 451 453 454 27 41 38 40 40 40 27 41 39 . . 54 . 282 . 151 N Network monitoring applications . . . . . . . . . . . . . . . . . . 151 NVRAM, see Configuration files Issue 1 February 2007 593 Index P Packet sniffing ip capture-list ip-rule icmp . . . . . . . . . . . . . . . . show upload status . . . . . . . . . . Password, see Users Passwords changing . . . . . . . . . . . . . . . . . managing . . . . . . . . . . . . . . . . overview . . . . . . . . . . . . . . . . . recovery password . . . . . . . . . . . . Phones supported in SLS mode . . . . . . . PIM accessing . . . . . . . . . . . . . . . . description . . . . . . . . . . . . . . . . SLS configuration . . . . . . . . . . . . . Policy ip access-control-list ip-rule icmp . . . . . . . . . . . . . . . . ip qos-list ip-rule icmp . . . . . . . . . . . . . . . . Port classification show port classification . . . . . . . . . . Ports analog line . . . . . . . . . . . . . . . . PPP encapsulation show interfaces . . . . . . . . . . . . . . PRI links, see Link status Priority VoIP queuing . . . . . . . . . . . . . Privilege levels changing . . . . . . . . . . . . . . . . . description . . . . . . . . . . . . . . . . Provisioning and Installation Manager, see PIM . . . 279 . . . 494 . . . . . . . . . . . . . . . 29 28 28 32 50 . . . 27 . . . 27 . . . 67 . . . 279 . . . 279 . . . 458 . . . 133 . . . 431 . . . 131 . . . 29 . . . 29 Q QoS analyzing fault and clear trap output . configuration . . . . . . . . . . . . displaying parameters . . . . . . . . fair packet scheduling . . . . . . . . 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 voip-parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 . 130 . 130 . 131 . 160 . 153 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 . 130 . 364 . 365 . 368 . 497 QoS, (continued) SNMP traps . . . . . . . . . . . traps in messages file . . . . . . traps, viewing . . . . . . . . . . Weighted Fair VoIP Queuing . . . QoS, see RTP, RTCP, RSVP, WFVQ Queues fair packet scheduling . . . . . . Weighted Fair VoIP Queuing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 170 169 131 . . . . . . . 131 . . . . . . . 131 R 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 . . . . . . . . . . . . . . RSA authentication . . . . . . . . . . . RSVP . . . . . . . . . . . . . . . . . set qos 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 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 . . . . . . . . . . . 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 . . . . . . . 594 IG550 Integrated Gateway Administration and CLI Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28, 31 223 369 370 370 371 372 372 461 . 32 392 . . . . . . . . . . . . . . . 463 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520 . 30 131 365 460 129 367 460 129 151 151 153 . . . . . 151 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 301 303 304 305 306 306 307 464 465 466 468 469 470 Index 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 . . . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 . 152 . 159 . 160 . 158 . 155 . 162 . 161 . 156 . 159 . 158 . 152 . 153 . 156 . 176 . 155 . 155 . 160 . 161 . 156 . 170 S SAT sat . . . . . . . . . . . . . . . . . . . . SCP . . . . . . . . . . . . . . . . . . . . transferring announcement files using . . . Security overview . . . . . . . . . . . . . . . . . special features . . . . . . . . . . . . . . Session log, see Logging Session logs, see Logging Setting synchronization, see Synchronization . SLS Avaya phones supported in SLS . . . . . . call processing not supported by SLS . . . call processing supported by SLS . . . . . capabilities . . . . . . . . . . . . . . . . capacities by gateway model . . . . . . . CDR log . . . . . . . . . . . . . . . . . CLI command hierarchy . . . . . . . . . . configuring . . . . . . . . . . . . . . . . configuring Avaya Communication Manager for SLS . . . . . . . . . . . . . . . . . disabling . . . . . . . . . . . . . . . . . down-conversion from release 4.0 . . . . . enabling . . . . . . . . . . . . . . . . . entry in MGC list . . . . . . . . . . . . . features . . . . . . . . . . . . . . . . . . . . 310 . . . 30 . . . 147 . . . 28 . . . 32 . . . 197 . . . . . . . . . . . . . . . . . . . . . . . . 50 52 51 49 74 61 87 62 . . . . . . . . . . . . . . . . . . 63 73 113 73 54 49 SLS, (continued) interaction with call transfer . . . . . . . . . . . . . . . . Direct Inward Dialing . . . . . . . . . . . . ETR . . . . . . . . . . . . . . . . . . . . Hold feature . . . . . . . . . . . . . . . . multiple call appearances . . . . . . . . . . shared administrative identity with softphone . introduction . . . . . . . . . . . . . . . . . . logging . . . . . . . . . . . . . . . . . . . . manual CLI configuration administering BRI parameters . . . . . . . . administering dial-pattern parameters . . . . administering DS1 parameters . . . . . . . administering incoming-routing parameters . administering signaling-group parameters . . administering station parameters . . . . . . administering trunk-group parameters . . . . command sub-contexts . . . . . . . . . . . commands hierarchy . . . . . . . . . . . . instructions . . . . . . . . . . . . . . . . introduction . . . . . . . . . . . . . . . . preparing SLS data set . . . . . . . . . . . prerequisites . . . . . . . . . . . . . . . . PIM configuration . . . . . . . . . . . . . . . preparing SLS data set . . . . . . . . . . . . analog stations data . . . . . . . . . . . . ARS dial patterns data . . . . . . . . . . . DS1 trunks data . . . . . . . . . . . . . . FAC data . . . . . . . . . . . . . . . . . incoming call handling data . . . . . . . . . IP stations data . . . . . . . . . . . . . . ISDN-BRI trunks data . . . . . . . . . . . signaling groups data . . . . . . . . . . . . system parameters data . . . . . . . . . . provisioning data . . . . . . . . . . . . . . . states . . . . . . . . . . . . . . . . . . . . . registered . . . . . . . . . . . . . . . . . setup . . . . . . . . . . . . . . . . . . . teardown . . . . . . . . . . . . . . . . . unregistered . . . . . . . . . . . . . . . . supported functionality . . . . . . . . . . . . . up-conversion to release 4.0 . . . . . . . . . . SLS survivability survivable-call-engine . . . . . . . . . . . . . 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 . . . . . . . . . . . . . . . . Issue 1 February 2007 . . . . . . . . 58 56 60 57 56 60 49 61 102 . 111 . 97 . 112 . 110 . 94 104 . 86 . 87 . 92 . 73 . 73 . 73 . 67 . 73 . 74 . 84 . 79 . 82 . 85 . 75 . 81 . 80 . 83 . 52 . 54 . 55 . 54 . 55 . 54 . 51 . 113 513 210 313 322 329 330 331 339 340 342 357 595 Index SLS survivability, survivable-call-engine, bri, (continued) set side . . . . . . . . . . . . . . . . . 376 set spid-a . . . . . . . . . . . . . . . . 380 set spid-b . . . . . . . . . . . . . . . . 381 set tei-assignment . . . . . . . . . . . . 391 show . . . . . . . . . . . . . . . . . . 399 clear bri . . . . . . . . . . . . . . . . . . . 212 clear dial-pattern . . . . . . . . . . . . . . 214 clear ds1 . . . . . . . . . . . . . . . . . . 215 clear extension . . . . . . . . . . . . . . . 216 clear fac . . . . . . . . . . . . . . . . . . 217 clear incoming-routing . . . . . . . . . . . . 218 clear sig-group . . . . . . . . . . . . . . . 224 clear slot-config . . . . . . . . . . . . . . . 225 clear station . . . . . . . . . . . . . . . . . 227 clear survivable-config . . . . . . . . . . . . 228 clear trunk-group . . . . . . . . . . . . . . 230 dial-pattern . . . . . . . . . . . . . . . . . 267 set delete-digits . . . . . . . . . . . . . 324 set deny . . . . . . . . . . . . . . . . . 326 set insert-digits . . . . . . . . . . . . . . 337 set max-length . . . . . . . . . . . . . . 354 set min-length . . . . . . . . . . . . . . 357 set tgnum . . . . . . . . . . . . . . . . 392 set type . . . . . . . . . . . . . . . . . 396 show . . . . . . . . . . . . . . . . . . 399 ds1 . . . . . . . . . . . . . . . . . . . . . 271 set bearer-capability . . . . . . . . . . . 313 set bit-rate . . . . . . . . . . . . . . . . 314 set channel-numbering . . . . . . . . . . 316 set connect . . . . . . . . . . . . . . . 319 set country-protocol . . . . . . . . . . . 322 set interface . . . . . . . . . . . . . . . 339 set interface-companding . . . . . . . . . 340 set long-timer . . . . . . . . . . . . . . 352 set name. . . . . . . . . . . . . . . . . 357 set protocol-version. . . . . . . . . . . . 362 set side . . . . . . . . . . . . . . . . . 376 set signaling-mode . . . . . . . . . . . . 377 show . . . . . . . . . . . . . . . . . . 399 incoming-routing . . . . . . . . . . . . . . . 281 set delete-digits . . . . . . . . . . . . . 325 set insert-digits . . . . . . . . . . . . . . 338 set length . . . . . . . . . . . . . . . . 343 set match-pattern . . . . . . . . . . . . . 352 show . . . . . . . . . . . . . . . . . . 399 set date-format . . . . . . . . . . . . . . . 323 set fac . . . . . . . . . . . . . . . . . . . 333 set ip-codec-set . . . . . . . . . . . . . . . 341 set max-ip-registrations . . . . . . . . . . . 353 set pim-lockout . . . . . . . . . . . . . . . 360 set slot-config . . . . . . . . . . . . . . . . 378 set survivable-call-engine . . . . . . . . . . 383 show bri. . . . . . . . . . . . . . . . . . . 410 show date-format . . . . . . . . . . . . . . 417 SLS survivability, survivable-call-engine, (continued) 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 survivable-call-engine . . . . . . . . . show trunk-group. . . . . . . . . . . . . . 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 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 . . . . . . . . . . . . . . . . . . 596 IG550 Integrated Gateway Administration and CLI Reference 418 424 427 428 434 435 446 451 457 473 474 482 483 488 498 205 296 313 362 395 399 512 320 331 357 360 361 383 393 395 399 523 206 229 297 317 317 318 326 328 327 328 335 334 342 357 359 374 375 382 390 394 399 Index 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 . . . . . . . . defining the SNMPv3 notification host . . . deleting an OID from a view . . . . . . . . disabling authentication failure traps . . . . disabling link-up/down notifications/traps . . disabling link-up/down traps on an interface displaying a list of views . . . . . . . . . . displaying group lists . . . . . . . . . . . displaying information . . . . . . . . . . . displaying notification receiver list . . . . . displaying the engine ID . . . . . . . . . . displaying user lists . . . . . . . . . . . . displaying users and group mapping . . . . enabling access . . . . . . . . . . . . . enabling authentication failure traps . . . . 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 SNMPv3 timeout notifications . . . . setting the engine ID . . . . . . . . . . . snmp-server community . . . . . . . . . . supported trap versions . . . . . . . . . . user groups . . . . . . . . . . . . . . . user-based security model (USM) . . . . . USM security levels . . . . . . . . . . . . version 1 . . . . . . . . . . . . . . . . . version 2 . . . . . . . . . . . . . . . . . version 3 . . . . . . . . . . . . . . . . . versions . . . . . . . . . . . . . . . . . views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 . 135 . 138 . 145 . 141 . 143 . 143 . 140 . 140 . 138 . 137 . 137 . 141 . 143 . 141 . 141 . 142 . 143 . 144 . 141 . 144 . 143 . 144 . 143 . 143 . 141 . 141 . 141 . 142 . 141 . 139 . 135 . 135 . 139 . 158 . 143 . 141 . 143 . 144 . 141 . 143 . 143 . 136 . 139 . 138 . 138 . 137 . 137 . 137 . 136 . 140 SNMP access configuration ip snmp-server . . . . . . . . . . . . . . . . set snmp community . . . . . . . . . . . . . . set snmp retries . . . . . . . . . . . . . . . . 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 clear snmp trap . . . . . . . . . . . . . . . . show snmp . . . . . . . . . . . . . . . . . . snmp-server enable notifications . . . . . . . . snmp-server host . . . . . . . . . . . . . . . snmp-server informs . . . . . . . . . . . . . . Software management, see Firmware management Software, see Firmware . . . . . . . . . . . . . . SSH configuration . . . . . . . . . . . . . . . . . overview . . . . . . . . . . . . . . . . . . . SSH protocol clear ssh-client known-hosts . . . . . . . . . . disconnect ssh . . . . . . . . . . . . . . . . ip ssh . . . . . . . . . . . . . . . . . . . . . show ip ssh . . . . . . . . . . . . . . . . . . Standard Local Survivability, see SLS Standard Local Survivability, see SLS survivability Status of the device, see Device status Survivability auto fallback to primary MGC . . . . . . . . . configuring the MGClist . . . . . . . . . . . . connection preserving migration . . . . . . . . ELS . . . . . . . . . . . . . . . . . . . . . enhanced local survivability, see ELS . . . . . . MGC list . . . . . . . . . . . . . . . . . . . modem dial-backup . . . . . . . . . . . . . . options . . . . . . . . . . . . . . . . . . . . overview . . . . . . . . . . . . . . . . . . . setting reset times . . . . . . . . . . . . . . . SLS, see SLS SYN attacks protection, see SYN cookies SYN cookies attack notification . . . . . . . . . . . . . . . clearing counters . . . . . . . . . . . . . . . configuring . . . . . . . . . . . . . . . . . . introduction . . . . . . . . . . . . . . . . . . overview . . . . . . . . . . . . . . . . . . . statistics . . . . . . . . . . . . . . . . . . . strategies employed . . . . . . . . . . . . . . Issue 1 February 2007 285 379 380 474 475 476 477 478 479 499 501 502 508 509 . 511 225 474 501 504 507 . 22 . 30 . 29 226 271 286 439 . . . . . . . . . . 38 39 38 38 38 38 39 38 38 41 . . . . . . . 35 35 35 34 34 35 34 597 Index SYN flood attack protection, see SYN cookies Synchronization clear sync interface . . . . . . . . . . . . displaying synchronization timing . . . . . LED status . . . . . . . . . . . . . . . . overview . . . . . . . . . . . . . . . . . set sync interface . . . . . . . . . . . . . set sync source . . . . . . . . . . . . . . set sync switching . . . . . . . . . . . . show sync timing . . . . . . . . . . . . . Synchronization setting the sync source . . . . 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 . . . . . . . Syslog server see Logging Syslog, see Logging System Access Terminal, see SAT System identification set system contact . . . . . . . . . . . . set system location . . . . . . . . . . . . set system name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 . 198 . 198 . 197 . 384 . 385 . 386 . 484 . 197 . . . 229 . . . 485 . . . 514 . . . . . . . . . 260 . 260 . 261 . 494 . . . 387 . . . 388 . . . 389 T Telnet enabling and disabling access . . . . . . . Telnet access ip telnet . . . . . . . . . . . . . . . . . ip telnet-client . . . . . . . . . . . . . . telnet . . . . . . . . . . . . . . . . . . Terminal display, see Display TFTP . . . . . . . . . . . . . . . . . . . . TFTP server IP phone upgrades, see IP phone upgrades ip tftp-server . . . . . . . . . . . . . . . ip tftp-server file-system size . . . . . . . Tools for monitoring. . . . . . . . . . . . . . . VMON . . . . . . . . . . . . . . . . . . TRK port see Fixed analog trunk port . . . 33 . . . 286 . . . 287 . . . 516 . . . 44 . . . 288 . . . 288 . . . 151 . . . 151 U Upgrading firmware, see Firmware management USB mass storage device dir . . . . . . . . . . . . . . . . . . . . show restore status . . . . . . . . . . . . User authentication . . . . . . . . . . . . . . SSH . . . . . . . . . . . . . . . . . . . Usernames configuring . . . . . . . . . . . . . . . . managing . . . . . . . . . . . . . . . . . overview . . . . . . . . . . . . . . . . . removing . . . . . . . . . . . . . . . . . Users show username . . . . . . . . . . . . . . username . . . . . . . . . . . . . . . . . . . . . . . . . 269 463 . 28 . 29 . . . . . . . . . . . . 29 28 28 29 . . 495 . . 526 V VAM . . . . . . . . . . . . . . . Verifying WAN configuration show interfaces . . . . . . . . show ip interface . . . . . . . VMON, for troubleshooting QoS . . VoIP available transmission protocols enabling queuing . . . . . . . fair packet scheduling . . . . . overview . . . . . . . . . . . queue delay . . . . . . . . . . queue size . . . . . . . . . . RSVP protocol . . . . . . . . Weighted Fair VoIP Queuing . . VoIP QoS, see QoS VoIP testing busyout voip-dsp . . . . . . . release voip-dsp. . . . . . . . show voip-parameters . . . . . test voip-dsp . . . . . . . . . . . . . . . . . 147 . . . . . . . . 431 . . . . . . . . 436 . . . . . . . . 151 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 130 131 129 130 130 131 131 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 296 497 518 W Weighted Fair VoIP Queuing . . . . . . . . . . . 131 WFVQ, see Weighted Fair VoIP Queuing 598 IG550 Integrated Gateway Administration and CLI Reference