Planet VIP-110 manual

Inte r n e t T el e p hon y G at e wa y VIP - 1 1 0 / VIP - 2 10 C o m mand R eference Releas e 1.00 Janua ry 2004[...]

2 CO M M A NDL I NE C O N FIGU R A T I ON Command l in e int e r fac e in P L ANET V I P- 11 0 / V I P-210 This manual is a co m mand-by-command description for the PLA N ET VIP-110/VIP-210 CLI administration mode.[...]

i Table of Contents About This Manual 7 Document Objective s .......................................... . 7 Audienc e ..................................................... . 7 Document Organizatio n ........................................ . 7 Notation Convention s ......................................... . 7 Designating IP Addres s ..............[...]

ii net set wan dn s ............................................ . 8 net set wan gatewa y ........................................ . 8 net set wan i p ............................................. . 9 net set wan ip_to s ......................................... . 9 net set wan mas k ........................................... . 9 net show wa n ...[...]

iii net show managemen t ....................................... . 17 Storing IP Interface Parameter s ............................. . 18 net stor e ................................................. . 18 4. Telephony Interface Port Configuration Commands 19 Configuring Port-Unique Parameter s .......................... . 19 set port port# cid nam e[...]

iv set port_cfg fxs ff_batt_re v .............................. . 26 set port_cfg fxs offhook_d b ............................... . 27 set port_cfg fxs offhook_detec t ........................... . 27 set port_cfg fxs onhook_d b ................................ . 27 set port_cfg fxs onhook_detec t ............................ . 28 set port_cfg fxs [...]

v set h323 h245_timeou t ..................................... . 38 set h323 h245_tunnelin g ................................... . 38 set h323 in_fast_star t .................................... . 39 set h323 local_aler t ...................................... . 39 set h323 nat_cal l ......................................... . 39 set h323 out_fast_[...]

vi Destination Table Management Command s ....................... . 51 atpm dad d ................................................. . 51 atpm dde l ................................................. . 52 atpm dfin d ................................................ . 52 atpm dlis t ................................................ . 52 Hunt Group Tabl[...]

Int r oduction 7 A b out This Manu a l This section discusses the objectives, audience, organization, and conventio ns associated with this document. Do c u m e nt O b je c tiv e s This document p r o v ides a n in - d e p t h d e scrip t i o n of t he c o mm a nds nec e ssar y for configuring and m a intaining t he I T G . Au d ience This pu b lic[...]

8 Convention Description boldface Comman d s a nd k e ywords are in b o l d f a ce. Bold Courier User i n put (an y t h i n g y o u are ex p ected t o t y pe i n ) i s s e t i n Bold Courier . italic A rguments f o r w hic h y o u sup p l y values. courier M e ssages that t h e IT G CLI dis p la y s a r e i n p lain cour i e r font. [ ] E lem e nts[...]

Int r oduction 9 DTMF Du a l Tone Mu l ti-Freque n cy EIA E l e c t r o nic I ndustry Assoc i a t ion FXS F o reign Exchange Statio n GK Gate k ee p er H.323 ITU sp e cification for m ul t i media trans m i ss i o n over I P n e t w o rks ICMP Int e r ne t C o ntro l Message Pr o t oco l IFP Int e r ne t Facsimile Pr o t oco l IMTC Int e r national[...]

[...]

Int r oduction 1 1. Intr o du c tion T h e I TG i s a V oIP gate w a y i n t e g r a t e d w i t h a N e twork A d dress Translati o n ( NAT) router. It i s equ i pp e d w i th tw o IP i nter f ac e s, o n e f o r co n nectin g to i n t e r n al n e t w o rk ( h ereaf t e r ca l l e d L AN) , the other f o r co n necti n g t o extern a l n e t w or[...]

[...]

U t ili t y Commands 3 2. Uti l ity C ommands This chapter describes the general-purpose utility commands. get The I T G i m pl e m en t s T F T P c l ien t s o f t ware. This command is used t o download n e w re v i s i on s o ftwa r e f r o m a r em o t e TF T P ser v er, or import d i a l p l a n and s y s t em configura t ion parame t ers from[...]

