ZyXEL Communications APS 1.0 Service manual

Auto Provisioning
For VoIP Devices
Administrator’s Guide
Ver si on 2 .0
3/2006

Auto Provisioning Administrator’s Guide
Copyright 3
Copyright
Copyright © 2006 by ZyXEL Communications Corporation.
The contents of this publication may not be reproduced in any part or as a whole, transcribed,
stored in a retrieval system, translated into any language, or transmitted in any form or by any
means, electronic, mechanical, magnetic, optical, chemical, photocopying, manual, or
otherwise, without the prior written permission of ZyXEL Communications Corporation.
Published 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 it convey any license under its patent rights nor the
patent rights of others. ZyXEL further reserves the right to make changes in any products
described herein without notice. This publication is subject to change without notice.
Trademarks
ZyNOS (ZyXEL Network Operating System) is a registered trademark of ZyXEL
Communications, Inc. Other trademarks mentioned in this publication are used for
identification purposes only and may be properties of their respective owners.

Auto Provisioning Administrator’s Guide
4Customer Support
Customer Support
Please have the following information ready when you contact customer support.
• Product model and serial number.
• Warranty Information.
• Date that you received your device.
• Brief description of the problem and the steps you took to solve it.
METHOD
LOCATION
SUPPORT E-MAIL TELEPHONEAWEB SITE
REGULAR MAIL
SALES E-MAIL FAX FTP SITE
CORPORATE
HEADQUARTERS
(WORLDWIDE)
[email protected] [phone] www.zyxel.com
www.europe.zyxel.com
ZyXEL Communications Corp.
6 Innovation Road II
Science Park
Hsinchu 300
Taiwan
[email protected] [phone] ftp.zyxel.com
ftp.europe.zyxel.com
CZECH REPUBLIC
[email protected] [phone] www.zyxel.cz ZyXEL Communications
Czech s.r.o.
Modranská 621
143 01 Praha 4 - Modrany
Ceská Republika
[email protected] [phone]
DENMARK
[email protected] [phone] www.zyxel.dk ZyXEL Communications A/S
Columbusvej
2860 Soeborg
Denmark
[email protected] [phone]
FINLAND
[email protected] [phone] www.zyxel.fi ZyXEL Communications Oy
Malminkaari 10
00700 Helsinki
Finland
[email protected] [phone]
FRANCE
[email protected] [phone] www.zyxel.fr ZyXEL France
1 rue des Vergers
Bat. 1 / C
69760 Limonest
France
[phone]
GERMANY
[email protected] [phone] www.zyxel.de ZyXEL Deutschland GmbH.
Adenauerstr. 20/A2 D-52146
Wuerselen
Germany
[email protected] [phone]
HUNGARY
[email protected] [phone] www.zyxel.hu ZyXEL Hungary
48, Zoldlomb Str.
H-1025, Budapest
Hungary
[email protected] [phone]
KAZAKHSTAN
http://zyxel.kz/support [phone] www.zyxel.kz ZyXEL Kazakhstan
43, Dostyk ave.,Office 414
Dostyk Business Centre
050010, Almaty
Republic of Kazakhstan
[email protected] [phone]
NORTH AMERICA
[email protected] 1-800-255-4101
[phone]
www.us.zyxel.com ZyXEL Communications Inc.
1130 N. Miller St.
Anaheim
CA 92806-2001
U.S.A.
[email protected] [phone] ftp.us.zyxel.com
NORWAY
[email protected] [phone] www.zyxel.no ZyXEL Communications A/S
Nils Hansens vei 13
0667 Oslo
Norway
[email protected] [phone]

