Linksys SPA942 Cisco Small Business IP Telephony Devices Provisioning Guide
Linksys SPA942 - Cisco - IP Phone Manual
UPC - 745883569113
View all Linksys SPA942 manuals
Add to My Manuals
Save this manual to your list of manuals |
Linksys SPA942 manual content summary:
- Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 1
PROVISIONING GUIDE Cisco Small Business Voice System, Voice Gateways, and IP Telephones - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 2
, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco Nurse Connect, Cisco Stackpower, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 3
Provisioning Setup Software Tools Server Configuration TFTP HTTP Enabling HTTPS Syslog Server Where to Go From Here Chapter 2: Creating Provisioning Scripts Configuration Profile and the SIP Profile Compiler Open Format Configuration File Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 4
Rule Upgrade Rule Data Types Chapter 3: Provisioning Tutorial Preparation Basic Resync TFTP Resync Logging with syslog Automatic Resync Unique Profiles and Macro Expansion URL Resolution HTTP GET Resync Secure Resync Basic HTTPS Resync Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 5
Parameters Firmware Upgrade Parameters General Purpose Parameters Macro Expansion Variables Internal Error Codes Appendix A: Example Configuration Profile Appendix B: Acronyms Appendix C: Where to Go From Here Contents 74 75 77 77 78 79 80 81 83 84 89 90 91 94 95 109 113 Cisco Small Business IP - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 6
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 10/100 Ethernet port for connecting another device to the LAN Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 7
Ethernet (PoE), 10/100 switch, BlueTooth, WiFi 802.11g, USB port, MP3 player. - WIP310-One line, hi-resolution color display. WiFi 802.11g Document Audience This document is written for service providers who offer services using Cisco Small Business VoIP products and specifically for administrative - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 8
provides links to resources for information and support. Finding Information in PDF Files The guides for Cisco Small Business products are available as Enter your search terms in the Find text box on the toolbar. NOTE By default, the Find tool is available at the right end of the Acrobat toolbar. - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 9
network, and click OK. c. If you want to specify additional search criteria, click Use Advanced Search Options, and choose the options you want. d. Click Search. Cisco Small Business IP Telephony Devices Provisioning Guide vii - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 10
Preface STEP 4 When the Results appear, click + to open a folder, and then click any link to open the file where the search terms appear. For more information about the Find and Search functions, see the Adobe Acrobat online help. Cisco Small Business IP Telephony Devices Provisioning Guide viii - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 11
Angle brackets () are used to identify parameters that appear on the configuration pages of the administration web server. The index at the end of this document contains an value. Indicates code samples or system output. Cisco Small Business IP Telephony Devices Provisioning Guide ix - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 12
12 • Configuration Access Control, page 16 • Using HTTPS, page 19 • Provisioning Setup, page 23 • Where to Go From Here, page 29 Residential Deployment Provisioning Requirements Cisco Small Business IP Telephony Devices are primarily intended for high-volume deployments by VoIP service providers to - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 13
reason, the service provider may wish to encrypt the configuration profile communication between the provisioning server and the IP Telephony Device, in addition to restricting access to the administration web server for the device. Cisco Small Business IP Telephony Devices Provisioning Guide 11 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 14
VoIP Devices Provisioning Overview 1 Provisioning Overview The Cisco Small Business IP Telephony Devices support secure remote provisioning and firmware upgrades. Configuration profiles can be generated by by using common, open source tools that facilitate integration into service provider - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 15
models: • Retail distribution In this model, the customer purchases the IP Telephony Device from a retail outlet and subsequently requests VoIP service from the service provider. The service provider must then support secure remote configuration of the unit. • Bulk distribution In this model, the - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 16
with the A-records responds, the IP Telephony Device logs an error to the syslog server. Retail Provisioning The firmware for each IP Telephony Device includes an administration web server that displays the internal configuration and accepts new configuration parameter values. The server also - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 17
inhouse preprovisioning. With the factory default configuration, an IP Telephony Device automatically tries to resync to a specific file on a TFTP server, whose IP address is offered as one of the DHCP-provided parameters. A service provider can connect each new IP Telephony Device to a LAN - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 18
service provider can completely disable any user access to the administration web server. • The factory reset control using the IVR can be disabled via provisioning. • The Internet domains accessed by the device for resync, upgrades, and SIP registration for Line 1 can be restricted. Configuration - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 19
Software Type page appears, choose Profile Compiler (SPC) Tool. STEP 5 In the next step, choose the latest release of firmware. STEP 6 Follow the instructions on the screen to continue through the steps in the download process. Cisco Small Business IP Telephony Devices Provisioning Guide 17 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 20
: http://x.x.x.x/admin/resync?prvserv/ device.cfg where x.x.x.x is the IP address of the IP Telephony Device and prvserv is the target TFTP server, and device.cfg is the name of the configuration file on the server. • Edit Profile_Rule parameter. Open the provisioning pane on the web interface, and - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 21
Provisioning Cisco Small Business VoIP Devices Using HTTPS 1 Flow Step SEC-PRV-1 SEC-PRV-2 Step Description Secure Provisioning-Initial Configuration: The initial deviceunique CFG file should be targeted to each IP Telephony Device by compiling the CFG file with the spc --target option. This - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 22
IP Telephony Device, or any attempt to spoof the provisioning server. Without such protection, an attacker might be able to reprovision the IP Telephony Device, to gain configuration information, or to use a different VoIP service. Cisco Small Business IP Telephony Devices Provisioning Guide 20 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 23
Provisioning Cisco Small Business VoIP Devices Using HTTPS 1 Client Certificates In addition to a direct attack on an IP Telephony Device, an attacker might attempt to contact a provisioning server by using a standard web browser or other HTTPS client, to obtain the configuration profile from the - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 24
Provisioning Cisco Small Business VoIP Devices Using HTTPS Certificate Authority Flow 1 Cisco Small Business IP Telephony Devices Provisioning Guide 22 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 25
• Ethernet packet analyzer (such as the freely downloadable Ethereal/ Wireshark): to verify secure exchanges between provisioning servers and Cisco Small Business voice devices • The ssldump utility: for monitoring HTTPS transactions Cisco Small Business IP Telephony Devices Provisioning Guide 23 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 26
Cisco Small Business VoIP Devices Provisioning Setup 1 Server Configuration Provisioning requires the availability of servers, which for testing purposes can be installed and run on a local PC: • TFTP (UDP port 69) • HTTP (TCP port 80) • HTTPS (TCP port 443) • Syslog (UDP port 514) To troubleshoot - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 27
The supplied information conveys manufacturer, product name, current firmware version, and product serial number. For example, the following is the User-Agent request field from a SPA962: User-Agent: cisco/SPA-962-2.0.5 (88012BA01234) Cisco Small Business IP Telephony Devices Provisioning Guide 25 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 28
CN=sprov.callme.com CN=pv.telco.net/mailto:[email protected] CN=prof.voice.com/[email protected] In addition to verifying the server certificate, the IP Telephony Device tests the server IP address against a DNS lookup of the server name specified in the server certificate. A certificate signing request - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 29
Provisioning Cisco Small Business VoIP Devices Provisioning Setup 1 In addition, Cisco also provides a Sipura CA Client Root Certificate to the service provider. This root certificate certifies the authenticity of the client certificate carried by each IP Telephony Device. The unique client - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 30
Provisioning Cisco Small Business VoIP Devices Provisioning Setup 1 Refer to the documentation provided for an HTTPS server for specific information. Firmware release 2.0.6 supports the following cipher suites for SSL connection to a server using HTTPS. Future release updates may implement - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 31
... Learn to work with Cisco provisioning scripts and configuration profiles. Review step-by-step procedures for using the scripting language to create a configuration profile. Refer to the function and usage of each parameter on the Provisioning tab of the administration web server. View a sample - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 32
Guide, the ATA Administration Guide, the WRP400 User Guide, or the SPA and Wireless IP Phone Administration Guide. Each guide describes the parameters that can be configured through the administration web server, which likewise are used in configuration profiles. Configuration Profile and the SIP - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 33
download the SPC tool, see see Downloading the SIP Profile Compiler (SPC) Tool, page 17. To run the SPC tool, open a command prompt, and then run the executable file. Open Format Configuration > 7200 Cisco Small Business IP Telephony Devices Provisioning Guide 31 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 34
must be unique. In the administration web pages, the same fields may appear on multiple web pages, such as the Line, User, and Extension pages. Append [n] to the element name to indicate the number that is shown in the page tab. For example, the Dial Plan for Line 1 is represented by the following - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 35
> Attributes: • Element attributes are allowed. Their value must be enclosed by double quotes. All such attributes are ignored by the IP Telephony Device, except for the user-access attribute: ua. Cisco Small Business IP Telephony Devices Provisioning Guide 33 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 36
Open Format Configuration File 2 • The user-access attribute defines access to the administration web server for a specific parameter by the User account. Access by the Admin account is unaffected by this attribute. • The ua attribute, if present, must have one of the following values: - na-no - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 37
than symbols that are required in a dial plan rule. This example defines an information hotline dial plan, which sets the Dial_Plan[1] parameter equal firmware does not support the full Unicode character set, but only the ASCII subset. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 38
for download from various Internet sites, can be used to perform the encryption. Note that support for 256-bit AES encryption may require recompilation of the tool (so as to enable the AES code). The firmware has been tested against version openssl-0.9.7c. Cisco Small Business IP Telephony - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 39
the load on the HTTPS server in large scale deployments. The final file name does not need to follow a specific format, but it is conventional to end the name with the .cfg extension to indicate that it is a configuration profile. Cisco Small Business IP Telephony Devices Provisioning Guide 37 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 40
the SPC The SPC can generate different types of configuration files, using different types of encryption. • file without an explicit key, but uses the MAC address of the target IP Telephony Device, and only that device can decode it Cisco Small Business IP Telephony Devices Provisioning Guide 38 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 41
. SPC can also be used to generate sample configuration source files (for both plain text and XML formats), corresponding to the accompanying firmware release. The commands for producing sample files are : spc --sample-xml config.xml Cisco Small Business IP Telephony Devices Provisioning Guide 39 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 42
of the parameter remains unchanged in the IP Telephony Device. The syntax also controls the User account access to the parameter in the administration web server. An optional exclamation point or question mark, immediately following the parameter name, indicates the parameter should be read-write - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 43
Scripts Proprietary Plain-Text Configuration File 2 • Each element name must be unique. For fields that are duplicated on multiple Line, User, or Extension pages, you must append [n] to indicate the line, user, or extension number. For example, the Dial Plan for Line 1 is represented by the - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 44
Creating Provisioning Scripts Proprietary Plain-Text Configuration File 2 When compiled, spa1234.txt becomes: controlling the resync and upgrade activities of the IP Telephony Device. The parameter Optional Resync Arguments section. Cisco Small Business IP Telephony Devices Provisioning Guide 42 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 45
The administrator enters: $(MAU:4) The resulting macro expansion for a device with MAC address 000E08012345 is: 08012345 The administrator enters: $(MAU:8:2) The resulting macro expansion for a device with MAC address 000E08012345 is: 23 Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 46
Plain-Text Configuration File 2 Conditional Expressions Conditional expressions can trigger resync events and select from alternative URLs for resync and upgrade operations. Yes Applicable to Quoted String Operands Yes Yes No No Cisco Small Business IP Telephony Devices Provisioning Guide 44 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 47
legacy support of firmware versions upgrade rule example: ( $SWVER ne 2.0.6 )? http://ps.tell.com/sw/spa021024.bin On the other hand, the syntax above using parentheses should not be used when configuring the Resync_Trigger_* parameters. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 48
configuration files and firmware loads in Profile_Rule* and Upgrade_Rule parameters, respectively. The syntax is as follows: [ scheme:// ] [ server [:port]] filepath Where scheme is one of the following values: • tftp • http • https Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 49
Creating Provisioning Scripts Proprietary Plain-Text Configuration File 2 If scheme is omitted, tftp is assumed. The server can be a DNS-recognized host name or a numeric IP address. The port is the destination UDP or TCP port number. The filepath must begin with the root directory (/). In other - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 50
the SIP registration parameters: name, number, auth-secret, enclosed in an XML element hierarchy as follows: J. Smith 14085551234 732091751563sfd Cisco Small Business IP Telephony Devices Provisioning Guide 48 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 51
Proprietary Plain-Text Configuration File 2 To map these three parameters directly to the Display_Name_1_, User_ID_1_, and Password_1_ parameters (Line 1), enter this mapping in a general purpose parameter (for example, GPP_M): /CPE/SIP-Credentials/name = /flat-profile - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 52
Upgrade Rule, page 56 General Purpose Parameters The general purpose parameters GPP_* are used as free string registers when configuring the IP Telephony Device to interact with a particular provisioning server solution. The GPP_* parameters are empty by default macro names (A macro names SA through - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 53
resync and upgrade URL commands issued through the administration web server. Both of these parameters are set to yes by default. In addition, the Resync_From_SIP parameter controls requests for resync operations via a SIP NOTIFY event sent from the service provider proxy server to the IP Telephony - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 54
Profile resyncs and upgrades provide for automatic retries in case of failure, in addition to periodic configuration updates. Time intervals are specified via three parameters, which are usually specified as a specific interval duration, in seconds. Starting with firmware version 3, these parameters - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 55
, the device retries the upgrade in 30 minutes, then again after one more hour, then in two hours. If it still fails, it subsequently retries every four to five hours, until it succeeds. Profile Rules The IP Telephony Device provides multiple remote configuration profile parameters (Profile_Rule - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 56
part of that alternative, an attempt is made to download the profile located at the specified URL, and update the internal parameters accordingly. If all alternatives have conditional . http://remote.server.com/cisco/$MA.cfg Cisco Small Business IP Telephony Devices Provisioning Guide 54 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 57
default value for Resync_Fails_On_FNF is Yes. Report Rule The IP Telephony Device provides a mechanism for reporting its current internal configuration to of passwords, keys, and the GPP_SA to GPP_SD parameters, which are not shown. Cisco Small Business IP Telephony Devices Provisioning Guide 55 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 58
SIP NOTIFY report request generates one attempt to transmit the report. Retries are not supported. Upgrade Rule The IP Telephony Device provides one configurable remote upgrade . Then, an upgrade to the specified URL is attempted. Cisco Small Business IP Telephony Devices Provisioning Guide 56 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 59
of scheme + server + port + filepath is changed, following macro expansion and evaluation of the rule. In order to attempt a firmware upgrade, the device disables audio . • Float-A floating point value with up to n decimal places. Cisco Small Business IP Telephony Devices Provisioning Guide 57 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 60
• IP-IP Address in the form of x.x.x.x, where x between 0 and 255. For example 10.1.2.100. • Port-TCP/UDP Port number (0-65535). It can be specified in decimal of hex format. • UserID-User ID as appeared in a URL; up to 63 characters. • FQDN-Fully Qualified Domain Name, such as "sip.Cisco.com:5060 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 61
L1-L6 are corresponding levels in dBm (with up to 1 decimal places). White spaces before and after the comma are allowed (but not recommended). Example 1-Call Waiting Tone: 440@-10 Cisco Small Business IP Telephony Devices Provisioning Guide 59 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 62
specifies the frequency, level and cadence parameters of a call progress tone. May contain up to 127 characters. in a segment, the components are summed together. Example 1-Dial tone: 350@-19,440@-19;10(*/0/1+2) Number of Frequencies Cisco Small Business IP Telephony Devices Provisioning Guide 60 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 63
=0.38s, Off=0s, with Frequency 2 Segment 3: On=0.38s, Off=0s, with Frequency 3 Segment 4: On=0s, Off=4s, with no frequency components Total Tone Length = 20s Cisco Small Business IP Telephony Devices Provisioning Guide 61 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 64
and firmware upgrade rules. • DialPlanScript-Scripting syntax used to specify Line 1 and Line 2 dial plans. NOTE • represents a configuration parameter name. In a profile, the corresponding tag is formed by replacing the space with an underscore "_", such as Par_Name. • An empty default - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 65
That establishes proper server operation independent of the interaction with Cisco Small Business VoIP devices. The pertinent servers include: syslog (UDP port 514), TFTP (UDP port 69), HTTP (TCP port 80), HTTPS (TCP port 443). For generating configuration profiles, it is useful to install the open - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 66
the SIP Profiler Compiler (SPC). The examples in this tutorial use configuration profiles the basic resync functionality of Cisco Small Business VoIP devices. It includes the IP Telephony Device supports multiple network protocols for retrieving configuration profiles. The most basic profile transfer - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 67
the analog phone, obtain the IP address of the IP Telephony Device (IVR menu **** 110 #). If the configuration has been modified since it was manufactured, perform factory reset on it by using the IVR RESET option (**** 73738#). STEP 7 Open the PC web browser on the admin/advanced configuration page - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 68
the resync has either completed or failed. This server is identified in the web server administration (admin/advanced, System tab, Syslog_Server parameter). It is instructive to configure the syslog server IP address into the device and observe the messages generated during each exercise. Exercise - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 69
STEP 1 Using the PC web browser, open the admin/advanced page, Provisioning tab. STEP 2 Define the Profile_Rule parameter. STEP 3 The following value assumes a TFTP server IP address of 192.168.1.200: tftp://192.168.1.200/basic.txt Cisco Small Business IP Telephony Devices Provisioning Guide 67 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 70
Telephony Device, in turn, must be configured to resync to its own profile, according to some predetermined profile naming convention. The profile URL syntax can include identifying information specific to each IP Telephony Device (such as MAC address and serial number) via macro expansion of built - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 71
. STEP 2 Copy the basic.txt configuration file to a new file named spa_mac_address.cfg and place the new file in the virtual root directory of the TFTP server. Replace mac_address with the actual MAC address of the IP Telephony Device. STEP 3 Open the admin/advanced page, Provisioning tab. STEP - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 72
a provisioning server name instead of an explicit IP address. In this case, the IP Telephony Device performs a DNS lookup to resolve the name. A non-standard server port can be specified in the URL, using the standard syntax :port following the server name. Also, the configuration profile can be - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 73
HTTP (with the GET method) simply means changing TFTP to HTTP in the URL defined in the Profile_Rule parameter. On the server side, the service provider must install and configure the HTTP server. The IP Telephony Device does not require any special configuration setting on the server to be able to - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 74
3 STEP 6 In the HTTP server logs, observe how information identifying the test IP Telephony Device appears in the log of user agents. This should include the manufacturer, product name, current firmware version, and serial number. Secure Resync This section demonstrates the preferred mechanisms - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 75
.txt configuration profile from the earlier exercises onto the virtual root directory of the HTTPS server. STEP 8 Verify proper server operation by downloading basic.txt from the HTTPS server, using a standard browser from the local PC. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 76
the file, given knowledge of the file name and directory location. For secure resync, the server must also authenticate the client, as demonstrated in the next exercise. HTTPS With Client Certificate Authentication In the factory default configuration, the server does not request an SSL client - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 77
request. For the purpose of illustration, this exercise uses the open source Perl scripting language, and assumes that Apache (v.2) is used as the HTTPS server. Cisco Small Business IP Telephony Devices Provisioning Guide 75 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 78
or else generic strings if it is a unit manufactured before firmware release 2.0. A similar script could be used to determine information about the resyncing device and then provide it with appropriate configuration parameter values. Cisco Small Business IP Telephony Devices Provisioning Guide 76 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 79
, page 79 • Parameter Name Aliases, page 80 • Proprietary Profile Format, page 81 Profile Compression A configuration profile in XML format can Click Submit All Changes. STEP 6 Observe the syslog trace from the IP Telephony Device. Cisco Small Business IP Telephony Devices Provisioning Guide 77 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 80
3 Upon resync, the new file is downloaded by the IP Telephony Device and used to update its parameters. The file size of such the IP Telephony Device with the following URL option: [--key MyOwnSecret ] tftp://192.168.1.200/basic.cfg Cisco Small Business IP Telephony Devices Provisioning Guide 78 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 81
Formats 3 STEP 5 Click Submit All Changes. STEP 6 Observe the syslog trace from the IP Telephony Device. On resync, the new file is downloaded by the IP Telephony Device and used to update its parameters. Partitioned Profiles An IP Telephony Device downloads multiple separate profiles during each - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 82
the following example: 17775551234 512835907884 STEP 2 Store the file in the TFTP server virtual root directory. STEP 3 Open the test web interface on the admin/advanced page, Provisioning tab, and edit - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 83
parameters. STEP 6 View the Line 1 tab to verify the new configuration. NOTE The IP Telephony Device supports alias remapping of a limited number of parameters. It is not meant to rename all parameters in its configuration. Proprietary Profile Format Firmware releases prior to 2.0.6 do not - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 84
Submit All Changes. Upon resync, the IP Telephony Device retrieves the new file, recognizes its binary format and updates the two specified parameters. STEP 7 Observe the syslog messages sent by the IP Telephony Device during resync. Cisco Small Business IP Telephony Devices Provisioning Guide 82 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 85
a listing of the parameters provided on the administration web server Provisioning tab, which can be used in configuration profile scripts. It includes the following sections: • Configuration Profile Parameters, page 84 • Firmware Upgrade Parameters, page 89 • General Purpose Parameters, page - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 86
parameter updates and firmware upgrades. The default value is Yes. The maximum value for a random time interval that the device waits before making its initial contact with the provisioning server. This delay is effective only on the initial configuration attempt following device power-on or reset - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 87
user to make calls in succession without interruption. The device has a timer that begins counting down when all of its lines become idle. This parameter is the initial value of the counter. Resync events are delayed until this counter decrements to zero. The default value is 14,400 seconds. Cisco - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 88
is obtained through DHCP option 66. In the URL, either the IP address or the FQDN of the server can be specified. The file name can have macros, such as $MA, which expands to the device MAC address. The default value is /spa$PSN.cfg. Cisco Small Business IP Telephony Devices Provisioning Guide 86 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 89
of a resync attempt. The default value is $PN $MAC - Successful resync $SCHEME:// $SERVIP:$PORT$PATH -- $ERR. The syslog message that is issued after a failed resync attempt. The default value is $PN $MAC - Resync failed: $ERR. Cisco Small Business IP Telephony Devices Provisioning Guide 87 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 90
same syntax as the Profile_Rule parameter, and resolves to a TCP/IP command with an associated URL. A configuration report is generated in response to an authenticated SIP NOTIFY message, with Event: report. The report is an XML file containing the name and value of all the device parameters. This - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 91
upgrade conditions and associated firmware URLs. The default value is (empty). The syslog message that is issued at the start of a firmware upgrade attempt. The default value is $PN $MAC -- Requesting upgrade $SCHEME://$SERVIP:$PORT$PATH. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 92
purpose provisioning parameters. These parameters can be used as variables in provisioning and upgrade rules. They are referenced by prepending the variable name with a '$' character, such as $GPP_A. The default value is (empty). Cisco Small Business IP Telephony Devices Provisioning Guide 90 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 93
in the parameter value after expansion. Parameter Name $ A through P Description and Default Value The form $$ expands to a single $ character. Replaced by the contents of the general purpose parameters GPP_A through GPP_P. Cisco Small Business IP Telephony Devices Provisioning Guide 91 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 94
Macro Expansion Variables Parameter Name SA through SD MA MAU MAC PN PSN SN CCERT IP EXTIP SWVER HWVER 4 Description and Default Value Replaced by the contents of the special purpose parameters GPP_SA through GPP_SD. These parameters are meant to hold keys or passwords used in provisioning. Note - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 95
use. Request target server host name, as obtained after parsing resync or upgrade URL. Request target server IP address, as obtained after parsing resync or upgrade URL, possibly following DNS lookup. Request target UDP/TCP port, as obtained after parsing resync or upgrade URL. Request target file - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 96
. SIP request times out while waiting for a response. General SIP protocol error (for example, unacceptable codec in SDP in 200 and ACK messages, or times out while waiting for ACK). Dialed number invalid according to given dial plan. Cisco Small Business IP Telephony Devices Provisioning Guide 94 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 97
"Manual" ; # options: Manual/Manual,DHCP/ "Parallel" ; # options: Parallel/Sequential "" ; "" ; "0" ; # options: 0/1/2/3 "" ; "" ; # *** Configuration Profile Provision_Enable Resync_On_Reset "Yes" ; "Yes" ; Cisco Small Business IP Telephony Devices Provisioning Guide 95 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 98
$SCHEME:// "$PN $MAC -- Upgrade failed: $ERR" ; # *** General Purpose Parameters GPP_A GPP_B GPP_C GPP_D GPP_E GPP_F GPP_G GPP_H GPP_I GPP_J GPP_K GPP_L GPP_M GPP_N GPP_O GPP_P GPP_SA GPP_SB GPP_SC GPP_SD # *** SIP Parameters Cisco Small Business IP Telephony Devices Provisioning Guide 96 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 99
Example Configuration Profile Max_Forward Max_Redirection Max_Auth SIP_User_Agent_Name flash" ; "No" ; "No" ; # *** SIP Timer Values (sec) SIP_T1 SIP_T2 SIP_T4 SIP_Timer_B SIP_Timer_F SIP_Timer_H SIP_Timer_D "telephone-event" ; Cisco Small Business IP Telephony Devices Provisioning Guide A 97 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 100
Example Configuration Profile A G711u_Codec_Name NAT Support Parameters line/1-line excl. OPT/1-line excl. NTFY/1-line excl. REG/1-line ID[1] "No" ; # *** Proxy and Registration Proxy[1] Use_Outbound_Proxy[1] "" ; "No" ; Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 101
" ; "Yes" ; "Yes" ; "Yes" ; "Yes" ; "Yes" ; # *** Audio Configuration Preferred_Codec[1] "G711u" ; G726-24/G726-32/G726-40/G729a/G723 Silence_Supp_Enable[1] "No" ; Use_Pref_Codec_Only[1] "No" ; # options: G711u/G711a/G726-16/ Cisco Small Business IP Telephony Devices Provisioning Guide 99 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 102
*** Dial Plan Dial_Plan[1] 9]xxxxxxS0|xxxxxxxxxxxx.)" ; Enable_IP_Dialing[1] "(*xx|[3469]11|0|00|[2-9]xxxxxx|1xxx[2"No" ; # *** FXS Port Polarity Configuration Idle_Polarity[1] Caller_Conn_Polarity[1] Callee_Conn_Polarity[1] "Forward" ; # options: Forward/Reverse "Forward" ; # options: Forward - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 103
Configuration Profile A Cfwd_Sel8_Dest[1] Cfwd_Last_Caller[1] Cfwd_Last_Dest[1] Block_Last_Caller[1] Accept_Last_Caller[1] # *** Speed Dial Available/New VM Arrives Ring_On_No_New_VM[1] "No" ; # *** Line_Enable[2] "Yes" ; Cisco Small Business IP Telephony Devices Provisioning Guide 101 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 104
[2] SRTP_Private_Key[2] No # *** Supplementary Service Subscription Call_Waiting_Serv[2] Block_CID_Serv[2] Block_ANC_Serv[2] Dist_Ring_Serv[2] Cfwd_All_Serv[2] Cfwd_Busy_Serv[2] "Yes" ; "Yes" ; "Yes" ; "Yes" ; "Yes" ; "Yes" ; Cisco Small Business IP Telephony Devices Provisioning Guide 102 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 105
"Yes" ; # *** Dial Plan Dial_Plan[2] 9]xxxxxxS0|xxxxxxxxxxxx.)" ; Enable_IP_Dialing[2] "(*xx|[3469]11|0|00|[2-9]xxxxxx|1xxx[2"No" ; # *** FXS Port Polarity Configuration Idle_Polarity[2] "Forward" ; # options: Forward/Reverse Cisco Small Business IP Telephony Devices Provisioning Guide 103 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 106
Configuration Profile A Caller_Conn_Polarity[2] Callee_Conn_Polarity[2] "Forward" ; # options: Forward/Reverse "Forward" ; # options: Forward/Reverse # *** Call Forward Settings Cfwd_All_Dest[2] Cfwd_Busy_Dest[2] Cfwd_No_Ans_Dest[2] Cfwd_No_Ans_Delay[2] 20" ; # *** Selective Call Forward - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 107
Example Configuration Profile A Ring1_Caller[2] Ring2_Caller[2] Ring3_Caller[2] Ring4_Caller[2] Ring5_Caller[2] "No" ; # *** Call Progress Tones Dial_Tone Second_Dial_Tone Outside_Dial_Tone ; "60(.4/.2,.3/.2,.8/4)" ; Cisco Small Business IP Telephony Devices Provisioning Guide 105 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 108
".1" ; ".9" ; "0" ; "5" ; "1800" ; "30" ; ".5" ; "30" ; "10" ; "3" ; "2" ; "0" ; # *** Vertical Service Activation Codes Call_Return_Code Blind_Transfer_Code Call_Back_Act_Code Call_Back_Deact_Code "*69" ; "*98" ; "*66" ; "*86" ; Cisco Small Business IP Telephony Devices Provisioning Guide 106 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 109
Configuration ; "*18" ; "*19 # *** Outbound Call Codec Selection Codes Prefer_G711u_Code Force_G711u_Code Prefer_G711a_Code Force_G711a_Code Prefer_G723_Code "*0172632" ; "*0272632" ; "*0172640" ; "*0272640" ; "*01729" ; Cisco Small Business IP Telephony Devices Provisioning Guide A 107 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 110
Example Configuration Profile A Force_G729a_Code "*02729" ; # *** Miscellaneous Set_Local_Date_(mm/dd) "" ; Set_Local_Time_(HH/mm) UK) FXS_Port_Power_Limit "3" ; # options: 1/2/3/4/5/6/7/8 Protect_IVR_FactoryReset "No" ; Cisco Small Business IP Telephony Devices Provisioning Guide 108 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 111
Noise Generation Calling Party Control Customer Premises Equipment Call Waiting Caller ID Call Waiting Tone Digital to Analog Converter decibel dB with respect to 1 milliwatt Dynamic Host Configuration Protocol Domain Name System Cisco Small Business IP Telephony Devices Provisioning Guide 109 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 112
Local Exchange Carrier Internet Protocol Internet Service Provider Internet Telephony Service Provider Interactive Voice Response Local Area Network Low Bit Rate Low Bit Rate Codec Mini-Certificate Media Gateway Control Protocol Cisco Small Business IP Telephony Devices Provisioning Guide B 110 - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 113
(SIP) Response Message (SIP) Response Status Code, such as 404, 302, 600 Real Time Protocol Round Trip Time Streaming Audio Server Session Description Protocol Synchronous DRAM seconds Session Initiation Protocol Shared line appearance Subscriber Line Interface Circuit Cisco Small Business IP - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 114
Acronyms SP SSL TFTP TCP UA uC UDP URL VM VMWI VQ WAN XML Service Provider Secure Socket Layer Trivial File Transfer Protocol Transmission Control Protocol User Agent Micro-controller User Datagram Protocol Uniform Resource Locator Voicemail Visual Message Waiting Indication/Indicator Voice - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 115
Voice Gateways/Analog Telephone Adapters: www.cisco.com/en/US/products/ps10024/ tsd_products_support_series_home.html IP Phones: www.cisco.com/en/US/products/ps10033/ tsd_products_support_series_home.html Firmware Downloads Go to tools.cisco.com/support/downloads, and enter the model number in - Linksys SPA942 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 116
and Safety Information Cisco Partner Central site for Small Business Cisco Small Business Home Location www.cisco.com/go/osln See the Technical Documentation pages listed above. www.cisco.com/web/partners/sell/smb www.cisco.com/smb Cisco Small Business IP Telephony Devices Provisioning Guide 114
Cisco Small Business
Voice System, Voice Gateways, and IP Telephones
PROVISIONING
GUIDE