Utili t y Co m mands 4 te l erase_ i vr This command erases t he gre e t in g m essage that was r ecorded p re v iousl y . tel er a s e_ivr Synta x Desc r i ption This c o mm a nd has no a r g u m ents or k e ywords te l set ring _ fre q The I T G rin g s FXS port f o r signaling an incomin g c a l l, and p ro v ide 4 types of r inging signal , eac[...]

U t ili t y Commands 5 show ve r si o n This comman d is use d to displa y i nforma t i on that id e n t i f ies t he versions of v arious softwa r e c o m pone n t s t h at a r e i m p l emented i n the I TG. sh o w ver s i on Synta x Desc r i ption This c o mm a nd has no a r g u m ents or k e ywords Examp l e The f ol l owin g e xa m pl e shows [...]

[...]

I P Con f igur a tion Commands 7 3. IP Conf i gu r ation Commands This chapter describes the commands for configuring and displaying the IP interface parameters. The configured parameter will n ot take effect until t he configured parameter is store in NVS and the ITG is reset. This chapter is organized as follows: l Commands for configuring and di[...]

I P Configur a t i on C o m mands 8 Factory def a u lt 255.255.255.0 Rel a ted Comm a n ds n et set lan i p net sh o w l a n This command displa y s the L AN in t e rface par a m e t e rs net sh o w lan Synta x d escrip t i on This c o mm a nd has no a r g u m ents or k e ywords Configuri n g W AN I n t erface The se c t io n des c r i b es comman [...]

I P Con f igur a tion Commands 9 Rel a ted Comm a n ds n et set w a n i p n et set w a n ma sk net set wan ip This command i s used to assign a static IP a d d r ess for the WAN int e rface net set w a n ip ip _ a d dr Synta x d escrip t i on ip _ a ddr I P a d d ress for the WAN int e rface Factory def a u lt 172.16 . 0 .1 Rel a ted Comm a n ds n [...]

I P Configur a t i on C o m mands 10 Factory def a u lt 255.255.0.0 Rel a ted Comm a n ds n et set w a n i p net sh o w w an This command displa y s the WAN i n t e rface par a met e rs net sh o w w a n Synta x d escrip t i on This c o mm a nd has no a r g u m ents or k e ywords Configuri n g DHCP Server a n d Client The I T G i m pl e m ents a D H[...]

I P Con f igur a tion Commands 11 MA C addr e ss of t he WA N i n t erface. net set dhcp s erver The I T G supports D H CP s e r v er o v er i ts LA N i n t e rface, a llowing hosts in the LA N int e rface t o dyna m ically o b t a in I P configura t i o n from t h e I T G. The n e t set dhc p ser v e r c o m mand allows y ou to co n f ig u re the [...]

I P Configur a t i on C o m mands 12 Configuri n g PPPoE The I T G i m p lements P P P oE clie n t ove r i t s W A N i n t erfac e . P P P oE client p rovid e s the ITG t he abil i ty t o con n ect t o I n t e rnet o v er a b r id g ing a c cess devic e ( suc h a s an AD S L mod e m) t o a remote a ccess conce n t r ator, typic a l ly l o ca t e d [...]

I P Con f igur a tion Commands 13 net set pppoe {on | off } This command s en a bles or d i s a bl e s t he PPPo E cl i e n t . net set pppoe { on | off } Synta x d escrip t i on on E nable PPPoE cl i ent off Dis a b l e P P P o E client Factory def a u lt off net set pppoe service _ n a me This com m e nd i s used t o specif y the s e r v ice name[...]

I P Configur a t i on C o m mands 14 p assw o rd P PPoE c l ient us e r p assw o rd. U p to 23 charac t e r s . Factory def a u lt U s er name: “” U s er pas s w o rd: “” net sh o w ppp This command displa y s P P P co n f ig u ration param e t e rs. net sh o w ppp Synta x d escrip t i on This c o mm a nd has no a r g u m ents or k e ywords[...]

