ZyXEL Communications APS 1.0, Administrator'S Manual

Page 1: ...Auto Provisioning For VoIP Devices Administrator s Guide Version 2 0 3 2006...

Page 2: ......

Page 3: ...d by ZyXEL Communications Corporation All rights reserved Disclaimer ZyXEL does not assume any liability arising out of the application or use of any products or software described herein Neither does...

Page 4: ...g Denmark sales zyxel dk 45 39 55 07 07 FINLAND support zyxel fi 358 9 4780 8411 www zyxel fi ZyXEL Communications Oy Malminkaari 10 00700 Helsinki Finland sales zyxel fi 358 9 4780 8448 FRANCE info z...

Page 5: ...N support zyxel se 46 31 744 7700 www zyxel se ZyXEL Communications A S Sj porten 4 41764 G teborg Sweden sales zyxel se 46 31 744 7701 UKRAINE support ua zyxel com 380 44 247 69 78 www ua zyxel com Z...

Page 6: ...Auto Provisioning Administrator s Guide 6 Customer Support...

Page 7: ...em Usage 18 1 3 3 Auto Provisioning Server System Important Notes 19 Chapter 2 Auto Provisioning Commands 21 2 1 Auto Provisioning Commands 21 Chapter 3 Provisioning Utility 23 3 1 Provisioning Utilit...

Page 8: ...g 52 5 6 2 View SPTGEN 54 5 6 3 Delete a Product Type 55 5 6 4 Add a Product Type 56 5 6 5 Import 57 5 6 6 Note on SPTGEN Files 57 5 6 7 Export to SPTGEN 58 5 7 Device Management 59 5 7 1 Device Searc...

Page 9: ...Service Flowchart 77 Appendix B Auto Provisioning Server System Configuration 79 Appendix C Auto Provisioning Server Database Description 81 Appendix D Sample CRM Server Database Description 87 Appen...

Page 10: ...Auto Provisioning Administrator s Guide 10 Table of Contents...

Page 11: ...46 Figure 14 Partitioning 46 Figure 15 Login Screen 50 Figure 16 Navigation Panel 51 Figure 17 Product Type List Edit Setting 52 Figure 18 Product Type Edit Setting 53 Figure 19 Parameter Edit Field...

Page 12: ...Figure 44 Loading Statistics 67 Figure 45 New User Info 67 Figure 46 Registered Device Info 68 Figure 47 Login History 68 Figure 48 Unit Device File Example 69 Figure 49 Import Device Info 69 Figure...

Page 13: ...able 16 ServerConfiguration 83 Table 17 SpecifySetting 83 Table 18 Sptgen 83 Table 19 Sptgengroup 84 Table 20 UnLockedDevice 84 Table 21 User 84 Table 22 Creditcard 87 Table 23 Itspphone 87 Table 24 S...

Page 14: ...Auto Provisioning Administrator s Guide 14 List of Tables...

Page 15: ...writing you can use TFTP HTTP or HTTPS1 protocol for auto provisioning The following sections introduce two scenarios for using auto provisioning with ZyXEL s VoIP ATAs and IADs The first uses a prov...

Page 16: ...gure the ZyXEL VoIP devices to get the configuration files from the server see Chapter 2 on page 21 Figure 2 Provisioning Utility Set Up 1 Create an account file containing settings such as the userna...

Page 17: ...ovisioning server software for a automated end to end solution The auto provisioning server provides the following key benefits and features Efficient management The database centric approach automati...

Page 18: ...tem VSS See Appendix D on page 87 for its database structure Install the auto provisioning server software on a server see Chapter 4 on page 43 Integrate the auto provisioning server with the CRM syst...

Page 19: ...o get the latest configuration file every time the device starts and connects to the Internet 3 The VoIP device uses the SIP number PIN code and its MAC address and model name to authenticate with the...

Page 20: ...mple SER server does not enforce any security so a SIP device does not have to be registered to use it When you implement the auto provisioning server system you will want to have the CRM server and S...

Page 21: ...oning settings Table 1 Auto Provisioning Commands COMMAND DESCRIPTION voice config autopro index index Starts an auto provisioning configuration session active index 0 off 1 on Turns auto provisioning...

