Planet Networking & Communication VIP-101T, Command Line Interface Manual

Page 1: ...IP Phone VIP 101T CLI User s Manual This document is a command by command description for the PLANET VIP 101T CLI administration mode ...

Page 2: ...ve occurred Information in this User s Manual is subject to change without notice and does not represent a commitment on the part of PLANET PLANET assumes no responsibility for any inaccuracies that may be contained in this User s Manual PLANET makes no commitment to update or keep current the information in this User s Manual and reserves the right to make improvements to this User s Manual and o...

Page 3: ... on different branch circuits If necessary you should consult the place of purchase or an experienced radio television technician for additional suggestions CE mark Warning The is a class B device In a domestic environment this product may cause radio interference in which case the user may be required to take adequate measures Trademarks The PLANET logo is a trademark of PLANET Technology This do...

Page 4: ...it 4 6 ifaddr 4 a ip mask gate 5 b dhcp 6 c sntp 6 d dns 6 e timezone 7 f ipsharing 7 7 time 8 8 ping 8 9 pbook 9 a print 11 b add 11 c search 12 d delete 12 e insert 12 f modify 13 10 pppoe 13 a print 13 b dev 14 c open 14 d close 14 e id 15 f pwd 15 g reboot 15 11 ddns command 16 12 sysconf command 17 a print 17 b plan 17 c callalive 18 ...

Page 5: ... d dfgw 22 e algk 23 f gkname 23 g e164 23 h e164 x 24 i alias 24 j tokenpwd 25 k gkdis 25 l rtp 26 m ttl 26 n gkfind 26 o ras 26 p range 27 q respto 27 r connto 27 13 voice 28 a print 29 b send 30 c priority 31 d volume 31 e nscng 31 f echo 31 g mindelay 32 h maxdealy 32 14 tos 32 15 tone 33 16 support 34 a print 35 ...

Page 6: ... b fstart 35 c tunnel 35 d h245fs 35 17 bureau 36 a print 36 b hold 37 18 rom 37 a print 37 b app boot dsptest dspcore dspapp rbpcm and htpcm 37 c boot2m 38 d s 38 e f 38 f server 39 g method 39 h ftp 39 19 passwd 40 a set 40 b clean 41 ...

Page 7: ...will prompt with usr config this shows you are log into the CLI of the VIP 101T successfully Operation commands in command line interface CLI are introduced in respective session please press either or help to display related command messages 1 help Type help or man or to display all the command lists The following figure shows the supported commands of the VIP 101T Syntax Description This command...

Page 8: ...hine flash clean configuration from flash rom commit commit flash rom data ifaddr internet address manipulation time show current time ping test that a remote host is reachable pbook Phonebook information and configuration pppoe PPPoE stack manipulation sysconf system information manipulation h323 H 323 information manipulation voice voice information manipulation tone Setup of call progress tones...

Page 9: ... If you ignore the prompt type n to reboot machine without saving data all the modifications will be lost after rebooting 4 flash Flash command will erase current running configuration and load factory default parameter and reboot VIP 101T Syntax Description flash clean this command only can be applied while logging in as root privilege Default This command has no default value Example usr config ...

Page 10: ...nload or receive firmware upgrade from your service provider it is required to perform a flash clean to activate new configuration in machine Machine default IP address 192 168 0 1 Web Telnet logon username root password null press Enter to log in machine 6 ifaddr Command ifaddr is used to configure and display TCP IP related information in VIP 101T There are sub parameters in this menu please ins...

Page 11: ...zone ipsharing Specify usage of an IP sharing device and specify IP address cmcenter Specify management center IP address Note Range of ip address setting 0 0 0 0 255 255 255 255 DHCP client setting value On 1 Off 0 If DHCP set to On Obtain a set of Internet configuration from DHCP server assgined SNTP mode 0 no update 1 specify server IP 2 broadcast mode Example ifaddr ip 210 59 163 202 mask 255 ...

Page 12: ...mation from timeserver on the net To enable the SNTP feature in machine please assign the trigger parameter 1 and SNTP IP address in SNTP parameter Syntax Description sntp 1 xxx xxx xxx xxx Default 1 SNTP option turned on IP 213 91 2 137 d dns VIP 101T support domain name resolution you may configure the DNS server IP address obtained from ISP or your preferred DNS server After configuring this yo...