Auto Provisioning Administrator’s Guide
Customer Support 5
POLAND
[email protected] [phone] www.pl.zyxel.com ZyXEL Communications
ul.Emilli Plater 53
00-113 Warszawa
Poland
[phone]
RUSSIA
http://zyxel.ru/support [phone] www.zyxel.ru ZyXEL Russia
Ostrovityanova 37a Str.
Moscow, 117279
Russia
[email protected] [phone]
SPAIN
[email protected] [phone] www.zyxel.es ZyXEL Communications
Alejandro Villegas 33
1º, 28043 Madrid
Spain
[email protected] [phone]
SWEDEN
[email protected] [phone] www.zyxel.se ZyXEL Communications A/S
Sjöporten 4, 41764 Göteborg
Sweden
[email protected] [phone]
UKRAINE
[email protected] [phone] www.ua.zyxel.com ZyXEL Ukraine
13, Pimonenko Str.
Kiev, 04050
Ukraine
[email protected] [phone]
UNITED KINGDOM
[email protected] [phone]
08707 555779 (UK only)
www.zyxel.co.uk ZyXEL Communications UK
Ltd.,11 The Courtyard,
Eastern Road, Bracknell,
Berkshire, RG12 2XB,
United Kingdom (UK)
[email protected] [phone] ftp.zyxel.co.uk
a. “+” is the (prefix) number you enter to make an international telephone call.
METHOD
LOCATION
SUPPORT E-MAIL TELEPHONEAWEB SITE
REGULAR MAIL
SALES E-MAIL FAX FTP SITE

Auto Provisioning Administrator’s Guide
6Customer Support

Auto Provisioning Administrator’s Guide
Table of Contents 7
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
1.3.2 Auto Provisioning Server System 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 Utility Overview ..............................................................................23
3.2 Account File .......................................................................................................23
3.3 Account Field File ...............................................................................................23
3.4 Common File ......................................................................................................24
3.4.1 The Common File Format .........................................................................24
3.4.2 File Modification - Important Points to Remember ..................................24
3.5 Getting an SPTGEN File ....................................................................................25
3.6 Auto Provisioning Text Files ...............................................................................25
3.6.1 Auto Provisioning Text File Menus Example .............................................26
3.7 Using the Auto Provision Encryption Utility ........................................................37
3.8 Auto Provision Encryption Utility Usage Example 1 ...........................................38
3.9 Auto Provision Encryption Utility Usage Example 2 ...........................................40

Auto Provisioning Administrator’s Guide
8Table of Contents
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
5.4 Navigation Panel ................................................................................................50
5.5 Help ....................................................................................................................52
5.6 Product Type ......................................................................................................52
5.6.1 Edit Setting ...............................................................................................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 Search ..........................................................................................59
5.7.2 Edit Device ................................................................................................60
5.7.3 Delete Device ...........................................................................................61
5.7.4 Unlock Device ...........................................................................................62
5.7.5 Lock History ..............................................................................................62
5.8 Account Management ........................................................................................63
5.8.1 Add a Viewer ............................................................................................63
5.8.2 Viewer Search ..........................................................................................63
5.8.3 Edit a Viewer .............................................................................................64
5.8.4 Delete a Viewer ........................................................................................65
5.8.5 Change Password ....................................................................................65
5.9 Information Center .............................................................................................66
5.9.1 System Up Time .......................................................................................66
5.9.2 Loading Statistics ......................................................................................66
5.9.3 New User Info ...........................................................................................67
5.9.4 Registered Device Info .............................................................................67
5.9.5 Login History .............................................................................................68
5.10 System Maintenance .......................................................................................68
5.10.1 Import Unit Device ..................................................................................69
5.10.2 Database Backup ...................................................................................69

Auto Provisioning Administrator’s Guide
Table of Contents 9
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................................................ 79
Appendix C
Auto Provisioning Server Database Description ................................................ 81
Appendix D
Sample CRM Server Database Description ......................................................... 87
Appendix E
VoIP Provisioning Server SOAP Description ...................................................... 89
setSubScriberRegistered Method ............................................................................ 89
getTotalUnregistered Method ................................................................................... 90
getTotalSubScriber Method...................................................................................... 92
getPageUnregisteredUnitDevice Method................................................................. 93
getNewSubScriberByDate Method ........................................................................ 107
Appendix F
Configuration File Example................................................................................. 109
Index.......................................................................................................................111

Auto Provisioning Administrator’s Guide
10 Table of Contents

