Planet Technology VIP-110, VIP-210 User Manual
Internet Telephony Gateway
VIP-110/VIP-210
Command Reference
Release 1.00
January 2004
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.
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
i
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
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
v
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
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.
Document Organization
This document is organized as follows:
• Introduction, gives an overview about this document.
• Utility Commands describes general-purpose utility commands.
• IP Configuration Commands describes commands for configuring the network interfaces
and displaying the configuration.
• Telephony Interface Port Configuration Commands describe commands for configuring
the telephony interface ports.
• Voice and Fax Coder Configuration Commands, describe commands for configuring the
voice and fax coders supported by the ITG.
• Call Progress Tone Configuration Commands describe commands for configuring the call
progress detector and generator.
• H323 Configuration Commands describe commands for configuring the H.323 call control
and signaling protocol stack.
• Configuration Management Commands describe the command for managing the
configuration parameters.
•
Dial Plan Management Commands describe commands for setting up and viewing the dial
plan.
Notation Conventions
This document uses the following conventions:
• Examples that contain system prompts denote interactive sessions, indicating that the
user enters commands at the prompt.
• Different type styles and characters are used. These serve a variety of purposes as
described below:
Introduction
7
8
Convention Description
boldface
Bold Courier
italic
courier
[ ]
{ x | y | z }
[ x | y | z ]
“string”
<key>
Commands and keywords are in boldface.
User input (anything you are expected to type in) is set in Bold Courier.
Arguments for which you supply values.
Messages that the ITG CLI displays are in plain courier font.
Elements in square brackets are optional.
Alternative but required elements are grouped in braces ({ }) and separated by
vertical bars ( | ).
Optional alternative keywords are grouped in brackets ([ ]) and separated by
vertical bars ( | ).
A non-quoted set of characters. Do not use quotation marks around the string
or the string will include the quotation marks.
A key on the VT-100 terminal or terminal emulator. For example <Enter>
denotes the Enter 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:
192.168.0.1
Designating Port ID
Each telephony port of the ITG is assigned with an ID. Some commands require a telephony
port ID. The ITG assigned ID 0 to the first telephony port, ID 1 to the 2nd port, and so on.
Documentation Abbreviations
Throughout this document, the user will come across a number of abbreviations, some of
them are commonly used in the industry and some are unique to the ITG. The user should be
familiar with the following abbreviations:
ATPM
CLI
DHCP
DIS
DNS
DSP
Address Translation and Parsing Manager
Command Line Interface
Dynamic Host Configuration Protocol
Digital Identification Signal
Domain Name System
Digital Signal Processor
DTMF
EIA
FXS
GK
H.323
ICMP
IFP
IMTC
IP
ISP
ITG
KTS
LAN
PPP
PPPoE
NAT
NAPT
NVS
PBX
PSTN
RAM
RAS
RCF
RRQ
RTP
TFTP
UDP
UUIE
VAD
WAN
Dual Tone Multi-Frequency
Electronic Industry Association
Foreign Exchange Station
Gatekeeper
ITU specification for multimedia transmission over IP
networks
Internet Control Message Protocol
Internet Facsimile Protocol
International Multimedia Telecommunications
Consortium
Internet Protocol
Internet Service Provider
Internet Telephony Gateway
Key Telephone System
Local Area Network
Point-to-Point Protocol
PPP Over Ethernet
Network Address Translation
Network Address Port Translation
Non-Volatile Storage
Private Branch Exchange
Public Switched Telephone Network
Read-Write Memory
Registration, Admission and Status
Registration Confirmation
Registration Request
Real-Time Transport Protocol
Trivial File Transfer Protocol
User Datagram Protocol
User-to-User Information Element
Voice Activity Detection
Wide Area Network
Introduction
9
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). You
can configure ITG by entering commands from the CLI.
You can access the CLI from a VT-100 terminal or terminal emulator connected through a Telnet session.
Command Help
Help for commands is provided by the CLI. Type help to see a list of the top-level commands.
On most cases, if you enter a command using the wrong number of arguments or
inappropriate arguments, the CLI will give further usage.
Introduction
1
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.
help
Syntax Description
This command has no arguments or keywords
reset
Use the reset command to reset the ITG. The CLI will prompt you to confirm the command
before resetting the ITG.
net reset
Syntax Description
This command has no arguments or keywords
ping
The ping command sends ICMP echo request packets to another host on the network.
ping host [count]
Syntax description
host The IP address or IP alias of the host.
count Number of echo request packets to send.
Utility Commands
3
4
tel erase_ivr
ID of the telephony port. If not specified, hook status for all telephony ports
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.
tel set ring_freq {1 | 2 | 3 | 4}
Syntax description
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
tel show port
This command displays the hook status of a telephony port.
tel show port [port]
Syntax description
port
available will be displayed.
tel show ring_freq
This command displays the ringing frequency that was configured by the tel set ring_freq
command.
tel show ring_freq
Syntax description
This command has no arguments or keywords
Related Command
tel set ring_freq
Utility Commands
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.0 Gateway (Build 4)
ITG>
Utility Commands
5
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
Configuring LAN Interface
The section describes commands for setting and displaying LAN interface parameters.
net set lan ip
This command is used to assign a static IP address for the LAN interface
net set lan ip ip_addr
Syntax description
ip_addr IP address for the LAN interface.
Factory default
192.168.0.1
Related Commands
net set lan mask
net set lan mask
This command is used to assign the subnet mask for the LAN interface
net set lan mask mask
Syntax description
mask Subnet mask for the LAN interface.
IP Configuration Commands
7
8
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.
net set wan dns
This command is used to specify the DNS servers for the WAN interface. Up to two DNS
servers can be specified.
net set wan dns pri_server [sec_server]
Syntax description
pri_server Primary DNS server for the WAN interface
sec_server Secondary DNS server for 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 to specify the default gateway for the WAN interface.
net set wan gateway ip_addr
Syntax description
ip_addr IP address of the default gateway for the WAN interface
Factory default
0.0.0.0
IP Configuration Commands
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. The Service Type field is broken down into five subfields,
among which four subfileds are user configurable. This command is used to set these
subfields.
net set wan ip_tos ip_preced [d] [t] [r]
Syntax description
ip_preced The 3-bit PRECEDENCE subfiled ranging from 0 through 7.
d The D bit subfield, either 0 or 1.
t The T bit subfield, either 0 or 1.
r The R bit subfield, either 0 or 1.
Factory default
ip_preced: 0
d: 0
t: 0
r: 0
net set wan mask
This command is used to assign the subnet mask for the WAN interface
net set wan mask mask
Syntax description
mask Subnet mask for the WAN interface.
IP Configuration Commands
9
10
Factory default
byte, in hexadecimal format, hardware address for the
the least significant one, should be
”). If not specified, the ITG will use the
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.
net set dhcp client
The ITG supports DHCP client over its WAN interface for obtaining IP configuration from a
remote DHCP server.
The net set dhcp client command allows you to configure the DHCP client.
net set dhcp client {on | off}
Syntax description
on Enable DHCP client over WAN interface
off Disable DHCP client
Factory default
off
net set dhcp mac_addr
Certain DHCP server allows DHCP client to request IP configuration only if predefined
hardware address is specified by the client.
The net set dhcp mac_addr command allows you to specify the hardware address for the
DHCP client. If not specified, the ITG will use the MAC address of the WAN interface.
net set dhcp mac_addr mac_addr
Syntax description
mac_addr The 6-
DHCP client. Each byte, except
delimited by a hyphen (“-
IP Configuration Commands
Loading...