ZyXEL Communications APS 1.0 Administrator's Manual
  1. Manuals
  2. Brands
  3. ZyXEL Communications Manuals
  4. VoIP
  5. APS 1.0
  6. Administrator's manual
ZyXEL Communications APS 1.0 Administrator's Manual

ZyXEL Communications APS 1.0 Administrator's Manual

Auto provisioning
Hide thumbs
Table of Contents

Advertisement

Quick Links

Auto Provisioning
For VoIP Devices
Administrator's Guide
Version 2.0
3/2006

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the APS 1.0 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for ZyXEL Communications APS 1.0

Summary of Contents for ZyXEL Communications APS 1.0

  • Page 1 Auto Provisioning For VoIP Devices Administrator’s Guide Version 2.0 3/2006...

  • Page 3: Copyright

    ZyXEL Communications Corporation. Published by ZyXEL Communications Corporation. All rights reserved.

  • Page 4: Customer Support

    • Brief description of the problem and the steps you took to solve it. METHOD SUPPORT E-MAIL TELEPHONE WEB SITE REGULAR MAIL SALES E-MAIL FTP SITE LOCATION support@zyxel.com.tw +886-3-578-3942 www.zyxel.com ZyXEL Communications Corp. CORPORATE www.europe.zyxel.com 6 Innovation Road II HEADQUARTERS Science Park sales@zyxel.com.tw +886-3-578-2439 ftp.zyxel.com Hsinchu 300 (WORLDWIDE) Taiwan ftp.europe.zyxel.com...
  • Page 5 +34-902-195-420 www.zyxel.es ZyXEL Communications Alejandro Villegas 33 SPAIN sales@zyxel.es +34-913-005-345 1º, 28043 Madrid Spain support@zyxel.se +46-31-744-7700 www.zyxel.se ZyXEL Communications A/S SWEDEN Sjöporten 4, 41764 Göteborg sales@zyxel.se +46-31-744-7701 Sweden support@ua.zyxel.com +380-44-247-69-78 www.ua.zyxel.com ZyXEL Ukraine 13, Pimonenko Str. UKRAINE sales@ua.zyxel.com +380-44-494-49-32...
  • Page 6 Auto Provisioning Administrator’s Guide Customer Support...

  • Page 7: Table Of Contents

    Auto Provisioning Administrator’s Guide Table of Contents Copyright ........................3 Customer Support....................4 Table of Contents ..................... 7 List of Figures ......................11 List of Tables ......................13 Chapter 1 Auto Provisioning ....................15 1.1 Auto Provisioning Overview ................15 1.2 Provisioning Utility Scenario ................15 1.2.1 Provisioning Utility System Usage ............16 1.3 Auto Provisioning Server Scenario ..............17 1.3.1 Requirements for Using the Auto Provisioning Server ......18...
  • Page 8 Auto Provisioning Administrator’s Guide Chapter 4 Auto Provisioning Server Installation ..............43 4.1 System Requirements ..................43 4.2 Requirements for Installation by Source Code ...........43 4.3 Installation Using the Installer CD ..............43 4.4 Manual Installation .....................47 Chapter 5 Using the Auto Provisioning Server..............49 5.1 General Information and Guidelines ..............49 5.2 Web Manager Overview ..................49 5.3 Web Manager Login ...................50...
  • Page 9 Auto Provisioning Administrator’s Guide 5.10.3 Database Restore ...................70 5.11 Utilities ......................70 5.11.1 Configurations ..................70 5.11.2 Export Database as SPTGEN ..............71 Chapter 6 Using the Auto Provisioning Server..............73 Chapter 7 Troubleshooting ..................... 75 Appendix A Auto Provisioning Service Flowchart ..............77 Appendix B Auto Provisioning Server System Configuration..........
  • Page 10 Auto Provisioning Administrator’s Guide Table of Contents...

  • Page 11: List Of Figures

    Auto Provisioning Administrator’s Guide List of Figures Figure 1 Provisioning Utility Scenario ................. 16 Figure 2 Provisioning Utility Set Up ..................16 Figure 3 Auto Provisioning Server Scenario ............... 17 Figure 4 Auto Provisioning Server Operation ..............19 Figure 5 Account File Example ................... 23 Figure 6 Account Field File Example ..................
  • Page 12 Auto Provisioning Administrator’s Guide Figure 39 Viewer List ......................64 Figure 40 Viewer Edit ......................64 Figure 41 Viewer Delete ...................... 65 Figure 42 Change Password ....................65 Figure 43 System Up Time ....................66 Figure 44 Loading Statistics ....................67 Figure 45 New User Info .....................

  • Page 13: List Of Tables

    Auto Provisioning Administrator’s Guide List of Tables Table 2 Example Auto Provisioning Menus Abbreviations ..........26 Table 3 Menu 4 Internet Access Setup ................27 Table 4 Menu 24.10 Time and Date Setting ............... 27 Table 5 Menu 24.11 Remote Management Control ............28 Table 7 Navigation Panel Summary ...................
  • Page 14 Auto Provisioning Administrator’s Guide List of Tables...

  • Page 15: Chapter 1 Auto Provisioning

    Auto Provisioning Administrator’s Guide H A P T E R Auto Provisioning 1.1 Auto Provisioning Overview This document is for administrators who need to configure a large number of ZyXEL’s VoIP ATAs and IADs. Auto provisioning has the VoIP devices periodically download a configuration text file from a server that you set up and maintain.

  • Page 16: Provisioning Utility System Usage

    Auto Provisioning Administrator’s Guide Figure 1 Provisioning Utility Scenario 1.2.1 Provisioning Utility System Usage Use the following steps to set up auto provisioning using the provisioning utility. Note: You must use the Command Line Interface (CLI) command to pre- autopro configure the ZyXEL VoIP devices to get the configuration files from the server (see Chapter 2 on page...

  • Page 17: Auto Provisioning Server Scenario

    Auto Provisioning Administrator’s Guide 3 Use the provisioning utility to generate and encrypt a batch of configuration files (see Chapter 3 on page 23). Each includes subscriber specific SIP settings (username, password and SIP number). 4 Store the configuration files on a TFTP or HTTP server. Subscribers do not need to configure any SIP settings.

  • Page 18: Requirements For Using The Auto Provisioning Server

    Auto Provisioning Administrator’s Guide 1.3.1 Requirements for Using the Auto Provisioning Server You need to do the following. • Provide and maintain a CRM system (database) that: Stores a record of VoIP subscriber device MAC addresses. Generates a unique PIN code to map to each VoIP subscriber device MAC address. Stores each subscriber’s SIP number, user ID, password PIN code and MAC address.

  • Page 19: Auto Provisioning Server System - Important Notes

    Auto Provisioning Administrator’s Guide Figure 4 Auto Provisioning Server Operation 1 Register a VoIP subscriber device and create a subscriber profile in the CRM database. The device’s type and MAC address have to be stored in the CRM database. You could set it up so that a subscriber uses a credit card on-line to register for VoIP service and the CRM database creates the subscriber profile and maps it to a device MAC address.
  • Page 20 Auto Provisioning Administrator’s Guide By default the sample 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 SIP server interact to make sure that only registered SIP devices can use the SIP server.

  • Page 21: Auto Provisioning Commands

    Auto Provisioning Administrator’s Guide H A P T E R Auto Provisioning Commands Before you deploy the VoIP devices, you need to configure them with your provisioning server’s IP address and enable the auto provisioning feature. Use the Command Line Interface (CLI) to configure the VoIP device’s auto provisioning settings.
  • Page 22 Auto Provisioning Administrator’s Guide Table 1 Auto Provisioning Commands (continued) COMMAND DESCRIPTION Displays the auto provisioning configuration display <index> settings. Displays the auto provisioning settings in the dumpCfg <index> temporary buffer. Chapter 2 Auto Provisioning Commands...

  • Page 23: Provisioning Utility

    Auto Provisioning Administrator’s Guide H A P T E R Provisioning Utility 3.1 Provisioning Utility Overview Use the provisioning utility to create encrypted configuration text files. The utility uses triple DES encryption for strong security. Use the correct utility for your operating system (ZyConfigGen_Win32 for Windows or ZyConfigGen_Linux for Linux).

  • Page 24: Common File

    Auto Provisioning Administrator’s Guide The following example is named “Field.txt”. Figure 6 Account Field File Example 980101014 = SIP #1 Phone Number 980101012 = SIP #1 UserId 980101013 = SIP #1 Password 980102014 = SIP #2 Phone Number 980102012 = SIP #2 UserId 980102013 = SIP #2 Password 3.4 Common File You can also include a common file of general settings if you want to change them from the...

  • Page 25: Getting An Sptgen File

    Auto Provisioning Administrator’s Guide 3.5 Getting an SPTGEN File You can use an internal SPTGEN file to create a common file. Use the following procedure to get a SPTGEN file from a VoIP device via FTP. 1 Launch the FTP client on your computer. 2 Enter “open”, followed by a space and the IP address of your VoIP device.

  • Page 26: Auto Provisioning Text File Menus Example

    Auto Provisioning Administrator’s Guide Your server must include a database with a different configuration file for each subscriber. The filename of each configuration file must include the VoIP device’s MAC address, for example: sip<MAC ADDRESS>.txt. This allows each VoIP device to download its unique configuration file.

  • Page 27: Table 3 Menu 4 Internet Access Setup

    Auto Provisioning Administrator’s Guide Note: DO NOT alter or delete any field except parameters in the INPUT column. Table 3 Menu 4 Internet Access Setup INPUT 40000000 Configured <0(No) | 1(Yes)> 40000001 <0(No) | 1(Yes)> 40000002 Active <0(No) | 1(Yes)> 40000003 ISP's Name 1234...

  • Page 28: Table 5 Menu 24.11 Remote Management Control

    Auto Provisioning Administrator’s Guide Table 5 Menu 24.11 Remote Management Control INPUT 241100001 TELNET Server Port 241100002 TELNET Server Access <0(all)|1(none)|2(Lan)|3 (Wan)> 241100003 TELNET Server Secured IP 0.0.0.0 address 241100004 FTP Server Port 241100005 FTP Server Access <0(all)|1(none)|2(Lan)|3 (Wan)> 241100006 FTP Server Secured IP 0.0.0.0 address 241100007 WEB Server Port...
  • Page 29 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION Registration timeout value. 980101006 SIP #1 Registration <2~65535> 7200 Expiration Time Registration resend timeout 980101007 SIP #1 Register ReSend <1~65535> value. Time Local SIP listening port. 980101009 SIP #1 Local signaling <1025~65535>...
  • Page 30 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION SIP server’s listening port. 980102003 SIP #2 Server Port <1~65535> 5060 <1024~65535> SIP register server address. 980102004 SIP #2 Registartion 192.168.1.33 Server IP SIP register server’s 980102005 SIP #2 Registartion <1~65535>...
  • Page 31 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION STUN server’s listening 980102028 SIP #2 STUN Server Port <1024~65535> port. / Menu 98.2 VoIP QoS Setup DiffServ setting for SIP. 980200001 SIP TOS Priority <0~255>...
  • Page 32 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION Disables or enables echo 980302005 Phone #2 G.168 Echo <0(No) |1(Yes)> cancellation. Cancellation Disables or enables VAD. 980302006 Phone #2 Voice Active <0(No) |1(Yes)> Detection Support Sets the short dialing 980302007 Phone #2 Dialing Short...
  • Page 33 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION / Menu 98.6 Auto Provision Setup Disables or enables auto- 980600001 Auto Provision Active <0(No) |1(Yes)> provision. Auto-provision server’s 980600002 Auto Provision Server 172.21.3.144 address.
  • Page 34 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION / Menu 98.7.3 Phone Book (Speed Dial) #3 Setup Disables or enables the 980703001 Phone Book #3 Active <0(No) |1(Yes)> speed dial entry. Speed dial entry’s SIP 980703002 Phone Book #3 SIP 1234 number.
  • Page 35 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION Disables or enables the 980706001 Phone Book #6 Active <0(No) |1(Yes)> speed dial entry. Speed dial entry’s SIP 980706002 Phone Book #6 SIP 1234 number.
  • Page 36 Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION Speed dial entry’s SIP 980709002 Phone Book #9 SIP 1234 number. Number Peer or SIP server’s IP 980709003 Phone Book #9 SIP IP/ Testsip.com address or URL.

  • Page 37: Using The Auto Provision Encryption Utility

    Auto Provisioning Administrator’s Guide Table 6 Menu 98 VoIP, Phone and Auto Provision Setup INPUT DESCRIPTION The FTP site for f/w 980900002 Firmware_Download_Addr ftp:// upgrade. 172.21.3.144 /p2002L/ras IVR language for f/w 980900003 Fw_Notify_Voice_Type notification. Username for f/w upgrade. 980900004 Target_Firmware_Userna justin Password for f/w upgrade.

  • Page 38: Auto Provision Encryption Utility Usage Example 1

    Auto Provisioning Administrator’s Guide “|“ means “or”. Add this to the command to have the utility not encrypt the SIP -NoEnc configuration text files that it generates. It is recommended that you use encryption since the SIP configuration text files include the subscriber’s username and password.

  • Page 39: Figure 8 Utility Command Example 1

    Auto Provisioning Administrator’s Guide Figure 8 Utility Command Example 1 C:\>cd\Program Files\ZyXEL C:\Program Files\ZyXEL>ZyConfGen_Win32 -C P2002L.txt -O Results -D Field.txt Account.txt Auto Provision Encryption Utility Version: 1.2.0.0 Field: 0 Name: 980101014 = SIP #1 Phone Number Field: 1 Name: 980101012 = SIP #1 UserId Field: 2 Name: 980101013 = SIP #1 Password Field: 3 Name: 980102014 = SIP #2 Phone Number Field: 4 Name: 980102012 = SIP #2 UserId...

  • Page 40: Auto Provision Encryption Utility Usage Example 2

    Auto Provisioning Administrator’s Guide 3.9 Auto Provision Encryption Utility Usage Example 2 In this next example, the common settings remain the same, and are not included. Do the following: 1 Modify the Account Field File for fields needed in Account File. 2 Prepare Account File from database.

  • Page 41: Figure 9 Utility Command Example 2

    Auto Provisioning Administrator’s Guide Figure 9 Utility Command Example 2 C:\>cd\Program Files\ZyXEL C:\Program Files\ZyXEL>ZyConfGen_Win32 -O Results -D Field.txt Account.txt Auto Provision Encryption Utility Version: 1.2.0.0 Field: 0 Name: 980101014 = SIP #1 Phone Number Field: 1 Name: 980101012 = SIP #1 UserId Field: 2 Name: 980101013 = SIP #1 Password Field: 3 Name: 980102014 = SIP #2 Phone Number Field: 4 Name: 980102012 = SIP #2 UserId...
  • Page 42 Auto Provisioning Administrator’s Guide Chapter 3 Provisioning Utility...

  • Page 43: Auto Provisioning Server Installation

    Auto Provisioning Administrator’s Guide H A P T E R Auto Provisioning Server Installation This chapter covers how to install the auto provisioning server software. 4.1 System Requirements You need a minimum of the following in order to use the auto provisioning server software. •...

  • Page 44: Figure 10 Auto Install Start

    Auto Provisioning Administrator’s Guide Figure 10 Auto Install Start 4 Select the disk partitioning setup type. The Autopartition option is recommended. Figure 11 Disk Partitioning Setup Chapter 4 Auto Provisioning Server Installation...

  • Page 45: Figure 12 Automatic Partitioning: Remove All Partitions

    Auto Provisioning Administrator’s Guide 5 Remove all partitions on this system. Note: Warning: This will delete all data on your system. Figure 12 Automatic Partitioning: Remove All Partitions 6 Select Yes. Chapter 4 Auto Provisioning Server Installation...

  • Page 46: Figure 13 Automatic Partitioning Warning

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

  • Page 47: Manual Installation

    Auto Provisioning Administrator’s Guide 8 The server restarts after a few seconds. 9 After the server restarts, it should be up and running. The server is pre-configured. You can use it with the default settings. If you want to change these settings, see Appendix B on page 4.4 Manual Installation...
  • Page 48 Auto Provisioning Administrator’s Guide ## apache run user RUN_AS="apache" 5 Modify /etc/rc.d/init.d/httpd, add or edit like the following (CONF value must be same as $sys_logfile in step 1) CONF=/var/log/httpd.log DATE=`date +%Y.%m.%d-%X` case "$1" in start) detect echo "$DATE ---> httpd is starting" >> $CONF start stop) detect...

  • Page 49: Using The Auto Provisioning Server

    Auto Provisioning Administrator’s Guide H A P T E R Using the Auto Provisioning Server This chapter provides instructions for using the features of your auto-provisioning server Explanations are provided for: • Using “Product Type” • Using “Unit Device management” •...

  • Page 50: Web Manager Login

    Auto Provisioning Administrator’s Guide • Web browser pop-up windows from your device. Web pop-up blocking is enabled by default in Windows XP SP (Service Pack) 2. • JavaScripts (enabled by default). • Java permissions (enabled by default). 5.3 Web Manager Login 1 Launch your web browser.

  • Page 51: Figure 16 Navigation Panel

    Auto Provisioning Administrator’s Guide Figure 16 Navigation Panel The following table describes the categories of links. Table 7 Navigation Panel Summary CATEGORY LINKS FUNCTION Product Type View Use these screens to add, edit, view, and delete your list of VoIP subscriber product types and the parameters to use for each.

  • Page 52: Help

    Auto Provisioning Administrator’s Guide Table 7 Navigation Panel Summary (continued) CATEGORY LINKS FUNCTION Utilities Configuration Use these screens to change server settings and export device settings from the database. Export DB as SPTGEN Logout Use this link to exit the 5.5 Help Click to view on-line help descriptions.

  • Page 53: Figure 18 Product Type Edit Setting

    Auto Provisioning Administrator’s Guide Figure 18 Product Type Edit Setting Click a parameter’s Edit button to edit 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 complete the editing process. Click the Cancel button to abort the action.

  • Page 54: View Sptgen

    Auto Provisioning Administrator’s Guide 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 List: View SPTGEN Click View SPTGEN, to display the following screen. Chapter 5 Using the Auto Provisioning Server...

  • Page 55: Delete A Product Type

    Auto Provisioning Administrator’s Guide 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 List: Delete Click Delete to display the following screen. Chapter 5 Using the Auto Provisioning Server...

  • Page 56: Add A Product Type

    Auto Provisioning Administrator’s Guide Figure 24 Product Type Delete Click OK to remove the product 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 the Add a Product Type button to display the following screen.

  • Page 57: Import

    Auto Provisioning Administrator’s Guide 2 The Import SPTGEN from field can be empty. You may import a SPTGEN file later using the import function. 3 Click the Submit button to add a new product type into the server. 5.6.5 Import Product Type >...

  • Page 58: Export To Sptgen

    Auto Provisioning Administrator’s Guide Figure 28 SPTGEN File Example / Menu 1 General Setup / Menu 98.1.1 VoIP SIP #1 Setup 980101001 = SIP #1 Active <0(No) | 1(Yes)> = 1 980101002 = SIP #1 Server Address = 127.0.0.1 980101003 = SIP #1 Server Port <1024~65535> = 5060 980101004 = SIP #1 Registartion Server IP = 127.0.0.1 980101005 = SIP #1 Registartion Server Port <1024~65535>...

  • Page 59: Device Management

    Auto Provisioning Administrator’s Guide Figure 29 Export Product Type Select at least one product and click Export to display the following screen. Figure 30 Export Product Type Successful All the exported files will be stored in the directory home\apache2\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 subscriber devices and edit their settings.

  • Page 60: Edit Device

    Auto Provisioning Administrator’s Guide Note: “Unit Device” refers to subscriber devices. Figure 31 Device Search 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 Device Device Management >...

  • Page 61: Delete Device

    Auto Provisioning Administrator’s Guide The following table lists details about the device fields. Table 8 Device Editing Details TEXT FIELD LIMITATION Product Type Fixed, cannot be changed User ID Maximum 20 characters Password Maximum 12 characters SIP NO. Must be 8 characters PIN Code Maximum 15 characters MAC Address...

  • Page 62: Unlock Device

    Auto Provisioning Administrator’s Guide Click OK to remove the specified device from the server. Click Cancel to abort this action. 5.7.4 Unlock Device Device Management > Unit Device > Unit Device List > Unlock If a device sends 3 incorrect PIN codes consecutively in 10 minutes, the server locks the device.

  • Page 63: Account Management

    Auto Provisioning Administrator’s Guide Figure 36 Lock History 5.8 Account Management The account management tool allows you to add, edit, view, and delete users of this server. 5.8.1 Add a Viewer Account Management > Add a Viewer Administrators can create a viewer account by entering the required text fields (Viewer ID, Viewer Name, Password and Retype Password).

  • Page 64: Edit A Viewer

    Auto Provisioning Administrator’s Guide Figure 38 Viewer Search When you 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.

  • Page 65: Delete A Viewer

    Auto Provisioning Administrator’s Guide Click Update to update the information. The browser will go back to the previous screen if you click the Back button. 5.8.4 Delete a Viewer Account Management > Edit a Viewer > Viewer List > Delete Administrators can delete viewer accounts.

  • Page 66: Information Center

    Auto Provisioning Administrator’s Guide 5.9 Information Center The information center tool displays server statistics and other server information, such as system loading, users, and login history. 5.9.1 System Up Time Information Center > System 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.

  • Page 67: New User Info

    Auto Provisioning Administrator’s Guide Figure 44 Loading Statistics 5.9.3 New User Info Information Center > New User Info This screen displays the number of newly registered users per day. You can specify a time period (including dates and times) for details. Figure 45 New User Info 5.9.4 Registered Device Info Information Center >...

  • Page 68: Login History

    Auto Provisioning Administrator’s Guide You can also display statistics for a specific product type. Figure 46 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 Viewer to display.

  • Page 69: Import Unit Device

    Auto Provisioning Administrator’s Guide 5.10.1 Import Unit Device System Maintenance > Import Unit Device Administrators can import information for multiple devices from a text file. The file information must use the following format: MAC address,user ID,password,phone number,pin code,sip# Note: Make sure you remove any blank lines from the file. Figure 48 Unit Device File Example #PRODUCT = P2602R #DATA_START...

  • Page 70: Database Restore

    Auto Provisioning Administrator’s Guide Figure 50 Database Backup 5.10.3 Database Restore System Maintenance > Database Restore Administrators can use this screen to restore the database from a backup file. Figure 51 Database Restore 5.11 Utilities Utilities provides powerful tools to change server settings and export device settings from the database.

  • Page 71: Export Database As Sptgen

    Auto Provisioning Administrator’s Guide Figure 52 Configuration 5.11.2 Export Database as SPTGEN Utilities > Export DB as SPTGEN Administrators can export the SPTGEN 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 device SPTGEN files by 3DES.
  • Page 72 Auto Provisioning Administrator’s Guide Chapter 5 Using the Auto Provisioning Server...

  • Page 73: Using The Auto Provisioning Server

    Auto Provisioning Administrator’s Guide H A P T E R Using the Auto Provisioning Server After you have installed the auto provisioning server and integrated it with the CRM system, do the following to prepare the auto provisioning server to configure VoIP devices. 1 Upload a file of SIP accounts (System Maintenance >...
  • Page 74 Auto Provisioning Administrator’s Guide Chapter 6 Using the Auto Provisioning Server...

  • Page 75: Chapter 7 Troubleshooting

    Auto Provisioning Administrator’s Guide H A P T E R Troubleshooting 1 When I use Export DB as SPTGEN with 3DES, the system freezes up. 3DES is a very powerful encryption algorithm and requires a lot of CPU power. It is suggested that you perform the function during an off-peak period or offline.

  • Page 76: Figure 54 Database Replication

    Auto Provisioning Administrator’s Guide • Better response time for clients can be achieved by splitting the load for processing client queries between the master and slave servers. SELECT queries may be sent to the slave to reduce the query 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.

  • Page 77: Auto Provisioning Service Flowchart

    Auto Provisioning Administrator’s Guide P P E N D I X Auto Provisioning Service Flowchart This flow chart illustrates how the auto provisioning service (PS) handles a request from a device. Figure 55 Auto Provisioning Flowchart Appendix A Auto Provisioning Service Flowchart...
  • Page 78 Auto Provisioning Administrator’s Guide Appendix A Auto Provisioning Service Flowchart...

  • Page 79: Auto Provisioning Server System Configuration

    Auto Provisioning Administrator’s Guide P P E N D I X Auto Provisioning Server System Configuration The server is pre-configured. You can use it with the default settings. If you want to change these settings, you must log into the server’s Linux command line as “root”. The default password is “password”.
  • Page 80 Auto Provisioning Administrator’s Guide Appendix B Auto Provisioning Server System Configuration...

  • Page 81: Auto Provisioning Server Database Description

    Auto Provisioning Administrator’s Guide P P E N D I X Auto Provisioning Server Database Description In some advanced scenarios, you might want to move the provisioning server’s database to another server. The auto provisioning server uses a MySQL-based database. The following tables describe the auto provisioning server’s database structure.

  • Page 82: Table 13 Pinfaillog

    Auto Provisioning Administrator’s Guide Table 12 LoginLog (continued) COLUMN NAME DATATYPE NULL KEY DEFAULT VALUE DESCRIPTION LoginName Varchar(100) Account name LoginTime Datetime 0000-00-00 00:00:00 Login time LogoutTime Datetime 0000-00-00 00:00:00 Logout time Table 13 PinFailLog ID COLUMN DATATYPE NULL KEY DEFAULT VALUE DESCRIPTION NAME RowID...

  • Page 83: Table 16 Serverconfiguration

    Auto Provisioning Administrator’s Guide Table 16 ServerConfiguration COLUMN NAME DATATYPE NULL KEY DEFAULT VALUE DESCRIPTION Protocal varchar(100) Provisioning protocol varchar(100) Encrypted pin? (reserved) MaximumBackup Int(11) Maximum backup file (reserved) Userlockedtime varchar(100) How long the subscriber device will be locked IsDefault varchar(100) This setting is default or not.

  • Page 84: Table 19 Sptgengroup

    Auto Provisioning Administrator’s Guide Table 19 Sptgengroup ID COLUMN NAME DATATYPE NULL KEY DEFAULT VALUE DESCRIPTION RowID int (11) auto_increment ProductType varchar(100) Product type of subscriber device SPTGenGroupName varchar(100) Group name of product type GroupID int(11) Group ID of product type Table 20 UnLockedDevice ID COLUMN DATATYPE...
  • Page 85 Auto Provisioning Administrator’s Guide Table 21 User (continued) ID COLUMN NAME DATATYPE NULL KEY DEFAULT VALUE DESCRIPTION Status Char(1) Account’s status A: Active S: Suspend 10 CreateDate timestamp CURRENT_TIMESTAMP Account’s creation date Appendix C Auto Provisioning Server Database Description...
  • Page 86 Auto Provisioning Administrator’s Guide Appendix C Auto Provisioning Server Database Description...

  • Page 87: Sample Crm Server Database Description

    Auto Provisioning Administrator’s Guide P P E N D I X Sample CRM Server Database Description These tables describe the database structure of the VoIP Subscribing System (VSS) sample CRM server software. Table 22 Creditcard ID COLUMN NAME DATATYPE NULL KEY DEFAULT VALUE COMMENT UserID varchar(50) CardType...

  • Page 88: Table 25 Unitdevice

    Auto Provisioning Administrator’s Guide Table 24 Subscriber DEFAULT ID COLUMN NAME DATATYPE NULL KEY COMMENT VALUE EMail Varchar(50) NULL E-mail FirstName Varchar(50) NULL First name LastName Varchar(50) NULL Last name 10 CurrentPhone Varchar(50) NULL Current phone 11 Occupation Varchar(50) NULL Occupation 12 StreetAddress longtext...

  • Page 89: Voip Provisioning Server Soap Description

    Auto Provisioning Administrator’s Guide P P E N D I X VoIP Provisioning Server SOAP Description This appendix describes how the ZyXEL auto provisioning server uses SOAP to communicate with the CRM system. Use this information when you integrate the ZyXEL auto provisioning server with the CRM system.

  • Page 90: Gettotalunregistered Method

    Auto Provisioning Administrator’s Guide SOAP Request & Response Sample Request <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/ encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.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"> <SOAP-ENV:Body> <ns3751:setSubScriberRegistered xmlns:ns3751="http://tempuri.org"> <deviceModel xsi:type="xsd:string">P2002</deviceModel> <phoneNumber xsi:type="xsd:string">10000002</phoneNumber> <macAddress xsi:type="xsd:string">00A0C0000016</macAddress> </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/"...

  • Page 91: Table 29 Gettotalunregistered Method Output

    Auto Provisioning Administrator’s Guide Table 29 getTotalUnregistered Method Output PARAMETER NAME DATA TYPE COMMENT nums string The amount of the unregistered unit devices. SOAP Request & Response Sample Request <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/ soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.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/"...

  • Page 92: Gettotalsubscriber Method

    Auto Provisioning Administrator’s Guide getTotalSubScriber Method This is how the auto provisioning server gets the number of subscribers with a specified product type (from the CRM server). Table 30 getTotalSubScriber Method Input PARAMETER NAME DATA TYPE COMMENT ProductType string Product type Table 31 getTotalSubScriber Method Output PARAMETER NAME DATA TYPE COMMENT...

  • Page 93: Getpageunregisteredunitdevice Method

    Auto Provisioning Administrator’s Guide Response <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/ soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.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"> <SOAP-ENV:Body> <ns1:getTotalSubScriberResponse xmlns:ns1="http://tempuri.org"> <return xsi:type="SOAP-ENC:Array" SOAP- ENC:arrayType="unnamed_struct_use_soapval[1]"> <item> <soapVal xsi:type="xsd:string"> </soapVal> <totalnums xsi:type="xsd:string"> </totalnums> </item> </return> </ns1:getTotalSubScriberResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> getPageUnregisteredUnitDevice Method This is how the auto provisioning server gets a list of the unregistered subscriber devices (by search keyword and current page number) from the CRM server.
  • Page 94 Auto Provisioning Administrator’s Guide Table 33 getPageUnregisteredUnitDevice Method Output PARAMETER NAME DATA TYPE COMMENT password string Password pincode string PIN code macaddress string Mac address SOAP Request & Response Sample Request <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/ soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"...
  • Page 95 Auto Provisioning Administrator’s Guide Response <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/ soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.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"> <SOAP-ENV:Body> <ns1:getPageUnregisteredUnitDeviceResponse xmlns:ns1="http:// tempuri.org"> <return xsi:type="SOAP-ENC:Array" SOAP- ENC:arrayType="unnamed_struct_use_soapval[16]"> <item> <soapVal xsi:type="xsd:string"> </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> </soapVal> <userid xsi:type="xsd:string"> </userid> <soapVal xsi:type="xsd:string"> P2002 </soapVal>...
  • Page 96 Auto Provisioning Administrator’s Guide <soapVal xsi:type="xsd:string"> </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> H102 </soapVal> <userid xsi:type="xsd:string"> H102 </userid> <soapVal xsi:type="xsd:string"> P2002 </soapVal> <producttype xsi:type="xsd:string"> P2002 </producttype> <soapVal xsi:type="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>...
  • Page 97 Auto Provisioning Administrator’s Guide <producttype xsi:type="xsd:string"> P2002 </producttype> <soapVal xsi:type="xsd:string"> 87920774 </soapVal> <phonenumber xsi:type="xsd:string"> 87920774 </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"> 1234 </pincode> <soapVal xsi:type="xsd:string"> 00A0C0000004 </soapVal> <macaddress xsi:type="xsd:string"> 00A0C0000004 </macaddress> </item>...
  • Page 98 Auto Provisioning Administrator’s Guide <soapVal xsi:type="xsd:string"> 1234 </soapVal> <pincode xsi:type="xsd:string"> 1234 </pincode> <soapVal xsi:type="xsd:string"> 00A0C0000005 </soapVal> <macaddress xsi:type="xsd:string"> 00A0C0000005 </macaddress> </item> <item> <soapVal xsi:type="xsd:string"> </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal 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">...
  • Page 99 Auto Provisioning Administrator’s Guide </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> H107 </soapVal> <userid xsi:type="xsd:string"> H107 </userid> <soapVal xsi:type="xsd:string"> P2002 </soapVal> <producttype xsi:type="xsd:string"> P2002 </producttype> <soapVal xsi:type="xsd:string"> 87920777 </soapVal> <phonenumber 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">...
  • Page 100 Auto Provisioning Administrator’s Guide P2002 </producttype> <soapVal xsi:type="xsd:string"> 87920778 </soapVal> <phonenumber xsi:type="xsd:string"> 87920778 </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"> 1234 </pincode> <soapVal xsi:type="xsd:string"> 00A0C0000008 </soapVal> <macaddress xsi:type="xsd:string"> 00A0C0000008 </macaddress> </item> <item> <soapVal xsi:type="xsd:string">...
  • Page 101 Auto Provisioning Administrator’s Guide 1234 </soapVal> <pincode xsi:type="xsd:string"> 1234 </pincode> <soapVal xsi:type="xsd:string"> 00A0C0000009 </soapVal> <macaddress xsi:type="xsd:string"> 00A0C0000009 </macaddress> </item> <item> <soapVal xsi:type="xsd:string"> </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> H110 </soapVal> <userid xsi:type="xsd:string"> H110 </userid> <soapVal xsi:type="xsd:string"> P2002 </soapVal> <producttype xsi:type="xsd:string"> P2002 </producttype>...
  • Page 102 Auto Provisioning Administrator’s Guide </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> H111 </soapVal> <userid xsi:type="xsd:string"> H111 </userid> <soapVal xsi:type="xsd:string"> P2002 </soapVal> <producttype xsi:type="xsd:string"> P2002 </producttype> <soapVal xsi:type="xsd:string"> 87920781 </soapVal> <phonenumber 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">...
  • Page 103 Auto Provisioning Administrator’s Guide </producttype> <soapVal xsi:type="xsd:string"> 87920781 </soapVal> <phonenumber 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"> 1234 </pincode> <soapVal xsi:type="xsd:string"> 00A0C0000012 </soapVal> <macaddress xsi:type="xsd:string"> 00A0C0000012 </macaddress> </item> <item> <soapVal xsi:type="xsd:string"> </soapVal>...
  • Page 104 Auto Provisioning Administrator’s Guide </soapVal> <pincode xsi:type="xsd:string"> 10875 </pincode> <soapVal xsi:type="xsd:string"> 00A0C0000014 </soapVal> <macaddress xsi:type="xsd:string"> 00A0C0000014 </macaddress> </item> <item> <soapVal xsi:type="xsd:string"> </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> 10000001 </soapVal> <userid xsi:type="xsd:string"> 10000001 </userid> <soapVal xsi:type="xsd:string"> P2002 </soapVal> <producttype xsi:type="xsd:string"> P2002 </producttype>...
  • Page 105 Auto Provisioning Administrator’s Guide <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> 10001992 </soapVal> <userid xsi:type="xsd:string"> 10001992 </userid> <soapVal xsi:type="xsd:string"> P2002 </soapVal> <producttype xsi:type="xsd:string"> P2002 </producttype> <soapVal xsi:type="xsd:string"> 10001992 </soapVal> <phonenumber xsi:type="xsd:string"> 10001992 </phonenumber> <soapVal xsi:type="xsd:string"> </soapVal> <password xsi:type="xsd:string"> </password> <soapVal xsi:type="xsd:string"> 6325 </soapVal>...
  • Page 106 Auto Provisioning Administrator’s Guide </soapVal> <password xsi:type="xsd:string"> 789456 </password> <soapVal xsi:type="xsd:string"> 17807 </soapVal> <pincode xsi:type="xsd:string"> 17807 </pincode> <soapVal xsi:type="xsd:string"> 00A0C0000018 </soapVal> <macaddress xsi:type="xsd:string"> 00A0C0000018 </macaddress> </item> <item> <soapVal xsi:type="xsd:string"> </soapVal> <rowid xsi:type="xsd:string"> </rowid> <soapVal xsi:type="xsd:string"> 10000004 </soapVal> <userid xsi:type="xsd:string"> 10000004 </userid>...

  • Page 107: Getnewsubscriberbydate Method

    Auto Provisioning Administrator’s Guide </macaddress> </item> </return> </ns1:getPageUnregisteredUnitDeviceResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> getNewSubScriberByDate Method This is how the auto provisioning server gets the number of new subscribers for a specified time period from the CRM server. Table 34 getNewSubScriberByDate Method Input PARAMETER NAME DATA TYPE COMMENT startDate string...
  • Page 108 Auto Provisioning Administrator’s Guide Response <?xml version="1.0" encoding="ISO-8859-1"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/ soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.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"> <SOAP-ENV:Body> <ns1:getNewSubScriberByDateResponse xmlns:ns1="http://tempuri.org"> <return xsi:type="SOAP-ENC:Array" SOAP- ENC:arrayType="unnamed_struct_use_soapval[1]"> <item> <soapVal xsi:type="xsd:string"> 05/05/24 </soapVal> <createdate xsi:type="xsd:string"> 05/05/24 </createdate> <soapVal xsi:type="xsd:string"> </soapVal> <nums xsi:type="xsd:string"> </nums> </item>...

  • Page 109: Configuration File Example

    Auto Provisioning Administrator’s Guide P P E N D I X Configuration File Example This is a sample auto provisioning server configuration file. File Name: Config.php //MySQL server setup //== Start == $mysql_server = '192.168.11.224'; $user_id = 'admin'; $user_password = '1234'; $database = 'provisioning';...
  • Page 110 Auto Provisioning Administrator’s Guide // == 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) $zyxel_3des_key = "this is a secret key";...

  • Page 111: Index

    Auto Provisioning Administrator’s Guide Index Symbols Auto Provisioning Server Database Description Auto Provisioning Server Installation Auto Provisioning Server Usage $ zyxel_3des_key Auto Provisioning Text File Menus $database Auto Provisioning Text Files $database_connection_error_msg Auto Redial $mysql_server Auto Upgrade Common Setup $ps_web_path Autopartition $sys_logfile $user_id...
  • Page 112 Auto Provisioning Administrator’s Guide Database Backup Database Connection Error Message Database Description Field Identification Number Database Replication Field Name Database Structure File Menus Daylight Saving File Modification Debug Message Delete a Product Type Finland, Contact Information Delete a Viewer Firmware Download Address Denmark, Contact Information Firmware Version First Phone Port...
  • Page 113 Auto Provisioning Administrator’s Guide MAC Address Import Manual Installation Import Device Info Mapping Outgoing Calls Import SPTGEN Mapping to Phone1 Information Center Mapping to Phone2 INPUT Mapping to POTS Phone1 INPUT Column Master Server Input Volume Gain Maximum Flash Key Interval Installation Mcrypt Module Installation by Source Code...
  • Page 114 Auto Provisioning Administrator’s Guide Product Type List Product Type Management Protocol Off-line Provisioning 3DES Key One-way Replication Provisioning Server Database Description Optional Fields Provisioning Server Database Name Provisioning Server Installation Outgoing Call Use Provisioning Server Path Output Directory Provisioning Server SOAP Description Output Volume Gain Provisioning Utility PSTN Calls...
  • Page 115 Auto Provisioning Administrator’s Guide Square Brackets Start Date Statistics Schedule Backup STUN Second Phone Port STUN Server Active Serial Number STUN Server Address Server Address 28, 33 STUN Server Port Server Database Description Support E-mail Server Port Sweden, Contact Information Server Replication System Configuration Service Access...
  • Page 116 United Kingdom, Contact Information User ID 29, 61 User Locked Time Using the Auto Provisioning Server Utilities ZyConfigGen_Linux ZyConfigGen_Win32 ZyNOS ZyXEL Communications Corporation ZyXEL Network Operating System Viewer Configurations Viewer Delete Database Restore Viewer Edit Delete Device Viewer List Import Product Type...

Table of Contents