Auto Provisioning Administrator’s Guide
List of Figures 11
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 .................................................................................. 24
Figure 7 FTP Session Example .......................................................................................... 25
Figure 8 Utility Command Example 1 .................................................................................. 39
Figure 9 Utility Command Example 2 .................................................................................. 41
Figure 10 Auto Install Start ................................................................................................. 44
Figure 11 Disk Partitioning Setup ........................................................................................ 44
Figure 12 Automatic Partitioning: Remove All Partitions ..................................................... 45
Figure 13 Automatic Partitioning Warning ........................................................................... 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 Example ............................................................................ 53
Figure 20 Parameter Groups .............................................................................................. 54
Figure 21 Product Type List: View SPTGEN ....................................................................... 54
Figure 22 View SPTGEN ..................................................................................................... 55
Figure 23 Product Type List: Delete .................................................................................... 55
Figure 24 Product Type Delete ........................................................................................... 56
Figure 25 Product Type List: Add ........................................................................................ 56
Figure 26 Product Type Add ............................................................................................... 56
Figure 27 Import Product Type ............................................................................................ 57
Figure 28 SPTGEN File Example ....................................................................................... 58
Figure 29 Export Product Type ........................................................................................... 59
Figure 30 Export Product Type Successful ......................................................................... 59
Figure 31 Device Search ..................................................................................................... 60
Figure 32 Device List ..........................................................................................................60
Figure 33 Edit Device ..........................................................................................................61
Figure 34 Delete Device ...................................................................................................... 61
Figure 35 Unlock Device ..................................................................................................... 62
Figure 36 Lock History ........................................................................................................ 63
Figure 37 Add a Viewer ....................................................................................................... 63
Figure 38 Viewer Search ..................................................................................................... 64

Auto Provisioning Administrator’s Guide
12 List of Figures
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 ..................................................................................................... 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 50 Database Backup ................................................................................................ 70
Figure 51 Database Restore ............................................................................................... 70
Figure 52 Configuration ....................................................................................................... 71
Figure 53 Export Database as SPTGEN ............................................................................. 71
Figure 54 Database Replication .......................................................................................... 76
Figure 55 Auto Provisioning Flowchart ............................................................................... 77

Auto Provisioning Administrator’s Guide
List of Tables 13
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 ................................................................................... 51
Table 8 Device Editing Details ............................................................................................ 61
Table 9 Auto Provisioning Server System Configuration .................................................... 79
Table 10 LockedDevice ...................................................................................................... 81
Table 11 LoginLog .............................................................................................................. 81
Table 12 LoginLog .............................................................................................................. 81
Table 13 PinFailLog ............................................................................................................ 82
Table 14 ProductType ........................................................................................................ 82
Table 15 RequestLog ......................................................................................................... 82
Table 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 Subscriber ...........................................................................................................87
Table 25 Unitdevice ............................................................................................................ 88
Table 26 setSubScriberRegistered Method Input ............................................................... 89
Table 27 setSubScriberRegistered Method Output ............................................................ 89
Table 28 getTotalUnregistered Method Input ..................................................................... 90
Table 29 getTotalUnregistered Method Output ................................................................... 91
Table 30 getTotalSubScriber Method Input ........................................................................ 92
Table 31 getTotalSubScriber Method Output ..................................................................... 92
Table 32 getPageUnregisteredUnitDevice Method Input ................................................... 93
Table 33 getPageUnregisteredUnitDevice Method Output ................................................ 93
Table 34 getNewSubScriberByDate Method Input ............................................................. 107
Table 35 getNewSubScriberByDate Method Output .......................................................... 107

Auto Provisioning Administrator’s Guide
14 List of Tables

