Internet Telephony Gateway VIP-110/VIP-210 Command Reference Release 1.
COMMANDLINE CONFIGURATION Command line interface in PLANET VIP-110/VIP-210 This manual is a command-by-command description for the PLANET VIP-110/VIP-210 CLI administration mode.
Table of Contents About This Manual 7 Document Objectives ........................................... 7 Audience ...................................................... 7 Document Organization ......................................... 7 Notation Conventions .......................................... 7 Designating IP Address ........................................ 8 Designating Port ID ........................................... 8 Documentation Abbreviations ................................... 8 1.
net set wan dns ............................................. 8 net set wan gateway ......................................... 8 net set wan ip .............................................. 9 net set wan ip_tos .......................................... 9 net set wan mask ............................................ 9 net show wan ............................................... 10 Configuring DHCP Server and Client ........................... 10 net set dhcp client ........................................
net show management ........................................ 17 Storing IP Interface Parameters .............................. 18 net store .................................................. 18 4. Telephony Interface Port Configuration Commands 19 Configuring Port-Unique Parameters ........................... 19 set port port# cid name .................................... 19 set port port# cid number .................................. 19 set port port# default .....................................
set port_cfg fxs ff_batt_rev ............................... 26 set port_cfg fxs offhook_db ................................ 27 set port_cfg fxs offhook_detect ............................ 27 set port_cfg fxs onhook_db ................................. 27 set port_cfg fxs onhook_detect ............................. 28 set port_cfg fxs ring_id ................................... 28 5. Voice and Fax Coder Configuration Commands 31 Common Coding Profile Configuration Commands .................
set h323 h245_timeout ...................................... 38 set h323 h245_tunneling .................................... 38 set h323 in_fast_start ..................................... 39 set h323 local_alert ....................................... 39 set h323 nat_call .......................................... 39 set h323 out_fast_start .................................... 40 set h323 rtp_port_base ..................................... 40 set h323 term_id ...........................................
Destination Table Management Commands ........................ 51 atpm dadd .................................................. 51 atpm ddel .................................................. 52 atpm dfind ................................................. 52 atpm dlist ................................................. 52 Hunt Group Table Management Commands ......................... 53 atpm hadd .................................................. 53 atpm hdel ..................................................
About This Manual This section discusses the objectives, audience, organization, and conventions associated with this document. Document Objectives This document provides an in-depth description of the commands necessary for configuring and maintaining the ITG. Audience This publication is intended as a standalone document for experienced system administrators or engineers who will be configuring and maintaining the ITG and would like to reference commands.
Convention Description boldface Commands and keywords are in boldface. Bold Courier User input (anything you are expected to type in) is set in Bold Courier. italic Arguments for which you supply values. courier Messages that the ITG CLI displays are in plain courier font. [ Elements in square brackets are optional. ] { x | y | z } Alternative but required elements are grouped in braces ({ }) and separated by vertical bars ( | ).
Introduction DTMF Dual Tone Multi-Frequency EIA Electronic Industry Association FXS Foreign Exchange Station GK Gatekeeper H.
1. Introduction The ITG is a VoIP gateway integrated with a Network Address Translation (NAT) router. It is equipped with two IP interfaces, one for connecting to internal network (hereafter called LAN), the other for connecting to external network (hereafter called WAN). The ITG performs NAPT for host in LAN interface, allowing multiple hosts in the LAN interface to share a single IP address. The ITG has a built-in command line interpreter and provides users a Command Line Interface (CLI).
2. Utility Commands This chapter describes the general-purpose utility commands. get The ITG implements TFTP client software. This command is used to download new revision software from a remote TFTP server, or import dial plan and system configuration parameters from a remote gateway. get [ip_addr | host_name] [file] Syntax Description ip_addr IP address of the TFTP server. host_name Host of the TFTP server file Name of the file to be downloaded help The help command lists the top-level commands.
tel erase_ivr This command erases the greeting message that was recorded previously. tel erase_ivr Syntax Description This command has no arguments or keywords tel set ring_freq The ITG rings FXS port for signaling an incoming call, and provide 4 types of ringing signal, each having a unique frequency. This command is for selecting the frequency of the ringing signal that the ITG sends to FXS ports.
show version This command is used to display information that identifies the versions of various software components that are implemented in the ITG. show version Syntax Description This command has no arguments or keywords Example The following example shows how to use the show version command ITG>show version Internet Telephony Gateway Ver 1.00 Boot Loader Version: 1.00 DSP image Version: 8.1.2.1. TSG Version: R8.
3. IP Configuration Commands This chapter describes the commands for configuring and displaying the IP interface parameters. The configured parameter will not take effect until the configured parameter is store in NVS and the ITG is reset.
Factory default 255.255.255.0 Related Commands net set lan ip ëNote The LAN interface only supports Class C network. That is, the subnet mask for the LAN interface must be greater than or equal 255.255.255.0. net show lan This command displays the LAN interface parameters net show lan Syntax description This command has no arguments or keywords Configuring WAN Interface The section describes commands for setting and displaying WAN interface parameters.
Related Commands net set wan ip net set wan mask net set wan ip This command is used to assign a static IP address for the WAN interface net set wan ip ip_addr Syntax description ip_addr IP address for the WAN interface Factory default 172.16.0.1 Related Commands net set wan gateway net set wan mask net set wan ip_tos The ITG allows users to set the 8-bit Service Type field in the IP header for all the packets it sends across the WAN interface.
Factory default 255.255.0.0 Related Commands net set wan ip net show wan This command displays the WAN interface parameters net show wan Syntax description This command has no arguments or keywords Configuring DHCP Server and Client The ITG implements a DHCP server over its LAN interface and a DHCP client over its WAN interface. This section describes commands for setting and displaying parameters for DHCP server and client.
MAC address of the WAN interface. net set dhcp server The ITG supports DHCP server over its LAN interface, allowing hosts in the LAN interface to dynamically obtain IP configuration from the ITG. The net set dhcp server command allows you to configure the DHCP server. net set dhcp server no_of_client base_address Syntax description no_of_client Number of DHCP clients the ITG would support over the LAN interface.
Configuring PPPoE The ITG implements PPPoE client over its WAN interface. PPPoE client provides the ITG the ability to connect to Internet over a bridging access device (such as an ADSL modem) to a remote access concentrator, typically located at the ISP site. This section describes commands for setting and displaying parameters for PPPoE client. net set pppoe auth_proto The PPPoE client implements two types of authentication protocol.
net set pppoe {on | off} This commands enables or disables the PPPoE client. net set pppoe {on | off} Syntax description on Enable PPPoE client off Disable PPPoE client Factory default off net set pppoe service_name This commend is used to specify the service name the PPPoE client encapsulates in the PPPoE Discovery packet it broadcast across the WAN interface. net set pppoe service_name “service_name” Syntax description service_name PPPoE service name, up to 23 characters.
password PPPoE client user password. Up to 23 characters. Factory default User name: “” User password: “” net show ppp This command displays PPP configuration parameters. net show ppp Syntax description This command has no arguments or keywords Configuring Dynamic DNS The ITG implement a dynamic DNS client which allows a remote dynamic DNS server to alias the IP address of the ITG to a static host name.
net set ddns add For the dynamic DNS server to be able to translate a static host name to an IP address, the ITG has to register to it upon reset.
This command has no arguments or keywords Configuring Management Options The ITG has built-in HTTP server and Telnet server, allowing the configuration from web browser or Telnet client. This section describes commands for setting and displaying the management options. net set http The ITG allows users to enable or disable its built-in HTTP server. This command is used to enable or disable the HTTP server. net set http {on | off} Syntax description on Enable HTTP server.
specified by command net set manager ip are allowed to connect to ITG’s Telnet server via WAN interface. Factory default 0.0.0.0 Related Commands net set manager ip net set manager password This command is used to change the password for logging into ITG interface, web server or Telnet server for configuring the ITG. net set manager password password1 password2 Syntax description password1 New password password2 New password for ensuring the password is entered correctly.
Storing IP Interface Parameters Configuration parameters changed by command net set are stored in dynamic memory, which would lose when the ITG is powered off. The save the configuration parameter you’ve changed, the parameters have to be stored into NVS before powering off the ITG. This section describes command for storing IP interface parameters into NVS. net store This command stores IP interface parameters into NVS.
4. Telephony Interface Port Configuration Commands Each telephony interface port equipped by the ITG, regardless of its interface type, is characterized by two sets of configuration parameters. One set is unique to each port, hereafter referred to as port-unique parameters. The other set is common to all the telephony interface ports, hereafter referred to as port-common parameters. The ITG maintains two sets of port-common parameters, primary and secondary.
port# Zero-based number of the telephony port. number Caller ID number, 1 to 15 digits. O Call ID is number is not available Factory default No caller ID number set port port# default This command sets all the port-unique parameters to factory default values. set port port# default Syntax description port# Zero-based number of the telephony port.
show port port# This command displays port-unique parameters for a telephony interface port. show port Syntax Description port# Zero-based number of the telephony port. Configuring Port-Common Parameters The ITG maintains two sets of port-common parameters, primary and secondary. Each telephony port chooses which of them to be used by specifying it in one of its port-unique parameters.
set port_cfg call_limit This command is used to set a call length limit for calls on a telephony port. If the call length is exceeded, the call is automatically terminated. set port_cfg call_limit seconds Syntax description seconds Value in seconds, ranging from 0 to 65534, or –1 or 65535 for forever. Factory default -1 set port_cfg default This command resets the port-common parameters to factory default values.
tone set port_cfg out_wait This command is used to specify the time to delay after going off-hook before generating outbound dial digits. set port_cfg out_wait milliseconds Syntax description milliseconds Value is milliseconds, ranging from 0 to 65535. Factory default 400 set port_cfg rxgain The ITG adjust the power level of the PCM signal coming in from the telephony ports before feeding it to the voice processor for further processing.
set port_cfg tone_out_on milliseconds Syntax description milliseconds Value is milliseconds, ranging from 0 to 65535. Factory default 200 ms Related Commands set port_cfg tone_out_off set port_cfg tone_out_pwr set port_cfg tone_out_pwr This command is used to set the power level for DTMF tones generated by the ITG. set port_cfg tone_out_pwr power Syntax description power Power level of DTMF tones in 0.1 dBm. Factory default -60. The factory setting for DTMF tone power for all telephony ports is –6.
on page 31 for details about coding profile. set port_cfg voice_prof profile_id Syntax description profile_id Preferred coding profile ID for voice Factory default The factory default preferred voice coding profile for all the telephony ports is coding profile number 0, which is the coder for G.723 6.3 kbps. show port_cfg This command displays port-common parameters. show port_cfg [pri | sec] Syntax Description pri Display the primary port-common parameters.
Related Commands set port port cid name set port port cid number set port_cfg fxs cpc_dur The ITG implements loop current shutdown feature on FXS port. It shuts down the current feeding toward a FXS port upon detecting a call is being terminated by the other party participated in the call. This command is used to set the duration, in milliseconds, of the loop current shutdown (CPC supervisory disconnect).
set port_cfg fxs offhook_db This command specifies the time in milliseconds to use as a debouncer interval for debouncing the off-hook signal. set port_cfg fxs offhook_db milliseconds Syntax description milliseconds Time in milliseconds, ranging from 1 to 1000. Factory default 50 Related Command set port_cfg fxs offhook_detect set port_cfg fxs offhook_detect This command is used to set the time to wait, in milliseconds, before an off-hook condition is declared.
set port_cfg fxs onhook_detect This command is used to set the time to wait, in milliseconds, before an on-hook condition is declared. For preventing from mistakenly interpreting noise signal as on-hook, when a hook switch on state is detected on a FXS port, the switch on state must sustain for at least this duration, otherwise it is no regarded as a on-hook. set port_cfg fxs onhook_detect milliseconds Syntax description milliseconds Time in milliseconds, ranging from 1 to 1000.
Factory default 0 Telephony Interface Port Configuration Commands 29
5. Voice and Fax Coder Configuration Commands The coding profile is used to store coding parameters for voice and fax coders that can be used by any telephony port on the ITG. The ITG has 4 built-in coding profiles, each having a unique profile ID and parameters for a specific voice or fax application. Table 5-1 summarizes coding profiles available for voice and fax applications. Profile ID 0 1 2 3 5 Profile Name g723 g729 g723_53 g711 fax Coder G.723 6.3 kbps voice coder G.729AB voice coder G723 5.
set coding profile_id dtmf_relay The ITG supports DTMF relay, in which DTMF tones are detected during voice processing, encoded into H323-UserInformation packets and conveyed to the remote ITG via the H.323 call control band. This command is used to enable or disable the DTMF relay feature. set coding profile_id dtmf_relay {on | off} Syntax description profile_id Profile ID or name, as shown in Table 5-1, of the coder to be modified. on Enable DTMF relay. off Disable DTMF relay.
Profile g723 g729 g723_53 g711 Setting 30 20 30 10 set coding profile_id vad This command is used to enable/disable the Voice Activity Detector (VAD) for a coding profile. set coding profile_id vad {on | off} Syntax description profile_id Profile ID or name, as shown in Table 5-1, of the coder to be modified. on Enable VAD. off Disable VAD.
Profile ID fax Setting 1 Related Command set coding profile_id fax_ls_redundancy set coding profile_id fax_ls_redundancy This T.38 mode command is used to specify the packet-level redundancy for low-speed data transmissions (i.e., T.30 handshaking information), for a fax coder. set coding profile_id fax_ls_redundancy pkt Syntax description profile_id Profile ID or name, as shown in Table 5-1, of the coder to be modified.
6. H323 Configuration Commands The ITG employs ITU-T H.323 protocol for call signaling and call control. The gatekeeper is an H.323 entity on the network that provides admission control and address translation services. The ITG allows calls to remote gateways be routed through a H.323 gatekeeper or not. This chapter describes commands for configuring the H.323 protocol. This chapter is organized as follows: l General H.323 configuration commands l H.323 gatekeeper related configuration commands General H.
set h323 display_name set h323 term_id set h323 callSignalPort Per ITU-T H.323 standard, the TCP port which the H.225 listens for incoming call setup request is port number 1720. This command is used to configure the TCP port number which the ITG listens for incoming call setup request.. set h323 callSignalPort port Syntax Description port TCP port number which the ITG listens for incoming H.225 call setup request Factory default 1720 set h323 cisco_t38 Cisco FoIP solutions support standard T.38 fax.
imtc Convey DTMF digits per IMTC specification. Factory default h323v2 Related Command set h323 alt_dtmf set h323 display_name One of the UUIEs in the H.323 Setup message that the ITG sends to a remote gateway when initiating a call is sourceAddress. The sourceAddress UUIE is a list of alias addresses, by which the remote gateway identifies the ITG. This command is used to set a string that the ITG will place in the 2 nd alias address filed of the sourceAddress UUIE in the H.323 Setup message.
manual Enable gatekeeper in manual discovery mode. The gk_addr must be set appropriately. Factory default off Related Command H.323 Gatekeeper Related Configuration Commands set h323 h245_term_type This command is used to set the H.245 terminal type. The terminal type is used as part of the master/slave determination process of H.245. set h323 h245_term_type terminal_type Syntax Description termmal_type A numerical value designating the H245 terminal type. Typically, setting the H.
set h323 in_fast_start This command is used to enable or disable accepting incoming call in H.323 Fast Start mode. set h323 in_fast_start {on | off} Syntax Description on Accept incoming calls with H323 Faststart mode off Do not accept incoming calls with Set H323 Faststart mode Factory default off Related Command set h323 out_fast_start set h323 local_alert Per ITU-T H.323 standard, an H.
off Disable the feature. Factory default on set h323 out_fast_start This command is used to select the H.323 mode for outgoing calls. set h323 out_fast_start {on | off} Syntax Description on Initiate outgoing calls with H323 Fast Start mode off Initiate outgoing calls with H323 Non Fast Start mode Factory default off Related Command set h323 in_fast_start set h323 rtp_port_base This command is used to select the starting port number for assignment of RTP ports.
address field of sourceAddress UUIE of the H.323 Setup message Factory default Null Related Commands set h323 call_name set h323 display_name show h323 This command displays all H.323 related parameters. show h323 Syntax description This command has no argument or keyword H.323 Gatekeeper Related Configuration Commands The following sections describe the general H.323 configuration commands. set h323 alias This command is used to create and delete aliases that are registered with the gatekeeper.
false Always claim call setup failure when ITG fails obtaining ACF from the gatekeeper. Factory default true set h323 alt_gk When the ITG is configured in gatekeeper mode, it can specify two gatekeepers, default and alternate, to register with. After failing registering to the default gatekeeper, the ITG will attempt to register to the alternate gatekeeper. This command is used to specify the address of the alternate gatekeeper.
set h323 endpoint_prefix This command is used to set the H.323 prefix that the ITG uses when registering to an H.323 gatekeeper. After registering to a gatekeeper using the prefix, the gatekeeper will map all Admission Request with destination matching the prefix to the ITG. set h323 endpoint_prefix alias Syntax Description alias H.323 alias of the prefix. Factory default Null set h323 endpoint_reg_type When the ITG registers to a gatekeeper, it specifies the H.
set h323 gk_id When the ITG registers to a gatekeeper, it specifies the gatekeeper is wishes to register with in the gatekeeperIdentifier field in the RRQ message it sends to the gatekeeper. This command is for setting the string to be placed in the gatekeeperIdentifier field in the RRQ message the ITG sends to gatekeeper. set h323 gk_id “string” Syntax Description string Character string to be placed in the gatekeeperIdentifier filed in the RRQ message.
set h323 time_to_live When the ITG registers to a gatekeeper, it specifies the duration of the validity of the registration in the timeToLive field in the RRQ message it sends to the gatekeeper. The gatekeeper may optionally change the timeToLive by returning a different value in the RCF message it returns to the ITG. This command is for setting the timeToLive to be encapsulated in the RRQ message. set h323 time_to_live seconds Syntax Description seconds Value in seconds Factory default 0 H.
7. Configuration Management Command The CLI maintains three areas where the parameters for telephony interface ports, voice and fax coders, and H.323 configuration are stored: l Temporary l Active l Non-volatile Storage (NVS) When a set command is entered and processed, it changes the parameter value in the Temporary area. This does not affect current operation of the ITG, which is using the values in the Active area.
8. Dial Plan Management Commands The dial plan is a database, that the Address Translation and Parsing Manager (ATPM) of the ITG looks up for translating a dial string to a destination. The dial plan management commands allow you to modify and display the dial plan. Commands that change the dial plan are only allowed when the ITG is in the database update state. This chapter describes the dial plan management commands.
atpm purge {all | addr | dest | hunt} Syntax description all Delete all entries from ATPM address, destination and hunt group tables. addr Delete all entries from ATPM address table. dest Delete all entries from ATPM destination table. hunt Delete all entries from ATPM hunt group table. Allowed only in database update mode Yes Related Commands atpm restore atpm store atpm req This command starts the dial plan database update session.
atpm store This command stores the ATPM address, destination and hung group tables to the non-volatile storage. atpm store [erase] Syntax description erase Erase the non-volatile storage before storing the dial plan database. This option is not recommended except at the very first time you use the atpm store command. Allowed only in database update mode No Related Command atpm restore Destination Table Management Commands atpm dadd This command adds a destination entry into the ATPM destination table.
atpm ddel This command deletes an entry from the ATPM destination table. atpm ddel dest_id Syntax description dest_id ID of a previously added destination entry to be deleted from destination table. Allowed only in database update mode Yes Related Commands atpm dadd atpm dfind atpm dlist atpm dfind This command finds and displays an entry in the ATPM destination table. atpm dfind dest_id Syntax description dest_id ID of a previously added destination entry to be displayed.
Hunt Group Table Management Commands atpm hadd This command adds an entry into the ATPM hunt group table. atpm hadd id {1 | 2} dest_id [dest_id] [dest_id] . . . Syntax description id Hunt group ID. For each hunt group, you need to assign it a unique identifier between 0 and 99. 1 Hunt type 1. Hunt type 1 hunts destination within a hunt group starting from the destination member just after the last used member. 2 Hunt type 2.
Syntax description id ID of the hunt group to be displayed. Allowed only in database update mode No Related Commands atpm hadd atpm hdel atpm hlist This command displays all entries in the ATPM hunt group table. atpm hlist Syntax description This command has no arguments or keywords Allowed only in database update mode No Related Commands atpm hadd atpm hdel Address Table Management Commands atpm aadd Use the atpm aadd command to add an entry into the ATPM address table.
Allowed only in database update mode Yes Related Commands atpm adel atpm afind atpm alist atpm adel This command deletes an entry from the ATPM address table. atpm adel tel# Syntax description tel# Number of a previously added entry to be deleted from the address table. Allowed only in database update mode Yes Related Commands atpm adel atpm adel atpm alist atpm afind This command finds and displays an entry in the ATPM address table.
Syntax description This command has no arguments or keywords Allowed only in database update mode No Related Commands atpm adel atpm afind Dialing Control Commands atpm slist This command displays the parameters that controls the dialing atpm slist Syntax description This command has no arguments or keywords Allowed only in database update mode No Related Commands atpm sys atpm sys This command sets the time constraints for the collection of dialed digits.
Syntax description The maximum time, in millisecond, allowed for entry of the entire dial_time string of dialed digits. At expiration, ATPM starts address lookup. 1st_digit_wait The maximum time, in millisecond, allowed between off-hook and when the first dialed digit is entered. At expiration, ATPM considers address lookup to fail. inter_digit_wait The maximum time allowed between entry of each digit after the previous digit. At expiration, ATPM starts address lookup.
Index Ａ Ｇ ATPM ...................................61 address table ............... 66, 67 database update ................62 destination table .......... 63, 64 first digit wait ....................69 hunt group table .......... 65, 66 inter-digit wait ...................69 automatic ring-down..............20 G.711 ................................. 35 G.723 ................................. 35 G.729 ................................. 35 gain level ....................... 23, 24 greeting message ..........
Ｐ Ｓ ping...................................... 3 signaling protocol ................. 71 spy ..................................... 71 Ｒ redundancy ..........................38 reset .................................... 3 ring frequency ....................... 4 ringing cadence ....................32 router ..................................14 RTCP ...................................52 RTP .....................................52 60 Ｔ T.38............................... 35, 48 Telnet ...................