I P Con f igur a tion Commands 15 net set dd n s a dd F o r the dynami c DNS server t o be able t o tr a nsla t e a sta t ic h ost na m e t o an IP add r e ss, t he ITG has t o regist e r t o i t u p on reset. To r e giste r to th e d y n a m i c DNS serv e r, the ITG needs to con v e y t o t he s e rver t h e fol l owing informa t io n : Ÿ Nam e [...]

I P Configur a t i on C o m mands 16 This c o mm a nd has no a r g u m ents or k e ywords Configuri n g Management O pti o ns The I T G has built-in H T TP ser v e r and T elne t ser v e r, a ll o wing the conf i gura t ion from web br o wse r o r Telnet clie n t . T his sec t i on describes comm a n d s for se t t i ng a nd displaying the man a ge[...]

I P Con f igur a tion Commands 17 s pecified b y command net set man a g er ip are a l l owed t o con n ec t t o I TG ’ s T el n et ser v e r v ia WAN i n t erface. Factory def a u lt 0.0. 0 . 0 Rel a ted Comm a n ds n et set manager i p net set manager pa s s wor d Thi s com m an d is use d to c h ange t h e p a s sword for loggin g i n t o ITG [...]

I P Configur a t i on C o m mands 18 S t o ring IP I n terface Par a meters Config u ra t ion parame t ers chang e d by comman d net set are stored in d y n a m i c memory, wh i ch would l ose when the I TG is p o w e red o ff. T he save the configu r at i on parameter you ’ v e c h a nged, th e parame t ers h a v e t o be s t ored i n t o NVS b [...]

Te l ephon y Inte r face Po r t Configur a tion Co m m a nds 19 4. T e l epho n y Interf a c e P o r t C onf i gu r ation Commands Each telephony inte r face port equipped b y the ITG, regardles s of its interface typ e, is characterized by two sets of configu r ation parameters. One set is unique to each port, hereafter referred to as port-unique [...]

Te l ephon y Inte r face Po r t Configur a tion C o m m a nds 20 port# Zer o - based n u m b e r o f t h e telephon y port. nu m b er Ca l ler ID n u m b e r , 1 to 15 dig i ts. O Ca ll I D is nu m ber is not avai l a bl e Factory def a u lt N o c a l l e r ID n u m ber set p ort port# d efau l t This command s e t s all t he p ort-unique param e t[...]

Te l ephon y Inte r face Po r t Configur a tion Co m m a nds 21 show p ort port# This command displa y s p o r t - u niq u e parame t ers for a tele p hony interf a ce port. sh o w p o r t Synta x Desc r i ption port# Zer o - based n u m b e r o f t h e telephon y port. Configuri n g Port - C omm o n P a rameters The ITG m a i n t a ins two sets of[...]

Te l ephon y Inte r face Po r t Configur a tion C o m m a nds 22 set p or t _cfg c a ll_l i mit This command i s u s ed t o s e t a c a ll le n g t h limit for c a l l s on a t elep h ony port. I f the c a l l l eng t h i s exc e eded, the call is automa t ically ter m ina t ed. set por t _ cfg c a l l_limit s e conds Synta x d escrip t i on s econ[...]

Te l ephon y Inte r face Po r t Configur a tion Co m m a nds 23 ton e set p or t _cfg o u t _wait This comm a n d i s used t o specif y t he ti m e t o de l ay a fter going off- h o o k b e fore generating o u t boun d dial digits. set por t _ cfg ou t _wait millis e conds Synta x d escrip t i on millis e conds Value i s m ill i second s , rang i n[...]

Te l ephon y Inte r face Po r t Configur a tion C o m m a nds 24 set por t _ cfg tone_o u t _on millis e conds Synta x d escrip t i on millis e conds Value i s m ill i second s , rang i ng from 0 t o 6553 5 . Factory def a u lt 200 m s Rel a ted Comm a n ds set p o rt _ cfg tone_ou t _ o ff set p o rt _ cfg tone_ou t _ p wr set p or t _cfg to n e_o[...]