Auto Provisioning Administrator’s Guide
Chapter 1 Auto Provisioning 15
CHAPTER 1
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. The VoIP device changes its
configuration to match the configuration file (if they are different). At the time of writing, you
can use TFTP, HTTP or HTTPS1protocol for auto provisioning.
The following sections introduce two scenarios for using auto provisioning with ZyXEL’s
VoIP ATAs and IADs. The first uses a provisioning utility and the second uses an auto
provisioning server.
1.2 Provisioning Utility Scenario
For smaller-scale deployments, you can manually use the ZyXEL configuration generator
provisioning utility to generate and encrypt a batch of configuration files. Then store the
configuration files on a server for the ZyXEL Customer Premises Equipment (CPE) VoIP
devices to automatically download and use.
1. HTTPS support is optional and is not supported in the standard release.

Auto Provisioning Administrator’s Guide
16 Chapter 1 Auto Provisioning
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) autopro command to pre-
configure the ZyXEL VoIP devices to get the configuration files from the server
(see Chapter 2 on page 21).
Figure 2 Provisioning Utility Set Up
1Create an account file containing settings such as the username, password and SIP
number (see Section 3.2 on page 23 for details). You can export data from your Customer
Relationship Management (CRM) database to use in the account file.
2Create a common file with general SIP settings such as the SIP server’s IP address, port
number, codec and timeout (see Section 3.4 on page 24).

Auto Provisioning Administrator’s Guide
Chapter 1 Auto Provisioning 17
3Use 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).
4Store the configuration files on a TFTP or HTTP server. Subscribers do not need to
configure any SIP settings. After the VoIP device starts and connects to the Internet, it
automatically downloads its unique configuration text file from the provisioning server.
1.3 Auto Provisioning Server Scenario
For large-scale deployments, you can use ZyXEL’s auto provisioning 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 automatically generates and
manages VoIP subscriber device profiles. The auto provisioning server’s database uses
MySQL.
• It is easy to update settings for individual VoIP subscriber devices when you change SIP
parameters.
• PIN code based authentication for enhanced security. The auto provisioning server uses
Hypertext Preprocessor (PHP) to communicate with the VoIP subscriber devices.
• The web-based management interface is easy-to-use.
• ZyXEL’s auto provisioning server software supports the XML and Simple Object Access
Protocol (SOAP) to ease integration with your existing CRM database.
Figure 3 Auto Provisioning Server Scenario

Auto Provisioning Administrator’s Guide
18 Chapter 1 Auto Provisioning
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.
Note: The auto provisioning server software package includes sample CRM server
software called the VoIP Subscribing System (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 system. See Appendix E on page 89
for how the auto provisioning server uses SOAP to communicate with the CRM system.
• Provide SIP numbers and PIN codes to the subscribers either through a card, information
sheet or other method.
• Use the autopro command in the Command Line Interface (CLI) to pre-configure the
ZyXEL VoIP devices to get the configuration files from the server (see Chapter 2 on page
21).
1.3.2 Auto Provisioning Server System Usage
The following figure and steps describe how auto provisioning works with the auto
provisioning server.

Auto Provisioning Administrator’s Guide
Chapter 1 Auto Provisioning 19
Figure 4 Auto Provisioning Server Operation
1Register 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.
2The subscriber connects the VoIP device to the Internet and uses the telephone keypad to
enter the assigned SIP number and PIN code. The subscriber must press *99** SIP
number * PIN code #. For example, *99** 10000002 * 1234 #. After the subscriber
enters this information once, the device uses it to get the latest configuration file every
time the device starts and connects to the Internet.
3The VoIP device uses the SIP number, PIN code and its MAC address and model name to
authenticate with the auto provisioning server.
4For a new subscriber, the auto provisioning server requests subscriber specific settings
from the CRM database.
5The CRM server sends the subscriber specific settings to the auto provisioning server.
6The provisioning server combines the subscriber specific settings with general SIP setting
to make a configuration file.
7The subscriber’s VoIP device downloads and uses the configuration file.
1.3.3 Auto Provisioning Server System - Important Notes
The default address for accessing the sample CRM server is http://192.168.1.200/ZyXEL/.
Sample VoIP SIP Express Router (SER) software is also included on the auto provisioning
CD. You can use http://192.168.1.200 to access it. See iptel.org for more information on SER
servers.

Auto Provisioning Administrator’s Guide
20 Chapter 1 Auto Provisioning
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.