Page 13: ...you may enable IP sharing function and insert WAN IP address of the device to prevents one way communication in NAT environment Syntax Description ipsharing 0 1 WAN side IP address of the IP sharing device Default 0 no IP Sharing device M Note 1 Please consult your network administrator or ISP for DNS related information to have best performance in domain name resolution 2 If you d like to use dom...

Page 14: ...y when SNTP server is configured in VIP 101T s SNTP function 8 ping Command ping can be used to verify network connection status Syntax Description ping xxx xxx xxx xxx Pinging results will be displayed on screen to show network status Default This command has no default value G Hint If time information cannot display properly please check command ifaddr sntp for configuration tips ...

Page 15: ...92 168 0 254 icmp_seq 3 time 0 ms 192 168 0 254 PING Statistics 4 packets transmitted 4 packets received 0 packet loss round trip ms min avg max 0 1 5 Example 9 pbook Phonebook in VIP 101T is the phone number database for connection toward other H 323 terminal gateway This command is provided for Peer to Peer Mode use only While machine is running in GK mode dial string depends on the registration...

Page 16: ...in specified position modify Modify an exist record pbook add name Test ip 210 59 163 202 e164 1001 pbook insert 3 name Test ip 210 59 163 202 e164 1001 pbook delete 3 pbook search ip 192 168 4 99 pbook modify 3 name Test ip 210 59 163 202 e164 1001 Note If parameter end_record is omited only record start_record will be display If both parameters end_record and start_record are omited all records ...

Page 17: ...ata in phone book by adding print parameter Furthermore you like to display a section of data indication parameter start_record and end_record can be used pbook print start index end index If parameter end_record is omitted only record start_record will be display pbook print start index Syntax Description print start index end index Display phonebook data Default This command has no default value...

Page 18: ... Description This command has no arguments or keywords Default This command has no default value d delete Parameter delete can be used to delete a telephone entry in VIP 101T phone book database Syntax Description delete index number Default This command has no default value e insert Parameter insert allows user to enter an entry in specified index number of phone book Syntax Description insert In...

Page 19: ...h Internet connection without assistance Example a print Parameter print can be used to display overall PPPoE information and configurations When PPPoE connection established related information IP gateway etc can be G Hint When dialing please press after dialing E 164 number to send out telephone number to destination usr config pppoe PPPoE device information and configuration Usage pppoe print o...

Page 20: ...n in VIP 101T Default 0 PPPoE function in VIP 101T is turned off c open While VIP 101T is not in PPPoE connection state you may use parameter open to initiate a PPPoE connection Syntax Description open Initiate a PPPoE connection Default This command has no default value d close While VIP 101T is in PPPoE connection state you may use parameter close to disconnect a PPPoE connection usr config pppo...

Page 21: ...f user enable this function after PPPoE being disconnected unexpectedly VIP 101T will automatically reboot to re establish PPPoE conhnection After reboot if VIP 101T still can t get contact with server VIP 101T will keep trying to connect one more time On the other hand if this function is disabled VIP 101T won t reboot and keep trying to connect Syntax Description reboot Reboot VIP 101T while PPP...

Page 22: ...hen this function is enabled VIP 101T will check it s public IP address by asking IP address check server and send to DDNS server to update DDNS data If this function is disabled when VIP 101T is behind IP sharing it will send it s private IP address to DDNS server 8 checkipsrv to set IP address of IP address check server 9 delay to set the update interval time VIP 101T will re update it s IP addr...

Page 23: ... no default value Example b plan System information and configuration Usage sysconf plan digits callalive flag h450 flag keypad type idto time eod type sysconf print print Display system overall information and configuration plan Number of digits for dial plan No or positive number 1 24 callalive Enable or disable auto disconnection after 10 seconds not receiving packets from remote party keypad S...

Page 24: ...ng party Syntax Description callalive Enable or disable auto disconnection after 10 seconds not receiving packets from remote party 0 for disable and 1 for enable Default 0 d keypad Parameter keypad is used to setup DTMF transmission method You may select DTMF type in VIP 101T for DTMF receiving and transmitting activities Syntax Description keypad 0 1 2 3 0 for inband 1 for H 245 alphanumeric 2 f...

