Planet VIP-110 Installation manual

InternetTelephonyGateway
VIP-110/VIP-210
Command Reference
Release1.00
January 2004

2
COMMANDLINE CONFIGURATION
Command lineinterfacein PLANET VIP-110/VIP-210
This manual is acommand-by-command description for the PLANET VIP-110/VIP-210 CLI
administration mode.

i
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. Introduction 1
Command Help..................................................1
2. Utility Commands 3
get...........................................................3
help..........................................................3
reset.........................................................3
ping..........................................................3
tel erase_ivr.................................................4
tel set ring_freq.............................................4
tel show port.................................................4
tel show ring_freq............................................4
show version..................................................5
3. IP Configuration Commands 7
Configuring LAN Interface.....................................7
net set lan ip..............................................7
net set lan mask............................................7
net show lan................................................8
Configuring WAN Interface.....................................8

ii
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........................................10
net set dhcp mac_addr......................................10
net set dhcp server........................................11
Configuring TFTP Server......................................11
net set tftpsrv............................................11
Configuring PPPoE............................................12
net set pppoe auth_proto...................................12
net set pppoe fixed_ip.....................................12
net set pppoe idle_timeout.................................12
net set pppoe {on | off}...................................13
net set pppoe service_name.................................13
net set pppoe tx_bw........................................13
net set pppoe user.........................................13
net show ppp...............................................14
Configuring Dynamic DNS......................................14
net set ddns {on | off}....................................14
net set ddns add...........................................15
net set ddns del...........................................15
net show ddns..............................................15
Configuring Management Options...............................16
net set http...............................................16
net set manager ip.........................................16
net set manager mask.......................................16
net set manager password...................................17
net set telnet.............................................17

iii
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.....................................20
set port port# dial_in plar................................20
set port port# port_cfg....................................20
show port port# ............................................21
Configuring Port-Common Parameters...........................21
Configuration General Port-Common Parameters.................21
set port_cfg ans_wait......................................21
set port_cfg call_limit....................................22
set port_cfg default.......................................22
set port_cfg fax_prof......................................22
set port_cfg out_type......................................22
set port_cfg out_wait......................................23
set port_cfg rxgain........................................23
set port_cfg tone_out_off..................................23
set port_cfg tone_out_on...................................23
set port_cfg tone_out_pwr..................................24
set port_cfg txgain........................................24
set port_cfg voice_prof....................................24
show port_cfg..............................................25
FXS Signaling Configuration Commands.........................25
set port_cfg fxs answ_clear_detect.........................25
set port_cfg fxs caller_id.................................25
set port_cfg fxs cpc_dur...................................26
set port_cfg fxs cpc_wait..................................26

iv
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.................31
set coding default...........................................31
show coding profile_id .....................................31
Voice Coding Profile Configuration Commands..................31
set coding profile_id dtmf_relay.............................32
set coding profile_id sampling_time..........................32
set coding profile_id vad....................................33
Fax Coding Profile Configuration Commands....................33
set coding profile_id fax_hs_pkt_rate......................33
set coding profile_id fax_hs_redundancy....................33
set coding profile_id fax_ls_redundancy....................34
7. H323 Configuration Commands 35
General H.323 Configuration Commands.........................35
set h323 alt_dtmf..........................................35
set h323 call_name.........................................35
set h323 callSignalPort....................................36
set h323 cisco_t38.........................................36
set h323 default...........................................36
set h323 default_dtmf......................................36
set h323 display_name......................................37
set h323 dtmf_duration.....................................37
set h323 gk_mode...........................................37
set h323 h245_term_type....................................38

v
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..................................................41
H.323 Gatekeeper Related Configuration Commands..............41
set h323 alias.............................................41
set h323 allow_calls_wo_gk.................................41
set h323 alt_gk............................................42
set h323 alt_gk_name.......................................42
set h323 endpoint_prefix...................................43
set h323 endpoint_reg_type.................................43
set h323 gk_addr...........................................43
set h323 gk_id.............................................44
set h323 gk_max_tries......................................44
set h323 gk_name...........................................44
set h323 time_to_live......................................45
8. Configuration Management Command 47
config.......................................................47
9. Dial Plan Management Commands 49
Database Update Control Commands.............................49
atpm done..................................................49
atpm erase.................................................49
atpm purge.................................................49
atpm req...................................................50
atpm restore...............................................50
atpm store.................................................51

vi
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.................................................54
Address Table Management Commands............................54
atpm aadd..................................................54
atpm adel..................................................55
atpm afind.................................................55
atpm alist.................................................55
Dialing Control Commands.....................................56
atpm slist.................................................56
atpm sys...................................................56
Index 59