Te l ephon y Inte r face Po r t Configur a tion Co m m a nds 25 on p a ge 31 f o r det a i l s ab o u t coding prof i l e . set por t _ cfg voice_ p r o f profile_id Synta x d escrip t i on p rofi l e _ id P referred codin g prof i l e ID for voice Factory def a u lt The fac t ory d efault pref e r r e d voic e codin g prof i l e f o r al l the tel[...]

Te l ephon y Inte r face Po r t Configur a tion C o m m a nds 26 Rel a ted Comm a n ds set p o r t p ort cid name set p o r t p ort cid n u mbe r set p or t _cfg f x s c p c_dur The I T G i m pl e m en t s loop curre n t sh u t down featur e on FXS p o rt. It shuts dow n the curren t feeding toward a FXS port upon de t ec t i ng a c a ll is being t[...]

Te l ephon y Inte r face Po r t Configur a tion Co m m a nds 27 set p or t _cfg fx s o ffhook_db This command spec i fi e s t he t ime i n millis e conds to use as a debounc e r i n t e rv a l for de b ou n cing the off-ho o k sign a l . set por t _ cfg fx s offho o k _ db millise c on ds Synta x d escrip t i on millis e conds T ime i n millis e co[...]

Te l ephon y Inte r face Po r t Configur a tion C o m m a nds 28 set p or t _cfg fx s o nho o k _ detect This command i s u sed t o set t he t i m e to w a i t, i n m illis e conds, bef o re a n on-hoo k cond i t io n is d e c l are d . For preve n t ing from mist a k enly in t e rpre t in g no i se sign a l a s on - hook, w hen a hoo k sw i t ch o[...]

Te l ephon y Inte r face Po r t Configur a tion Co m m a nds 29 Factory def a u lt 0[...]

[...]

C a l l P r og r e ss Tone Configur a tion Commands 31 5. V oice and F ax Coder C o nfigu r ati o n Co mmands The coding profile is used to store coding parameters for voice and fax coders that can be used by any telephony port on the I TG. The ITG has 4 built-in coding profiles, each having a uniqu e p rofile ID and parameters for a specifi c voic[...]

C a l l P rogr e s s Tone Con f igur a t i on C o m mands 32 set coding p r ofi l e _ id d tmf_re l a y The I T G supports D T MF re l a y , i n which DTMF tones are d e t ec t ed during vo i ce p r ocessin g , encoded in t o H 32 3 -UserInforma t ion pack e t s a n d co n v eyed t o the r emote ITG v i a t h e H .323 call control ban d . Th i s co[...]

C a l l P r og r e ss Tone Configur a tion Commands 33 Prof i le g723 g729 g723_53 g711 Setting 30 2 0 30 1 0 set coding p r ofi l e _ id vad This c o mm a nd i s used t o enable / dis a ble the V oi c e A c t i v i ty D e t ector (V A D) f o r a codin g p r ofile . set c o ding profile_id v a d { on | off } Synta x d escrip t i on profi l e_id Pro[...]