Page 25: ...ied digit is pressed on the keypad VIP 101T will send out the dialed digits Syntax Description eod 0 1 2 3 0 for no end of dial key 1 for OK button 2 for button 3 for button Default g h450 Parameter h450 can be used to enable or disable the H 450 features supported in VIP 101T H 450 service supported call transfer call on hold and call forward Syntax Description h450 Enable or disable H 450 relate...

Page 26: ...ment It is strongly recommended not to modify these parameters on your own If you met difficulty to establish communication toward destination call party please consult ITSP engineering staff experienced personnel or local distributor support staff for proper configuration There are sub parameters in VIP H 323 configuration menu which will be illustrated in following sections ...

Page 27: ...mode gk Gatekeeper ip address 0 0 0 0 255 255 255 255 dfgw Default Gateway IP Address 0 0 0 0 255 255 255 255 algk Second Gatekeeper ip address 0 0 0 0 255 255 255 255 gkname Gatekeeper ID e164 IP side registered number e164 x IP side registered number x 1 9 alias IP side registered H323 ID tokenpwd RRQ ARQ authentication token password gkdis Gatekeeper auto discovery multicast On 1 Off 0 rtp RTP ...

Page 28: ...d with PBX or PSTN line to establish the communications please add sysconf 2nddial 0 parameter to make this one time dialing working iii In this mode if you like to dial remote PSTN number via default gateway configuration VIP 101T will dial to default gateway first then the remote gateway will forward this number to PSTN line and connect the call iv If called party equips with FXS interface you m...

Page 29: ... algk IP address of Secondary Gatekeeper Default Null This command has no default value f gkname Parameter gkname is used to configure the Gatekeeper name ID for Gatekeeper auto discovery operations When VIP 101T send out Gatekeeper discovery message this ID will be encapsulated to search matched Gatekeeper to register with Syntax Description gkname Destination Gatekeeper ID Default Null This comm...

Page 30: ...gistered telephone number toward destination Gatekeeper in VIP 101T phone book database Default This command has no default value i alias Parameter alias is used to identify H 323 ID for VIP 101T to register with Gatekeeper Default alias is related to MAC address of VIP 101T so each VIP 101T has different alias which can register with GK without conflict Syntax Description alias Registered H323 ID...

Page 31: ...to a GateKeeper which implement H 235 security token feature VIP 101T has to set a RRQ ARQ authentication token password which is provided by GateKeeper manager VIP 101T can t work normally with this GateKeeper unless Token Password is set Default x k gkdis Parameter gkdis can be used to enable or disable auto discovery function in VIP 101T If this function is enabled and IP address of Gatekeeper ...

Page 32: ... toward Gatekeeper Definable time range 0 3600 second s Syntax Description ttl RAS TTL time 0 3600 second Default 60 seconds n gkfind This parameter is used to assign GateKeeper finding port number definable port range 1024 65535 Syntax Description gkfind Port assignment of Gatekeeper finding port 1024 65535 Default 1718 o ras This parameter is used to assign Gatekeeper RAS port definable port ran...

Page 33: ...ponse from detination call party during call setup process If this value expired you will hear busy tone from the handset or speaker phone Range 1 200 seconds Syntax Description respto Maximum waiting time for 1st response to a new call 1 200 Default 5 seconds r connto This parameter is used to setup Max waiting time for call establishment after receiving first response during call setup process d...

Page 34: ...rienced personnel or local distributor support staff for proper configuration G Note 1 Parameters in this H 323 configuration menu are not suggested to change without assistance of ITSP or experienced personnel improper configuration will case communications fail or malfunction in machine 2 In Peer to Peer mode h323 print will only display information on e164 alias mode RTP port and allocated port...

Page 35: ...and configuration send Specify sending packet size G 723 30 60 ms G 711A 20 40 60 ms G 711U 20 40 60 ms G 729A 20 40 60 ms G 729 20 40 60 ms priority Priority preference of installed codecs G 723 G 711A G 711U G 729A G 729 volume Specify the following levels voice volume 0 40 default 30 input gain 0 63 default 32 dtmf volume 0 31 default 27 nscng Silence suppression and CNG G 723 1 only On 1 Off 0...

