Cisco Systems Linksys Spa9000 Administrators Guide
SPA9000 to the manual c37f5891-12d2-4828-946d-972d65ae63e9
2015-01-05
: Cisco-Systems Cisco-Systems-Linksys-Spa9000-Administrators-Guide-202148 cisco-systems-linksys-spa9000-administrators-guide-202148 cisco-systems pdf
Open the PDF directly: View PDF
.
Page Count: 226
Linksys SPA9000 Administrator Guide
Document Version 3.01
Corporate Headquarters
Linksys
121 Theory Drive
Irvine, CA 92617
USA
http://www.linksys.com
Tel: 949 823-1200
800 546-5797
Fax: 949 823-1100
Specifications are subject to change without notice. Linksys is 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.
Linksys SPA9000 Administrator Guide
Copyright ©2007 Cisco Systems, Inc. All rights reserved.
CONTENTS
Preface
i-xi
i-xi
Document Audience
How This Document is Organized
Document Conventions
i-xii
Related Documentation
i-xiii
Technical Support
CHAPTER
1
i-xii
i-xiii
Using the Linksys Voice System
1-1
The Linksys Voice System 1-1
Overview 1-1
SPA400 SIP-PSTN Gateway and Voicemail 1-2
Auto-Attendant 1-3
SPA9000 System Features 1-3
Additional Features When Used with SPA900 Series IP Phones
1-5
Technology Background 1-6
Session Initiation Protocol 1-6
SPA9000 Media Proxy 1-7
Using the SPA9000 with a Firewall or Router 1-8
SPA400 SIP-PSTN Gateway 1-8
Network Address Translation (NAT) 1-9
NAT Overview 1-9
NAT Types 1-10
Simple Traversal of UDP Through NAT 1-10
SIP-NAT Interoperation 1-11
SPA9000 Architecture 1-11
Architectural Components 1-12
Multicast Addressing and Group Paging 1-13
Configuration Options 1-14
Interactive Voice Response 1-14
Setup Wizard 1-14
Administration Web Server 1-14
Local Client Configuration and Registration
1-15
Linksys SPA9000 Administrator Guide
Document Version 3.01
iii
Contents
Remote Provisioning of the SPA9000
Where to Go From Here
CHAPTER
2
Getting Started
1-15
1-16
2-1
Implementing LVS 2-1
Using the SPA9000 and SPA400 as a VoIP PBX System
Using the SPA9000 as a Media Proxy 2-3
Using the LVS as a Key System 2-3
SPA9000 Hardware 2-4
SPA9000 Back Panel 2-4
The Front Panel 2-5
SPA400 Hardware 2-6
Bandwidth Requirements 2-6
Caring for Your Hardware 2-7
Making the Physical Connections 2-8
2-2
Using the Interactive Voice Response Interface 2-8
Using the IVR Menu 2-9
IVR Options 2-10
Entering a Password through the IVR 2-12
Initial Setup and Configuration 2-12
Licensing 2-13
Using DHCP or Static IP Addressing 2-13
Using the Wizard for Initial Configuration 2-13
Using the Wizard to Upgrade Software 2-18
Setting the SPA9000 Administrator Account Password
Using the Administration Web Server 2-22
Connecting to the Administration Web Server
Administrator Account Privileges 2-24
2-22
2-22
Advanced Methods of Configuration 2-24
Web Interface URLs 2-24
Upgrade URL 2-25
Resync URL 2-25
Reboot URL 2-25
Provisioning 2-26
Provisioning Capabilities 2-26
Configuration Profile 2-26
Client Auto-Configuration 2-27
Manual Client Configuration 2-28
Client Registration
2-30
Linksys SPA9000 Administrator Guide
iv
Document Version 3.01
Contents
Troubleshooting and Configuration FAQ
CHAPTER
3
Configuring Voice Service and Voicemail
2-31
3-1
Using the Wizard to Configure ITSP Voice Services and Voicemail
Completing the Voicemail Configuration
3-1
3-6
Configuring the SPA400 for PSTN Connectivity or Voicemail 3-8
Understanding How the SPA400 Interacts with the SPA9000 3-8
Using the SPA9000 Setup Wizard to Configure the SPA400 3-8
Using the Administration Web Server to Configure the SPA400 3-11
Accessing the Administration Web Server 3-12
Configuring the SPA400 to Connect to the SPA9000 3-12
Configuring the SPA9000 to Register the SPA400 3-15
Configuring the SPA400 Voicemail Services 3-15
Configuring the SPA9000 Voicemail Settings 3-16
Configuring SPA400 Voicemail Accounts 3-17
Configuring a SPA IP Phone for Voice Mail Service
SPA400 Voicemail Options
3-20
Managing Voicemail 3-20
How Voicemail Works 3-21
Checking Voicemail from an External Number
Depositing Voicemail 3-22
Subscribing to Voicemail Notification 3-23
CHAPTER
4
Configuring SPA9000 Features
3-18
3-22
4-1
Using the Wizard to Configure SPA9000 Voice Features
Configuring Client Stations 4-2
Configuring Client Extensions 4-4
Configuring Shared Extensions 4-5
Configuring a Call Hunt Group 4-6
Using the Wizard for Localization 4-7
4-1
Using Dial Plans 4-9
Configuring Dial Plans 4-9
Dial Plan Digit Sequences 4-9
Dial Plan Rules 4-10
Dial Plan Examples 4-11
Dial Plan Timers 4-12
Interdigit Long Timer 4-12
Interdigit Short Timer 4-12
Linksys SPA9000 Administrator Guide
Document Version 3.01
v
Contents
Dial Plans
4-13
Basic Call Management 4-13
Receiving External Phone Calls 4-13
Calling Between Client Stations 4-13
Client Stations Calling an External Number 4-14
External Users Calling the SPA9000 4-15
Supporting Multiple DID Numbers Per Line Interface
4-16
Managing Call Forwarding 4-17
How Call Forwarding Works 4-17
Using Call Hunt Groups 4-19
Overview 4-19
Configuring a Hunt Group Rule 4-19
Using the Contact List Parameter 4-20
Using the Administration Web Server to Configure Hunt Groups 4-20
Client Station Blind Transfers External Caller To DID/Hunt Group 4-21
Using Shared Line Appearance 4-22
Managing Call Pickup 4-25
Directed Call Pickup 4-25
Group Call Pickup 4-26
Call Park and Pickup 4-26
Multicast and Group Paging
4-27
Music On Hold 4-28
Overview 4-28
Changing the Internal Music Source 4-28
Restoring the Default Internal Music Source 4-29
Using a Streaming Audio Server 4-30
Using the IVR with an SAS Line 4-30
Example SAS with MOH 4-31
Configuring the Streaming Audio Server 4-32
Enhancements in Release 5.1 4-32
Bridge Mode 4-32
Call Forward Bridge Mode 4-33
Call Transfer Bridge Mode 4-33
REGISTER Enhancement 4-33
Renew DHCP On SIP Request Timeout
CHAPTER
5
Configuring the LVS Auto-Attendant
Configuring Auto-Attendant 5-1
How the Auto-Attendant Works
4-34
5-1
5-1
Linksys SPA9000 Administrator Guide
vi
Document Version 3.01
Contents
Using the IVR to Record Auto-Attendant Prompts 5-2
Using the Wizard to Configure the Auto-Attendant 5-4
Using the Administration Web Server to Configure the Auto-Attendant
Downloading Prompts
5-6
5-8
Configuring Dial Plans for the Auto-Attendant
Alternative AA Configuration
5-9
5-10
Switching Between Alternative AAs Using the IVR
5-10
XML Scripting for the Auto-Attendant 5-13
Overview 5-13
XML Scripting Grammar 5-13
Node Type Dialog 5-14
Menu Type Dialog 5-14
Dialplan Statement 5-14
AA Instructions 5-15
Audio Instruction 5-15
Action Instruction 5-15
Noinput Instruction 5-15
Nomatch Instruction 5-16
Menu Matched Instruction—Recognition of Touch Tone (DMTP) Key Presses
AA XML Script Examples 5-17
Example 1—AA Default XML Script 5-17
Example 2 5-18
Example 3—AA Script with Two Treatments
Office Hour AA Treatment 5-19
Non-Office Hour AA Treatment 5-20
Auto-Attendant XML Instructions Set
CHAPTER
6
SPA9000 Field Reference
5-16
5-19
5-22
6-1
Info Tab 6-2
Product Information 6-2
System Status 6-2
Line 1/2/3/4 Status 6-3
FXS 1/2 Status 6-3
Auto Attendant Prompt Status
Internal Music Status 6-5
6-4
System Tab 6-6
System Configuration 6-6
Miscellaneous Settings 6-6
Linksys SPA9000 Administrator Guide
Document Version 3.01
vii
Contents
SIP Tab 6-7
SIP Parameters 6-7
SIP Timer Values (sec) 6-8
Response Status Code Handling 6-10
RTP Parameters 6-10
SDP Payload Types 6-11
NAT Support Parameters 6-13
PBX Parameters 6-14
Internal Music Source Parameters 6-17
Auto Attendant Parameters 6-18
PBX Phone Parameters 6-21
Regional Tab 6-23
Call Progress Tones 6-23
Distinctive Ring Patterns 6-24
Distinctive Call Waiting Tone Patterns 6-26
Distinctive Ring/CWT Pattern Names 6-26
Ring and Call Waiting Tone Spec 6-27
Control Timer Values (sec) 6-28
Vertical Service Activation Codes 6-29
Vertical Service Announcement Codes 6-33
Outbound Call Codec Selection Codes 6-33
Miscellaneous 6-35
FXS 1/2 Tab 6-38
Line Enable 6-38
Network Settings 6-38
SIP Settings 6-39
Subscriber Information 6-41
Dial Plan 6-41
Mailbox Status 6-41
Streaming Audio Server (SAS)
Call Feature Settings 6-43
Audio Configuration 6-43
FXS Port Polarity Configuration
6-42
6-46
Line 1/2/3/4 Tab 6-47
Line Enable 6-47
Network Settings 6-47
SIP Settings 6-48
Subscriber Information 6-50
Dial Plan 6-52
Linksys SPA9000 Administrator Guide
viii
Document Version 3.01
Contents
NAT Settings 6-53
Proxy and Registration
APPENDIX
A
Acronyms
APPENDIX
B
Glossary
6-54
INDEX
Linksys SPA9000 Administrator Guide
Document Version 3.01
ix
Contents
Linksys SPA9000 Administrator Guide
x
Document Version 3.01
Preface
The LVS 9000 solution includes a line of IP communication products including desktop IP phones, an
IP PBX, and PSTN gateway
This guide describes basic administration and use of the Linksys SPA9000 IP PBX and the SPA400
PSTN gateway. It contains the following sections:
•
Document Audience, page xi
•
How This Document is Organized, page xii
•
Document Conventions, page xii
•
Related Documentation, page xiii
•
Technical Support, page xiii
Document Audience
This document is written for the following audience:
•
Service providers offering services using LVS products
•
VARs and resellers who need LVS configuration references
•
System administrators or anyone who performs LVS installation and administration
Note
This guide does not provide the configuration information required by specific service
providers. Please consult with the service provider for specific service parameters.
Linksys SPA9000 Administrator Guide
Document Version 3.01
xi
Preface
How This Document is Organized
How This Document is Organized
This document is divided into the following chapters and appendices.
Chapter
Contents
Chapter 1, “Using the Linksys
Voice System.”
This chapter introduces the SPA9000 IP PBX and the SPA400
PSTN gateway.
Chapter 2, “Getting Started.”
This chapter describes how to establish connectivity between the
SPA9000, the SPA400, and other components.
Chapter 3, “Configuring Voice
Service and Voicemail.”
This chapter describes how to configure voice services and SPA400
or ITSP-hosted voicemail.
Chapter 4, “Configuring
SPA9000 Features.”
This chapter describes how to configure SPA9000 features.
Chapter 5, “Configuring the LVS This chapter describes how to configure or write XML scripts for
the Auto-Attendant
Auto-Attendant.”
Chapter 6, “SPA9000 Field
Reference”
This chapter lists the function and usage for each field or parameter
on the SPA9000 administration web server pages.
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.
Document Conventions
The following are the typographic conventions used in this document.
Typographic Element
Meaning
Boldface
Indicates an option on a menu or a literal value to be entered in a field.
Angle brackets (<>) are used to identify parameters that appear on the
configuration pages of the SPA9000 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 6, “SPA9000
Field Reference”
Italic
Indicates a variable that should be replaced with a literal value.
Monospaced Font
Indicates code samples or system output.
Linksys SPA9000 Administrator Guide
xii
Document Version 3.01
Preface
Related Documentation
Related Documentation
The following documentation provides additional information about features and functionality of the
SPA9000:
•
LVS CTI Integration Guide
•
LVS Integration with ITSP Hosted Voicemail Guide
•
AA & IVR Quick Guides
•
SPA Provisioning Guide
•
SPA9000 User Guide
The following documentation describes how to use other Linksys Voice System products:
•
SPA900 Series IP Phones Administrator Guide
•
LVS Linksys Voice over IP Products Guide
•
SPA 2.0 Analog Telephone Adapter Administrator Guide
Technical Support
If you are an end user of LVS products and need technical support, contact the reseller or Internet
telephony service provider (ITSP) that supplied the equipment.
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
voipsupport@linksys.com
Linksys SPA9000 Administrator Guide
Document Version 3.01
xiii
Preface
Technical Support
Linksys SPA9000 Administrator Guide
xiv
Document Version 3.01
C H A P T E R
1
Using the Linksys Voice System
This chapter provides an introduction to the components and functionality of the Linksys Voice System
(LVS). It includes the following sections:
•
The Linksys Voice System, page 1-1
•
Technology Background, page 1-6
•
SPA9000 Architecture, page 1-11
•
Where to Go From Here, page 1-16
The Linksys Voice System
This section provides basic information about the LVS VoIP PBX system and includes the following
topics:
•
Overview, page 1-1
•
SPA400 SIP-PSTN Gateway and Voicemail, page 1-2
•
Auto-Attendant, page 1-3
•
SPA9000 System Features, page 1-3
•
Additional Features When Used with SPA900 Series IP Phones, page 1-5
Overview
The Linksys Voice System (LVS) is an affordable, feature-rich, multi-line voice over IP (VoIP) telephone
system that provides sophisticated communication services to small business users. The LVS uses
standard TCP/IP protocols and can provide global connectivity through any Internet Telephony Service
Provider (ITSP) that supports Session Initiation Protocol (SIP). In addition, with the optional SPA400,
the LVS provides full interconnectivity with the Public Switched Telephone Network (PSTN).
The LVS solution, illustrated in Figure 1-1, provides a line of IP communication products that include
the following:
•
SPA9000 IP PBX
•
SPA400 SIP-PSTN gateway
•
SPA900 Series IP phones (SPA921, 922, 941, 942, and 962)
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-1
Chapter 1
Using the Linksys Voice System
The Linksys Voice System
Figure 1-1
The Linksys Voice System (LVS) with the SPA9000 and SPA400
PSTN
Up to 4 FXO lines
Local voicemail
SPA400
SIP-PSTN
gateway
Switch
ISP
SPA901, 921, 922, 941, 942, 962
Internet
ITSP
SPA9000
IP PBX
FXS1
FXS2
Fax/Analog
Phones
The LVS 9000 system uses the power of VoIP to provide enterprise-quality telephony features to small
office/home office (SOHO) and small businesses. The LVS is based on open standards, such as SIP,. This
allows interoperation with other standards-based products and simplifies configuration and use. The
SPA9000, with a base license, supports up to four IP phones and up to 16 phones with an upgraded
license.
With the optional SPA400, the SPA9000 can also manage calls to and from the PSTN. The SPA9000 also
includes an Analog Telephone Adapter (ATA), with two FXS ports for connecting analog telephones, fax
devices, or an external music source for the music on-hold service included with the SPA9000.
The SPA9000 supports four independent line interfaces with numbers assigned by one to four different
ITSPs, with each line supporting up to 16 extensions. If the service provider supplies a group of
sequential direct inward dial (DID) phone numbers (such as 408-777-1000 through 777-1015) the
SPA9000 can support all the assigned numbers on a single line interface.
For information about LVS architecture, refer to the “SPA9000 Architecture” section on page 1-11.
SPA400 SIP-PSTN Gateway and Voicemail
The SPA400 is optionally used with the SPA9000 to provide a SIP-PSTN gateway, providing voice
connectivity between the PSTN and local client stations connected to the SPA9000. It also provides a
local voicemail server.
Note
The SPA400 provides four FXO ports and occupies one line interface on the SPA9000.
A total of four SPA400 devices can be configured per SPA9000, using up to 16 analog phone lines and,
with the SPA9000, automatically routing calls to and from your existing PSTN telephone service.
Linksys SPA9000 Administrator Guide
1-2
Document Version 3.01
Chapter 1
Using the Linksys Voice System
The Linksys Voice System
Designed to be implemented with the SPA9000, the SPA400 lets cost-conscious business users take
advantage of all the high-value features on the LVS, which are typically found on much more expensive
voice communications systems. The SPA400 includes an integrated voicemail application supporting up
to 32 voicemail accounts with customized greetings, providing LVS users the ability to receive and
playback voicemail messages. The SPA400 ships with a USB voicemail module, which stores voicemail
prompts and allows recording of up to four hours of high-quality voice messages.
For detailed information about using the SPA400 voice services and voicemail servers, refer to
Chapter 3, “Configuring Voice Service and Voicemail.”
Auto-Attendant
The Auto-Attendant is an internal service within the SPA9000. It plays pre-recorded voice messages that
offer the caller a menu of choices, so the Auto-Attendant can appropriately direct the call. After the
caller has made a choice, the call is routed to the appropriate extension. When the Auto-Attendant is
enabled, it parses and operates on user input (key presses or DTMF tones) following the rules specified
in the Auto-Attendant script on the SPA9000.
For detailed information about using and configuring the Auto-Attendant, refer to Chapter 5,
“Configuring the LVS Auto-Attendant.”
SPA9000 System Features
This following summarizes the features provided by the SPA9000:
•
SIP Application Server, Proxy, Registrar and Location Server (RFC3261)
•
Multiple Service Provider Lines / SIP Account Support (4)
•
Shared Line Appearance (SLA)
•
Configurable AA Answer Delay
•
Interactive Voice Response (IVR)
•
Recordable IVR Prompts
•
Automatic Call Distribution (ACD)
•
Configurable Call Routing
– Least Cost Routing
– Multiple DID Numbers Per VoIP Line
– Call Routing to Multiple Extensions or Targeted User
– Call Hunting - Sequential, Round Robin, Random
•
Phone Configuration and Management Server
– Discovery and Configuration of IP Phones
– Assignment of Extension
– Assignment of Dial plan
– Proxy Logging of SIP Messages
– Phone Firmware Upgrade Management
•
Corporate Directory with Automatic Update
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-3
Chapter 1
Using the Linksys Voice System
The Linksys Voice System
•
Configuration and Maintenance via Web Interface (Local or Remote
– Status Display of All Connections
•
Remote Configuration via
– HTTPS with XML Formatted Files
– HTTP or TFTP with 256-Bit Encrypted Binary Files
•
Call Park -User Definable Parking Space Number
•
Call Unpark
•
Call Transfer - Attended and Blind
•
Call Forward
•
Group Paging
•
Intercom
•
Directed Call Pick Up
•
Group Call Pick Up
•
Music / Information via Streaming Audio Server (SAS) for Calls:
– On Hold
– Parked in the Parking Lot
– Being Transferred
•
Simultaneous Ringing (Find Me Service)
•
Do Not Disturb
•
Voice Mail Integration - Service Provider Based
– Voice Mail Notification via SUBSCRIBE / NOTIFY
– Forward Call Directly to Voice mail
•
Integrated Media Proxy or Direct RTP Routing to ITSP
•
Differentiated Services (DiffServ) / Type of Service (TOS) Support
•
Two FXS (RJ-11) ports for Phones, Fax machines, Media Adapters
•
Voice encoding with G.711 (64kbit/s) and other codecs (G.723, G.726, and G.729
•
Fax Support using G.711 Pass-Through or T.38
•
Echo Cancellation (G.165)
•
Line Status - Active Line Indication, Name/Number
•
Digits Dialed with Number Auto-Completion
•
Call Hold
•
Call Waiting
•
Call Conferencing
•
Automatic Redial
•
Call Pick Up - Selective and Group
•
Call Forwarding - Unconditional, No Answer, On Busy
Linksys SPA9000 Administrator Guide
1-4
Document Version 3.01
Chapter 1
Using the Linksys Voice System
The Linksys Voice System
Additional Features When Used with SPA900 Series IP Phones
The following lists the additional features available when using the SPA9000 with SPA900 Series IP
phones:
•
Line Status - Active Line Indication, Name/Number
•
Digits Dialed with Number Auto-Completion
•
Call Hold
•
Call Waiting
•
Call Transfer - Attended and Blind
•
Call Conferencing
•
Automatic Redial
•
Call Pick Up - Selective and Group
•
Call Swap
•
Call Forwarding - Unconditional, No Answer, On Busy
•
Hot Line and Warm Line Automatic Calling
•
Call Log (60 entries each): Made, Answered, Missed Calls
•
Personal Directory with Auto-dial (100 entries)
•
Do Not Disturb
•
URI (IP) Dialing Support (Vanity Numbers)
•
On Hook Default Audio Configuration (Hands Free/Headset)
•
Multiple Ring Tones with Selectable Default Ring Tone per Line
•
Called Number with Directory Name Matching
•
Calling Number with Name - Directory Matching or via Caller ID
•
Subsequent Incoming Calls with Calling Name and Number
•
Date and Time with Intelligent Daylight Savings Support
•
Call Duration with Call Time Stamp Stored in Call Logs
•
Name/Identity (Text) Display at Start Up
•
Distinctive Ringing Based on Calling and Called Number
•
User Downloadable Ring Tones and Ring Tone Generator (Free from www.linksys.com)
•
Download on Demand Ring Tones - 10
•
Speed Dial Support
•
Configurable Dial/Numbering Plan Support - per Line
•
DNS SRV and Multiple A Records for Proxy Lookup and Proxy Redundancy
•
Syslog, Debug, Report Generation and Event Logging
•
Secure Call Encrypted Voice Communication Support
•
Built-in Web Server for Admin and Config with Multiple Security Levels
•
Automated Provisioning, Multiple Schemes-Up to 256 Bit Encryption: (HTTP, HTTPS, TFTP)
•
Require Admin Password to Reset Unit to factory Defaults Option
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-5
Chapter 1
Using the Linksys Voice System
Technology Background
Technology Background
This section provides background information about the technology and protocols used by the SPA9000
system. It includes the following topics:
•
Session Initiation Protocol, page 1-6
•
SPA9000 Media Proxy, page 1-7
•
Using the SPA9000 with a Firewall or Router, page 1-8
•
SPA400 SIP-PSTN Gateway, page 1-8
•
Network Address Translation (NAT), page 1-9
Session Initiation Protocol
The LVS is implemented using open standards, such as Session Initiation Protocol (SIP), allowing
interoperation with all ITSPs supporting SIP. Figure 1-2 illustrates a SIP request for connection to
another subscriber in the network. In the SIP protocol, the requestor of the session is called the user agent
server (UAS), while the receiver of the request is called the user agent client (UAC).
Figure 1-2
SIP Requests and Responses
SIP UA
2
4
SIP Proxy
RTP
SIP Proxy
3
SIP Proxy
1
SIP UA
Note
In this manual, the term client station is used to describe any SIP UA (including IP phones) that registers
with the SPA9000.
In a SIP VoIP network, when the SIP proxy receives a request from a client station (UAS) for a
connection and it does not know the location of the UAC, it forwards the message to another SIP proxy
in the network. Once the UAC is located and the response is routed back to the UAS, a direct peer-to-peer
session is established between the two UAs. The actual voice traffic is transmitted between UAs over
dynamically assigned ports using the Real-time Protocol (RTP).
Linksys SPA9000 Administrator Guide
1-6
Document Version 3.01
Chapter 1
Using the Linksys Voice System
Technology Background
In Figure 1-3, UserA and UserB are client stations (UAs) that register over the local area network to
which the SPA9000 PBX is connected. When UserA calls UserB, the SPA9000 acts as a SIP proxy and
establishes a session between the two UAs. After the session is established, RTP traffic flows directly
between the two client stations.
Figure 1-3
SPA9000 as a SIP Proxy
UserC
UserA
UserB
Hub/switch
IP Router (firewall)
Broadband modem
ISP
Internet
Internet (WAN)
Interface
SPA9000
ITSP
SIP Proxy with
media proxy enabled
When a user picks up the handset in an LVS system, the SPA9000 collects DTMF digits from a touchtone
analog telephone or the locally connected SPA900 Series IP phones. Unless the call is for a local client
station, the SPA9000 system sends the full number in a SIP INVITE message to another SIP proxy server
for further call processing.
To minimize dialing delay, a dial plan is maintained that is matched against the cumulative number
entered by the user. Invalid phone numbers that are not compatible with the dial plan are detected and
the user is alerted using a configurable tone (reorder) or announcement.
Figure 1-3 also illustrates connectivity between the SPA9000 and the ITSP over the Internet. When
UserA calls UserC, the SPA9000 directs the request to the SIP proxy at the ITSP, which is then
responsible for routing the request to UserC. Again, once the session is established, RTP packets are
exchanged directly between UserA and UserC. However, this requires that the firewall on the Internet
routers allow UserA access to the Internet. Because the SIP UAs are generally assigned IP addresses
dynamically through DHCP, this makes implementing a secure firewall policy more difficult.
SPA9000 Media Proxy
To address this possible security issue, the SPA9000 can also function as a media (RTP) proxy. This
option forces RTP traffic destined for the Internet (or IP WAN) to be directed to the SPA9000, which
then directs it to the remote UA. This configuration may simplify firewall configuration because the
client stations do not require direct access to the Internet through the firewall.
To enable the media proxy, set the PBX Parameters: parameter to True. With the
media proxy enabled, when UserA calls User C, the SPA9000 still acts as the SIP proxy and forwards
the request to the SIP server on the ITSP. However, even after the SIP session is established, the
SPA9000 continues to direct RTP packets between UserA and the ITSP.
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-7
Chapter 1
Using the Linksys Voice System
Technology Background
Local traffic is not affected by this configuration. When UserA initiates a call to UserB, RTP traffic still
flows directly between the two UAs. The media proxy only affects RTP traffic to a UA connected
through the ITSP.
Using the SPA9000 with a Firewall or Router
When using the SPA9000 behind a firewall or router, make sure that the following ports are not blocked:
•
SIP ports—By default, UDP port 5060 and 5061
•
RTP ports—16384 to 16482
Also disable SPI if this function exists on your firewall.
SPA400 SIP-PSTN Gateway
When a local user on the SPA9000 network initiates a call to a PSTN subscriber, the SPA400 acts as the
SIP-PSTN gateway, which converts the SIP and RTP media packets into the appropriate signal for
transmission to the PSTN switch. For example, if UserA calls UserD, the SIP request is routed by the
SIP proxy in the SPA9000 to the SPA400 (see Figure 1-4).
Figure 1-4
The SPA400 as a SIP-PSTN Gateway
PSTN
UserD
1 to 4 DID lines
SPA400
SIP-PSTN
Gateway
UserB
UserA
Switch
Internet (WAN) Interface
SPA9000
SIP Proxy
The SPA400 then converts the SIP and RTP packets it receives from UserA and the signals it receives
from the PSTN switch.
Linksys SPA9000 Administrator Guide
1-8
Document Version 3.01
Chapter 1
Using the Linksys Voice System
Technology Background
Network Address Translation (NAT)
This section describes issues that arise when using the LVS on a network behind a network address
translation (NA) device. It includes the following topics:
•
NAT Overview, page 1-9
•
NAT Types, page 1-10
•
Simple Traversal of UDP Through NAT, page 1-10
•
SIP-NAT Interoperation, page 1-11
NAT Overview
Network Address Translation (NAT) allows multiple devices to share the same public, routable, IP
address for establishing connections over the Internet. NAT is typically performed by a router that
forwards packets between the Internet and the internal, private network.
A typical application of a NAT is to allow all the devices in a subscriber home network to access the
Internet through a router with a single public IP address assigned by an ISP. The IP header of the packets
sent from the private network to the public network is substituted by NAT with the public IP address and
a port assigned by the router. The receiver of the packets on the public network sees the packets as
coming from the external address instead of the private address of the device.
The association between a private address and port and a public address and port is called a NAT
mapping. This mapping is maintained for a short period of time, that varies from a few seconds to several
minutes. The expiration time is extended whenever the mapping is used to send a packet from the source
device.
Figure 1-5
NAT Support with Session Border Controller Provided by ITSP
Private IP address
192.168.1.1
192.168.1.101
External IP address
assigned by ISP
192.168.1.102
NAT Device
ISP
Internet
DHCP
server
SPA9000
ITSP
SIP Proxy
192.168.1.100
Session Border
Controller
The ITSP may support NAT mapping using a Session Border Controller (see Figure 1-5). This is the
preferred option because it eliminates the need for managing NAT on the SPA9000. If this is not
available, you will need to discuss with the ITSP how to use the NAT Support Parameters provided by
the SPA9000, such as and .
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-9
Chapter 1
Using the Linksys Voice System
Technology Background
NAT Types
The different types of NAT implementation are sometimes divided into the following categories:
•
Full cone NAT—Also known as one-to-one NAT. All requests from the same internal IP address and
port are mapped to the same external IP address and port. An external host can send a packet to the
internal host, by sending a packet to the mapped external address
•
Restricted cone NAT—All requests from the same internal IP address and port are mapped to the
same external IP address and port. Unlike a full cone NAT, an external host can send a packet to the
internal host only if the internal host had previously sent a packet to it.
•
Port restricted cone NAT/symmetric NAT—Port restricted cone NAT or symmetric NAT is like a
restricted cone NAT, but the restriction includes port numbers. Specifically, an external host can
send a packet to a particular port on the internal host only if the internal host had previously sent a
packet from that port to the external host.
With symmetric NAT all requests from the same internal IP address and port to a specific destination IP
address and port are mapped to a unique external source IP address and port. If the same internal host
sends a packet with the same source address and port to a different destination, a different mapping is
used. Only an external host that receives a packet can send a UDP packet back to the internal host.
Simple Traversal of UDP Through NAT
Simple Traversal of UDP through NATs (STUN) is a protocol defined by RFC 3489, which allows a
client behind a NAT device to find out its public address, the type of NAT it is behind, and the port
associated on the Internet connection with a particular local port. This information is used to set up UDP
communication between two hosts that are both behind NAT routers. Open source STUN software can
be obtained at the following website:
http://www.voip-info.org/wiki-Open+Source+VOIP+Software
STUN does not work with a symmetric NAT router. To determine the type of NAT your router uses,
complete the following steps:
Step 1
Enable debugging on the SPA9000:
1.
Make sure you do not have firewall running on your PC that could block the syslog port (by default
this is 514).
2.
On the administration web server, System tab, set to the IP address and port number
of your syslog server.
Note that this address and port number has to be reachable from the SPA.
3.
Set to 3 but you do not need to change the value of the parameter.
4.
To capture SIP signaling messages, under the Line tab, set to Full. The output
is named syslog.514.log.
Step 2
To determine the type of NAT your router is using set to yes.
Step 3
View the syslog messages to determine whether your network uses symmetric NAT.
Linksys SPA9000 Administrator Guide
1-10
Document Version 3.01
Chapter 1
Using the Linksys Voice System
SPA9000 Architecture
SIP-NAT Interoperation
In the case of SIP, the addresses where messages/data should be sent to a SPA9000 system are embedded
in the SIP messages sent by the device. If the SPA9000 system is sitting behind a NAT device, the private
IP address assigned to it is not usable for communications with the SIP entities outside the private
network.
Note
If the ITSP offers an outbound NAT-Aware proxy, this discovers the public IP address from the remote
endpoint and eliminates the need to modify the SIP message from the UAC.
The SPA9000 system must substitute the private IP address information with the proper external IP
address/port in the mapping chosen by the underlying NAT to communicate with a particular public peer
address/port. For this, the SPA9000 system needs to perform the following tasks:
•
Discover the NAT mappings used to communicate with the peer.
This can be done with the help of an external device, such as a STUN server. A STUN server
responds to a special NAT-Mapping-Discovery request by sending back a message to the source IP
address/port of the request, where the message contains the source IP address/port of the original
request. The SPA9000 system can send this request when it first attempts to communicate with a SIP
entity over the Internet. It then stores the mapping discovery results returned by the server.
•
Communicate the NAT mapping information to the external SIP entities.
If the entity is a SIP Registrar, the information should be carried in the Contact header that
overwrites the private address/port information. If the entity is another SIP UA when establishing a
call, the information should be carried in the Contact header as well as in the SDP embedded in SIP
message bodies. The VIA header in outbound SIP requests might also need to be substituted with
the public address if the UAS relies on it to route back responses.
•
Extend the discovered NAT mappings by sending keep-alive packets.
Because the mapping is alive only for a short period, the SPA9000 system continues to send periodic
keep-alive packets through the mapping to extend its validity as necessary.
SPA9000 Architecture
This section describes the basic architecture, function, and configuration options for the SPA9000. It
includes the following topics:
•
Architectural Components, page 1-12
•
Multicast Addressing and Group Paging, page 1-13
•
Configuration Options, page 1-14
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-11
Chapter 1
Using the Linksys Voice System
SPA9000 Architecture
Architectural Components
Figure 1-6
SPA9000 Architecture
SPA9000
Application
server
Administration
web server
Line 2
SIP Proxy
SIP Registrar
Switch
Media (RTP) Proxy
FXS1
FXS2
aa
Line 1
imusic
(408)111-1000 to 7
SPA 400
SIP-PSTN
gateway
ITSP SIP Proxy
(408)111-1111
(408)111-1112
(408)111-1113
(408)111-1114
PSTN
Line 3
(949)111-2000 to 7
ITSP SIP Proxy
Line 4
(888)111-3000 to 7
ITSP SIP Proxy
Call
park
As shown in Figure 1-6, the SPA 9000 provides four logical line interfaces, referred to as Line 1, 2, 3,
and 4. Each line can be configured with the same or a different ITSP. Each SPA400 also occupies one
line interface. The SPA9000 has five internal clients that register implicitly with the internal SIP proxy:
•
FXS1 (fxs1)
•
FXS2 (fxs2)
•
Call Park (callpark)
•
Auto-Attendant (aa)
•
Internal Music Server (imusic)
FXS1 and FXS2 correspond to the two physical FXS ports. The FXS ports can only register with the
local SIP proxy. The Call Park is used to maintain calls that are parked, and AA is a scriptable
auto-attendant application.
Table 1-1
Architectural Components
Architectural Component
Function
SIP proxy and Registrar server
Accepts registration from client stations and
proxies SIP messages.
Media proxy server
Proxies RTP packets between client stations and
proxies SIP messages.
Configuration server
Serves configuration files to client stations and
auto configures un-provisioned client stations.
Application server
Supports advanced features such as call
park/pickup, directory, directed call pickup and
group paging, hunt groups, and shared line
appearances.
Linksys SPA9000 Administrator Guide
1-12
Document Version 3.01
Chapter 1
Using the Linksys Voice System
SPA9000 Architecture
Table 1-1
Architectural Components
Architectural Component
Function
Internal music source
Streams audio files to client stations (both on-net
and off-net).
The FXS1 and FXS2 can optionally be connected
to an external music source to act as a streaming
audio server (SAS). When working in this mode,
each FXS port can handle up to 10 concurrent
calls.
Administration web server
Allows configuration and monitoring of the
SPA9000.
ATA with 2 FXS ports
Each FXS port can be connected to analog
phones, fax machine, or an external music
source. Each port can support up to two calls
simultaneously. The FXS ports can only register
to the internal proxy server.
Call park
The call park is used to maintain calls that are
parked and can handle up to 10 calls
simultaneously
Auto-Attendant
AA is a scriptable auto-attendant application that
can handle up to 10 calls simultaneously
Multicast Addressing and Group Paging
The parameter on the PBX Parameters page defines the multicast address used by
the SPA9000 and the SPA900 Series phones to communicate with each other. The default value is
224.168.168.168:6061. This address can also be set using the IVR option 181 and reviewed using option
180.
The parameter is used by the SPA9000 for group paging of all active client
stations. The default value is 224.168.168.168:34567.
The SPA9000 can send the following messages to the phone group:
•
Graceful Reboot
•
Immediate Reboot
•
Graceful Restart
•
Immediate Restart
•
Group Page Start
•
Group Page End
•
Get Ringing Calls
Client stations send multicast messages to the SPA9000 when they are looking for the configuration
server.
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-13
Chapter 1
Using the Linksys Voice System
SPA9000 Architecture
Configuration Options
This section describes the different methods for configuring the SPA9000. It includes the following
topics:
•
Interactive Voice Response, page 1-14
•
Setup Wizard
•
Administration Web Server
•
Local Client Configuration and Registration, page 1-15
•
Remote Provisioning of the SPA9000, page 1-15
Interactive Voice Response
The Interactive Voice Response (IVR), which is strictly for administration purposes, lets you use an
analog phone to perform basic configuration and troubleshooting operations. To access the IVR, connect
an analog phone to an FXS port and press **** to access the IVR menu.
For detailed information about using the IVR, refer to the “Using the Interactive Voice Response
Interface” section on page 2-8. A convenient quick-reference for the IVR is available at the following
website:
http://www.linksys.com/
Setup Wizard
The Setup Wizard is a convenient way to perform initial configuration for the SPA9000. It provides
step-by-step guidance for configuring the basic operation of voice services, voicemail, and most of the
main features provided by the SPA9000.
The Setup Wizard overwrites any existing configuration information that has been entered through the
administration web server, so it should not be used for ongoing administration and configuration unless
it provides adequate functionality for you to use it exclusively. You can, however, use the Setup Wizard
for initial configuration and then use the administration web server for ongoing configuration and
maintenance.
You can download the latest Setup Wizard from the following website:
http://www.linksys.com/
To start the Wizard, just double-click on the executable file. For information about getting started with
the Setup Wizard, refer to the “Using the Wizard for Initial Configuration” section on page 2-13
Administration Web Server
The administration web server provides a series of web pages that let you enter detailed configuration
information for the many features and options provided by the SPA9000. It also lets you monitor the
status of the attached client stations.
The administration server provides a basic and an advanced view from which the various configuration
parameters can be accessed. The Provisioning tab is only visible from the advanced Administrator
account view of the web interface.
To access the administration web server, direct a browser to the Internet (WAN) interface of the
SPA9000. To determine this address, use IVR Option 110#.
Linksys SPA9000 Administrator Guide
1-14
Document Version 3.01
Chapter 1
Using the Linksys Voice System
SPA9000 Architecture
For detailed information about using the administration web server, refer to the “Using the
Administration Web Server” section on page 2-22. For a description of each parameter provided by the
administration web server, refer to Chapter 6, “SPA9000 Field Reference”
Local Client Configuration and Registration
SPA9000 provides a TFTP server to assign configuration information to the locally attached client
stations. When the SPA9000 receives a request for /cfg/init_$MA.xml, it automatically assigns the next
available user id (extension number) to the client station. The initial user ID is configured using the PBX
Phone Parameters: parameter and is automatically incremented each time a new
number is assigned. Before assigning a new user ID, the SPA9000 also checks if there is any registered
client station using that ID and increases the ID until an unused value is found.
Remote Provisioning of the SPA9000
The SPA9000 provides for secure provisioning and remote upgrade. Provisioning is achieved through
configuration profiles transferred to the device via TFTP, HTTP, or HTTPS. User intervention is not
required to initiate or complete a profile update or firmware upgrade.
The SPA9000 can be configured to automatically resync its internal configuration state to a remote
profile periodically and during power up. The automatic resync is controlled by configuring the profile
URL for the device.
The SPA9000 accepts profiles in XML format, or alternatively in a proprietary binary format, which can
be generated by a profile compiler tool available to qualified VoIP vendors and partners from Linksys.
The SPA9000 supports up to 256-bit symmetric key encryption of profiles. For the initial transfer of the
profile encryption key (initial provisioning stage), the SPA9000 can receive a profile from an encrypted
channel (HTTPS with client authentication), or it can resync to a binary profile generated by the
Linksys-supplied profile compiler. In the latter case, the profile compiler can encrypt the profile
specifically for the target SPA9000, without requiring an explicit key exchange.
Remote firmware upgrade is achieved via TFTP or HTTP (firmware upgrades using HTTPS are not
supported). Remote upgrades are controlled by configuring the desired firmware image URL into the
SPA9000 via a remote profile resync.
For further information about remote provisioning refer to the LVS SPA Provisioning Guide.
Linksys SPA9000 Administrator Guide
Document Version 3.01
1-15
Chapter 1
Using the Linksys Voice System
Where to Go From Here
Where to Go From Here
The following table summarizes the steps required to implement and configure the SPA9000 system and
indicates where to look for the information required.
Task
Refer to
Establishing connectivity among system
components
Chapter 2, “Getting Started.”
Configuring voice services and SPA400 or
ITSP-hosted voicemail
Chapter 3, “Configuring Voice Service and
Voicemail.”
Configuring and understanding SPA9000 features Chapter 4, “Configuring SPA9000 Features.”
Configuring or writing XML scripts for the
Auto-Attendant
Chapter 5, “Configuring the LVS
Auto-Attendant.”
Identify the function or setting required for a
specific parameter on the administration web
server pages
Chapter 6, “SPA9000 Field Reference”
For additional information about specific functionality or features of the SPA9000, refer to the following
documents:
•
LVS CTI Integration Guide
•
LVS Integration with ITSP Hosted Voicemail Guide
•
Auto-Attendant Quick Guide
•
Interactive Voice Response (IVR) Quick Guide
•
SPA Provisioning Guide
•
SPA900 Series IP Phones Administrator Guide
Linksys SPA9000 Administrator Guide
1-16
Document Version 3.01
C H A P T E R
2
Getting Started
This chapter provides the information required to implement a SPA9000 system, including making the
required network connections and establishing basic connectivity among the system components. It
includes the following sections:
•
Implementing LVS, page 2-1
•
Using the Interactive Voice Response Interface, page 2-8
•
Initial Setup and Configuration, page 2-12
•
Setting the SPA9000 Administrator Account Password, page 2-22
•
Using the Administration Web Server, page 2-22
•
Advanced Methods of Configuration, page 2-24
•
Client Registration, page 2-30
•
Troubleshooting and Configuration FAQ, page 2-31
Implementing LVS
This section describes the first steps in implementing a SPA9000 system (LVS). It includes the following
topics:
•
Using the SPA9000 and SPA400 as a VoIP PBX System, page 2-2
•
Using the LVS as a Key System, page 2-3
•
SPA9000 Hardware, page 2-4
•
SPA400 Hardware, page 2-6
•
Bandwidth Requirements, page 2-6
•
Caring for Your Hardware, page 2-7
•
Making the Physical Connections, page 2-8
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-1
Chapter 2
Getting Started
Implementing LVS
Using the SPA9000 and SPA400 as a VoIP PBX System
Figure 2-1 illustrates the hardware required to implement a SPA9000 system with the SPA400 connected
to the PSTN.
Figure 2-1
SPA9000 and SPA400 System Hardware
PSTN
PC connected
through SPA9x2 IP phone
Up to 4 FXO lines
SPA400
(optional)
Hub/switch
IP Router/
Broadband
Modem
ISP
SPA901, 921, 922, 941, 942, 962
Public
Internet
Internet (WAN) Interface
SPA9000
ITSP
The following are the basic hardware requirements to implement an LVS PBX system:
•
SPA9000
•
One or more SPA900 series IP Phones (as client stations)
•
Ethernet network cables
•
One or more Ethernet switches with QoS support and with the required number of available ports
•
A PC for configuration of the SPA9000 and other client stations on the network. This can be
connected to the switch or directly to the Ethernet port on the SPA922, 942, or 962 IP phone.
The following components can optionally be added to provide additional functionality:
•
FAX machine to send or receive faxes
•
A router with QoS support, and a broadband (cable/DSL) modem (gateway) with connectivity to an
ISP
•
SPA400 SIP-PSTN gateway for connectivity to the PSTN and local voicemail service
•
PSTN DID lines
For best results, use a router and switch that both support Quality of Service (QoS). QoS allows top
priority to be assigned to voice traffic. Otherwise, the quality of the voice connection may suffer when
large files are moved over the network.
Note
The SPA9000, the SPA400, and the SPA900 Series IP phones should all be within the same LAN.
Separating the devices through VPN encryption, firewalls, routers, or other devices that affect multicast
traffic may prevent proper functioning of the IP PBX system.
Linksys SPA9000 Administrator Guide
2-2
Document Version 3.01
Chapter 2
Getting Started
Implementing LVS
In addition, you need at least one active ITSP phone service account and its settings (including DID
number for incoming calls) if you use the Internet for telephone service. If you are using the SPA400 for
connection to the PSTN, you need at least one active PSTN line.
The LVS can also be implemented with hosted voicemail services provided by the ITSP. In this scenario,
the SPA-400 is not configured for voicemail, but is only used for as a SIP-PSTN gateway, providing
telephone connectivity to PSTN subscribers.
Note
For first-time installation of the SPA9000, it is recommended that you use the SPA9000 Setup Wizard,
which you can download from www.linksys.com. For further information, see “Using the Wizard for
Initial Configuration” section on page 2-13.
Using the SPA9000 as a Media Proxy
The SPA9000 can act as a media proxy, which means that all RTP traffic between local client stations
and client stations on the Internet are routed through the SPA9000. This simplifies firewall configuration
because only the SPA9000 requires access to the Internet through the firewall.
By default, the SPA9000 acts only as a SIP proxy. This means that once a SIP connection is established,
further communication between the SIP UAs occurs directly. To enable the SPA9000 as a media proxy,
set the PBX Parameters: parameter to yes.
Using the LVS as a Key System
An easy and cost-effective way to implement the SPA9000 is as a replacement of a legacy key system,
in which a single DID line from the PSTN supports a single extension. In a key system all lines appear
as shared lines. This allows a user to pick up a ringing line from any phone in the key system (see
Figure 2-2).
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-3
Chapter 2
Getting Started
Implementing LVS
Figure 2-2
Using LVS with SPA9000 and SPA400 as a Key System
PSTN
Up to 4 DID lines per SPA400
Shared line appearance
1 to 4 SPA400s
Hub/switch
ISP
Internet
IP Router/
Broadband modem
Internet (WAN) Interface
SPA9000
ITSP
When implementing the SPA9000 and SPA400 as a key system, the SPA9000 is connected through a
switch to one or more SPA400s, which are then connected to the existing DID lines from the PSTN. The
SPA9000 has four line interfaces, each of which can support one SPA400 or a single VoIP account with
an ITSP. A single VoIP account with an ITSP can map to multiple DID numbers assigned by the ITSP.
Each SPA400 can support up to four DID lines assigned by the PSTN, so with a SPA400 connected to
all four line interfaces, the SPA9000 can support up to 16 DID lines to the PSTN.
SPA9000 Hardware
The following are the ports provided by the SPA9000:
•
Two analog (FXS) telephone ports (Phone 1 and Phone 2), which are designed for use by the
following devices:
– Analog telephone
– Fax machine
– Music/audio player with a music source adapter (RJ11-to-Line-In) for use as a Streaming Audio
Server (SAS)
•
Two Ethernet ports, designed for the following functions:
– Ethernet: administrative access for troubleshooting with a directly connected PC or laptop
– Internet: SIP call traffic and signaling to client stations and administration web server access
(through switch)
SPA9000 Back Panel
The SPA9000 ports are located on the back panel.
Linksys SPA9000 Administrator Guide
2-4
Document Version 3.01
Chapter 2
Getting Started
Implementing LVS
Figure 2-3
SPA9000 Back Panel
The following are the interfaces provided by the SPA9000, from left to right:
•
Phone 1/2—Connect to an analog telephone or fax machine with an RJ-11 cable.
•
Internet—Connect to a switch, router, or broadband (cable/DSL) modem. Also referred to as the
WAN port, because it provides connectivity to the wide area VoIP network.
•
Ethernet—For troubleshooting only.
•
Power—Connect to the power adapter.
The Front Panel
The SPA9000 LEDs are located on its front panel.
Figure 2-4
SPA9000 Front Panel
The following are the LEDs provided by the SPA900, from left to right:
•
Power—Steady green: powered on and connected to the Internet. Flashing: not connected to the
Internet or is booting or upgrading firmware.
•
Ethernet—Steady green: active connection. Flashing: indicates traffic.
•
Phone 1/2—Steady green: active/registered connection to ITSP through port. Flashing: in use or off
hook.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-5
Chapter 2
Getting Started
Implementing LVS
SPA400 Hardware
Figure 2-5
SPA400 Back Panel
The SPA400 provides the following interfaces (from left to right):
•
USB—Use this to connect the SPA400 USB voicemail module containing voicemail prompts and
provides the storage location for saving voice mailbox messages.
•
Ethernet—Connect to the SPA9000 through the appropriate switch.
•
Line 1 to 4—Connect to the telephone line provisioned by your PSTN provider.
•
Power—Connect to the power supply.
Figure 2-6
SPA400 Front Panel
The SPA400 provides the following LEDs, from left to right:
•
Power—Steady green: powered on and connected to the Internet. Flashing: not connected to the
Internet, booting, or upgrading firmware.
•
Status—Steady green: SPA400 registered to the SPA9000. Flashing: SPA400 not registered.
•
Line 1-4—Steady green: line is active; flashing: ringing; off: idle.
•
Ethernet—Steady green: active connection. Flashing: indicates traffic.
•
USB—Steady green: USB voicemail module registered. Off: no module detected.
Bandwidth Requirements
Depending on how you have your IP phones configured, each call requires 55 to 110 kbps in each
direction. Therefore, using G.729 as the voice codec setting, and with an average business-grade
broadband Internet connection supporting 1.5 Mbps downstream and 384 kbps upstream, a total of seven
(7) simultaneous conversations can be reliably supported with adequate bandwidth available for file
downloads.
Linksys recommends using the SPA9000 with QoS-capable networking equipment that can prioritize the
VoIP application traffic. QoS features are available on many Linksys data networking switches and
routers. A QoS-enabled router prioritizes the packets going upstream to the ISP. Table 2-1 illustrates the
bandwidth budget using different codecs.
Linksys SPA9000 Administrator Guide
2-6
Document Version 3.01
Chapter 2
Getting Started
Implementing LVS
Table 2-1
Ethernet Bandwidth Budget for Off-Net VoIP Calling
Codec
Approximate bandwidth budget for each
side of conversation
2 calls
4 calls
6 calls
8 calls
G.711
110 kbps
220 kbps
440 kbps
660 kbps
880 kbps
G.726-40
87 kbps
174 kbps
348 kbps
522 kbps
696 kbps
G.726-32
79 kbps
158 kbps
316 kbps
474 kbps
632 kbps
G.726-24
71 kbps
142 kbps
284 kbps
426 kbps
568 kbps
G.726-16
63 kbps
126 kbps
252 kbps
378 kbps
504 kbps
G.729
55 kbps
110 kbps
220 kbps
330 kbps
440 kbps
This table is based on the following assumptions:
•
Bandwidth Calculated with No Silence Suppression
•
20 Millisecond of payload per RTP packet
Note
The use of silence suppression can reduce the average bandwidth budget by 30% or more.
For more information about bandwidth calculation, refer to the following websites:
http://www.erlang.com/calculator/lipb/
http://www.packetizer.com/voip/diagnostics/bandcalc.html
Caring for Your Hardware
The SPA9000, SPA400, and the SPA900 Series phones are electronic device that should not be exposed
to excessive heat, sun, cold or water. To clean the equipment, use a slightly moistened paper or cloth
towel. Do not spray or pour cleaning solution directly onto the hardware unit.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-7
Chapter 2
Getting Started
Using the Interactive Voice Response Interface
Making the Physical Connections
To establish or verify the necessary connectivity complete the following steps.
Note
This includes the steps required to establish basic connectivity for LVS and does not address the
configuration of other networking components that may affect VoIP services.
To complete these steps, you need a multiport switch, Ethernet cables, the SPA9000, and a PC connected
to the network.
1.
Connect a network cable between the SPA9000 Internet Port and the switch.
2.
Connect a network cable between the computer you use to configure the SPA9000 and the switch.
3.
Plug an analog phone into the Phone 1 port on the SPA9000.
4.
Connect the included Power Adapter to the power port of the SPA9000.
The status LED starts flashing as the SPA9000 boots up.
5.
Connect a network cable from the broadband modem to the Internet port of the broadband router.
6.
Connect an network cable from one of the LAN ports of the router to the Uplink port of the LAN
switch.
7.
Connect the power adapters to the power ports of the broadband router and the LAN switch.
8.
If the SPA9000 has been used previously, reset it to its factory defaults before starting configuration.
a.
Connect an analog phone to Phone 1 or Phone 2.
b.
Press **** to access the IVR menu.
For detailed information about the IVR system, refer to “Using the Interactive Voice Response
Interface” section on page 2-8.
c.
Press 73738# and then 1#.
This resets the unit to its factory defaults.
d.
Wait about 30 seconds while the system reboots.
Using the Interactive Voice Response Interface
This section describes how to read or write basic network configuration settings using a touchtone
telephone connected to one of the FXS (RJ-11) phone ports of the SPA9000. It includes the following
topics:
•
Using the IVR Menu, page 2-9
•
IVR Options, page 2-10
•
Entering a Password through the IVR, page 2-12
By default, there is no password required for any of the IVR options. If the Administrator account
password is set, password authentication is required for some options.
Linksys SPA9000 Administrator Guide
2-8
Document Version 3.01
Chapter 2
Getting Started
Using the Interactive Voice Response Interface
The interactive voice response (IVR) features that are available depend on your system configuration.
A convenient quick-reference for the IVR is available at the following website:
http://www.linksys.com/
Using the IVR Menu
To use the IVR menu, complete the following steps.
Step 1
Connect an analog telephone to the Phone 1 or Phone 2 port of the SPA9000.
Note
Step 2
You can only access the IVR menu through an analog telephone, not an IP phone.
Press **** (quickly press the star key four times).
Wait until you hear “Linksys configuration menu.”
Note
You cannot access the IVR from a phone that is currently connected to a call.
Step 3
Refer to Table 2-2 to identify the option required.
Step 4
Enter the required option followed by the # (pound) key.
To enter a period, use the star key (*).
When entering a value, such as an IP address, to exit without entering any changes, press the * (star) key
twice within half a second. Otherwise, the * is treated as a decimal point.
After entering a value, such as an IP address, press the # (pound) key to indicate you have finished your
selection. To save the new setting, press 1. To review the new setting, press 2. To re-enter the new setting,
press 3. To cancel your entry and return to the main menu, press * (star).
For example, to enter the IP address 191.168.1.105 by keypad, press these keys: 191*168*1*105. Press
the # (pound) key to indicate that you have finished entering the IP address. Then press 1 to save the IP
address or press the * (star) key to cancel your entry and return to the main menu.
If the menu is inactive for more than one minute, the SPA9000 times out. You need to re-enter the menu
by pressing ****.
Step 5
To exit the menu, hang up the telephone.
The settings you have saved take effect after you hang up the telephone. The SPA9000 may reboot at this
time.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-9
Chapter 2
Getting Started
Using the Interactive Voice Response Interface
IVR Options
Table 2-2 summarizes the options provided by the IVR.
Table 2-2
IVR Options
IVR Action
IVR Menu Choice
Parameter(s)
Notes
Enter IVR Menu
****
None
Ignore SIT or other tones until you hear,
“Linksys configuration menu. Please
enter option followed by the pound key or
hang-up to exit.”
Exit IVR Menu
3948
None
Check DHCP
100
None
IVR announces if DHCP in enabled or
disabled.
Enable/Disable DHCP
101
Enter 1 to enable
Requires password
Enter 0 to disable
Check WAN IP Address
110
None
IVR announces the current IP address of
the WAN port.
Set Static IP Address
111
Enter IP address using
numbers on the telephone
key pad. Use the * (star) key
when entering a decimal
point.
DHCP must be “Disabled,” otherwise you
hear, “Invalid Option,” if you try to set
this value.
Requires password
Check Network Mask
120
None
IVR announces the current network mask
of SPA.
Set Network Mask
121
Enter value using numbers on
the telephone key pad. Use
the * (star) key when entering
a decimal point.
DHCP must be “Disabled,” otherwise you
hear, “Invalid Option,” if you try to set
this value.
Requires password
Check Static Gateway IP
Address
130
None
IVR announces the current gateway IP
address of SPA.
Set Static Gateway IP
Address
131
Enter IP address using
numbers on the telephone
key pad. Use the * (star) key
when entering a decimal
point.
DHCP must be “Disable,” otherwise you
hear, “Invalid Option,” if you try to set
this value.
Requires password
Check MAC Address
140
None
IVR announces the MAC address of SPA
in hex string format.
Check Firmware Version
150
None
IVR announces the version of the
firmware running on the SPA.
Check Primary DNS
Server Setting
160
None
IVR announces the current setting in the
parameter.
Linksys SPA9000 Administrator Guide
2-10
Document Version 3.01
Chapter 2
Getting Started
Using the Interactive Voice Response Interface
Table 2-2
IVR Options (continued)
Set Primary DNS Server
161
Enter IP address using
Requires password
numbers on the telephone
key pad. Use the * (star) key
when entering a decimal
point.
Check administration web 170
server port
None
IVR announces the port that the web
server is listening on. (Default is 80)
Check LAN IP Address
210
None
IVR announces the current IP address of
the LAN port.
Check PBX multicast
address
180
None
IVR announces the current value.
Set PBX multicast
address
181
Enter IP address and port.
Enter a * between the IP address and the
Use * key for entering a dot. Port fields. Requires Password
For example,
224.168.168.169:8089 is
224*168*168*169*8089.
Enable/Disable
7932
administration web server
Enter 1 to enable
Enter 0 to disable
Requires password
Manual Reboot of Unit
732668
None
After you hear “Option Successful,” hang
up. Unit reboots automatically.
User Factory Reset of
Unit
877778
Enter 1 to confirm
Enter *(star) to cancel
operation
SPA prompts for confirmation. After
confirming, you hear “Option
Successful.” Hang up. Unit reboots and
all “User Changeable” configuration
parameters are reset to factory default
values.
73738
Enter 1 to confirm
Enter * (star) to cancel
operation
SPA prompts for confirmation. After
confirming, you hear “Option
Successful.” Hang up. Unit reboots and
all configuration parameters are reset to
factory default values.
WARNING:
ALL “User-Changeable”
NON-DEFAULT
SETTINGS WILL BE
LOST!
This might include
network and service
provider data.
Factory Reset of Unit
WARNING:
ALL NON-DEFAULT
SETTINGS WILL BE
LOST!
This includes network and
service provider data.
Note
The items marked with “Requires Password” only require a password if the Administrator password is
set.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-11
Chapter 2
Getting Started
Initial Setup and Configuration
Entering a Password through the IVR
To input the password using the phone keypad, the following translation conventions apply:
– To input: A, B, C, a, b, c—press “2’
– To input: D, E, F, d, e, f—press “3’
– To input: G, H, I, g, h, i—press “4’
– To input: J, K, L, j, k, l— press “5’
– To input: M, N, O, m, n, o—press “6’
– To input: P, Q, R, S, p, q, r, s—press “7’
– To input: T, U, V, t, u, v—press “8’
– To input: W, X, Y, Z, w, x, y, z—press “9’
– To input all other characters in the Administrator account password, press “0’
Note
This translation convention only applies to the password input.
For example, to input password test#@1234 by phone keypad, you need to press the following
sequence of digits: 8378001234.
1.
After entering a value, press the # (pound) key to indicate end of input.
– To save value, press 1.
– To review the value, press 2.
– To re-enter the value, press 3.
– To cancel the value entry and return to the main configuration menu, press
*’ (star).
Notes:
– The final # key is not included in the password value.
– Saved settings take effect when the telephone is hung-up, and if necessary, the SPA9000
automatically reboots.
2.
After one minute of inactivity, the unit times out. The user needs to re-enter the configuration menu
from the beginning by pressing * * * *.
Initial Setup and Configuration
This section describes how to complete the initial connection and configuration of the SPA9000 system.
It includes the following topics:
•
Licensing, page 2-13
•
Using DHCP or Static IP Addressing, page 2-13
•
Using the Wizard for Initial Configuration, page 2-13
•
Using the Wizard to Upgrade Software, page 2-18
Linksys SPA9000 Administrator Guide
2-12
Document Version 3.01
Chapter 2
Getting Started
Initial Setup and Configuration
Licensing
The SPA9000 is shipped from the factory with a four-user license. This means that the SPA9000 allows
registration from up to four external IP addresses (first come/first serve). If you need to support more
client stations, you can purchase a 16-user license and install it by entering the license key using the
parameter on the Provisioning page. To obtain a license, contact
sipura-sales@cisco.com.
Using DHCP or Static IP Addressing
Before running the Setup Wizard, you need to decide whether you are using DHCP or static IP
addressing. Static IP addressing is recommended for the SPA400. The SPA900 series phones typically
obtain their addresses through the DHCP server on the broadband router that connects to the broadband
modem. The SPA9000 can either be assigned a static address if this has been provided by your ISP, or it
can be assigned a dynamic IP address by the DHCP server on your router or by the ISP.
If you are using static IP addressing for the SPA400, you need to know the correct static IP address to
assign. To determine the dynamically assigned address of the SPA400, you can use the Setup Wizard or
view the DHCP client table for the broadband router.
To determine the current IP address of the SPA9000, complete the following steps.
Step 1
Connect an analog telephone to one of the FXS (RJ-11) ports on the SPA9000.
Step 2
Press **** on the keypad to access the IVR menu.
Step 3
Press 110# and note the response.
Using the Wizard for Initial Configuration
Step 1
After completing the required physical network connections and powering on all devices, start the SPA
Setup Wizard.
The latest wizard can be obtained at the following URL:
www.linksys.com/
Figure 2-7 shows the first screen that you should see.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-13
Chapter 2
Getting Started
Initial Setup and Configuration
Figure 2-7
Step 2
SPA Setup Wizard—Page 1
Click Next.
The subsequent screen provides a review of the setup requirements that are required to successfully
complete the wizard. After verifying that you have completed the required setup, click Next.
The system displays Page 3 of the wizard (see Figure 2-8).
Figure 2-8
Step 3
SPA Setup Wizard—Page 3
If you are configuring the SPA9000 for the first time, accept the default and click Next on Page 3.
If you are using the wizard to change your existing configuration, click the second radio button on Page
3 and enter the IP address of your SPA9000 on the page that appears.
Note
If you use the Setup Wizard to configure the SPA9000 after using the administration server web, you
may lose any changes to the factory default configuration that you made using the administration server
web pages.
Linksys SPA9000 Administrator Guide
2-14
Document Version 3.01
Chapter 2
Getting Started
Initial Setup and Configuration
Complete the following steps before continuing with the wizard:
Step 4
1.
Connect a multi-port switch to the router in your network.
2.
Connect the Internet port on the SPA9000 to the switch.
3.
Connect the SPA900 series phones to the switch.
4.
Connect the administration PC to the switch.
5.
Ensure that all devices are powered up.
6.
Connect the SPA400s to the switch.
7.
Power on the SPA400s.
8.
Connect the FXO ports of the SPA400 to the phone ports connected to the PSTN (demarc) using a
standard telephone cord.
9.
Click Next on Page 4 of the wizard.
After making the necessary connections, click Next on Page 5 of the wizard.
The displays Page 6, as shown in Figure 2-9.
Figure 2-9
Step 5
SPA Setup Wizard—Page 6
Complete Page 6:
1.
Select the MAC address of the SPA400 from the pull-down selection list.
2.
Type the Administrator account password if it is set.
Note
3.
The administrator user ID for the SPA400 is Admin (with a capital A). By default, no password
is required (leave the password field empty). The administrator user ID for the SPA9000 is
admin (with a lower-case a).
Select the connection type (DHCP or Static IP) from the pull-down selection list.
If using DHCP, skip Step d. and do not enter any IP addresses.
Note
It is highly recommended that you use Static IP addressing for the SPA400.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-15
Chapter 2
Getting Started
Initial Setup and Configuration
4.
To use Static IP, type the static IP address, type the default router address (in the Gateway field),
and type the addresses of the primary and secondary DNS servers.
The Secondary DNS server is optional when using static IP addressing.
5.
Step 6
Click Submit on Page 6.
Complete the following steps, as described on Page 7 and Page 8 of the wizard:
1.
Check the firmware version.
a.
Plug an analog phone into the Phone 1 port of the SPA9000.
b.
Pick up the analog phone and enter **** on the phone keypad to access the IVR menu.
c.
Press 150# to hear the firmware version.
2.
Enable web access.
a.
Enter 7932# on the phone keypad.
This allows you to enable or disable the administration web server on the SPA9000.
b.
Press 1#.
This enables the administration web server.
3.
Press Next on Page 7.
4.
If it has been used before, reset the SPA9000 to the factory defaults:
a.
On the keypad of the analog phone, press 73738#.
This allows you to reset the unit to its factory default.
b.
Press 1 on the keypad.
5.
If it has been used before, reset each SPA900 series IP phone to its factory defaults.
a.
Press the Menu button on the SPA900 series phone.
b.
Use the Navigate button to scroll down to Factory Reset.
(or press Menu, type 14, and click OK).
c.
Click Select.
Note
6.
To reset a SPA901 phone press **** on the SPA901 keypad, press 73738#, and then press 1.
Press Next on Page 8.
The system displays Page 9, shown in Figure 2-9.
Linksys SPA9000 Administrator Guide
2-16
Document Version 3.01
Chapter 2
Getting Started
Initial Setup and Configuration
Figure 2-10 SPA Setup Wizard—Page 9
Step 7
Type the IP address of the SPA9000 on the Internet.
To determine the Internet IP address of the SPA9000:
1.
Pickup the handset of an analog phone connected to the Phone 1 port of the SPA9000.
2.
Press ****.
3.
Press 110# and note the address.
Step 8
Type the Administrator account password on Page 9 if this has been supplied to you. Otherwise, leave
this field blank.
Step 9
Click Next.
The system displays Page 10 of the Setup Wizard, which is the last page required to establish basic
connectivity for the system (see Figure 2-11).
Figure 2-11 SPA Setup Wizard—Page 10
Step 10
Select the connection type (DHCP or Static IP) from the pull-down selection list.
Step 11
If you are using Static IP, type the IP addresses of the primary and secondary DNS servers.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-17
Chapter 2
Getting Started
Initial Setup and Configuration
Step 12
Click Submit.
The system displays the Main Menu of the Setup Wizard (see Figure 2-12).
Figure 2-12 SPA Setup Wizard—Main Menu
You can use the options on this menu to perform the following configuration operations:
•
Software Upgrade—Upgrade the SPA9000, SPA400, or SPA900 series telephone software (see the
“Using the Wizard to Upgrade Software” section on page 2-18).
•
Configure SPA400—Configure PSTN voice services and voicemail services using the SPA400 (see
the “Using the SPA9000 Setup Wizard to Configure the SPA400” section on page 3-8.)
•
Configure SPA9000—Configure voice services and voicemail with an ITSP (see the “Using the
Wizard to Configure ITSP Voice Services and Voicemail” section on page 3-1).
•
Configure Client Stations—Configure the SPA900 series clients (see the “Configuring Client
Stations” section on page 4-2).
•
Configure Advanced Features:
– Change the Administrator password (see the “Setting the SPA9000 Administrator Account
Password” section on page 2-22).
– Hunt groups, shared extensions, and other features (see the “Using the Wizard to Configure
SPA9000 Voice Features” section on page 4-1)
– Auto-Attendant (see the “Using the Wizard to Configure the Auto-Attendant” section on
page 5-4).
Using the Wizard to Upgrade Software
Step 1
Download and save the latest software for whatever devices you want to upgrade from the following
website:
www.linksys.com/upgrade
Step 2
Make a note of the folder where you save it locally because you need this information during the upgrade
process.
Step 3
Select Software Upgrade on the Main Menu (Figure 2-12).
Linksys SPA9000 Administrator Guide
2-18
Document Version 3.01
Chapter 2
Getting Started
Initial Setup and Configuration
The system displays the first page of the Upgrade Wizard (see Figure 2-13).
Figure 2-13 Software Upgrade Wizard—Page 1
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-19
Chapter 2
Getting Started
Initial Setup and Configuration
Step 4
Select one of the following types of devices to upgrade:
•
SPA941/921
•
SPA942/922
•
SPA962
•
SPA901
•
SPA9000
•
SPA400
Step 5
Click Next.
Step 6
The system displays Page 2 of the Software Upgrade Wizard (see Figure 2-14
Figure 2-14 Software Upgrade Wizard—Page 2
Step 7
Type the IP address of the device you are upgrading and enter the Administrator account password, if
this is set.
1.
To determine the IP address of a SPA92x or 94x phone, press the Menu button,
2.
Scroll down to Network and press the left button (Select).
3.
Note the Current IP address, and enter it into Page 2 of the Software Upgrade wizard.
To determine the IP address of a SPA901 phone, pickup the handset, press ****, followed by 110#.
Step 8
Click Next on Page 2 of the Software Upgrade wizard.
Figure 2-15 illustrates the Upgrade Prompt that appears.
Figure 2-15 Upgrade Prompt
Step 9
Click OK to confirm the upgrade operation.
Linksys SPA9000 Administrator Guide
2-20
Document Version 3.01
Chapter 2
Getting Started
Initial Setup and Configuration
Step 10
The system displays Page 3 of the Software Upgrade Wizard (see Figure 2-16).
Figure 2-16 Software Upgrade Wizard—Page 3
Step 11
Click Select File.
The system displays the Windows Browse window (see Figure 2-17).
Figure 2-17 Use the Browse Window to Select the Upgrade File
Step 12
Select the upgrade software (.bin file) for the selected device and click OK.
Step 13
Click Upgrade.
The system performs the upgrade and reboots the system and returns you to the wizard Main Menu. You
can upgrade another device, or perform other configuration operations.
For information about using the Setup Wizard to configure voice services from an ITSP or to configure
local SPA400 voice mail or remote ITSP voicemail, refer to Chapter 3, “Configuring Voice Service and
Voicemail.” To configure other features, refer to Chapter 4, “Configuring SPA9000 Features.”
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-21
Chapter 2
Getting Started
Setting the SPA9000 Administrator Account Password
Setting the SPA9000 Administrator Account Password
Complete the folllowing steps to change the Administrator password.
Step 1
Select Change Admin Password from the Advanced Features menu (see Figure 2-18).
The system displays the page shown in Figure 2-19.
Figure 2-18 Set SPA9000 Admin Password
Step 2
Type the Administrator password in the field provided.
Step 3
Type the password again in the Confirm Password field and click Submit.
Step 4
Click Submit to enter the configuration for the previous wizard pages.
Using the Administration Web Server
This section describes how to use the administration web server to configure the SPA9000. It includes
the following topics:
•
Connecting to the Administration Web Server, page 2-22
•
Administrator Account Privileges, page 2-24
Connecting to the Administration Web Server
To access the SPA9000 administration web server, perform the following steps.
Step 1
Launch a web browser on a computer connected to the SPA9000.
Linksys SPA9000 Administrator Guide
2-22
Document Version 3.01
Chapter 2
Getting Started
Using the Administration Web Server
You access the administration web server through the Internet (WAN) interface on the SPA9000.
Step 2
Step 3
Determine the address of the administration web server.
a.
Connect an analog telephone to the Phone 1 or Phone 2 port on the SPA9000.
b.
Press **** on the keypad to access the IVR menu.
c.
Press 110# to determine the Internet (WAN) IP address.
Direct the browser to the IP address of the SPA9000.
Figure 2-19 Administration Web Server—Default Page (Basic User)
Changing between the tabs on the Voice page does not discard the unsubmitted changes. You can wait
until completing all your changes on the Voice pages before submitting them.
Note
Changing between the Router and Voice pages discards any unsubmitted changes to either page.
Step 4
Click the Voice tab.
Step 5
Click Admin Login and Advanced.
The Administrator account name for the SPA9000 is admin (with a lower-case a) and the User account
name is user. These account names cannot be changed.
The system prompts for the Administrator account password if it has been set. If prompted, type the
password provided by the ITSP and press Enter.
Step 6
To view the status information for the phones, click PBX Status.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-23
Chapter 2
Getting Started
Advanced Methods of Configuration
Enter the appropriate login information. Two views of the administration web server are available. Click
basic to view basic settings, or click advanced to view advanced settings.
Step 7
If you make changes on a screen, click Submit All Changes to save the changes,
Click Undo All Changes button to undo your changes. When changes are saved, the SPA9000 may
reboot.
Administrator Account Privileges
The SPA9000 supports two levels of administration privileges: Administrator and User. Both privileges
can be password protected.
Note
By default, there are no passwords assigned for either the Administrator account or the User account.
The Administrator account has the privilege to modify all the web profile parameters and can also
modify the passwords of both Administrator and User account. The User account only has the privilege
to access part of the web profile parameters. The parameters that the User account can access are
specified on the Provisioning page of the administration web server.
To directly access the Administrator account level privilege, use the following URL:
http://spa_9000_ipaddress/admin/voice
If the password has been set for the Administrator account, the browser prompts for authentication. The
User account name and the Administrator account name cannot be changed.
When browsing pages with the Administrator account privilege, you can switch to User account
privilege by clicking the User Login link.
If the User account password is set, the browser prompts for authentication when you click the User
Login link). From the User account, you can switch to the Administrator account by clicking the Admin
Login link. Authentication is required if the Administrator account password has been set.
Note
Switching between User and Administrator accounts or between basic and advanced views discards any
uncommitted changes that have already been made on the web pages.
Advanced Methods of Configuration
This section describes some advanced methods of configuration that you may find useful if you are
administering a large number of SPA9000 devices. This section includes the following topics:
•
Web Interface URLs, page 2-24
•
Provisioning, page 2-26
•
Client Auto-Configuration, page 2-27
•
Manual Client Configuration, page 2-28
Web Interface URLs
The SPA9000 web interface supports several functions through special URLs:
Linksys SPA9000 Administrator Guide
2-24
Document Version 3.01
Chapter 2
Getting Started
Advanced Methods of Configuration
•
Upgrade
•
Reboot
•
Resync
Administrator account privilege is needed for these functions.
Upgrade URL
The Upgrade URL lets you upgrade the SPA9000 to the firmware specified by the URL, which can
identify either a TFTP or HTTP server.
Note
If the value of the parameter in the Provisioning page is No, you cannot upgrade the
SPA9000 even if the web page indicates otherwise.
The syntax of the Upgrade URL is as follows:
•
http://spa-ip-addr/admin/upgrade?[protocol://][server-name[:port]][/firmware-pathname]
Both HTTP and TFTP are supported for the upgrade operation.
If no protocol is specified, TFTP is assumed. If no server-name is specified, the host that requests the
URL is used as server-name.
If no port specified, the default port of the protocol is used. (69 for TFTP or 80 for HTTP)
The firmware-pathname is typically the file name of the binary located in a directory on the TFTP or
HTTP server. If no firmware-pathname is specified, /spa.bin is assumed, as in the following example:
http://192.168.2.217/admin/upgrade?tftp://192.168.2.251/spa.bin
Resync URL
The Resync URL lets you force the SPA9000 to do a resync to a profile specified in the URL, which can
identify either a TFTP, HTTP, or HTTPS server.
Note
The SPA resyncs only when it is idle.
The syntax of the Resync URL is as follows:
http://spa-ip-addr/admin/resync?[[protocol://][server-name[:port]]/profile-pathname]
If no parameter follows /resync?, the Profile Rule setting from the Provisioning page is used.
If no protocol is specified, TFTP is assumed. If no server-name is specified, the host that requests the
URL is used as server-name.
If no port is specified, the default port is used (69 for TFTP, 80 for HTTP, and 443 for HTTPS).
The profile-path is the path to the new profile with which to resync, for example:
http://192.168.2.217admin/resync?tftp://192.168.2.251/spaconf.cfg
Reboot URL
The Reboot URL lets you reboot the SPA9000.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-25
Chapter 2
Getting Started
Advanced Methods of Configuration
Note
The SPA9000 reboots only when it is idle.
The Reboot URL is http://spa-ip-addr/admin/reboot.
Provisioning
This section describes the provisioning functionality of the SPA9000. This section includes the
following topics:
•
Provisioning Capabilities, page 2-26
•
Configuration Profile, page 2-26
For detailed information about provisioning the SPA9000, refer to the LVS SPA Provisioning Guide.
Provisioning Capabilities
The SPA9000 provides for secure provisioning and remote upgrade. Provisioning is achieved through
configuration profiles transferred to the device via TFTP, HTTP, or HTTPS.
The SPA9000 can be configured to automatically resync its internal configuration state to a remote
profile periodically and on power up. The automatic resyncs are controlled by configuring the desired
profile URL into the device.
The SPA9000 accepts profiles in XML format, or alternatively in a proprietary binary format, which is
generated by a profile compiler tool available from Linksys. The SPA9000 supports up to 256-bit
symmetric key encryption of profiles. For the initial transfer of the profile encryption key (initial
provisioning stage), the SPA9000 can receive a profile from an encrypted channel (HTTPS with client
authentication), or it can resync to a binary profile generated by the Linksys-supplied profile compiler.
In the latter case, the profile compiler can encrypt the profile specifically for the target SPA9000, without
requiring an explicit key exchange.
Remote firmware upgrade is achieved via TFTP or HTTP (firmware upgrades using HTTPS are not
supported). Remote upgrades are controlled by configuring the desired firmware image URL into the
SPA9000 via a remote profile resync.
For further information about remote provisioning refer to the LVS SPA Provisioning Guide. For further
information about certificate generation for use with an HTTPS server, contact sipura-sales@cisco.com.
Configuration Profile
The SPA9000 configuration profile can be either an XML file or a binary file with a proprietary format.
The XML file consists of a series of elements (one per configuration parameter), encapsulated within
the element tags … . The encapsulated elements specify values for
individual parameters. Here is an example of a valid XML profile:
some secret
Yes
Binary format profiles contain SPA9000 parameter values and user access permissions for the
parameters. By convention, the profile uses the extension .cfg (for example, spa2000.cfg). The Linksys
Profile Compiler (SPC) tool compiles a plain-text file containing parameter-value pairs into a properly
Linksys SPA9000 Administrator Guide
2-26
Document Version 3.01
Chapter 2
Getting Started
Advanced Methods of Configuration
formatted and encrypted .cfg file. The SPC tool is available from Linksys for the Win32 environment
and Linux-i386-elf environment. Requests for SPC tools compiled on other platforms are evaluated on
a case-by-case basis. Please contact your Linksys sales representative for further information about
obtaining the SPC tool.
The syntax of the plain-text file accepted by the profile compiler is a series of parameter-value pairs,
with the value in double quotes. Each parameter-value pair is followed by a semicolon. Here is an
example of a valid text source profile for input to the SPC tool:
Admin_Passwd “some secret”;
Upgrade_Enable “Yes”;
Refer to the LVS SPA Provisioning Guide for further details.
The names of parameters in XML profiles can generally be inferred from the SPA9000 configuration
Web pages, by substituting underscores (_) for spaces and other control characters. Further, to
distinguish between Lines 1, 2, 3, and 4, corresponding parameter names are augmented by the strings
_1_, _2_, _3_, and _4_. For example, Line 1 Proxy is named Proxy_1_ in XML profiles.
Parameters in the case of source text files for the SPC tool are similarly named, except that to
differentiate Line 1, 2, 3, and 4, the appended strings ([1], [2], [3], or [4]) are used. For example, the
Line 1 Proxy is named Proxy[1] in source text profiles for input to the SPC.
Client Auto-Configuration
An unprovisioned client station in the factory default state can be automatically provisioned by the
SPA9000 by following the flow chart shown in Figure 2-20.
When the SPA9000 receives a request for /cfg/init_$MA.xml, it automatically assigns the next available
user ID (extension number) to this client station. The next user ID to be assigned to a new client station
is configured using The parameter and is automatically incremented each time a
new number is assigned. Before assigning a new user ID, the SPA9000 also checks whether there is any
registered client station using that ID and keeps increasing the ID until an unused value is found.
Linksys SPA9000 Administrator Guide
Document Version 3.01
2-27
Chapter 2
Getting Started
Advanced Methods of Configuration
Figure 2-20 Unprovisioned Client Station Acquiring a Configuration Profile
DHCP
Request
/spa$PSN.cfg
Yes
Option 66?
No
Look For
Config Server
Request
/cfg/init_$MA.xml
Request
/cfg/generic.xml
To add a new IP phone to the SPA9000, connect the IP phone to the QoS switch to which the SPA9000
is connected and power on the unit.
To add a previously-used IP phone to the SPA9000, perform the following steps:
1.
Upgrade the IP phone with SPA9000-compatible firmware.
2.
Factory reset the unit.
3.
Power cycle the unit.
4.
Connect the unit to the switch.
The SPA9000 provisions only the necessary parameters to the client stations. It assumes the rest of the
parameters have appropriate values, which are either the default values or manually configured values.
For example, the SPA9000 provisions only Extension 1 on the client stations. Access the administration
web server using the Administrator account to manually configure other extensions on specific client
stations.
Manual Client Configuration
The client stations can also be manually configured with the contents of the profile served by the
SPA9000.
The following XML file is served by the SPA9000 when a client station requests /spa$PSN.cfg
1
tftp://spa-9000-ip-address:69/cfg/init_$MA.xml
The following XML file is served by the SPA9000 when client station requests /cfg/init_$MA.xml:
next-available-user-id
1
next-available-user-id
Linksys SPA9000 Administrator Guide
2-28
Document Version 3.01
Chapter 2
Getting Started
Advanced Methods of Configuration
1
next-available-user-id
1
next-available-user-id
1
next-available-user-id
client-station-mac-address
1
10
tftp://spa-9000-ip-address:69/cfg/generic.xml
1
The following XML file is served by the SPA9000 when a client station requests /cfg/generic.xml:
0
3600
spa-9000-admin-passwd
phone-ext-password
spa-9000-ip-address:proxy-listen-port
spa-9000-ip-address:proxy-listen-port
vmm
vm
vm
spa-9000-multicast-address
phone-upgrade-rule
phone-dial-plan
1
1
time-zone
daylight-saving-time
Table 2-3 lists the variables used in these XML files.
Table 2-3
Variables Used in XML Configuration Files
Variable
Description
spa-9000-ip-address
IP address of the SPA9000 SIP Proxy.
proxy-listen-port
Port at which the SPA9000 SIP Proxy is listening. This value is
configured in .
client-station-mac-address
This is the MAC address of the client station who is requesting the
profile /cfg/init_$MA.xml (in other words, the $MA portion of the
requested filename).
next-available-user-id
The current value of .
Phone-upgrade-rule
Upgrade rule to be used by the client stations. This value is
configured in .
Phone-dial-plan
Dial plan to be used by the client stations. This value is configured
in .
time-zone