Linksys SPA921 Cisco Small Business IP Telephony Devices Provisioning Guide
Linksys SPA921 - Cisco - IP Phone Manual
UPC - 745883570799
View all Linksys SPA921 manuals
Add to My Manuals
Save this manual to your list of manuals |
Linksys SPA921 manual content summary:
- Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 1
PROVISIONING GUIDE Cisco Small Business Voice System, Voice Gateways, and IP Telephones - Linksys SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 5
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 Telephony Devices Provisioning Guide iii - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 7
" using the scripting language to create a configuration profile. Chapter 4, "Provisioning This chapter provides a systematic reference for Field Reference" each parameter on the Provisioning tab of the administration web server. Cisco Small Business IP Telephony Devices Provisioning Guide v - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 8
PDF file. STEP 1 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. If the Find tool does displays the first instance of the search term. Cisco Small Business IP Telephony Devices Provisioning Guide vi - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 9
Browse for Location. Then choose the location on your computer or local 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 11
an alphabetical listing of each parameter, hyperlinked to the appropriate table in Chapter 4, "Provisioning Field Reference" Indicates a variable that should be replaced with a literal value. Indicates code samples or system output. Cisco Small Business IP Telephony Devices Provisioning Guide ix - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 12
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 residential and small - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 14
Small Business 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 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 15
1 Initial Provisioning Cisco Small Business IP Telephony Devices provide convenient mechanisms for initial provisioning, based on two deployment models: • Retail distribution In this model, the customer purchases the IP Telephony Device from a retail outlet and subsequently requests VoIP service - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 16
signs on to the service and establishes a VoIP account, possibly through an online portal with an Internet Telephony Service Provider (ITSP). Subsequently, the customer binds the particular device to the assigned service account. Cisco Small Business IP Telephony Devices Provisioning Guide 14 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 17
. In this case, you can use automatic 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 - Linksys SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 25
Provisioning Cisco Small Business VoIP Devices Provisioning Setup 1 As indicated in the lower half of the diagram, a Cisco Small Business Client Certificate Root Authority signs each unique certificate. The corresponding root certificate is made available to service providers for client - Linksys SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 28
Provisioning Cisco Small Business VoIP Devices Provisioning Setup 1 Enabling HTTPS For increased security managing remotely deployed units, the IP Telephony Device supports HTTPS for provisioning. To this end, each newly manufactured IP Telephony Device carries a unique SLL Client Certificate (and - Linksys SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 31
Provisioning Cisco Small Business VoIP Devices Where to Go From Here 1 • For firmware upgrades: - Log_Upgrade_Request_Msg - Log_Upgrade_Success_Msg - Log_Upgrade_Failure_Msg These parameters are macro expanded into the actual syslog messages. Where to Go From Here The following table summarizes - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 32
Any parameters that are not specified by a profile are left at the factory default values. The IP Telephony Device accepts a configuration profile in two formats: • Open Format (XML-style). See Open Format Configuration File, page 31. Cisco Small Business IP Telephony Devices Provisioning Guide 30 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 34
Provisioning Scripts Open Format Configuration File 2 tftp://prov.telco.com:6900/cisco/config/spa962.cfg A file can include element tags, attributes, and formatting features. Element tags: • The IP Telephony Device recognizes elements with proper parameter names - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 35
Provisioning Scripts Open Format Configuration File 2 • Element tags are case sensitive. • Empty element tags are allowed. • Unrecognized element names the IP Telephony Device, except for the user-access attribute: ua. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 36
Provisioning Scripts 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 a value are converted to spaces. Cisco Small Business IP Telephony Devices Provisioning Guide 34 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 37
Creating Provisioning Scripts Open Format Configuration File 2 • An XML header of the form is allowed, but is ignored by the IP Telephony Device. • firmware does not support the full Unicode character set, but only the ASCII subset. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 38
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 Devices Provisioning Guide 36 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 40
CFG file. This option requires that the key used to encrypt the file be preprovisioned in the target device, so that it can be decoded. Cisco Small Business IP Telephony Devices Provisioning Guide 38 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 41
to generate sample configuration source files (for both plain text and XML formats), corresponding to the accompanying firmware release. The config.xml to be fed directly to a device running 2.0.6 or above: spc --sample-xml config.xml Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 42
. To derive the element name from the field name, subsitute an underscore for spaces and the following special characters: [ ] ( ) / For example, the Resync On Reset field is represented by the following element: Cisco Small Business IP Telephony Devices Provisioning Guide 40 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 43
Provisioning 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 value 7" ; Cisco Small Business IP Telephony Devices Provisioning Guide 41 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 44
* • Profile_Rule* • Log_Resync_* • Upgrade_Rule • Log_Upgrade_* Under certain conditions, some general purpose parameters (GPP_*) also undergo macro expansion, as explicitly indicated in the Optional Resync Arguments section. Cisco Small Business IP Telephony Devices Provisioning Guide 42 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 45
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 43 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 46
Provisioning Scripts Proprietary Plain-Text Configuration File 2 Conditional Expressions Conditional expressions can trigger resync events and select from alternative URLs for resync and upgrade Quoted String Operands Yes Yes No No Cisco Small Business IP Telephony Devices Provisioning Guide 44 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 47
"( expr )?" as in the following 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 45 - Linksys SPA921 | 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 SPA921 | 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 following examples: [--key $SC] [--key "$SD"] Cisco Small Business IP Telephony Devices Provisioning Guide 47 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 51
configured alias map. The element itself can be nested further. In the example above, GPP_M could have contained the following instead: /SIP-Credentials/name = /flat-profile/Display_Name_1_ ; /SIP alias a --key abracadabra321 --post c] Cisco Small Business IP Telephony Devices Provisioning Guide 49 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 52
macro names SA through SD identify GPP_SA through GPP_SD as a special case when used as arguments of the key URL option. For example, if GPP_A contains the string ABC, and GPP_B contains 123, the expression $A$B macro expands into ABC123. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 53
, it waits no longer than Forced_Resync_Delay (seconds). A resync may cause configuration parameter values to change. This, in turn, causes a firmware reboot, which terminates any voice connection active at the time of the resync. Cisco Small Business IP Telephony Devices Provisioning Guide 51 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 55
could be supplied by still another profile, stored on a separate server. Whenever a resync operation is due, the IP Telephony Device evaluates the four Profile_Rule* parameters in sequence: 1. Profile_Rule 2. Profile_Rule_B Cisco Small Business IP Telephony Devices Provisioning Guide 53 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 56
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 the remote provisioning server. http://remote.server.com/cisco/$MA.cfg Cisco Small Business IP Telephony Devices Provisioning Guide 54 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 57
is useful for development and debugging. The report syntax is similar to the XML profile. All provisionable parameters are included, except for the values 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 58
configuration: [ --key secretphrase ] http://prov.serv.net/spa/$MA/rep.xml.enc Once the report rule is configured, an actual report can be generated and transmitted by sending the device a SIP upgrade to the specified URL is attempted. Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 59
changed, following macro expansion and evaluation of the rule. In order to attempt a firmware upgrade, the device disables audio at the start of the procedure, and reboots at the end of the procedure. For this reason, an upgrade driven by the contents of Upgrade_Rule is only automatically initiated - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 61
Creating Provisioning Scripts Data Types 2 Example 1: 60(2/4) Number of Cadence Sections = 1 Cadence Section 1: Section Length = 60 s 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 62
dBm • ToneScript-A mini-script that specifies the frequency, level and cadence parameters of a call progress tone. May contain up to 127 characters. Syntax: FreqScript;Z1[;Z2]. The , with Frequencies 1 and 2 Total Tone Length = 10s Cisco Small Business IP Telephony Devices Provisioning Guide 60 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 63
Creating Provisioning Scripts Data Types 2 Example 2-Stutter tone: 350@-19,440@-19;2(.1/.1/1+2);10(*/0/1+2) Number of Frequencies = 2 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 64
takes effect in the IP Telephony Device. • A parameter specification with an empty parameter value forces the parameter back to its default value. To specify an empty string instead, use the empty string "" as the parameter value. Cisco Small Business IP Telephony Devices Provisioning Guide 62 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 65
between provisioning servers and Cisco Small Business voice devices, it is useful to install an Ethernet packet sniffer (such as the freely downloadable Ethereal/Wireshark). For HTTPS transactions, you can use the ssldump utility. Cisco Small Business IP Telephony Devices Provisioning Guide 63 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 66
text file using the SIP Profiler Compiler (SPC). The examples in this tutorial use configuration profiles with XML-style configuration profile format uses the XML-style syntax: 12345678 Cisco Small Business IP Telephony Devices Provisioning Guide - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 67
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. For example, if the IP address is 192.168.1.100): http://192.168.1.100/admin/advanced STEP 8 The Provisioning tab in the admin/advanced page - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 68
is about to resync to a provisioning server and after 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 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 70
syntax can include identifying information specific to each IP Telephony Device (such as MAC address and serial number) via macro expansion of built-in variables. This eliminates the need to specify these values within each profile. Cisco Small Business IP Telephony Devices Provisioning Guide 68 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 71
with the actual MAC address of the IP Telephony Device. STEP 3 Open the admin/advanced page, Provisioning tab. STEP 4 Enter the following value in the Profile_Rule parameter: tftp://192.168.1.200/spa$MA.cfg STEP 5 Click Submit All Changes. This causes an immediate reboot and resync. When the - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 72
contain 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 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 73
messages sent by the IP Telephony Device. The periodic resyncs should now be obtaining the profile from the HTTP server. Also, the server should be logging each request if connection logging is enabled in the server configuration. Cisco Small Business IP Telephony Devices Provisioning Guide 71 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 74
service provider must install and set up the HTTPS server. In addition, an SSL server certificate signed by Cisco must be installed on the provisioning server. The devices cannot resync to a server using HTTPS, unless the server supplies a Cisco-signed server certificate. Cisco Small Business IP - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 76
. Nevertheless, the SSL key exchange within the HTTPS connection between the test IP Telephony Device and the server can be observed using the ssldump utility. The utility trace shows the interaction between client and server. Cisco Small Business IP Telephony Devices Provisioning Guide 74 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 77
the information in the certificate identifies the resyncing IP Telephony Device and supplies it with the correct configuration information. The HTTPS server makes the certificate assumes that Apache (v.2) is used as the HTTPS server. Cisco Small Business IP Telephony Devices Provisioning Guide 75 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 79
deflated file in place of the original XML file, as in the following example: tftp://192.168.1.200/basic.txt.gz STEP 5 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 80
on the test device to resync to the encrypted file in place of the original XML file. The encryption key is made known to 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 81
.txt STEP 4 Click Submit All Changes. The IP Telephony Device now resyncs to both the first and second profiles, in that order, whenever a resync operation is due. STEP 5 Observe the syslog trace to confirm the expected behavior. Cisco Small Business IP Telephony Devices Provisioning Guide 79 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 82
; /customer-account/SIP-password = /flat-profile/Password_1_ ; STEP 4 Edit the Profile_Rule to point to the new XML profile, and also specify the alias map as a URL option, as follows: [--alias a ] tftp://192.168.1.200/customer.xml Cisco Small Business IP Telephony Devices Provisioning Guide 80 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 83
Win32 environment, Linux ELF, and OpenBSD. STEP 2 Generate the text profile account.txt containing the two-line profile shown in the following example: User_ID[1] "17775551234" ; Password[1] "512835907884" ; Cisco Small Business IP Telephony Devices Provisioning Guide 81 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 85
Purpose Parameters, page 90 • Macro Expansion Variables, page 91 • Internal Error Codes, page 94 The Provisioning parameters described in this chapter are recognized by the IP Telephony Devices beginning with firmware release 2.0.6. Cisco Small Business IP Telephony Devices Provisioning Guide 83 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 86
every reboot except for reboots caused by 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 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 87
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 Small Business IP Telephony Devices Provisioning Guide 85 - Linksys SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 90
report is an XML file containing the name and value of all the device parameters. This parameter may optionally contain an encryption key. For example: [ --key $K ] tftp://ps.callhome.net/$MA/ rep.xml.enc The default value is (empty). Cisco Small Business IP Telephony Devices Provisioning Guide 88 - Linksys SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 94
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 that $SA - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 95
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 path, as obtained after parsing resync or upgrade URL. Cisco Small Business IP Telephony Devices Provisioning - Linksys SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 100
SIP_100REL_Enable[1] "No" ; Blind_Attn-Xfer_Enable[1] "No" ; SIP_Proxy-Require[1] "" ; Auth_Resync-Reboot[1] "Yes" ; SIP_Remote-Party-ID[1] "No" ; # *** Proxy and Registration Proxy[1] Use_Outbound_Proxy[1] "" ; "No" ; Cisco Small Business IP Telephony Devices Provisioning Guide 98 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 102
Configuration Idle_Polarity[1] Caller_Conn_Polarity[1] Callee_Conn_Polarity[1] "Forward" ; # options: Forward/Reverse "Forward" ; # options: Forward/Reverse "Forward" ; # options: Forward/Reverse # *** Call Forward [1] Cisco Small Business IP Telephony Devices Provisioning Guide 100 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 103
Example Configuration Profile A Cfwd_Sel8_Dest[1] Cfwd_Last_Caller[1] Cfwd_Last_Dest *** Supplementary Service Settings CW_Setting[1] VM Becomes 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 104
Example Configuration Profile Auth_Resync-Reboot[2] "Yes 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 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 106
[2] Block_ANC_Setting[2] DND_Setting[2] CID_Setting[2] CWCID_Setting[2] Dist_Ring_Setting[2] Secure_Call_Setting[2] ! "Yes" ; ! "No" ; ! "No" ; ! "No" ; ! "Yes" ; ! "Yes" ; ! "Yes" ; "No" ; # *** Distinctive Ring Settings Cisco Small Business IP Telephony Devices Provisioning Guide 104 - Linksys SPA921 | 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] Ring6_Caller[2] Ring7_Caller[2] Ring8_Caller[2] 60(.3/.2,1/.2,.3/4)" ; "60(.8/.4,.8/4)" ; "60(.4/.2,.3/.2,.8/4)" ; Cisco Small Business IP Telephony Devices Provisioning Guide 105 - Linksys SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 109
Example Configuration Profile Cfwd_All_Act_Code Cfwd_All_Deact_Code ; "*027111" ; "*01723" ; "*02723" ; "*0172616" ; "*0272616" ; "*0172624" ; "*0272624" ; "*0172632" ; "*0272632" ; "*0172640" ; "*0272640" ; "*01729" ; Cisco Small Business IP Telephony Devices Provisioning Guide A 107 - Linksys SPA921 | 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 SPA921 | 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 SPA921 | 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 SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 113
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 Telephony Devices Provisioning Guide 111 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 114
Protocol Transmission Control Protocol User Agent Micro-controller User Datagram Protocol Uniform Resource Locator Voicemail Visual Message Waiting Indication/Indicator Voice Quality Wide Area Network Extensible Markup Language B Cisco Small Business IP Telephony Devices Provisioning Guide 112 - Linksys SPA921 | Cisco Small Business IP Telephony Devices Provisioning Guide - Page 115
.com/community/ smallbizsupport/voiceandconferencing Phone Support www.cisco.com/en/US/support/ tsd_cisco_small_business_support_center_contacts.html Warranty and End www.cisco.com/go/warranty User License Agreement Cisco Small Business IP Telephony Devices Provisioning Guide 113 - Linksys SPA921 | 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