Page 36: ...toward destination call party Default G 723 1 30 ms G 729A 20 ms G 729 20 ms G 711U 20 ms G 711A 20 ms Example usr config voice print Voice codec setting relate information Sending packet size G 723 1 30 ms G 729A 20 ms G 729 20 ms G 711U 20 ms G 711A 20 ms Priority order codec g7231 g729a g729 g711u g711a Volume levels voice volume 30 input gain 26 dtmf volume 23 Silence suppression CNG G 723 1 O...

Page 37: ...fault Supported voice codec and priority order in VIP 101T G 7231 G 729a G 729 G 711u G 711a d volume Parameter volume can be used to adjust voice volume of H 323 calls signal input gain level and DTMF volume while communicating with destination call party Syntax Description volume Specify the voice volume level input gain DTMF volume in VIP 101T Default voice volume level 30 input gain 30 DTMF vo...

Page 38: ...is used to setup Maximum delay of jitter buffer in VIP 101T definable range 0 150 ms Syntax Description maxdelay Setting Maximum delay of jitter buffer Default 90 ms 15 tos This command is for setting IP packet TOS values to determine IP Packets priority on M Caution Parameters in voice configuration menu are for advanced user or system administrator only improper settings in this menu will cause ...

Page 39: ... are adjustable in VIP 101T In most circumstances there is no need to change tone setting Currently only ring tone and dial tone is functional in VIP 101T busy tone and reorder tone are reserved for future use Syntax Description tone toneX LowFreq HighFreq LowFreqLevel HighFreqLevel TOn1 TOff1 TOn2 TOff2 You need to key in 8 sets of number to finish this configuration If it is single frequency ton...

Page 40: ...tems as 0 Furthermore unit of on off time is 1 100 second and it is suggested to keep this as default value Default Example 17 support Parameters in support configuration menu are used to adjust H 323 call setup related parameters By default settings VIP 101T is able to work well in most operation environment If you met difficulties during call setup please contact ITSP related personnel or your l...

Page 41: ...s well Syntax Description fstart Enabled or disabled Fast start mode in VIP 101T o to disable 1 to enable this feature Default 0 H 323 fast start mode is disabled c tunnel Parameter tunnel is used to enable or disable H 245 tunneling function Syntax Description tunnel Enabled or disabled H 245 Tunneling 0 for disable and 1 for enable Default 0 H 245 tunnel mode is disabled d h245fs Parameter h245f...

Page 42: ...bureau setting information and configuration Syntax Description This command has no arguments or keywords G Note When H 323 fast start mode is enabled if you wish to send DTMF message after connection VIP 101T will send out Q 931 message to destination call party You ll need to specify the Keypad type as Q 931 in System configuration menu usr config bureau Bureau line setting information and confi...

Page 43: ...ou may refer to the following commands to upgrade your VIP 101T to obtain latest add on features or maintenance service rom command related parameters can be shown below a print Parameter print is used to displayVIP 101T firmware version information Please be sure to attach this information while sending support inquiry to our distributor support staff Syntax Description This command has no argume...

Page 44: ...plication code Default This command has no default value c boot2m Parameter boot2m is used to upgrade 2mb firmware file which includes all firmware image files mentioned in section b Syntax Description boot2m Update 2M firmware file Default This command has no default value d s Parameter s is used to specify the IP address of the destination TFTP FTP server which contains the firmware file for upg...

Page 45: ...which will be stored in machine Default This command has no default value g method Parameter method is used to specify download method to be TFTP or FTP Syntax Description method Specify firmware upgrade mode via TFTP or FTP session 0 for TFTP 1 for FTP Default 1 Firmware upgrade will be performed via TFTP method h ftp Specify user name and password for FTP firmware upgrade method For example User...

Page 46: ...n OK usr config passwd set root 321 Setting login root Password root OK ftp specify username and password for FTP Default This command has no default value 20 passwd For security protection user has to input the password before entering application user config mode Two configurations of login name password are supported by VIP 101T a set Parameter set is used to configure password for root or admi...

Page 47: ... this command you need to logon as root user to have sufficient privilege to execute this command After password erased you may logon VIP 101T via username password root null without password or administrator null without password Syntax Description This command has no arguments or keywords Default This command has no default value ...