While reasonable efforts have been made to ensure that the
information in this document is complete and accurate at the time of
printing, Avaya assumes no liability for any errors. Avaya reserves the
right to make changes and corrections to the information in this
document without the obligation to notify any person or organization of
such changes.
Documentation disclaimer
“Documentation” means information published by Avaya in varying
mediums which may include product information, operating instructions
and performance specifications that Avaya generally makes available
to users of its products. Documentation does not include marketing
materials. Avaya shall not be responsible for any modifications,
additions, or deletions to the original published version of
documentation unless such modifications, additions, or deletions were
performed by Avaya. End User agrees 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 End User.
Link disclaimer
Avaya is not responsible for the contents or reliability of any linked
websites referenced within this site or documentation provided by
Avaya. Avaya is not responsible for the accuracy of any information,
statement or content provided on these sites and does not necessarily
endorse the products, services, or information described or offered
within them. Avaya does not guarantee that these links will work all the
time and has no control over the availability of the linked pages.
Warranty
Avaya provides a limited warranty on its hardware and Software
(“Product(s)”). 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 to Avaya customers and other parties through the
Avaya Support website:
you acquired the Product(s) from an authorized Avaya reseller outside
of the United States and Canada, the warranty is provided to you by
said Avaya reseller and not by Avaya. “Software” means computer
programs in object code, provided by Avaya or an Avaya Channel
Partner, whether as stand-alone products or pre-installed on hardware
products, and any upgrades, updates, bug fixes, or modified versions.
Licenses
THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA
WEBSITE,
APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR
INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC.,
ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER
(AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH
AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS
OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES
NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED
FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR
AN AVAYA AUTHORIZED RESELLER; AVAYA RESERVES THE
RIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE
ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE.
BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR
AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF
YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING,
DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER
REFERRED TO INTERCHANGEABLY AS “YOU” AND “END USER”),
AGREE TO THESE TERMS AND CONDITIONS AND CREATE A
BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE
APPLICABLE AVAYA AFFILIATE (“AVAYA”).
HTTP://SUPPORT.AVAYA.COM/LICENSEINFO ARE
http://support.avaya.com. Please note that if
Avaya grants you a license within the scope of the license types
described below, with the exception of Heritage Nortel Software, for
which the scope of the license is detailed below. Where the order
documentation does not expressly identify a license type, the
applicable license will be a Designated System License. The applicable
number of licenses and units of capacity for which the license is granted
will be one (1), unless a different number of licenses or units of capacity
is specified in the documentation or other materials available to you.
“Designated Processor” means a single stand-alone computing device.
“Server” means a Designated Processor that hosts a software
application to be accessed by multiple users.
Copyright
Except where expressly stated otherwise, no use should be made of
materials on this site, the Documentation, Software, or hardware
provided by Avaya. All content on this site, the documentation and the
Product provided by Avaya including the selection, arrangement and
design of the content is owned either by Avaya or its licensors and is
protected by copyright and other intellectual property laws including the
sui generis rights relating to the protection of databases. You may not
modify, copy, reproduce, republish, upload, post, transmit or distribute
in any way any content, in whole or in part, including any code and
software unless expressly authorized by Avaya. Unauthorized
reproduction, transmission, dissemination, storage, and or use without
the express written consent of Avaya can be a criminal, as well as a
civil offense under the applicable law.
Third Party Components
“Third Party Components” mean certain software programs or portions
thereof included in the Software that may contain software (including
open source software) distributed under third party agreements (“Third
Party Components”), which contain terms regarding the rights to use
certain portions of the Software (“Third Party Terms”). Information
regarding distributed Linux OS source code (for those Products that
have distributed Linux OS source code) and identifying the copyright
holders of the Third Party Components and the Third Party Terms that
apply is available in the Documentation or on Avaya’s website at:
support.avaya.com/Copyright. You agree to the Third Party Terms for
any such Third Party Components.
Note to Service Provider
The Product may use Third Party Components that have Third Party
Terms that do not allow hosting and may need to be independently
licensed for such purpose.
Preventing Toll Fraud
“Toll Fraud” is the unauthorized use of your telecommunications
system by an unauthorized party (for example, a person who is not a
corporate employee, agent, subcontractor, or is not working on your
company's behalf). Be aware that there can be a risk of Toll Fraud
associated with your system and that, if Toll Fraud occurs, it can result
in substantial additional charges for your telecommunications services.
Avaya Toll Fraud intervention
If you suspect that you are being victimized by Toll Fraud and you need
technical assistance or support, call Technical Service Center Toll
Fraud Intervention Hotline at +1-800-643-2353 for the United States
and Canada. For additional support telephone numbers, see the Avaya
Support website:
vulnerabilities with Avaya products should be reported to Avaya by
sending mail to: [email protected].
Trademarks
The trademarks, logos and service marks (“Marks”) displayed in this
site, the Documentation and Product(s) provided by Avaya are the
registered or unregistered Marks of Avaya, its affiliates, or other third
parties. Users are not permitted to use such Marks without prior written
consent from Avaya or such third party which may own the Mark.
Nothing contained in this site, the Documentation and Product(s)
should be construed as granting, by implication, estoppel, or otherwise,
any license or right in and to the Marks without the express written
permission of Avaya or the applicable third party.
Avaya is a registered trademark of Avaya Inc.
All non-Avaya trademarks are the property of their respective owners.
Linux® is the registered trademark of Linus Torvalds in the U.S. and
other countries.
Downloading Documentation
For the most current versions of Documentation, see the Avaya
Support website: http://support.avaya.com.
Contact Avaya Support
See the Avaya Support website: http://support.avaya.com for product
notices and articles, or to report a problem with your Avaya product.
For a list of support telephone numbers and contact addresses, go to
the Avaya Support website: http://support.avaya.com, scroll to the
bottom of the page, and select Contact Avaya Support.
Support for a Secondary SIP server.................................................................................................
Show running option feature............................................................................................................
CPU utilization feature......................................................................................................................
Other changes...........................................................................................................................................
show console_timeout...............................................................................................................................
show configuration running.......................................................................................................................
show configuration stored.........................................................................................................................
show running-config..................................................................................................................................
show startup-config...................................................................................................................................
show system configuration........................................................................................................................
show user_accounts.................................................................................................................................
show users................................................................................................................................................
show whoami............................................................................................................................................
show file ls.................................................................................................................................................
show file version........................................................................................................................................
ip address..................................................................................................................................................
ip route......................................................................................................................................................
no user......................................................................................................................................................
show chassis.............................................................................................................................................
show dst....................................................................................................................................................
show module alarms.................................................................................................................................
show module configuration.......................................................................................................................
show module configuration all...................................................................................................................
show sntp..................................................................................................................................................
show telnet................................................................................................................................................
no switchport.............................................................................................................................................
show bridge port........................................................................................................................................
show interface ethernet.............................................................................................................................
Chapter 11: MAC address table commands.....................................................................
mac address..............................................................................................................................................
mac aging-time..........................................................................................................................................
show bridge config....................................................................................................................................
show bridge detail.....................................................................................................................................
show bridge mac.......................................................................................................................................
show bridge mac address.........................................................................................................................
show bridge mac dynamic.........................................................................................................................
show bridge mac static..............................................................................................................................
show bridge mac multicast........................................................................................................................
show bridge mac unicast...........................................................................................................................
show bridge vlan.......................................................................................................................................
show bridge port........................................................................................................................................
show mirror...............................................................................................................................................
show rmon alarm.......................................................................................................................................
show rmon alarms.....................................................................................................................................
show rmon ethernet_history......................................................................................................................
show rmon events.....................................................................................................................................
show rmon history_control........................................................................................................................
show rmon logs.........................................................................................................................................
show rmon statistics..................................................................................................................................
configure ip dhcps pool altvlan..................................................................................................................
configure ip dhcps pool callserver.............................................................................................................
configure ip dhcps pool clientid.................................................................................................................
configure ip dhcps pool commit.................................................................................................................
configure ip dhcps pool default_gateway..................................................................................................
configure ip dhcps pool dnsserver............................................................................................................
configure ip dhcps pool domain................................................................................................................
configure ip dhcps pool exclude-range.....................................................................................................
configure ip dhcps pool host.....................................................................................................................
configure ip dhcps pool hwaddr................................................................................................................
configure ip dhcps pool lease...................................................................................................................
configure ip dhcps pool netbios_name_server.........................................................................................
configure ip dhcps pool network...............................................................................................................
configure ip dhcps pool tftpserver.............................................................................................................
configure ip dhcps pool wireless...............................................................................................................
configure ip dhcps relay............................................................................................................................
configure ip dhcps remote_database........................................................................................................
configure ip domain_name........................................................................................................................
configure ip name_server..........................................................................................................................
configure ip pname_server........................................................................................................................
show dhcp-relay........................................................................................................................................
show ip dhcps address_pools...................................................................................................................
show ip dhcps bindings.............................................................................................................................
show ip dhcps config.................................................................................................................................
show ip dhcps interfaces...........................................................................................................................
show ip dhcps statistics.............................................................................................................................
show ip dns...............................................................................................................................................
show ftp.....................................................................................................................................................
show telnet................................................................................................................................................
show tftp_server_info................................................................................................................................
clear ip prefix-list.......................................................................................................................................
configure interface ip address...................................................................................................................
configure interface ip proxy-arp.................................................................................................................
configure interface ip redirects..................................................................................................................
configure interface ip unreachables..........................................................................................................
configure ip icmp rate-limit........................................................................................................................
configure ip load-balancing.......................................................................................................................
configure ip prefix-list................................................................................................................................
configure ip route......................................................................................................................................
show ip interfaces.....................................................................................................................................
show ip prefix-list.......................................................................................................................................
show ip protocols......................................................................................................................................
show ip proxy-arp......................................................................................................................................
show ip route.............................................................................................................................................
show route-map........................................................................................................................................
show ipv6 access-list................................................................................................................................
show ipv6 general-prefix...........................................................................................................................
show ipv6 interfaces..................................................................................................................................
show ipv6 mroute......................................................................................................................................
show ipv6 mtu...........................................................................................................................................
show ipv6 mvif...........................................................................................................................................
show ipv6 neighbors.................................................................................................................................
show ipv6 prefix-list...................................................................................................................................
show ipv6 route.........................................................................................................................................
show ipv6 routers......................................................................................................................................
show sla profile.........................................................................................................................................
show ip packet-filter..................................................................................................................................
show ipv6 packet-filter...............................................................................................................................
show mac packet-filter..............................................................................................................................
show aaa accounting................................................................................................................................
show aaa authentication...........................................................................................................................
show aaa authorization.............................................................................................................................
show aaa interface....................................................................................................................................
show aaa radius........................................................................................................................................
show aaa status........................................................................................................................................
show aaa tacacs.......................................................................................................................................
show dot1x................................................................................................................................................
clear ip ssh session...................................................................................................................................
show ip ssh config.....................................................................................................................................
show ip ssh session..................................................................................................................................
Chapter 29: SIP Media Gateway commands.....................................................................
show sip-ua calls.......................................................................................................................................
show sip-ua map pstn-sip.........................................................................................................................
show sip-ua map sip-pstn.........................................................................................................................
show sip-ua statistics................................................................................................................................
show sip-ua status....................................................................................................................................
show sip-ua timers....................................................................................................................................
Global VoIP configuration commands.......................................................................................................
configure terminal system logging syslog module voip-cdr.......................................................................
show trunk group.......................................................................................................................................
configure dial-peer voice voip fax protocol................................................................................................
configure dial-peer voice voip fax rate......................................................................................................
configure dial-peer voice voip modem passthrough.................................................................................
configure voice service voip fax protocol..................................................................................................
configure voice service voip fax rate.........................................................................................................
configure voice service voip modem passthrough....................................................................................
show call active fax...................................................................................................................................
Common voice port configuration commands...........................................................................................
show call active voice................................................................................................................................
show voice port.........................................................................................................................................
Common FXS/FXO port configuration commands....................................................................................
debug ip arp..............................................................................................................................................
debug ip vrrp.............................................................................................................................................
debug ip vrrp all.........................................................................................................................................
debug ip vrrp error.....................................................................................................................................
debug ip vrrp state....................................................................................................................................
debug ip vrrp events..................................................................................................................................
debug ip vrrp packet..................................................................................................................................
debug ip tunnel.........................................................................................................................................
debug ip tunnel all.....................................................................................................................................
debug ip tunnel error.................................................................................................................................
debug ip tunnel encap...............................................................................................................................
debug ip tunnel decap...............................................................................................................................
debug ip tunnel packet..............................................................................................................................
debug ip tunnel keepalive.........................................................................................................................
debug ip tunnel state.................................................................................................................................
debug ip dhcps..........................................................................................................................................
debug ip dhcps all.....................................................................................................................................
debug ip dhcps error.................................................................................................................................
debug ip dhcps state.................................................................................................................................
debug ip dhcps events..............................................................................................................................
debug ip dhcps packet..............................................................................................................................
debug ip ssh..............................................................................................................................................
debug ip statistics......................................................................................................................................
debug ip statistics ipshow.........................................................................................................................
debug ip statistics icmpshow.....................................................................................................................
debug ip statistics rtshow..........................................................................................................................
debug ip statistics tcpshow.......................................................................................................................
debug ip statistics udpshow......................................................................................................................
debug ip statistics ipmuxshow...................................................................................................................
debug ip statistics ipmuxclear...................................................................................................................
debug ip statistics ipclear..........................................................................................................................
debug ip statistics icmpclear.....................................................................................................................
This guide provides the function and syntax for the commands that you can execute using the
Command Line Interface (CLI) for the Avaya Advanced Gateway 2330.
Related resources
Documentation
See the Avaya Advanced Gateway 2330 Documentation Roadmap, NN47264-103, for a list
of the documentation for this product.
Training
Ongoing product training is available. For more information or to register, you can access the
Web site at http://avaya-learning.com.
Avaya Mentor videos
Avaya Mentor is an Avaya-run channel on YouTube that includes technical content on how to
install, configure, and troubleshoot Avaya products.
Go to http://www.youtube.com/AvayaMentor and perform one of the following actions:
• Enter a key word or key words in the Search Channel to search for a specific product
or topic.
• Scroll down Playlists, and click the name of a topic to see the available list of videos
posted on the site.
Command Line ReferenceAugust 2013 25
Page 26
Introduction
Support
Visit the Avaya Support website at
documentation, product notices, and knowledge articles. You can also search for release
notes, downloads, and resolutions to issues. Use the online service request system to create
a service request. Chat with live agents to get answers to questions, or request an agent to
connect you to a support team if an issue requires additional expertise.
This section details what is new in Command Line Reference Avaya Advanced Gateway 2330 (NN47264–
507) for Release 10.3.5.
Features
The following section details what is new in the Command Line Reference Avaya Advanced
Gateway 2330 (NN47264–507) for Release 10.3.5.
Support for a Secondary SIP server
The Secure Router and the Advanced Gateway (SR/AG) support dual Session Managers at
the headquarters. Then, if the Primary SIP server fails, the AG/SR fails over to the Secondary
SIP server so there’s no interruption in service. For more information, see configure sip-ua sip-
domain on page 306.
Show running option feature
Avaya Advanced Gateway 2300 Release 10.3.5 introduces options to the commands show
running-config and show startup-config that allow you to display specific parts of the current
configuration, rather than the full configuration. For more information, see
config on page 37 and show startup-config on page 37.
CPU utilization feature
Release 10.3.5 introduces CPU utilization monitoring functionality on the Avaya Advanced
Gateway 2330. For more information, see
show running-
CPU utilization commands on page 397.
Command Line ReferenceAugust 2013 27
Page 28
New in this release
Other changes
• The following commands have been updated with changes that were previously
documented in the Advanced Gateway 2330 Release Notes:
configure ip icmp rate-limit on page 185
-
- configure voice translation-rule rule on page 354
• New commands related to SNMPv3, that were previously documented in the Advanced
Gateway 2330 Release Notes, have been added to the section
page 131.
This chapter describes the basic CLI commands used in the Avaya Advanced Gateway 2330.
clear
Use this command to access the clear commands.
Syntax
clear
Example
AG# clear
configure admin_name
Use this command to modify the administrator account user name.
To modify the administrator user name, you must log in with level 1 user privileges using the
administrator account (default user name is admin and password is setup).
Syntax
admin_name <admin-name>
Table 1: Variable definitions
Variable
<admin-name>Specifies the new administrator user name.
Example
AG/configure# admin_name HQadmin
Value
Command Line ReferenceAugust 2013 29
Page 30
Basic CLI commands
configure console_timeout
Use this command to configure a timeout in seconds for console sessions. The default value
is 0, which indicates no timeout.
Syntax
console_timeout <0-3600>
Example
AG/configure# console_timeout 900
configure flash
Use this command to copy a saved .cfg file from flash to the gateway to reinstate a previously
saved configuration. After you enter the command, the system prompts you to enter the full
file name.
Syntax
configure flash
Example
AG# configure flash
filename: AG2330.cfg
configure header
Use this command to add a header with descriptive information to the top of the configuration
file. The maximum length of the header is 80 characters.
Syntax
header "<header>"
Example
AG/configure# header "This file was originally activated on
07/16/10."
Use this command to enter the interface mode, and configure interface properties.
Syntax
interface <IFNAME>
Table 2: Variable definitions
VariableValue
<IFNAME>name of the interface for which the properties
Example
AG/configure# interface ethernet 0/0
configure interface
are to be configured.
configure network
Use this command to copy a saved .cfg file from the network to the gateway to reinstate a
previously saved configuration. After you enter the command, the system prompts you to enter
the DNS name or IP address of the host and the path and name of the configuration file.
Syntax
configure network
Example
AG# configure network
host: 1.2.3.4
filename: /networks/AG2330.cfg
configure secure_passwords
Use this command to encrypt the user passwords to ensure that no one can view them in plain
text when they are displayed on screen, or viewed in the configuration file. Use the no form of
the command to display passwords in plain text.
Command Line ReferenceAugust 2013 31
Page 32
Basic CLI commands
Syntax
[no] secure_passwords
Example
AG/configure# secure_passwords
configure SYS_REM
Use this command to add comments at the beginning of a configuration. The comments appear
after saving the configuration using the save local command.
The maximum length of the comment string is 80 characters.
Syntax
SYS_REM "<comments>"
Example
AG/configure# SYS_REM “Configured on November 3, 2007 9:45 by JB.”
configure SYS_REM_
Use this command to add comments at the end of a configuration file. The comments appear
after saving the configuration using the save local command.
The maximum length of the comment string is 80 characters.
Syntax
SYS_REM_ "<comments>"
Example
AG/configure# SYS_REM_ "Everything left unchanged except IP packet
filter. JB 11/06/07 12:20."
configure terminal
Use this command to enter the configuration command mode from a console terminal or
management workstation and manually configure the gateway system parameters.
Use this command to configure users on the AG2330.
To configure users, you must log in with level 1 user privileges using the administrator
account.
You can configure any new user to have a user privilege level from 2 to 4. The administrator
account is the only account that has level 1 privileges.
Syntax
user <user-name> [<user-level>]
After you enter this command, the system prompts you to enter the password.
Table 3: Variable definitions
configure user
exit
VariableValue
<user-name>Specifies the user name.
[<user-level>]Specifies the privilege level for the user, from
2 to 4.
Example
AG/configure# user user1 2
Use this command to exits the system CLI or exit from a lower-level command prompt to a
higher-level command prompt in the CLI hierarchy.
Syntax
exit <n>
Table 4: Variable definitions
Variable
Value
<n>Specifies the number of levels to exit. The
range is 1 - 6; the default is 1.
Command Line ReferenceAugust 2013 33
Page 34
Basic CLI commands
Example
AG/configure/interface/bundle wan1# exit 2
password
Use this command to change your own user password. If you are logged in using the
administrator user account, you can also change the passwords of other users.
After you enter the command, the system prompts you for the new password information.
Syntax
password
Table 5: Variable definitions
VariableValue
<old password>current password in use.
pop
<new password>new password.
Example
AG# password
In configuration mode, use this command to reset the command prompt level to the main
configuration mode level ( AG/configure# ).
Use this command to reboot the AG2330 using the current boot parameters.
Syntax
reboot
Example
AG# reboot
Use this command to save the current configuration to a .cfg file on the flash. Save your
configuration to flash each time you make configuration changes to allow the system to boot
from the latest configuration upon subsequent reboot.
You can also use this command to save the configuration to a network location using TFTP,
providing a backup of your configuration, or to copy the configuration to another AG2330.
Syntax
save {local [<filename>] | network <IP address> <file path>}
Table 7: Variable definitions
Variable
local [<filename>]Specifies to save the configuration file to the
network <IP address> <file path>Specifies the network IP address, path, and
Value
local flash. You can also specify an optional
filename. The default filename is
system.cfg.
file name for the saved file.
Example
AG# save local
show
Use this command to access the show commands.
Command Line ReferenceAugust 2013 35
Page 36
Basic CLI commands
Syntax
show
Example
AG# show
show console_timeout
Use this command to display the configured console timeout value.
Syntax
show console_timeout
Example
AG# show console_timeout
show configuration running
Use this command to display the current running configuration.
Syntax
show configuration running
Example
AG# show configuration running
show configuration stored
Use this command to display the configuration that is stored in Flash.
Use this command to display selected parts of the current running configuration.
Enter the command without any options to show the full configuration.
Syntax
show running-config
Table 8: Variable definitions
VariableValue
begin <string>Displays the configuration starting at the line
include <string>Displays lines containing the string.
exclude <string>Displays lines not containing the string.
show running-config
that matches the string.
include-section <string>Displays lines containing and associated
with the string.
exclude-section <string>Displays lines not containing and not
associated with the string.
The optional <string> is formed by 3 substrings, for example, <string1> <string2> <string3>,
such as "interface ethernet 0/1". Each of these substrings consists of a maximum of 40
characters.
Examples
AG# show running-config begin interface
AG# show running-config include interface
AG# show running-config include interface ethernet
AG# show running-config exclude interface
AG# show running-config exclude interface ethernet 0/1
AG# show running-config include-section interface
AG# show running-config exclude-section interface
show startup-config
Use this command to display selected parts of the current startup configuration.
Command Line ReferenceAugust 2013 37
Page 38
Basic CLI commands
Enter the command without any options to show the full configuration.
Syntax
show startup-config
Table 9: Variable definitions
fileLocal file name.
begin <string>Displays the configuration starting at the line
include <string>Displays lines containing the string.
exclude <string>Displays lines not containing the string.
include-section <string>Displays lines containing and associated
exclude-section <string>Displays lines not containing and not
VariableValue
The default is system.cfg
that matches the string..
with the string.
associated with the string.
The optional <string> is formed by 3 substrings, for example <string1> <string2> <string3>,
such as "interface ethernet 0/1". Each of these substrings consists of a maximum of 40
characters.
Examples
AG# show startup-config file oldsystem.cfg begin interface
AG# show startup-config file oldsystem.cfg include interface
AG# show startup-config file oldsystem.cfg include interface ethernet
AG# show startup-config file oldsystem.cfg exclude interface
AG# show startup-config file oldsystem.cfg exclude interface ethernet
0/1
AG# show startup-config file oldsystem.cfg include-section interface
AG# show startup-config file oldsystem.cfg exclude-section interface
show system configuration
Use this command to display the system configuration.
Use this command to download a file from a remote host to compact flash or USB memory.
You can transfer the file using either TFTP or FTP. If you use this command with an FTP server,
you must specify the FTP user ID and password for authentication.
Use this command to format the compact flash or USB memory.
Syntax
file format [/cf0 | /cf1 | /usb0]
Example
AG# file format /cf0
Specifies the location and name of the file
destination.
file ls
Use this command to display all files that are saved on the compact flash (CF0 or CF1) or USB.
By default, CF0 files are shown.
Syntax
file ls [/cf0 | /cf1 | /usb0]
Example
AG# file ls /cf0
file upload
Use this command to upload a file from compact flash or USB memory to a remote host. You
can transfer the file using either TFTP or FTP. If you use this command with an FTP server,
you must specify the FTP user ID and password for authentication.
The daylight saving time (DST) feature allows you to configure a time offset for daylight saving.
Use this command to configure DST on the Advanced Gateway 2330.
Syntax
dst set <device location> <start hour> <start minute> <start week of
month> <start day of week> <start month> <end hour> <end minute> <end
week of month> <end day of week> <end month> <dst duration hrs> <dst
duration minutes>
Table 16: Variable definitions
VariableValue
<device location>Specifies the location of the device.
<start hour>Specifies the start hour (00 - 23), in other
words, the hour at which the DST offset time
begins.
<start minute>Specifies the start minute (00 - 59)
<start week of month>Specifies the start week of <start month> (1
- 4)
<start day of week>Specifies the start day of week (0 - sunday,
6 - saturday)
<start month>Specifies the start month of year (1 - 12)
<end hour>Specifies the end hour (00 - 23), in other
words, the hour at which the DST offset time
ends.
<end minute>Specifies the end minute (00 - 59)
<end week of month>Specifies the end week of <end month> (1 -
4)
<end day of week>Specifies the end day of week (0 - sunday, 6
- saturday)
<end month>Specifies the end month of year (1 - 12)
Command Line ReferenceAugust 2013 49
Page 50
Commissioning commands
<dst duration hrs>Specifies the number of offset hours to add
<dst duration minutes>Specifies the number of offset minutes to add
Example
Consider the following DST scenario:
• DST start: 2nd Sunday of April at 2:00 AM
• DST end: 2nd Sunday of October at 2:00 AM
• Offset time amount: 1:00 hours
To achieve this configuration, consider the following:
VariableValue
to the time at the start of DST (and remove
at the end of DST).
to the time at the start of DST (and remove
at the end of DST).
ParameterDST start: 2nd
Sunday of April at
2:00 AM
start hour2--
start minute0--
start week of month2--
start day of week0--
start month4--
end hour-2-
end minute-0-
end week of month-2-
end day of week-0-
end month-10-
dst duration hrs--1
dst duration minutes--0
DST end: 2nd Sunday
of October at 2:00 AM
To configure DST for this example, enter the following:
Use 9216 to enable jumbo frames, save config and reboot.
Syntax
<WORD>Enter MTU Limit 1500 or 9216 (default =1500)
Table 20: Variable definitions
VariableValue
<WORD>Specifies the name you want to assign to the
Example
AG/configure#system jumbo-mtu-limit>?
jumbo frame
gateway.
no user
Use this command to remove configured user names from the Advanced Gateway 2330.
Syntax
no user <username>
Example
AG/configure# no user user05
ping
Ping a device to verify the connection between the AG2330 and that network device. If the
network device sends a ping reply, a message indicates that the specified IP address is alive
and can communicate with the gateway. If the gateway does not receive a reply, the message
indicates that the address is not responding.
Syntax
ping <ipaddr>
Table 21: Variable definitions
Variable
Command Line ReferenceAugust 2013 53
Value
Page 54
Commissioning commands
<ipaddr>Specifies the destination IP address.
Example
AG# ping 10.11.12.13
show chassis
Use the procedure in this section to view summary information about the AG2330 chassis,
including its operational status. After you install interface modules, you can use the showchassis command to verify that the AG2330 recognizes the modules.
Syntax
show chassis
Example
AG# show chassis
show dst
Use this command to display the daylight saving time (DST) configuration and status.
Syntax
show dst
Example
AG# show dst
show module alarms
Use this command to check the system for alarms.
Syntax
show module alarms {t1|e1|ct3|serial|hssi|t3} <slot/port>
Use this command to quickly check the state and configuration of installed interface
modules.
Syntax
show module configuration {t1|e1|ct3|serial|hssi|t3} <slot/port>
Example
AG# show module configuration serial 2/1
show module configuration all
Use this command to check the state and configuration of all installed interface modules.
show module configuration
Syntax
show module configuration all
Example
AG# show module configuration all
show sntp
Use this command to display the SNTP configuration.
Syntax
show sntp
Example
AG# show sntp
show telnet
View the Telnet server settings for information about the status of the Telnet server (enabled
or disabled) and the Telnet session timeout value.
Command Line ReferenceAugust 2013 55
Page 56
Commissioning commands
Syntax
show telnet
Example
AG# show telnet
sntp server
The Simple Network Time Protocol (SNTP) synchronizes the internal clocks of various network
devices across large, diverse networks to universal standard time.
Use this command to configure the location of the SNTP server.
Syntax
sntp server {ipaddr|hostname}
Table 22: Variable definitions
VariableValue
{ipaddr|hostname}The IP address or host name of the
Example
AG/configure# sntp server 11.12.13.14
sntp timeout
Use this command to set the timeout value for the response from the server.
Syntax
sntp timeout <value>
Table 23: Variable definitions
Variable
<value>The timeout value in seconds. The default
broadcast server. The default value is any
broadcast server.
You can configure the timeout value for Telnet sessions. A Telnet session disconnects if it
remains inactive for the configured session duration. Use this command to enable or disable
the telnet server.
Syntax
telnet_timeout <value>
Table 27: Variable definitions
<value>Enter the time in seconds (from 0 to 3600)
telnet timeout
VariableValue
after which inactive Telnet sessions
automatically disconnect. The default value
is 900 seconds. If you enter a value of 0
seconds, inactive Telnet sessions do not
automatically disconnect.
Example
AG/configure# telnet_timeout 300
tftp server
Use this command to enable the TFTP service.
Syntax
[no] tftp_server
Example
AG/configure# tftp_server
utc
Use this command to set the current time for the AG2330 in relation to Coordinated Universal
Time (UTC).
Syntax
utc <+|-> <hour offset> <minute offset>
Command Line ReferenceAugust 2013 59
Page 60
Commissioning commands
Table 28: Variable definitions
<+|->The time zone offset. Enter + to indicate that
<hour offset>The number of hours that your local time is
<minute offset>The number of minutes that your local time
Example
AG/configure# utc - 4 0
VariableValue
your time zone is ahead of UTC. Enter - to
indicate that your time zone is behind UTC.
Use this command to allow system to drop an errored T1 or E1 link from the bundle. A bundle
is dropped if excessive errors of a user-specified type occur for a user-defined time interval.
This parameter does not apply for single-T1 or E1 link and N x DS0 (fractional T1 or E1)
bundles.
Syntax
drop error_type {es | ses | uas | eev | bpv | css | oof | crc } <dropvalue>
Table 29: Variable definitions
Variable
error_typeError condition that will cause droppage of a
esErrored Seconds
sesSeverely Errored Seconds
uasUnavailable Seconds
eevExcessive Error Violations Seconds
Value
T1 or E1 link from the bundle.
Command Line ReferenceAugust 2013 61
Page 62
T1/E1 module configuration commands
bpvBipolar Violations
cssControlled Slip Seconds
oofOut of Frame Seconds
crcCRC-6 Errors
<drop-value>Drop time in consecutive seconds (1-10 for
es, ses, uas) or drop counts.
Example
AG/configure/interface/bundle t1# drop error_type ses 10
configure interface bundle link e1/t1
Use this command to link a bundle to the T1/E1 interface to group DS0’s into one configurable
interface, and to configure the encapsulation.
When thresholds are exceeded, the system generates alarms that indicate the possible
deterioration of an E1 link. Use this command to define one alarm threshold for each available
parameter.
compared directly to the specified threshold
values, and the appropriate alarm type
(rising or falling) is reported.
ses | es | uas | css | oof | crc | bpvbpv: Threshold for bipolar violation crc:
Threshold for cyclic redundancy check css:
Threshold for controlled slip second es:
Threshold for errored seconds oof:
Threshold for out of frame ses: Threshold for
severely errored seconds uas: Threshold for
unavailable seconds
deltaThe errored second or event count is
compared to the difference between the
rising and falling thresholds, and a rising
alarm is reported if the actual error count
exceeds that difference. This is the default
setting if you do not specify a sampling
type.
falling-thresholdMinimum number of errored seconds or
events below which a falling alarm is
reported. This alarm is reported if a rising
alarm was previously reported and the
number of errored seconds or events
subsequently dropped below this minimum
threshold. The falling threshold value must
be less than the rising threshold value above.
The range is 0 - 2147483647.
Command Line ReferenceAugust 2013 63
Page 64
T1/E1 module configuration commands
rising-thresholdNumber of errored seconds or events which,
sampling-intervalSampling interval, in seconds. The range is
Example
AG/configure/module/e1 (3/1)/alarms/thresholds# user 1 ses 300 50 30
In this example, the monitored parameter is the number of Severely Errored Seconds that
occur. The sampling interval is set to 300 seconds (5 minutes). The rising alarm threshold is
50 SES and the falling alarm threshold is 30 SES. Delta sampling is used (by default), in which
a rising alarm is reported if the SES count increases by 20 (50 - 30 = 20) during any sampling
interval. Similarly, a falling alarm is reported if the SES count decreases by 20 during any
interval.
if exceeded during any sampling interval,
results in a rising alarm. The range is 0 2147483647
1 - 65535.
configure module e1 alarms hierarchy
Use this command to enable or disable the hierarchy for displaying Receive Loss of Signal
(RLOS) and Receive Loss of Frame (RLOF) on an E1 link.
Syntax
[no] alarms hierarchy
Table 32: Variable definitions
Variable
noDisables hierarchy.
Example
AG/configure/module/e1 (3/1)# alarms hierarchy
configure module e1 circuitId
Use this command to specify an optional circuit ID for the E1 interface.
Use this command to set the T1 user statistic alarm thresholds.
When user-configurable thresholds are exceeded, the AG2330 generates alarms that indicate
the possible deterioration of a T1 link. Refer to the following parameters to determine the
specific T1 data type that needs to be configured. You can define one alarm threshold for each
parameter.
absolute | deltaabsolute: The errored second or event count
is compared directly to the specified
threshold values, and the appropriate alarm
type (rising or falling) is reported. delta: The
errored second or event count is compared
to the difference between the rising and
falling thresholds, and a rising alarm is
reported if the actual error count exceeds
Value
Command Line ReferenceAugust 2013 69
Page 70
T1/E1 module configuration commands
VariableValue
ses | es | uas | eev | css | oof | crc | bpvSpecifies the threshold type: bpv: Threshold
falling-thresholdMinimum number of errored seconds or
that difference. This is the default setting if
you do not specify a sampling type.
for bipolar violation crc: Threshold for cyclic
redundancy check css: Threshold for
controlled slip second eev: Threshold for esf
error events es: Threshold for errored
seconds oof: Threshold for out of frame ses:
Threshold for severely errored seconds uas:
Threshold for unavailable seconds
events below which a falling alarm is
reported. This alarm is reported if a rising
alarm was previously reported and the
number of errored seconds or events
subsequently dropped below this minimum
threshold. The falling threshold value must
be less than the rising threshold value above.
The range is 0 - 2147483647.
rising-thresholdNumber of errored seconds or events which,
if exceeded during any sampling interval,
results in a rising alarm. The range is 0 2147483647
sampling-intervalSampling interval, in seconds. The range is
1 - 65535.
Example
AG/configure/module/t1 (3/1)/alarms/thresholds# user 1 ses 300 50 30
In this example, the monitored parameter is the number of Severely Errored Seconds that
occur. The sampling interval is set to 300 seconds (5 minutes). The rising alarm threshold is
50 SES and the falling alarm threshold is 30 SES. Delta sampling is used (by default), in which
a rising alarm is reported if the SES count increases by 20 (50 - 30 = 20) during any sampling
interval. Similarly, a falling alarm is reported if the SES count decreases by 20 during any
interval.
configure module t1 alarms hierarchy
Use this command to enable or disable the hierarchy for displaying Receive Loss of Signal
(RLOS) and Receive Loss of Frame (RLOF) on a T1 link.
Use this command to display the alarms detected on an E1 or T1 module.
This command also shows individual user threshold alarms for all user statistics currently
configured with alarm thresholds. To view the current user alarm threshold settings, use the
show module thresholds command.
To display the alarms in real-time, specify the desired refresh interval in minutes when entering
this command. To return to the system command prompt, type q.
Syntax
show module alarms {e1|t1} <slot/port> [refresh_interval <1-65535>]
Table 57: Variable definitions
VariableValue
[refresh_interval <1-65535>] Specifies how often, in minutes, the alarm display is updated
show module alarms
(optional entry; minimum is 1 minute). If you do not specify
an interval, you must repeat the command to update the
alarm display.
Example
AG# show module alarms t1 2/1
show module ansistats
Use this command to display ANSI statistics for a T1 interface.
The command shows the current 15-minute interval statistics, the elapsed time in the current
sampling interval, and the total counts for the past 8 hours. These statistics can be cleared
only by the carrier by FDL requests from the remote end.
You can view statistics for multiple 15-minute intervals by specifying the number of intervals
you wish to view (from 1 to 96).
Syntax
show module ansistats t1 <slot/port> [interval_range <1-96>]
Example
AG# show module ansistats t1 2/1
Command Line ReferenceAugust 2013 77
Page 78
T1/E1 module configuration commands
show module configuration
Use this command to display the configuration for a specified E1 or T1 module.
Syntax
show module configuration {e1|t1} <slot/port>
Example
AG# show module configuration t1 2/1
show module ietfstats
Use this command to display IETF performance statistics for T1 or E1 module interfaces. You
can view statistics for multiple 15-minute intervals by specifying the number of intervals you
wish to view (from 1 to 96).
Syntax
show module ietfstats {e1|t1} <slot/port> [interval_range <1-96>]
Example
AG# show module ietfstats t1 2/1
show module itutstats
Use this command to display ITUT performance statistics for an E1 interface. You can view
statistics for multiple 15-minute intervals by specifying the number of intervals you wish to view
(from 1 to 96).
Syntax
show module itutstats e1 <slot/port> [interval_range <1-96>]
Use this command to show the alarm threshold settings for a module interface. Alarm
thresholds are configured on a per-module basis.
Syntax
show module thresholds {e1|t1} <slot/port>
Example
AG# show module thresholds t1 2/1
show module userstats
Use this command to display performance statistics for a T1/E1 module interface.
show module thresholds
You can view statistics for multiple 15-minute intervals by specifying the number of intervals
you wish to view (from 1 to 96). To clear these statistics after viewing them, use the clearmodule command.
Syntax
show module userstats {e1|t1} <slot/port> [interval_range <1-96>]
If you change any of the ISDN properties (except callingnum, callednum, idle-timeout, callback, and connect-delay), you must deactivate ISDN (using the no activate command) and
then reactivate ISDN for the changes to be applied.
Syntax
activate
Example
AG/configure/interface/bundle pri1/isdn# activate
configure interface bundle isdn map
Use this command to override the default ISDN type and plan generated by the AG with custom
values.
Syntax
[no] map <address> <plan> <type>
Table 58: Variable definitions
Variable
[no]Reverts to the default ISDN type and plan.
<address>Specifies either the calling number or the
Value
called number. This parameter can be a
regular expression also for pattern matching.
It specifies that the ISDN type and plan will
be overridden for addresses that match the
regular expression.
Command Line ReferenceAugust 2013 81
Page 82
ISDN configuration commands
<plan>Specifies the numbering plan:
<type>Specifies the type:
• Unknown: unknown with bit value 0000
• isdn: ISDN/telephony numbering- E.164/
E.163 with bit value 0001
• tel: telephony numbering—E.163 with bit
value 0010
• data: data numbering—X.121 with bit
value 0011
• telex: telex numbering—Recommendation
F.69 with bit value 0100
• national: national standard numbering with
bit value 1000
• private: private numbering with bit value
1001
• unknown: unknown with bit value 000
• international: international number with bit
value 001
• national: national number with bit value
010
• network: network specific number with bit
value 011
• subscriber: subscriber number with bit
value 100
• overlap: overlap sending with bit value
1001
• abbreviated: abbreviated number with bit
value 110
Use this command to configure the switch type for the specified bundle.
Primary switch types are only supported on PRI interfaces. Basic switch types are supported
on BRI interfaces. Shut down the bundle before changing the interface type.
Use this command to configure an interface as a Layer 2 interface. Also use this command to
create an access port.
Syntax
switchport
Example
AG/configure/interface/ethernet (6/1)# switchport
no switchport
Use this command to disable a configured link (trunk, access, or hybrid) on an interface.
Syntax
no switchport
Example
AG/configure/interface/ethernet (6/1)# no switchport
switchport mode hybrid
A hybrid link is a LAN segment that contains both VLAN-aware and VLAN-unaware devices.
Consequently, a hybrid link can carry both VLAN tagged frames and other (untagged or prioritytagged) frames.
Use this command to enable a hybrid link between devices.
To disable a hybrid link on an interface, enter: no switchport
switchport mode trunk
Trunk links are required to pass VLAN information between devices. You can configure a trunk
port to be a member of all the VLANs that exist on the device. That port then carries traffic for
all the VLANs between the devices. To distinguish between the traffic flows, a trunk port must
mark the frames with special tags as they pass between the devices. You must enable trunking
on both sides of a link. If two devices are connected together, for example, you must configure
both device ports for trunking.
Use this command to enable trunking between the devices.
There can be only one VLAN assigned to an access port. VLAN ID 1 is the default VLAN
assigned to each port. Use this command to change the VLAN assigned to an access link.