Table of Contents
Advertisement
Quick Links
Download this manual
See also:
User Manual
Advertisement
Table of Contents
Related Manuals for Planet VIP-110
Summary of Contents for Planet VIP-110
-
Page 1: Command Reference
Internet Telephony Gateway VIP-110/VIP-210 Command Reference Release 1.00 January 2004... - Page 2 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.
-
Page 3: Table Of Contents
About This Manual Document Objectives ... 7 Audience ... 7 Document Organization ... 7 Notation Conventions ... 7 Designating IP Address ... 8 Designating Port ID ... 8 Documentation Abbreviations ... 8 Introduction Command Help ... 1 Utility Commands get ... 3 help ... - Page 4 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 ...
- Page 5 net show management ... 17 Storing IP Interface Parameters ... 18 net store ... 18 Telephony Interface Port Configuration Commands Configuring Port-Unique Parameters ... 19 set port port# cid name ... 19 set port port# cid number ... 19 set port port# default ... 20 set port port# dial_in plar ...
- Page 6 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 Voice and Fax Coder Configuration Commands Common Coding Profile Configuration Commands ...
- Page 7 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 ... 40 show h323 ...
- Page 8 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 ... 53 atpm hfind ... 53 atpm hlist ...
-
Page 9: About This Manual
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. -
Page 10: Designating Ip Address
Convention boldface Bold Courier italic courier { x | y | z } [ x | y | z ] “string” <key> 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:... - Page 11 Dual Tone Multi-Frequency DTMF Electronic Industry Association Foreign Exchange Station Gatekeeper ITU specification for multimedia transmission over IP H.323 networks Internet Control Message Protocol ICMP Internet Facsimile Protocol International Multimedia Telecommunications IMTC Consortium Internet Protocol Internet Service Provider Internet Telephony Gateway Key Telephone System Local Area Network Point-to-Point Protocol...
-
Page 13: Introduction
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. -
Page 15: Utility Commands
2. Utility Commands This chapter describes the general-purpose utility commands. 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... -
Page 16: Tel Erase_Ivr
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. -
Page 17: Show Version
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... -
Page 19: Ip Configuration Commands
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. This chapter is organized as follows: Commands for configuring and displaying LAN interface parameters Commands for configuring and displaying WAN interface parameters Commands for configuring and displaying DHCP server and client... -
Page 20: Net Show Lan
Factory default 255.255.255.0 Related Commands net set lan ip ë The LAN interface only supports Class C network. That is, the subnet mask Note 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... -
Page 21: Net Set Wan Ip
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 Factory default 172.16.0.1 Related Commands net set wan gateway net set wan mask net set wan ip_tos... -
Page 22: Net Show Wan
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. -
Page 23: Net Set Dhcp Server
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... -
Page 24: Configuring Pppoe
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. -
Page 25: Net Set Pppoe {On | Off
net set pppoe {on | off} This commands enables or disables the PPPoE client. net set pppoe {on | off} Syntax description Factory default 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. -
Page 26: Net Show Ppp
password 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. -
Page 27: Net Set Ddns Add
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. To register to the dynamic DNS server, the ITG needs to convey to the server the following information: Name of the dynamic DNS server Ÿ... -
Page 28: Configuring Management Options
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. -
Page 29: Net Set Manager Password
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 password2... -
Page 30: Storing Ip Interface Parameters
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. -
Page 31: Telephony Interface Port Configuration Commands
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. -
Page 32: Set Port Port# Default
port# number 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# set port port# dial_in plar This command is used to configure the number to be dialed in automatically (automatic ring-down) when a telephony port goes off-hook. -
Page 33: Show Port Port
show port port# This command displays port-unique parameters for a telephony interface port. show port Syntax Description 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. -
Page 34: Set Port_Cfg Call_Limit
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 Factory default set port_cfg default This command resets the port-common parameters to factory default values. -
Page 35: Set Port_Cfg Out_Wait
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 Factory default 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. -
Page 36: Set Port_Cfg Tone_Out_Pwr
set port_cfg tone_out_on milliseconds Syntax description milliseconds 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 Factory default... -
Page 37: Show Port_Cfg
on page 31 for details about coding profile. set port_cfg voice_prof profile_id Syntax description profile_id 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. -
Page 38: Set Port_Cfg Fxs Cpc_Dur
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. -
Page 39: Set Port_Cfg Fxs Offhook_Db
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 Factory default 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. -
Page 40: Set Port_Cfg Fxs Onhook_Detect
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. - Page 41 Factory default Telephony Interface Port Configuration Commands...
-
Page 43: Voice And Fax Coder Configuration Commands
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. -
Page 44: Set Coding Profile_Id Dtmf_Relay
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... -
Page 45: Set Coding Profile_Id Vad
Profile g723 Setting 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 Factory default Profile g723 Setting Fax Coding Profile Configuration Commands The following sections describe commands that apply to coding profiles for fax. -
Page 46: Set Coding Profile_Id Fax_Ls_Redundancy
Profile ID Setting 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 Factory default... -
Page 47: H323 Configuration Commands
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. -
Page 48: Set H323 Callsignalport
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.. -
Page 49: Set H323 Display_Name
imtc 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. -
Page 50: Set H323 H245_Term_Type
manual Factory default 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 Factory default... -
Page 51: Set H323 In_Fast_Start
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 Factory default Related Command set h323 out_fast_start set h323 local_alert Per ITU-T H.323 standard, an H.323 terminal initiating a call sends a Setup message to the remote gateway, then wait for an Alerting message from remote gateway. -
Page 52: Set H323 Out_Fast_Start
Factory default 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 Factory default 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. When calls are made to remote gateways, an RTP and RTCP ports are opened for each call. -
Page 53: Show H323
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. -
Page 54: Set H323 Alt_Gk
false 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. -
Page 55: Set H323 Endpoint_Prefix
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... -
Page 56: Set H323 Gk_Id
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. -
Page 57: Set H323 Time_To_Live
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. -
Page 59: Configuration Management Command
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: Temporary Active Non-volatile Storage (NVS) When a set command is entered and processed, it changes the parameter value in the Temporary area. -
Page 61: Dial Plan Management Commands
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. -
Page 62: Atpm Req
atpm purge {all | addr | dest | hunt} Syntax description addr dest hunt Allowed only in database update mode Related Commands atpm restore atpm store atpm req This command starts the dial plan database update session. Upon starting the database update session, the ATPM address translation is disabled, hence no phone calls can be made, until a atpm done command is issued. -
Page 63: Atpm Store
atpm store This command stores the ATPM address, destination and hung group tables to the non-volatile storage. atpm store [erase] Syntax description erase Allowed only in database update mode Related Command atpm restore Destination Table Management Commands atpm dadd This command adds a destination entry into the ATPM destination table. A local destination entry is one of the telephony ports on the ITG. -
Page 64: Atpm Ddel
atpm ddel This command deletes an entry from the ATPM destination table. atpm ddel dest_id Syntax description dest_id Allowed only in database update mode 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... -
Page 65: Hunt Group Table Management Commands
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 Hunt group ID. For each hunt group, you need to assign it a unique identifier between 0 and 99. -
Page 66: Atpm Hlist
Syntax description Allowed only in database update mode 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 Related Commands atpm hadd atpm hdel... -
Page 67: Atpm Adel
Allowed only in database update mode 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# Allowed only in database update mode Related Commands atpm adel atpm adel atpm alist... -
Page 68: Dialing Control Commands
Syntax description This command has no arguments or keywords Allowed only in database update mode 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 Related Commands atpm sys... - Page 69 Syntax description dial_time _digit_wait inter_digit_wait dial_term_digit Allowed only in database update mode Related Commands atpm slist Configuration Management Command The maximum time, in millisecond, allowed for entry of the entire string of dialed digits. At expiration, ATPM starts address lookup. The maximum time, in millisecond, allowed between off-hook and when the first dialed digit is entered.
-
Page 71: Index
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 Ｂ battery reversal ... 25, 26 Ｃ Caller ID ... 19, 20, 26, 29 detection ... - Page 72 Ｐ ping... 3 Ｒ redundancy ...38 reset ... 3 ring frequency ... 4 ringing cadence ...32 router ...14 RTCP ...52 RTP ...52 Ｓ signaling protocol ... 71 spy ... 71 Ｔ T.38... 35, 48 Telnet ... 17 Ｖ VAD ... 37 version...