C a l l P rogr e s s Tone Con f igur a t i on C o m mands 34 Prof i l e ID fax Setting 1 Rel a ted Comm a n d set c o ding p rofile _ id fax_ls_redundancy set coding p r ofi l e _ id fax_ls_red u ndancy This T .3 8 m ode comm a n d i s used to spec i fy t he p a cket-l e v e l r e d und a n cy for low-speed data tra n s m i ssions ( i .e., T.30 h a[...]

H.323 C on f i gu r a t i o n C om m ands 35 6. H 3 23 C o nfigu r at i on C o mmands 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 translatio n services. The ITG al l ows calls to remote g ateways be routed through a H.323 gatek[...]

H.323 C onfigur a t i on C o m mands 36 set h323 di s p l a y_ n a me set h323 term_i d set h 323 c a l lSignalPort P e r ITU-T H .32 3 standar d , t h e TCP port which t h e H .225 liste n s for i n co m i n g cal l s e tup reque s t i s p ort number 172 0 . This comm a n d is used to confi g u r e the TCP p o rt number wh i ch the I T G li s t en[...]

H.323 C on f i gu r a t i o n C om m ands 37 imtc C o n v e y DTMF dig i ts pe r IMTC specif i ca t ion. Factory def a u lt h323v2 Rel a ted Comm a n d set h323 a l t _ dtmf set h 323 d i s play_name One of t he UU I E s i n t he H.32 3 S e t up m e ss a g e that t h e I TG sends to a r e m ote g ateway w h en in i t ia t in g a call i s so u rceAd[...]

H.323 C onfigur a t i on C o m mands 38 m a n ual Enable ga t e k e ep e r in m anual disco v er y m od e . T he g k _addr m u s t be set a ppro p r ia t ely. Factory def a u lt off Rel a ted Comm a n d H .323 Gate k eeper Rela t ed Config u ra t ion C o m m ands set h 323 h245_term_ty p e Thi s c o m mand is used t o set th e H .245 ter m i nal t [...]

H.323 C on f i gu r a t i o n C om m ands 3 9 set h 323 in_fast_st a rt This command i s us e d t o enable or disable accep t ing inc o m ing call in H.32 3 F a st S t art mod e . set h323 i n_f a st_st a rt { on | o ff } Synta x Desc r i ption o n Accep t incoming calls with H 323 Fas t start mode o ff D o not accept inc o m ing calls w i t h Set [...]

H.323 C onfigur a t i on C o m mands 40 o ff Disable t he fea t u re. Factory def a u lt on set h 323 out_f a st_st a rt This command is us e d t o select t he H.323 m ode for ou t going cal l s. set h323 out _ f a st_star t { on | off } Synta x Desc r i ption o n In i tia t e outgoing cal l s with H323 Fast Start m ode o ff In i tia t e outgoing c[...]

H.323 C on f i gu r a t i o n C om m ands 41 address f i eld of so u rceAddress UU I E of th e H.323 S e t up m e ssage Factory def a u lt N u l l Rel a ted Comm a n ds set h323 call_name set h323 di s p l a y_ n a me show h 323 This command displa y s all H.323 r elate d p ara m e ters. sh o w h323 Synta x d escrip t i on This c o mm a nd has no a[...]

H.323 C onfigur a t i on C o m mands 42 false A l wa y s c laim c a l l se t up f a il u r e when I T G f a ils obt a ining A C F fr o m the g ate k eep e r. Factory def a u lt true set h 323 al t _ g k When the ITG i s co n f ig u re d in ga t ekee p er mode, i t c a n spec i fy two gate k e ep e rs, def a ult an d a l te r n ate, t o reg i s t er[...]

H.323 C on f i gu r a t i o n C om m ands 43 set h 323 endpoin t _ p r efi x This command is u s ed t o s e t the H . 32 3 pref i x that t h e I TG uses w h en r e gi s t ering to an H .323 ga t e k e ep e r . Afte r reg i stering t o a g atekee p e r u sing t he p r e fix, t he g a t ekeeper will m a p a l l Ad m i ss i on Request with des t ina t[...]

H.323 C onfigur a t i on C o m mands 44 set h 323 g k _ id When t he I TG reg i s t ers to a ga t ekeeper, i t spe c ifies t h e ga t ekeeper is wishes to register wi t h in t he ga t ekeep e r I den t ifi er field i n t he RR Q mess a ge i t sends to the gate k eeper. T his c o mm a nd i s for setting th e st r ing t o b e p l aced in t he gate k [...]

H.323 C on f i gu r a t i o n C om m ands 45 set h 323 t ime_ t o_live When th e ITG r egiste r s to a g a t ekee p er, i t specifie s th e duratio n of the v a lid i t y of the registra t ion in t he ti m e T o L ive field in t he R RQ m e ss a g e i t s e nd s to t he ga t e k eeper. The ga t e k e ep e r ma y optionall y chang e t he t imeToLive[...]

[...]

C onf i gur a t i on Management C om m and 47 7. C o nfigu r at i on Managem e nt C o mm a nd 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 proce s sed, it changes the para[...]

[...]

C onf i gur a t i on Management C om m and 49 8. Dial Plan Management C o mmands The dial plan is a database, that the Add r ess Translation and P arsing Manager (ATP M ) of the ITG looks u p for translating a dial st r ing to a destination. T he dial plan manageme nt commands allow you to modify and display t he dial plan. Comman d s that change t[...]

Configur a tion Management Co m mand 50 atpm p u rge { all | a d dr | de st | h u nt } Synta x d escrip t i on all Del e t e a l l e n tr i e s f r o m ATPM a d d ress, d estinat i o n a nd hunt g r oup tab l es. ad d r Del e t e a ll e n tri e s fr o m AT P M address table. d est Del e t e a ll e n tri e s fr o m AT P M des t inatio n t ab l e. h [...]

C onf i gur a t i on Management C om m and 51 a t p m s t o re This command st o r es the ATPM addr e ss, destina t i on a nd hung group tables t o the non - v o l a t il e storage. atpm store [ erase ] Synta x d escrip t i on era s e Era s e t h e no n -vola t i l e storage b efo r e st o r ing the d ia l pl a n database. T his o p t i o n is not [...]

Configur a tion Management Co m mand 52 a t p m d d el This command del e t es a n entry fro m th e A T P M des t i natio n tab l e. atpm d d el d es t _id Synta x d escrip t i on de s t _id ID of a pr evious l y a dde d des t i nation e n tr y t o be dele t ed f r o m de s t ination t a ble. Allowe d only i n dat a b a se u p date mo d e Ye s Rel [...]

C onf i gur a t i on Management C om m and 53 Hu n t G r o up Table Management C omman d s a t p m hadd This command a dds an entry in t o the A T PM hunt group t a ble. atpm hadd id {1 | 2} des t _ id [ des t _ id ] [ des t _id ] . . . Synta x d escrip t i on i d H u nt g rou p I D. F or e a c h hu n t group, yo u need to assign it a unique iden t[...]

Configur a tion Management Co m mand 54 Synta x d escrip t i on i d ID of t he hu n t g rou p t o be displa y e d . Allowe d only i n dat a b a se u p date mo d e N o Rel a ted Comm a n ds atpm had d atpm h d e l a t p m hl i s t This command displa y s all entries i n t h e A T P M hunt gro u p t a ble. atpm h l i s t Synta x d escrip t i on This [...]

C onf i gur a t i on Management C om m and 55 Allowe d only i n dat a b a se u p date mo d e Ye s Rel a ted Comm a n ds atpm adel atpm afin d atpm alist a t p m a d el This c o mm a nd d e le t e s a n e n try fro m the A T PM addre s s t able. atpm a d e l tel# Synta x d escrip t i on tel# N u mb e r of a p r e v i ously added e ntr y to be de l e[...]

Configur a tion Management Co m mand 56 Synta x d escrip t i on This c o mm a nd has no a r g u m ents or k e ywords Allowe d only i n dat a b a se u p date mo d e N o Rel a ted Comm a n ds atpm adel atpm afin d Dialing Co n t r o l C omm a n ds a t p m s l is t This command displa y s the p aram e t ers that c o ntro l s the di a l i ng atpm slist[...]

C onf i gur a t i on Management C om m and 57 Synta x d escrip t i on dial_time The maximum t i m e, in mill i second, a ll o w ed for e ntry o f t he en t i re string of d i a l ed digits. A t exp i ration, A T PM starts a ddres s lo o k u p . 1 st _digi t _wait The ma x imum t i m e, in millis e cond, a l lowed between o f f- hoo k a nd when t he[...]

[...]

C onf i gur a t i on Management C om m and 59 Ind e x Ａ ATP M .................................. . 6 1 address t a bl e .............. . 66, 6 7 d at a b as e upda t e ............... . 6 2 des t i natio n tab l e ......... . 63, 6 4 f i rst dig i t w a i t ................... . 6 9 hu n t g r oup t abl e ......... . 65, 6 6 int e r-dig i t w a i[...]

Index 60 Ｐ pi n g ..................................... . 3 Ｒ redundanc y ......................... . 3 8 re s e t ................................... . 3 r i ng frequenc y ...................... . 4 r i nging c a denc e ................... . 3 2 ro u te r ................................. . 1 4 RTC P .................................. . 5 2 RT[...]