Introduction 7
About This Manual
This section discusses the objectives, audience, organization, and conventions
associated with this document.
Document Objectives
This document provides anin-depthdescriptionof the commands necessaryfor configuring
and maintaining the ITG.
Audience
This publicationis intended asastandalone document for experienced systemadministrators
or engineerswho will be configuring and maintainingthe ITGand would liketo reference
commands.
Document Organization
This documentis organized as follows:
• Introduction, gives an overview about this document.
• Utility Commands describes general-purposeutilitycommands.
• IPConfigurationCommands describescommands for configuringthe network interfaces
anddisplaying the configuration.
• TelephonyInterface Port Configuration Commands describe commands forconfiguring
the telephonyinterface ports.
• Voice andFaxCoder ConfigurationCommands,describe commandsfor configuring the
voice and fax coders supported by the ITG.
• Call Progress ToneConfigurationCommands describe commandsforconfiguring thecall
progress detector and generator.
• H323 Configuration Commands describecommandsfor configuring the H.323 callcontrol
andsignaling protocolstack.
• Configuration Management Commands describe the command for managingthe
configuration parameters.
• Dial Plan ManagementCommands describecommandsfor setting up and viewing thedial
plan.
Notation Conventions
This documentuses the following conventions:
• Examples that contain system prompts denoteinteractivesessions, indicating that the
user enters commands at the prompt.
• Differenttype styles and characters are used. These serveavariety of purposesas
described below:

8
Convention Description
boldface Commandsand keywords are in boldface.
Bold Courier User input (anythingyouare expected totype in)isset in Bold Courier.
italic Arguments forwhichyou supplyvalues.
courier Messages that theITGCLI displaysare inplain courierfont.
[] Elements in square brackets areoptional.
{ x | y | z } Alternative but required elements are groupedin braces ({})andseparated by
verticalbars (|).
[ x | y | z ] Optionalalternativekeywords are grouped inbrackets([ ])andseparated by
verticalbars (|).
string”Anon-quotedset of characters. Do not usequotationmarks aroundthestring
orthe string willincludethe quotation marks.
<key> Akeyon theVT-100terminal or terminal emulator. For example <Enter>
denotes the Enterkey.
Designating IP Address
Some commands requirean IPaddress, which mustbe designated in astandardformat. The
IP address format is 32 bits,writtenas four octetsseparatedbyperiods (dotteddecimal
format) that are made upof a networksection, anoptionalsubnet section, and a host section,
asshown in thefollowing example:
192.168.0.1
Designating Port ID
Each telephony port of the ITGis assigned withanID. Somecommands requireatelephony
port ID. TheITG assigned ID 0to the firsttelephonyport, ID1to the 2nd port, and soon.
DocumentationAbbreviations
Throughout this document,the user will comeacross anumber of abbreviations, someof
them are commonlyused inthe industry and some areuniquetothe ITG.The usershould be
familiarwith the following abbreviations:
ATPM Address Translation and Parsing Manager
CLI Command LineInterface
DHCP Dynamic Host Configuration Protocol
DIS Digital IdentificationSignal
DNS DomainName System
DSP Digital Signal Processor

Introduction 9
DTMF DualTone Multi-Frequency
EIA Electronic Industry Association
FXS Foreign Exchange Station
GK Gatekeeper
H.323 ITU specification for multimedia transmissionover IP
networks
ICMP InternetControlMessage Protocol
IFP InternetFacsimile Protocol
IMTC International Multimedia Telecommunications
Consortium
IP InternetProtocol
ISP InternetService Provider
ITG InternetTelephonyGateway
KTS Key Telephone System
LAN Local Area Network
PPP Point-to-PointProtocol
PPPoE PPP Over Ethernet
NAT Network Address Translation
NAPT Network Address Port Translation
NVS Non-Volatile Storage
PBX PrivateBranch Exchange
PSTN PublicSwitched Telephone Network
RAM Read-WriteMemory
RAS Registration, Admission and Status
RCF Registration Confirmation
RRQ Registration Request
RTP Real-Time Transport Protocol
TFTP TrivialFile TransferProtocol
UDP User Datagram Protocol
UUIE User-to-User Information Element
VAD Voice ActivityDetection
WAN WideArea Network

Introduction 1
1. Introduction
TheITG isaVoIP gatewayintegratedwithaNetwork Address Translation(NAT) router. It isequippedwith
twoIP interfaces, oneforconnectingto internal network (hereaftercalledLAN),the other forconnectingto
externalnetwork (hereaftercalledWAN).The ITG performs NAPT forhost in LAN interface,allowing
multiplehosts in theLAN interface to share a singleIP address.
TheITGhasabuilt-incommandline interpreter and provides users aCommandLine Interface (CLI).You
canconfigure ITG by entering commandsfrom theCLI.
You can access theCLI from a VT-100 terminalor terminal emulatorconnected through a Telnet session.
Command Help
Help for commands is provided bythe CLI. Type help to see alistof the top-levelcommands.
On most cases, ifyou enter acommand using the wrong numberof arguments or
inappropriate arguments, the CLIwill give further usage.