Page 22: ...apter 2 Auto Provisioning Commands display index Displays the auto provisioning configuration settings dumpCfg index Displays the auto provisioning settings in the temporary buffer Table 1 Auto Provis...

Page 23: ...n according to the following format The MAC address must be listed first Syntax MAC Address SIP1 Phonenumber SIP1 User ID SIP1 Password SIP2 Phonenumber SIP2 User ID SIP2 Password The account file may...

Page 24: ...d identification number field name parameter values allowed input where input is your input conforming to parameter values allowed It is also the same format that Internal SPTGEN configuration files u...

Page 25: ...file on the device to your computer and renames it SPTGEN txt 7 Enter quit to exit the ftp prompt The following figure shows an example Figure 7 FTP Session Example 3 6 Auto Provisioning Text Files Au...

Page 26: ...s the labels that have been added to the example auto provisioning menu tables for identification purposes These labels do not appear in an actual auto provisioning configuration file Here are example...

Page 27: ...No 1 Yes 0 40000012 IP Address Assignment 0 Static 1 Dynamic 0 40000013 Wan IP Address 0 0 0 0 40000014 Remote Gateway 0 0 0 0 40000015 Remote IP subnet mask 0 40000024 ISP PPPoE idle timeout 100 400...

Page 28: ...SNMP Service Port 161 241100011 SNMP Service Access 0 all 1 none 2 Lan 3 Wan 0 241100012 SNMP Service Secured IP address 0 0 0 0 241100013 DNS Service Port 53 241100014 DNS Service Access 0 all 1 non...

Page 29: ...0 No 1 Yes 1 Map incoming calls to the second phone port 980101020 SIP 1 CODEC Type 1 0 G711mu 8 G711A 18 G729 18 Primary voice compression type 980101021 SIP 1 CODEC Type 2 0 G711mu 8 G711A 18 G729...

Page 30: ...980102014 SIP 2 Phone Number ChangeMe SIP account phone number 980102017 SIP 2 Domain Name 192 168 1 33 SIP service domain 980102018 SIP 2 Mapping to POTS Phone1 0 No 1 Yes 1 Map incoming calls to th...

Page 31: ...2 0 No 1 Yes 1 Outgoing call mapping to second SIP account 980301005 Phone 1 G 168 Echo Cancellation 0 No 1 Yes 1 Disables or enables echo cancellation 980301006 Phone 1 Voice Active Detection Support...

Page 32: ...r 980400004 Relay to PSTN 3 Phone Number Always use PSTN to call this phone number 980400005 Relay to PSTN 4 Phone Number Always use PSTN to call this phone number 980400006 Relay to PSTN 5 Phone Numb...

Page 33: ...ne Book 1 SIP Number 1234 Speed dial entry s SIP number 980701003 Phone Book 1 SIP IP URL Testsip com Peer or SIP server s IP address or URL 980701004 Phone Book 1 Name test Callee s name 980701005 Ph...

Page 34: ...SIP number 980704003 Phone Book 4 SIP IP URL Testsip com Peer or SIP server s IP address or URL 980704004 Phone Book 4 Name test Callee s name 980704005 Phone Book 4 Type 0 Proxy 1 Non Proxy 0 0 to us...

Page 35: ...r SIP server s IP address or URL 980707004 Phone Book 7 Name test Callee s name 980707005 Phone Book 7 Type 0 Proxy 1 Non Proxy 0 0 to use your SIP account 1 to use peer to peer or a different SIP ser...

Page 36: ...Book 10 Name test Callee s name 980710005 Phone Book 10 Type 0 Proxy 1 Non Proxy 0 0 to use your SIP account 1 to use peer to peer or a different SIP server 980710006 Phone Book 10 Speed Number 1111 S...

Page 37: ...le brackets 980900002 Firmware_Download_Addr ftp 172 21 3 144 p2002L ras The FTP site for f w upgrade 980900003 Fw_Notify_Voice_Type it IVR language for f w notification 980900004 Target_Firmware_User...

Page 38: ...the account file 8 Run the utility See the following figure for an example of the command The first line takes you into the directory where the utility is saved The common file is named P2002L txt Th...

Page 39: ...user1 980101013 SIP 1 Password 111 Results sip00A0C5891805 txt File Generated MACAddress 00A0C5999897 980101014 SIP 1 Phone Number 52293 980101012 SIP 1 UserId user3 980101013 SIP 1 Password 1234 980...

