|
The Elite Gateway* has a built-in command line interpreter and provides users with a Command Line Interface (CLI). The Elite Gateway can be configured by entering commands from the CLI.
The CLI can be accessed from a VT-100 terminal or terminal emulator connected to the RS-232 port on the front panel or through a Telnet session.
Connection through Serial Port The serial port of the Elite Gateway is fixed at the following settings:
| Baud rate |
19,200 |
| Number of data bit |
8 |
| Parity check |
None |
| Number of stop bit |
1 |
| Flow control |
None | | To access the Elite Gateway through the RS-232 serial port, follow these steps:
- Insert one end of the serial cable that came with the Elite Gateway into the 9-pin RS-232 port (labeled User Console) on the front panel.
- Insert the other end of the cable into your terminal's serial port.
- Configure the terminal so that settings for baud rate, number of data bit, parity check, number of stop bit and flow control capability exactly match Elite Gateway's serial interface. (Refer to your terminal documentation for more information about setting up these features).
- Press <Return> from the terminal.
- The Elite Gateway displays the following prompts on the terminal and you are ready to access the CLI.
Console>
Connection through Telnet To use Telnet, the IP address must have been previously set using the net set ip command for the Elite Gateway. Up to two sessions through Telnet are possible. See the Command Line Interface - Network Commands document for procedures for assigning IP address, default gateway and subnet mask.
To access the Elite Gateway from a remote host with Telnet, perform the following tasks:
| Task |
Prompt |
Type |
| From the remote host, enter the telnet command followed by the IP address of the Elite Gateway you want to access. |
None |
telnet ip_addr |
| When the Elite Gateway prompts "Login:", enter the user name "adm" |
Login: |
Adm |
| When the Elite Gateway prompts "Password:", enter the password. The default password is "123" unless a password was previously established using the net set user_pw command (Refer to the section describing net set user_pw command later in this chapter for details about the setting password). |
Password: |
123 | | After successfully entering the password, the Elite Gateway displays a greeting message along with the following prompts. The CLI commands are then ready to be accessed.
Console> Command Help Help for commands is provided by the CLI. Type help to see a listing of the top-level commands. In most cases, if a command is entered using the wrong number of arguments or inappropriate arguments, the CLI will give further usage.
Designating IP Address Some commands require an IP address, which must be designated in a standard format. The IP address format is 32 bits, written as four octets separated by periods (dotted decimal format) that are made up of a network section, an optional subnet section, and a host section, as shown in the following example:
192.168.0.1
Designating Port Number Some commands require a telephony port number. The Elite Gateway designates the first port on telephone interface module (TIM) slot A as port number 0, the 2nd port as port number 1 and so on. When a TIM is installed in slot B, the first port is designated as port number 4, the 2nd one is designated as port number 5 and so on.
Note: If you have only a single TIM, be certain to install it in slot A, otherwise, the Elite Gateway won't function.
Command Reference The following table list the CLI command type in alphabetical order:
| Command |
Description |
| atpm |
Dial plan management command |
| clrscr |
Clear screen |
| config |
Configuration management command |
| download |
Download new revision code image from TFTP server |
| help |
Display help screen |
| net |
Set or display network parameters |
| ping |
Ping another Internet host |
| set |
Set system configuration |
| tel |
Set or display telephony port options | | The CLI commands are categorized into the following command sets and the following sections explaining each set of the commands:
| Command Set |
Commands |
Function |
| Utility |
| clrscr |
| download |
| help |
| ping | |
General purpose utility commands |
| Network |
net |
Commands for setting or displaying network related parameters |
| Configuration management |
|
Commands for configuring the Elite Gateway or displaying configuration |
| Dial plan management |
atpm |
Commands for setting or displaying dial plan |
| Telephony |
tel |
Commands for setting or displaying telephony related options | |
| Command |
Description |
| atpm aadd |
Add an entry to the address table |
| atpm adel |
Delete an entry from the address table |
| atpm afind |
Find and display an entry in the address table |
| atpm alist |
Display all entries in the address table |
| atpm dadd |
Add an entry to the destination table |
| atpm ddel |
Delete an entry from the destination table |
| atpm dfind |
Find and display an entry in the destination atble |
| atpm dlist |
Display all entries in the address table |
| atpm hadd |
Add an entry to the hunt group table |
| atpm hdel |
Delete an entry from the hunt group table |
| atpm hfind |
Find and display an entry in the hunt group tble |
| atpm hlist |
Display all entries in the hunt group table |
| atpm done |
End the atpm table update session |
| atpm erase |
Erase all atpm tables from NVS |
| atpm purge |
Purge entries from atpm table(s) |
| atpm req |
Start atpm table update session |
| atpm restore |
Restore atpm tables from NVS |
| atpm store |
Store atpm tables into NVS |
| atpm slist |
Display atpm system parameters |
| atpm sys |
Set atpm system parameters |
| config activate |
Move the configuration from temporary area to active area. |
| config erase |
Erase the configuration from NVS |
| config store |
Store the active configuration data into NVS |
| clrscr |
Clear screen |
| download |
Switch to download mode |
| help |
Display help screen |
| net reset |
Reset the system |
| net set gateway |
Set default gateway's IP address |
| net set http |
Turn on/off HTTP server |
| net set ip |
Set IP address |
| net set ip_preced |
Set IP precedence bits |
| net set mask |
Set IP subnet mask |
| net set speed |
Select Ethernet link speed |
| net set user_pw |
Set password |
| net show |
Display IP parameters |
| net show hwstat |
Display hardware status |
| ping |
Send ICMP echo request to another host |
| show h323 |
Display H.323 parameter settings |
| show version |
Show software versions |
| set h323 |
Set H.323 parameters |
| tel show pcm_gain_level |
Display gain level setting of the PCM codec's receive channel. |
| tel show port |
Display hook state for a telephony port |
| tel show ring_freq |
Show ringer's frequency |
| tel set pcm_gain_level |
Set gain level for the PCM codec's receive channel |
| tel set ring_freq |
Set ringer's frequency | |
| Command |
Description |
| Help |
Display help screen |
| Quit |
Switch to normal operation mode |
| set gateway |
Set default gateway 's IP address |
| set ip |
Set IP address |
| net set mask |
Set IP subnet mask |
| start |
Start downloading file | | For detailed usage and parameters of the CLI command set see the follow documents:
This applies to:
|