Linksys SPA2102-AU User manual

Corporate Headquarters
Linksys
121 Theory Drive
Irvine, CA 92617
USA
http://www.linksys.com
Tel: [phone]
800 546-5797
Fax: [phone]
Linksys SPA Provisioning Guide
Version 3.0

Linksys SPA Provisioning Guide
Copyright ©2007 Cisco Systems, Inc. All rights reserved.Specifications are subject to change without notice. Linksysis a registered trademark or trademark of Cisco Systems,
Inc. and/or its affiliates in the U.S. and certain other countries. Other brands and product names are trademarks or registered trademarks of their respective holders.
Disclaimer – Please Read:
This document contains implementation examples and techniques using Linksys, a division of Cisco Systems, Inc. and, in some instances, other company’s technology and
products and is a recommendation only and does not constitute any legal arrangement between Linksys, a division of Cisco Systems, Inc. and the reader, either written or
implied. The conclusions reached and recommendations and statements made are based on generic network, service and application requirements and should be regarded as
a guide to assist you in forming your own opinions and decision regarding your particular situation. As well, Linksys reserves the right to change the features and
functionalities for products described in this document at any time. These changes may involve changes to the described solutions over time.
Use of Proprietary Information and Copyright Notice:
This document contains proprietary information that is to be used only by Linksys customers. Any unauthorized disclosure, copying, distribution, or use of this information
is prohibited.

iii
Linksys SPA Provisioning Guide
Version 3.0
CONTENTS
Preface vii
Document Audience vii
Linksys VoIP Products vii
How This Document is Organized viii
Document Conventions viii
Related Documentation ix
Technical Support ix
CHAPTER 1Provisioning Linksys VoIP Devices 1-1
Residential Deployment Provisioning Requirements 1-1
Remote Endpoint Control 1-2
Communication Encryption 1-2
Provisioning Overview 1-2
Initial Provisioning 1-3
Deploying RC Units 1-3
Redundant Provisioning Servers 1-4
Retail Provisioning 1-4
Automatic In-House Preprovisioning 1-5
Configuration Access Control 1-5
SPA Configuration Profiles 1-5
SPA Provisioning Flow 1-6
Using HTTPS 1-8
How HTTPS Works 1-8
Server Certificates 1-9
Client Certificates 1-9
Linksys Certificate Chain Structure 1-9
Provisioning Setup 1-10
License Keys 1-11
Software Tools 1-11
Server Configuration 1-11
TFTP 1-12
HTTP 1-12

Contents
iv
Linksys SPA Provisioning Guide Version 3.0
Enabling HTTPS 1-13
Syslog Server 1-15
Where to Go From Here 1-15
CHAPTER 2Creating Provisioning Scripts 2-1
SPA Configuration File 2-1
Open Format Configuration File 2-2
Configuration File Compression 2-5
File Encryption 2-5
SPA Configuration Profile Compiler 2-6
Proprietary Plain-Text Configuration File 2-8
Source Text Syntax 2-8
Comments 2-9
Macro Expansion 2-9
Conditional Expressions 2-10
Assignment Expressions 2-11
URL Syntax 2-12
Optional Resync Arguments 2-12
key 2-13
post 2-13
alias 2-13
Combining Options 2-14
Using Provisioning Parameters 2-15
General Purpose Parameters 2-15
Enables 2-15
Triggers 2-16
Configurable Schedules 2-16
Profile Rules 2-17
Report Rule 2-19
Upgrade Rule 2-19
Data Types 2-20
CHAPTER 3Provisioning Tutorial 3-1
Preparation 3-1
Basic Resync 3-2
TFTP Resync 3-2
Syslog 3-3
Automatic Resync 3-4

Contents
v
Linksys SPA Provisioning Guide
Version 3.0
Unique Profiles and Macro Expansion 3-5
URL Resolution 3-5
HTTP GET Resync 3-6
Secure Resync 3-7
Basic HTTPS Resync 3-7
HTTPS With Client Certificate Authentication 3-9
HTTPS Client Filtering and Dynamic Content 3-9
Profile Formats 3-10
Profile Compression 3-10
Profile Encryption 3-11
Partitioned Profiles 3-12
Parameter Name Aliases 3-12
Proprietary Profile Format 3-13
CHAPTER 4Provisioning Field Reference 4-1
Configuration Profile Parameters 4-1
Firmware Upgrade Parameters 4-4
General Purpose Parameters 4-6
Macro Expansion Variables 4-7
Internal Error Codes 4-9
APPENDIX AAcronyms
APPENDIX BGlossary
APPENDIX CExample SPA Configuration Profile
I NDEX