Page 40: ...fields needed in Account File 2 Prepare Account File from database 3 Run the utility See the following figure for an example of the command The first line takes you into the directory where the utili...

Page 41: ...980101013 SIP 1 Password 111 Results sip00A0C5891805 txt File Generated MACAddress 00A0C5999897 980101014 SIP 1 Phone Number 52293 980101012 SIP 1 UserId user3 980101013 SIP 1 Password 1234 980102014...

Page 42: ...Auto Provisioning Administrator s Guide 42 Chapter 3 Provisioning Utility...

Page 43: ...B Ethernet NIC OS RHEL 4 4 2 Requirements for Installation by Source Code The following applications must be installed prior to the installation of the auto provisioning server software if you install...

Page 44: ...Administrator s Guide 44 Chapter 4 Auto Provisioning Server Installation Figure 10 Auto Install Start 4 Select the disk partitioning setup type The Autopartition option is recommended Figure 11 Disk P...

Page 45: ...rator s Guide Chapter 4 Auto Provisioning Server Installation 45 5 Remove all partitions on this system Note Warning This will delete all data on your system Figure 12 Automatic Partitioning Remove Al...

Page 46: ...Provisioning Administrator s Guide 46 Chapter 4 Auto Provisioning Server Installation Figure 13 Automatic Partitioning Warning 7 Check the partitioning status Select OK to continue Figure 14 Partitio...

Page 47: ...e VSS_WebService http localhost VSS WebService SubscriberService php VSS Web Service ps_web_path var www html PS Provisioning Server Path sys_logfile var log httpd log Apache start and stop log file z...

Page 48: ...e 1 in start detect echo DATE httpd is starting CONF start stop detect echo DATE httpd is stopping CONF stop restart echo DATE httpd is stopping CONF detect echo DATE httpd is starting CONF stop detec...

Page 49: ...server s settings A Viewer user can only see server information The auto provisioning server software allows you to backup and restore your database It is recommended that you use MySQL to back up an...

Page 50: ...nabled by default Java permissions enabled by default 5 3 Web Manager Login 1 Launch your web browser 2 Type 192 168 1 200 PS as the URL make sure you use the same casing Figure 15 Login Screen 3 Type...

Page 51: ...and move parameters to other machines Device Management Unit Device Lock History Use these screens to view and delete individual VoIP subscriber devices and edit their settings Account Management Add...

Page 52: ...ting and exporting of SPTGEN files which you can use to backup and move the parameters to other machines 5 6 1 Edit Setting Product Type View Edit Setting Administrators can edit SPTGEN parameters Fig...

Page 53: ...its setting For example the following displays if you click the Parameter No 100000008 Edit button Figure 19 Parameter Edit Field Example Input the desired parameter and click the Update button to co...

Page 54: ...Auto Provisioning Server Figure 20 Parameter Groups 5 6 2 View SPTGEN Product Type View View SPTGEN Administrators and Viewers can display the SPTGEN details of the products Figure 21 Product Type Lis...

Page 55: ...the Auto Provisioning Server 55 Figure 22 View SPTGEN 5 6 3 Delete a Product Type Product Type View Delete Administrators can delete a product and its settings from the server Figure 23 Product Type L...

Page 56: ...roduct from the server Click Cancel to cancel the action 5 6 4 Add a Product Type Product Type View Add a Product Type Administrators can add a new product type Figure 25 Product Type List Add Click t...

Page 57: ...ll of its parameters will be overwritten by this action 5 6 6 Notes on SPTGEN Files It is recommended that your SPTGEN file only include VoIP and auto provisioning settings It is not recommended to yo...

Page 58: ...UserId changeme 980101013 SIP 1 Password 980101014 SIP 1 Phone Number changeme 980101015 SIP 1 Minimun Session Expire Time 20 1800 30 980101017 SIP 1 Domain Name 127 0 0 1 980101022 SIP 1 CODEC Type 1...

Page 59: ...he2 hotdocs PS temp ExporttoSPTGEN The file will be named as ProductName txt For example P2002 txt 5 7 Device Management The device management tool allows you to view and delete individual VoIP subscr...