UtilityCommands 3
2. Utility Commands
This chapter describes the general-purpose utility commands.
get
The ITGimplementsTFTPclientsoftware. This command is used todownload newrevision
softwarefromaremoteTFTPserver, or import dialplanand system configuration parameters
from a remote gateway.
get [ip_addr | host_name] [file]
SyntaxDescription
ip_addr IP addressof the TFTP server.
host_name Host of the TFTPserver
file Name of thefiletobe downloaded
help
The help command lists the top-level commands.
help
SyntaxDescription
This command has no arguments or keywords
reset
Use the resetcommand to resetthe ITG.The CLI willprompt you toconfirm the command
before resetting the ITG.
netreset
SyntaxDescription
This command has no arguments or keywords
ping
The pingcommand sends ICMP echo requestpackets toanother host on thenetwork.
ping host [count]
Syntaxdescription
host The IPaddress orIPalias of the host.
count Number of echo requestpackets to send.

UtilityCommands
4
telerase_ivr
This command erases the greetingmessage that was recorded previously.
tel erase_ivr
SyntaxDescription
This command has no arguments or keywords
telset ring_freq
The ITGringsFXS port forsignaling an incomingcall, and provide 4types of ringing signal,
each havingauniquefrequency. This command isfor selecting thefrequency of theringing
signalthat the ITG sends to FXS ports.
tel set ring_freq {1|2 | 3 | 4}
Syntaxdescription
1 Setting ring frequency to 17 Hz
2 Setting ring frequency to 20 Hz
3 Setting ring frequency to 25 Hz
4 Setting ring frequency to 50 Hz
Factory default
1- 17 Hz
Related Command
tel show ring_freq
telshow port
This command displays the hookstatus of atelephony port.
tel show port [port]
Syntaxdescription
port
ID of the telephonyport. If not specified, hookstatus for alltelephony ports
available willbe displayed.
telshow ring_freq
Thiscommanddisplays theringing frequencythat was configuredby the tel set ring_freq
command.
tel show ring_freq
Syntaxdescription
This command has no arguments or keywords
Related Command
tel set ring_freq

UtilityCommands 5
show version
This commandis usedto displayinformation that identifies the versions of various software
componentsthat are implemented in the ITG.
showversion
SyntaxDescription
This command has no arguments or keywords
Example
The followingexampleshows how to usethe 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.0 Gateway (Build 4)
ITG>

IPConfiguration Commands 7
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:
l Commands for configuring and displaying LAN interface parameters
l Commands for configuring and displaying WAN interface parameters
l Commands for configuring and displaying DHCP server and client
l Commands for configuring TFTP server
l Commands for configuring and displaying PPPoE options
l Commands for configuring and displaying dynamic DNS related parameters
l Commands for configuring and displaying management options
l Command for storing IP interface parameters to NVS
ConfiguringLAN Interface
The sectiondescribes commands for setting and displaying LAN interfaceparameters.
net set lan ip
This command is used to assign a static IP address for the LAN interface
net set lan ip ip_addr
Syntaxdescription
ip_addr IPaddress for the LAN interface.
Factory default
192.168.0.1
Related Commands
netsetlanmask
net set lan mask
This command is used to assign the subnet mask for the LAN interface
net set lan mask mask
Syntaxdescription
mask Subnet maskfor the LAN interface.

IPConfiguration Commands
8
Factory default
255.255.255.0
Related Commands
net set lan ip
net showlan
This command displays the LAN interface parameters
net show lan
Syntaxdescription
This command has no arguments or keywords
ConfiguringWAN Interface
The sectiondescribes commands for setting and displaying WANinterface parameters.
net set wan dns
This command isused to specifythe DNSservers for theWANinterface. Up to two DNS
servers can be specified.
net set wandns pri_server [sec_server]
Syntaxdescription
pri_server Primary DNS server forthe WAN interface
sec_server SecondaryDNS serverfor the WAN interface. Optional.
Factory default
Primary DNS server: 0.0.0.0
Secondary DNS server: 0.0.0.0
net set wan gateway
This command is used tospecify the defaultgatewayfor the WAN interface.
net set wangateway ip_addr
Syntaxdescription
ip_addr IPaddress of thedefault gatewayfor the WAN interface
Factory default
0.0.0.0
The LAN interface only supports Class C network. That is, the subnet mask
for theLAN interface must be greater than or equal255.255.255.0.
ë
Note