Contents
vi
Linksys SPA Provisioning Guide Version 3.0

vii
Linksys SPA Provisioning Guide
Version 3.0
Preface
This guide describes the provisioning of Linksys Voice over IP (VoIP) products. It contains the following
sections:
• Document Audience, page vii
• Linksys VoIP Products, page vii
• How This Document is Organized, page viii
• Document Conventions, page viii
• Related Documentation, page ix
• Technical Support, page ix
Document Audience
This document is written for service providers who offer services using Linksys VoIP products and
specifically for administrative staff responsible for remote provisioning and preprovisioning Linksys
devices.
Linksys VoIP Products
The following summarizes the Linksys VoIP products that can be remotely provisioned or
preprovisioned using the information provided in this document.
• SPA9000—IP PBX with Auto-Attendant; can beused with the SPA400, which provides a SIP-PSTN
gateway
• Linksys Analog Telephone Adapters (ATAs):
• PAPT2T—Voice adapter with two FXS ports
• SPA1001—Small VoIP adapter
• SPA2102—Voice adapter with router
• SPA3102—Voice adapter with router and PSTN gateway
• RTP300—IP router with two FXS ports
• WRTP54G—Wireless-G IP router with two FXS ports

viii
Linksys SPA Provisioning Guide Version 3.0
Preface
How This Document is Organized
• SPA900 Series IP phones:
• SPA901—One line, small, affordable, no display
• SPA921—One-line business phone
• SPA922—One-line business phone with Power over Ethernet (PoE) support and an extra
Ethernet port for connecting another device to the LAN
• SPA941—Default is two lines, upgradeable to four lines
• SPA942—Default is two lines, upgradeable to four lines. Power over Ethernet (PoE) support
and an extra Ethernet port for connecting another device to the LAN
• SPA962—Six lines, hi-res color display. Power over Ethernet (PoE) support and an extra
Ethernet port for connecting another device to the LAN
Note A Linksys VoIP device that supports the remote provisioning options described in this document is
referred to generically as a SPA.
How This Document is Organized
This document is divided into the following chapters and appendices.
Document Conventions
The following are the typographic conventions used in this document.
Chapter Contents
Chapter 1, “Provisioning
Linksys VoIP Devices” This chapter introduces Linksys VoIP products.
Chapter 2, “Creating
Provisioning Scripts” This chapter describes how to work with Linksys provisioning
scripts and configuration profiles.
Chapter 3, “Provisioning
Tutorial” This chapter provides step-by-step procedures for using the
scripting language to create a configuration profile.
Chapter 4, “Provisioning Field
Reference” This chapter provides a systematic reference for each parameter on
the Provisioning tab of the administration web server.
Appendix A, “Acronyms” This appendix provides the expansion of acronyms used in this
document.
Appendix B, “Glossary” This appendix defines the terms used in this document.
Typographic Element Meaning
Boldface Indicates an option on a menu or a literal value to be entered in a field.
<parameter> Angle brackets (<>) are used to identify parameters that appear on the
configuration pages of the Linksys device administration web server. The
index at the end of this document contains an alphabetical listing of each
parameter, hyperlinked to the appropriate table in Chapter 4, “Provisioning
Field Reference”

ix
Linksys SPA Provisioning Guide
Version 3.0
Preface Related Documentation
Related Documentation
The following documentation provides additional information about features and functionality of
Linksys ATAs:
• AA Quick Guide
• IVR Quick Guide
• SPA Provisioning Guide
The following documentation describes how to use other Linksys Voice System products:
• SPA9000 Administrator Guide
• LVS CTI Integration Guide
• LVS Integration with ITSP Hosted Voicemail Guide
• SPA900 Series IP Phones Administrator Guide
• SPA 2.0 ATA Administrator Guide
• Linksys Voice over IP Product Guide: SIP CPE for Massive Scale Deployment
Technical Support
Technical support contact information for authorized Linksys Voice System partners is as follows:
• LVS Phone Support (requires an authorized partner PIN)
888 333-0244 Hours: 4am-6pm PST, 7 days a week
• E-mail support
[e-mail]
Italic Indicates a variable that should be replaced with a literal value.
Monospaced Font Indicates code samples or system output.
Typographic Element Meaning

x
Linksys SPA Provisioning Guide Version 3.0
Preface
Technical Support