Page 60: ...rch After entering appropriate information click Search to display the following screen Figure 32 Device List Click Edit or Delete to modify or remove specified information for each device 5 7 2 Edit...

Page 61: ...Click Back to cancel this action 5 7 3 Delete Device Device Management Unit Device Unit Device List Delete Administrators can delete device entries When you click the Delete button in the Device List...

Page 62: ...of whether or not the PIN is correct for a specific period of time see Section 5 11 1 on page 70 for setting the lock time period This feature deters unauthorized access through brute force hacking r...

Page 63: ...nt Management Add a Viewer Administrators can create a viewer account by entering the required text fields Viewer ID Viewer Name Password and Retype Password The other fields are optional Telephone E...

Page 64: ...click Submit the system searches and displays the matching accounts Figure 39 Viewer List Click Edit to go to the Edit a Viewer screen Click Delete to go to the Delete a Viewer screen 5 8 3 Edit a Vi...

Page 65: ...agement Edit a Viewer Viewer List Delete Administrators can delete viewer accounts Figure 41 Viewer Delete Click OK to delete this viewer The action will be cancelled if you click Cancel 5 8 5 Change...

Page 66: ...stem Up Time This function shows the current system up time the time since the first start up and a record of start and stop times Figure 43 System Up Time 5 9 2 Loading Statistics Information Center...

Page 67: ...Info 5 9 4 Registered Device Info Information Center Registered Device Info This screen displays registered and unregistered device statistics in a pie chart diagram Registered devices have already a...

Page 68: ...Registered Device Info 5 9 5 Login History Information Center Login History This screen displays a record of who has logged into the server You can also specify the login ID of a particular Admin or V...

Page 69: ...Backup System Maintenance Database Backup Administrators can use this screen to backup the database There are two backup modes 1 Complete Backup Use this to backup the database immediately The backup...

Page 70: ...n Administrators can change the server s security settings 1 Transfer Mode Select With 3DES to apply triple DES encryption to the configuration files sent during the provisioning process The default v...

Page 71: ...PTGEN files of products and devices from the database They will be stored in directory home apache2 hotdocs PS temp ExportDBasSPTGEN There are two options 1 With 3DES Select this to encrypt all of the...

Page 72: ...Auto Provisioning Administrator s Guide 72 Chapter 5 Using the Auto Provisioning Server...

Page 73: ...re the auto provisioning server to configure VoIP devices 1 Upload a file of SIP accounts System Maintenance Import Unit Device See Section 5 10 1 on page 69 for the file format and an example file 2...

Page 74: ...Auto Provisioning Administrator s Guide 74 Chapter 6 Using the Auto Provisioning Server...

Page 75: ...e redundant databases MySQL supports one way replication One server acts as the master while one or more other servers act as slaves refer to Figure 54 on page 76 The master server writes updates to i...

Page 76: ...processing load of the master Statements that modify data should still be sent to the master so that the master and slave do not get out of sync This load balancing strategy is effective if non updati...

Page 77: ...ide Appendix A Auto Provisioning Service Flowchart 77 APPENDIX A Auto Provisioning Service Flowchart This flow chart illustrates how the auto provisioning service PS handles a request from a device Fi...

Page 78: ...Auto Provisioning Administrator s Guide 78 Appendix A Auto Provisioning Service Flowchart...

Page 79: ...to provisioning server system configuration Table 9 Auto Provisioning Server System Configuration NO VARIABLE NAME DESCRIPTION DEFAULT VALUE 1 mysql_server MySQL hostname or IP address localhost 2 use...

Page 80: ...Auto Provisioning Administrator s Guide 80 Appendix B Auto Provisioning Server System Configuration...

Page 81: ...r 100 Subscriber device mac address 3 phoneNumber varchar 50 Yes Phone number 4 LockTime timestamp Yes CURRENT_TIMESTAMP When the device was locked 5 LockMinutes int 11 0 How long the device will be l...

Page 82: ...tamp Yes CUPPENT_TIMESTAMP Pin fail time 5 PinErrMsg varchar 200 Yes Pin fail error message Table 14 ProductType ID COLUMN NAME DATATYPE NULL KEY DEFAULT VALUE DESCRIPTION 1 ProductType varchar 100 PR...

Page 83: ...1 PRI auto_increment 2 UserID varchar 50 Subscriber ID 3 ProductType varchar 100 Subscriber device product type 4 PhoneNumber varchar 50 U Phone number 5 Password varchar 50 Password 6 PINCode varchar...

Page 84: ...11 PRI Auto_increment 2 macAddress varchar 100 Subscriber device mac address 3 phoneNumber varchar 50 Yes Phone number 4 LockTime datetime CURRENT_TIMESTAMP When the device was locked 5 LockMinutes i...

Page 85: ...to Provisioning Server Database Description 85 9 Status Char 1 A Account s status A Active S Suspend 10 CreateDate timestamp Yes CURRENT_TIMESTAMP Account s creation date Table 21 User continued ID CO...

Page 86: ...Auto Provisioning Administrator s Guide 86 Appendix C Auto Provisioning Server Database Description...

Page 87: ...ration date 5 HolderName varchar 50 No Credit card holder s name 6 SecurityID varchar 50 No Security code of credit card Table 23 Itspphone ID COLUMN NAME DATATYPE NULL KEY DEFAULT VALUE COMMENT 1 Pho...

Page 88: ...LL PIN code 20 CreateType Varchar 50 Yes NULL Account create type 1 User registered 2 Created by administrator for reserve 21 CreateDate timestamp Yes CURRENT_TIME STAMP Account create date for reserv...

Page 89: ...auto provisioning server with the CRM system setSubScriberRegistered Method This is how the auto provisioning server synchronizes with the CRM server to provision a subscriber device for the first tim...

Page 90: ...ess ns3751 setSubScriberRegistered SOAP ENV Body SOAP ENV Envelope Response xml version 1 0 encoding ISO 8859 1 SOAP ENV Envelope SOAP ENV encodingStyle http schemas xmlsoap org soap encoding xmlns SO...

Page 91: ...ing macAddress ns6358 getTotalUnregisteredUnitDevice SOAP ENV Body SOAP ENV Envelope Response xml version 1 0 encoding ISO 8859 1 SOAP ENV Envelope SOAP ENV encodingStyle http schemas xmlsoap org soap...

Page 92: ...p org soap envelope xmlns xsd http www w3 org 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns SOAP ENC http schemas xmlsoap org soap encoding xmlns si http soapinterop org xsd S...

Page 93: ...string 18 soapVal totalnums xsi type xsd string 18 totalnums item return ns1 getTotalSubScriberResponse SOAP ENV Body SOAP ENV Envelope getPageUnregisteredUnitDevice Method This is how the auto provi...

Page 94: ...xmlsoap org soap encoding xmlns si http soapinterop org xsd SOAP ENV Body ns7639 getPageUnregisteredUnitDevice xmlns ns7639 http tempuri org ProductType xsi type xsd string P2002 ProductType SIPNO xs...

Page 95: ...ttp tempuri org return xsi type SOAP ENC Array SOAP ENC arrayType unnamed_struct_use_soapval 16 item soapVal xsi type xsd string 4 soapVal rowid xsi type xsd string 4 rowid soapVal xsi type xsd string...

Page 96: ...xsd string 87920773 soapVal phonenumber xsi type xsd string 87920773 phonenumber soapVal xsi type xsd string 1234 soapVal password xsi type xsd string 1234 password soapVal xsi type xsd string 1234 s...

Page 97: ...e xsi type xsd string 1234 pincode soapVal xsi type xsd string 00A0C0000004 soapVal macaddress xsi type xsd string 00A0C0000004 macaddress item item soapVal xsi type xsd string 8 soapVal rowid xsi typ...

Page 98: ...xsi type xsd string H106 soapVal userid xsi type xsd string H106 userid soapVal xsi type xsd string P2002 soapVal producttype xsi type xsd string P2002 producttype soapVal xsi type xsd string 8792077...

Page 99: ...honenumber xsi type xsd string 87920777 phonenumber soapVal xsi type xsd string 1234 soapVal password xsi type xsd string 1234 password soapVal xsi type xsd string 1234 soapVal pincode xsi type xsd st...

Page 100: ...code soapVal xsi type xsd string 00A0C0000008 soapVal macaddress xsi type xsd string 00A0C0000008 macaddress item item soapVal xsi type xsd string 12 soapVal rowid xsi type xsd string 12 rowid soapVal...

Page 101: ...string H110 soapVal userid xsi type xsd string H110 userid soapVal xsi type xsd string P2002 soapVal producttype xsi type xsd string P2002 producttype soapVal xsi type xsd string 87920780 soapVal phon...

Page 102: ...number xsi type xsd string 87920781 phonenumber soapVal xsi type xsd string 1234 soapVal password xsi type xsd string 1234 password soapVal xsi type xsd string 1234 soapVal pincode xsi type xsd string...

Page 103: ...l xsi type xsd string 00A0C0000012 soapVal macaddress xsi type xsd string 00A0C0000012 macaddress item item soapVal xsi type xsd string 17 soapVal rowid xsi type xsd string 17 rowid soapVal xsi type x...

Page 104: ...00001 soapVal userid xsi type xsd string 10000001 userid soapVal xsi type xsd string P2002 soapVal producttype xsi type xsd string P2002 producttype soapVal xsi type xsd string 10000001 soapVal phonen...

Page 105: ...si type xsd string 789 soapVal password xsi type xsd string 789 password soapVal xsi type xsd string 6325 soapVal pincode xsi type xsd string 6325 pincode soapVal xsi type xsd string 00A0C0000017 soap...

Page 106: ...pVal rowid xsi type xsd string 22 rowid soapVal xsi type xsd string 10000004 soapVal userid xsi type xsd string 10000004 userid soapVal xsi type xsd string P2002 soapVal producttype xsi type xsd strin...

Page 107: ...lns xsd http www w3 org 2001 XMLSchema xmlns xsi http www w3 org 2001 XMLSchema instance xmlns SOAP ENC http schemas xmlsoap org soap encoding xmlns si http soapinterop org xsd SOAP ENV Body ns3783 ge...

Page 108: ...p www w3 org 2001 XMLSchema instance xmlns SOAP ENC http schemas xmlsoap org soap encoding xmlns si http soapinterop org xsd SOAP ENV Body ns1 getNewSubScriberByDateResponse xmlns ns1 http tempuri org...

Page 109: ...be modified Start mysql_backup_path bkup mysql mysql_backup_ScheduleTime_file bkup ScheduleTime conf Path of provisioning database location mysql_ps_path home mysql var provisioning mysql_run_path ho...

Page 110: ...File Example End Export location setup No need to be modified 3DES in PHP only supports 24bits encryption zyxel_3des_key shouldn t be longer than 13bits Difference of total length and Mac Address zyx...

Page 111: ...ion Server Address 33 Auto Provision Setup 28 33 Auto Provisioning Menus Abbreviations 26 Auto Provisioning Server 17 Auto Provisioning Server Configuration File 109 Auto Provisioning Server Database...

Page 112: ...Pause Duration 37 DTMF Tones 29 E Echo Cancellation 31 Edit a Viewer 64 Edit Button 53 Edit Device 60 Edit Setting 52 Encapsulation 27 Encryption 70 Encryption Utility 37 End Date 27 Export Database...

Page 113: ...al Installation 47 Mapping Outgoing Calls 31 Mapping to Phone1 37 Mapping to Phone2 37 Mapping to POTS Phone1 29 Master Server 75 Maximum Flash Key Interval 31 Mcrypt Module 43 Memory 43 Menu 24 10 Ti...

Page 114: ...elete 56 Product Type Edit Setting 53 Product Type List 52 Product Type Management 52 Protocol 33 Provisioning 3DES Key 79 Provisioning Server Database Description 81 Provisioning Server Database Name...

Page 115: ...ents 15 SNMP 28 SNMP Service Access 28 SNMP Service Port 28 SNMP Service Secured IP Address 28 SOAP 17 SOAP Description 89 Sort Buffer Size 32 Spain Contact Information 5 Speaking Volume 31 Speed Dial...

Page 116: ...up 37 VoIP Lifeline PSTN Setup 32 VoIP QoS Setup 31 VoIP RTP Setup 32 VoIP Setup 28 VoIP SIP 1 Setup 28 VoIP Subscribing System 18 VSS 18 W Wan IP Address 27 Warranty Information 4 Web Server Access 2...