hit counter script
Cisco SPA901-UK - Small Business Pro Provisioning Manual
  1. Manuals
  2. Brands
  3. Cisco Manuals
  4. Network Hardware
  5. SPA901-UK - Small Business Pro
  6. Provisioning manual
Cisco SPA901-UK - Small Business Pro Provisioning Manual

Cisco SPA901-UK - Small Business Pro Provisioning Manual

Voice system, voice gateways, and ip telephones
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
PROVISIONING
GUIDE
Cisco Small Business
Voice System, Voice Gateways, and IP Telephones

Advertisement

Table of Contents
loading

Related Manuals for Cisco SPA901-UK - Small Business Pro

Summary of Contents for Cisco SPA901-UK - Small Business Pro

  • Page 1 PROVISIONING GUIDE Cisco Small Business Voice System, Voice Gateways, and IP Telephones...

  • Page 2: Table Of Contents

    Contents About This Document Purpose Document Audience Organization Document Conventions Chapter 1: Provisioning Cisco Small Business VoIP Devices Small Business and Residential Deployment Provisioning Remote Endpoint Control and NAT Communication Encryption Provisioning Overview Remote Firmware Upgrade Initial Provisioning Deploying RC Units...
  • Page 3 Source Text Syntax Comments Macro Expansion Conditional Expressions Assignment Expressions URL Syntax Optional Resync Arguments Using Provisioning Parameters General Purpose Parameters Enables Triggers Configurable Schedules Profile Rules Report Rule Upgrade Rule Data Types Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 4 Chapter 4: Provisioning Field Reference Configuration Profile 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 Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 5: About This Document

    Preface About This Document This guide describes the provisioning of Cisco Small Business Voice over IP (VoIP) products. It contains the following sections: • Purpose, page iv • Document Audience, page v • Organization, page v • Document Conventions, page vi •...

  • Page 6: Document Audience

    WIP310—One line, hi-resolution color display. WiFi 802. 1 1g Document Audience This document is written for service providers who offer services using Cisco Small Business VoIP products and specifically for administrative staff responsible for remote provisioning and preprovisioning Cisco Small Business devices.

  • Page 7: Document Conventions

    Angle brackets (<>) identify parameters that appear on the configuration pages of the administration web server. Italic A variable that should be replaced with a literal value. Monospaced A code sample or system output. Font Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 8: Chapter 1: Provisioning Cisco Small Business Voip Devices

    Provisioning Cisco Small Business VoIP Devices This chapter describes the features and functionality available when provisioning Cisco Small Business IP Telephony devices and explains the setup required. It includes the following sections: • Small Business and Residential Deployment Provisioning, page 10 •...

  • Page 9: Remote Endpoint Control And Nat

    The service provider can encrypt the configuration profile communication between the provisioning server and the IP Telephony device, in addition to restricting access to the administration web server. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 10: Provisioning Overview

    Secure first-time provisioning is provided through a mechanism that uses SSL functionality. Remote customization (RC) units are customized by Cisco so that when the unit is NOTE started, it contacts the Cisco provisioning server to download its customized profile.

  • Page 11: Initial Provisioning

    It also discourages the use of Cisco Small Business IP Telephony devices with a different service provider.

  • Page 12: Redundant Provisioning Servers

    The server also accepts a special URL command syntax for performing remote profile resync and firmware upgrade operations. In a retail distribution model, a customer purchases a Cisco Small Business voice endpoint device and subscribes to a particular service. The customer signs on to the service and establishes a VoIP account, possibly through an online portal with an Internet Telephony Service Provider (ITSP).

  • Page 13: Automatic In-House Preprovisioning

    MAC address or serial number before being shipped to the customer. Upon receiving the unit, the customer connects the unit to the broadband link. On power-up the IP Telephony device contacts the server to for its resync update. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 14: Configuration Access Control

    The plain-text configuration file uses a proprietary format that can be encrypted by using the SIP Profile Compiler (SPC) to prevent the unauthorized use of confidential information. By convention, the encrypted profile is named with the extension .cfg (for example, spa962.cfg). Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 15 The SIP Profiler Compiler (SPC) is provided for compiling the plain-text file containing parameter-value pairs into an encrypted CFG file. The SPC is available from Cisco for the Win32 environment (spc.exe) and Linux-i386-elf environment (spc-linux-i386-static). For the OpenBSD environment, the SPC tool is made available on a case-by-case basis.

  • Page 16: Provisioning States

    TFTP server and request a configuration file identified by the MAC-address. For example, the following entry contacts a specific provisioning server, requesting a new profile unique to this unit: Profile_Rule tftp.callme.com/profile/$MA/ spa962.cfg; Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 17: Using Https

    IP Telephony device. To use HTTPS, you must generate a Certificate Signing Request (CSR) and submit it to Cisco. Cisco generates a certificate for installation on the provisioning server. The IP Telephony device accepts the certificate when it seeks to establish an HTTPS connection with the provisioning server.

  • Page 18: How Https Works

    Each secure provisioning server is issued a SSL server certificate, directly signed by Cisco. The firmware running on the IP Telephony device recognizes only a Cisco certificate as valid. When a client connects to a server by using HTTPS, it rejects any server certificate that is not signed by Cisco.

  • Page 19: Client Certificates

    Certificate Authority Flow figure illustrates the relationship and placement of certificates, public/private key pairs, and signing root authorities, among the Cisco client, the provisioning server, and the certification authority. The upper half of the diagram shows the Provisioning Server Root Authority that is used to sign the individual provisioning server certificate.
  • Page 20 Provisioning Cisco Small Business VoIP Devices Using HTTPS Certificate Authority Flow Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 21: Provisioning Setup

    Provisioning Cisco Small Business VoIP Devices Provisioning Setup 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 authentication purposes.

  • Page 22: Server Configuration

    NAT or other protection mechanisms. HTTP and HTTPS work more reliably than TFTP in remote deployments, especially when the deployed units are connected behind residential firewalls or NAT-enabled routers. Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 23 HTTPS for every resync request. In a small deployment within a single LAN environment, it is common to rely on a TFTP server for the provisioning of network devices. Cisco Small Business voice devices support TFTP for both provisioning resync and firmware upgrade operations.

  • Page 24: Https

    IP Telephony device resyncs by using HTTPS. The server certificate must be signed by the Cisco Server CA Root Key, whose certificate is carried by all deployed units. To obtain a...
  • Page 25 Provisioning Cisco Small Business VoIP Devices Provisioning Setup In addition, Cisco 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 certificate offered by each device during an HTTPS session carries identifying information embedded in its subject field.

  • Page 26: Syslog Server

    (configuration profile or firmware load), and at the conclusion of the operation (indicating either success or failure). The logged messages themselves are configured in the following parameters: • For profile resync: Log_Resync_Request_Msg Log_Resync_Success_Msg Log_Resync_Failure_Msg Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 27: Where To Go From Here

    Provisioning Reference” tab of the administration web server. View a sample profile. Appendix A, “Example Configuration Profile” Look up the expansion for an Appendix B, “Acronyms” acronyms use in this document. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 28: Chapter 2: Creating Provisioning Scripts

    Administration Guide, the ATA Administration Guide, the WRP400 User Guide, or the SPA and Wireless IP Phone Administration Guide. Each guide describes the parameters that are used in configuration profiles and can be configured through the administration web server. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 29: Configuration Profile And The Sip Profile Compiler

    To protect confidential information contained in the configuration profile, this file is generally delivered from the provisioning server to the IP Telephony device over a secure channel provided by HTTPS. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 30: Element Tags, Attributes, Parameters, And Formatting

    For example, the Resync On Reset field is represented by the following element: <Resync_On_Reset> Each element name must be unique. In the administration web pages, the same fields might appear on multiple web pages, such as the Line, Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 31 <Speed_Dial_7_2_ ua=”rw”/> <Speed_Dial_8_2_ ua=”rw”/> <Speed_Dial_9_2_ ua=”rw”/> </flat-profile> • You can enter an empty value to set the corresponding parameter to an empty string. Enter an opening and closing element without any value Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 32 Parameters • Any parameters that are not specified by a profile are left unchanged in the IP Telephony device. • Unrecognized parameters are ignored. Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 33 This example defines an information hotline dial plan that sets the Dial_Plan[1] parameter equal to ( S0 <:18005551212> ). <flat-profile> <Dial_Plan_1_> ( S0 &lt;:18005551212&gt; ) Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 34: Configuration File Compression

    The IP Telephony device inspects the downloaded file header to determine the format of the file. The choice of file name is not significant and any convention that is convenient for the service provider can be used. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 35: File Encryption

    This value is programmed by using one of the Profile_Rule parameters. The key must be preprovisioned into the unit at an earlier time. This bootstrap of the secret key can be accomplished securely by using HTTPS. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 36: Encrypting A File With The Spc

    It requires one randomizing argument. For example, spc --scramble SomeSecretPhrase spa962.txt spa962.cfg The resulting encrypted spa962.cfg is accepted as valid by any IP Telephony device that resyncs to it. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 37: Targeted

    –-aes –-hex-key 8d23fe7...a5c29 spa962.txt spa962.cfg Any combination of scrambling, targeting, and explicit-key encrypting can be applied to a CFG file, as shown by the following example: spc –-target 000e08aaa010 –-aes –-ascii-key VerySecret a.txt a.cfg Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 38: Status Messages

    CFG file. The plain-text format is an alternative to the open format for firmware releases 2.0.6 and later, and it is the only format recognized by firmware releases prior to 2.0.6. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 39: Source Text Syntax

    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 following element: <Dial_Plan[1]> Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 40 Param1 “new value overrides base” ; Param7 “particular value 7” ; When compiled, spa1234.cfg becomes: Param1 “base value 1” ; Param2 “base value 2” ; Param1 “new value overrides base” ; Param7 “particular value 7” ; Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 41: Comments

    In the following example, the expression $(MAU) is used to insert the MAC address 000E08012345. The administrator enters: spa$(MAU)config.cfg The resulting macro expansion for a device with MAC address 000E08012345 is: spa000E08012345config.cfg Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 42: Conditional Expressions

    All comparisons must be satisfied for the condition to be true. Each comparison can relate one of three types of literals: • Integer values • Software or hardware version numbers • Doubled-quoted strings Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 43 ! character (in place of the two-character != string). Conditional expressions typically involve macro-expanded variables. For example: $REGTMR1 gt 300 and $PRVTMR gt 1200 and “$EXTIP” ne “” $SWVER ge 2.0.6 and “$CCERT” eq “Installed” Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 44: Assignment Expressions

    The example above is equivalent to the following: ( User_ID_1_ = “uid$B” ; c = “” ; d = “$MA” ; )! White space can be used for readability. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 45: Url Syntax

    A filepath must be present. It need not necessarily refer to a static file, but can indicate dynamic content obtained through CGI. Macro expansion applies within URLs. The following are examples of valid URLs: /$MA.cfg /cisco/spa021025.bin 192.168.1.130/profiles/init.cfg tftp://prov.call.com/cpe/cisco$MA.cfg http://neptune.speak.net:8080/prov/$D/$E.cfg https://secure.me.com/profile?Linksys Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 46: Optional Resync Arguments

    Using POST provides a convenient alternative to the GET method when arbitrary state or identifying information needs to be supplied from the IP Telephony device to the server, as part of periodic resyncs. Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 47 (showing an example URL for completeness): [--alias m ] http://acct.voipservice.net/credentials/spa$MA.xml Upon receiving the profile, the IP Telephony device would apply the indicated translations, assigning J. Smith to Display_Name_1_, 14085551234 to User_ID_1_, and 732091751563sfd to Password_1_. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 48: Using Provisioning Parameters

    General Purpose Parameters, page 48 • Enables, page 48 • Triggers, page 49 • Configurable Schedules, page 50 • Profile Rules, page 51 • Report Rule, page 53 • Upgrade Rule, page 55 Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 49: General Purpose Parameters

    The Event: reboot_now and Event: restart_now headers perform cold and warm restarts, respectively, are also challenged. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 50: Triggers

    (which undergoes macro expansion). If the condition in any of these parameters evaluates to true, a resync operation is triggered, as though the periodic resync timer had expired. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 51: Configurable Schedules

    The last element in the sequence is implicitly repeated forever. For example, Resync_Periodic 7200 Resync_Error_Retry_Delay 1800,3600,7200,14400 Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 52: Profile Rules

    Encryption keys and certificate information 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...
  • Page 53 The following are some examples of valid programming for a single Profile_Rule* parameter. The following example resyncs unconditionally to the profile at the specified URL, performing an HTTP GET request to the remote provisioning server. http://remote.server.com/cisco/$MA.cfg Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 54: Report Rule

    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...
  • Page 55 SPA504G_<MAC>_<serial#>.xml, do one of the following: • On the phone Web GUI, set the Report Rule field on the Configuration Profile page (Voice tab > Provisioning tab > Configuration Profile) to: [--delta] http://reportTargetServer/reportPath/$PN_$MA_$SN.xml Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 56: Upgrade Rule

    URL. The following is another example: (“$F” ne “beta-customer”)? http://p.tel.com/firmware/spa021025.bin | http://p.tel.com/firmware/spa-test-0527s.bin This example directs the unit to load one of two images, based on the contents of a general purpose parameter, GPP_F. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 57: Data Types

    • Phone—A phone number string, such as 14081234567, *69, *72, 345678, or a generic URL such as 1234@10. 1 0. 1 0. 1 00:5068, or jsmith@Cisco.com. It can contain up to 39 characters. Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 58 Total Ring Length = 60s Example 2—Distinctive ring (short,short,short,long): 60(.2/.2,.2/.2,.2/.2,1/4) Number of Cadence Sections = 1 Cadence Section 1: Section Length = 60s Number of Segments = 4 Segment 1: On=0.2s, Off=0.2s Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 59 < 6 indicates which of the frequency components given in the FreqScript are used in that segment; if more than one frequency component is used in a segment, the components are summed together. Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 60 Cadence Section 2: Section Length = 10s Number of Segments = 1 Segment 1: On=forever, with Frequencies 1 and 2 Total Tone Length = 12s Example 3—SIT tone: 985@-16,1428@-16,1777@-16;20(.380/0/1,.380/0/2,.380/0/ 3,0/4/0) Number of Frequencies = 3 Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 61 • 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...

  • Page 62: Preparation

    • To troubleshoot server configuration, it is helpful to install clients for each type of server on a separate server machine. This establishes proper server operation, independent of the interaction with Cisco Small Business VoIP devices. The pertinent servers are:...

  • Page 63: Basic Resync

    This procedure is described in the “Proprietary Profile Format” section on page Basic Resync This section demonstrates the basic resync functionality of Cisco Small Business VoIP devices. It includes the following topics: •...

  • Page 64: Tftp Resync

    IVR RESET option (**** 73738#). Open the PC web browser on the admin/advanced configuration page. STEP 7 For example, if the IP address is 192. 1 68. 1 . 1 00): http://192.168.1.100/admin/advanced Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 65: Logging With Syslog

    STEP 2 change. Click the System tab and enter the value of your local syslog server into the Syslog_Server parameter. Repeat the TFTP Resync operation described in the previous exercise. STEP 3 Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 66: Automatic Resync

    To cause the IP Telephony Device to automatically and periodically resync to a server, a configuration profile URL is defined using the Profile_Rule parameter, and a resync period is defined using the Resync_Periodic parameter. Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 67 Device does not try to resync following a failed resync attempt. (Optional) Verify that the value of Resync_Error_Retry_Delay is set to a small STEP 9 number, such as 30, disable the TFTP server, and observe the results in the syslog output. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 68: Unique Profiles And Macro Expansion

    STEP 5 This causes an immediate reboot and resync. When the next resync occurs, the IP Telephony Device retrieves the new file by expanding the $MA macro expression into its own MAC address. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 69: Url Resolution

    Again, this is specified using standard URL notation. For example, the following is a valid Profile_Rule that requests the file spa962.cfg, in the server subdirectory /cisco/config, for the TFTP server running on host prov.telco.com, which listens for connection on port 6900.

  • Page 70: Http Get Resync

    STEP 5 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...

  • Page 71: Secure Resync

    URL in the Profile_Rule parameter from http to https. On the server side, the 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.
  • Page 72 –new –out provserver.csr This command generates a public/private key pair, which is saved in the privkey.pem file. Submit the CSR file (provserver.csr) to Cisco for signing. STEP 4 A signed server certificate is returned (provserver.cert) along with a Sipura CA Client Root Certificate, spacroot.cert.

  • Page 73: Https With Client Certificate Authentication

    STEP 9 Inspect the server certificate supplied by the server. The browser probably does not recognize it as valid unless the browser has been preconfigured to accept Cisco as a root CA. However, the IP Telephony Devices expect the certificate to be signed this way.

  • Page 74: Https Client Filtering And Dynamic Content

    CGI programs) invoked as part of the resync 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...
  • Page 75 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...

  • Page 76: Profile Formats

    STEP 4 Modify the Profile_Rule on the test device to resync to the deflated file in place of the original XML file, as in the following example: tftp://192.168.1.200/basic.txt.gz Click Submit All Changes. STEP 5 Observe the syslog trace from the IP Telephony Device. STEP 6 Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 77: Profile Encryption

    STEP 4 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 Click Submit All Changes. STEP 5 Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 78: Partitioned Profiles

    The IP Telephony Device now resyncs to both the first and second profiles, in that order, whenever a resync operation is due. Observe the syslog trace to confirm the expected behavior. STEP 5 Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 79: Parameter Name Aliases

    /customer-account/SIP-password = /flat-profile/Password_1_ ; Edit the Profile_Rule to point to the new XML profile, and also specify the alias map STEP 4 as a URL option, as follows: [--alias a ] tftp://192.168.1.200/customer.xml Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 80: Proprietary Profile Format

    Password[1] “512835907884” ; Compile the text profile into a binary file, account.cfg by using the following STEP 3 command: spc account.txt account.cfg Store account.cfg in the TFTP server virtual root directory. STEP 4 Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 81 Upon resync, the IP Telephony Device retrieves the new file, recognizes its binary format and updates the two specified parameters. Observe the syslog messages sent by the IP Telephony Device during resync. STEP 7 Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 82 General Purpose Parameters, page 88 • Macro Expansion Variables, page 89 • Internal Error Codes, page 92 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...

  • Page 83: Configuration Profile Parameters

    This feature can be used to prevent an overload of the provisioning server when a large number of devices power-on simultaneously. The default value is 2 (40 seconds). Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 84 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...
  • Page 85 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...
  • Page 86 The default value is $PN $MAC – Successful resync $SCHEME:// $SERVIP:$PORT$PATH -- $ERR. Log_Resync_Failure_Msg 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...
  • Page 87 For example, to store delta configuration changes in a file with a name like SPA504G_<MAC>_<serial#>.xml, add the following to your provisioning file: [ --delta ] http://reportTargetServer/reportPath/ $PN_$MA_$SN.xml </Report_Rule> The default value is (empty). Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 88: Firmware Upgrade Parameters

    URLs. The default value is (empty). Log_Upgrade_Request_Msg 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...

  • Page 89: General Purpose 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...

  • Page 90: Macro Expansion Variables

    Parameter Name Description and Default Value The form $$ expands to a single $ character. A through P Replaced by the contents of the general purpose parameters GPP_A through GPP_P. Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 91 External IP of the IP Telephony Device, as seen on the Internet, for example 66.43. 1 6.52. SWVER Software version string, for example 2.0.6(b). HWVER Hardware version string, for example 1.88. 1 . Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 92 URL. Result message of resync or upgrade attempt. Only useful in generating result syslog messages. The value is preserved in the UPGERR variable in the case of upgrade attempts. Cisco Small Business IP Telephony Devices Provisioning Guide...

  • Page 93: Internal Error Codes

    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...
  • Page 94 "Parallel" ; # options: Parallel/Sequential Syslog_Server "" ; Debug_Server "" ; Debug_Level "0" ; # options: 0/1/2/3 Primary_NTP_Server "" ; Secondary_NTP_Server "" ; # *** Configuration Profile Provision_Enable "Yes" ; Resync_On_Reset "Yes" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 95 "" ; 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...
  • Page 96 RTCP_Tx_Interval "0" ; # *** SDP Payload Types NSE_Dynamic_Payload "100" ; AVT_Dynamic_Payload "101" ; G726r16_Dynamic_Payload "98" ; G726r24_Dynamic_Payload "97" ; G726r40_Dynamic_Payload "96" ; G729b_Dynamic_Payload "99" ; NSE_Codec_Name "NSE" ; AVT_Codec_Name "telephone-event" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 97 "high" ; # options: low/medium/high/very high 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...
  • Page 98 VMWI_Serv[1] "Yes" ; Speed_Dial_Serv[1] "Yes" ; Secure_Call_Serv[1] "Yes" ; Referral_Serv[1] "Yes" ; Feature_Dial_Serv[1] "Yes" ; # *** Audio Configuration Preferred_Codec[1] "G711u" ; # options: G711u/G711a/G726-16/ G726-24/G726-32/G726-40/G729a/G723 Silence_Supp_Enable[1] "No" ; Use_Pref_Codec_Only[1] "No" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 99 Cfwd_Sel4_Dest[1] ! "" ; Cfwd_Sel5_Caller[1] ! "" ; Cfwd_Sel5_Dest[1] ! "" ; Cfwd_Sel6_Caller[1] ! "" ; Cfwd_Sel6_Dest[1] ! "" ; Cfwd_Sel7_Caller[1] ! "" ; Cfwd_Sel7_Dest[1] ! "" ; Cfwd_Sel8_Caller[1] ! "" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 100 ! "0" ; Cblk_Ring_Splash_Len[1] ! "0" ; VMWI_Ring_Splash_Len[1] ! ".5" ; VMWI_Ring_Policy[1] "New VM Available" ; # options: New VM Available/New 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...
  • Page 101 Auth_ID[2] "" ; Mini_Certificate[2] "" ; SRTP_Private_Key[2] "" ; # *** Supplementary Service Subscription Call_Waiting_Serv[2] "Yes" ; Block_CID_Serv[2] "Yes" ; Block_ANC_Serv[2] "Yes" ; Dist_Ring_Serv[2] "Yes" ; Cfwd_All_Serv[2] "Yes" ; Cfwd_Busy_Serv[2] "Yes" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 102 # options: None/AVT/INFO FAX_Process_NSE[2] "Yes" ; Release_Unused_Codec[2] "Yes" ; # *** Dial Plan Dial_Plan[2] "(*xx|[3469]11|0|00|[2-9]xxxxxx|1xxx[2- 9]xxxxxxS0|xxxxxxxxxxxx.)" ; Enable_IP_Dialing[2] "No" ; # *** FXS Port Polarity Configuration Idle_Polarity[2] "Forward" ; # options: Forward/Reverse Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 103 Block_CID_Setting[2] ! "No" ; Block_ANC_Setting[2] ! "No" ; DND_Setting[2] ! "No" ; CID_Setting[2] ! "Yes" ; CWCID_Setting[2] ! "Yes" ; Dist_Ring_Setting[2] ! "Yes" ; Secure_Call_Setting[2] "No" ; # *** Distinctive Ring Settings Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 104 "350@-19,440@-19;2(.1/.1/1+2);10(*/0/1+2)" ; Cfwd_Dial_Tone "350@-19,440@-19;2(.2/.2/1+2);10(*/0/1+2)" ; Holding_Tone "600@-19;*(.1/.1/1,.1/.1/1,.1/9.5/1)" ; Conference_Tone "350@-19;20(.1/.1/1,.1/9.7/1)" ; Secure_Call_Indication_Tone "397@-19,507@-19;15(0/2/0,.2/.1/1,.1/2.1/ 2)" ; # *** Distinctive Ring Patterns Ring1_Cadence "60(2/4)" ; Ring2_Cadence "60(.3/.2,1/.2,.3/4)" ; Ring3_Cadence "60(.8/.4,.8/4)" ; Ring4_Cadence "60(.4/.2,.3/.2,.8/4)" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 105 "30" ; Interdigit_Long_Timer "10" ; Interdigit_Short_Timer "3" ; CPC_Delay "2" ; CPC_Duration "0" ; # *** Vertical Service Activation Codes Call_Return_Code "*69" ; Blind_Transfer_Code "*98" ; Call_Back_Act_Code "*66" ; Call_Back_Deact_Code "*86" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 106 "*01723" ; Force_G723_Code "*02723" ; Prefer_G726r16_Code "*0172616" ; Force_G726r16_Code "*0272616" ; Prefer_G726r24_Code "*0172624" ; Force_G726r24_Code "*0272624" ; Prefer_G726r32_Code "*0172632" ; Force_G726r32_Code "*0272632" ; Prefer_G726r40_Code "*0172640" ; Force_G726r40_Code "*0272640" ; Prefer_G729a_Code "*01729" ; Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 107 Detect_ABCD "Yes" ; Playback_ABCD "Yes" ; Caller_ID_Method "Bellcore(N.Amer,China)" ; # options: Bellcore(N.Amer,China)/DTMF(Finland,Sweden)/DTMF(Denmark)/ETSI DTMF/ETSI DTMF With PR/ETSI DTMF After Ring/ETSI FSK/ETSI FSK With PR(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...
  • Page 108 Calling Party Control Customer Premises Equipment CWCID Call Waiting Caller ID Call Waiting Tone Digital to Analog Converter decibel dB with respect to 1 milliwatt DHCP Dynamic Host Configuration Protocol Domain Name System Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 109 Incumbent Local Exchange Carrier Internet Protocol Internet Service Provider ITSP Internet Telephony Service Provider Interactive Voice Response Local Area Network Low Bit Rate LBRC Low Bit Rate Codec Mini-Certificate MGCP Media Gateway Control Protocol Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 110 (SIP) Response Status Code, such as 404, 302, 600 Real Time Protocol Round Trip Time Streaming Audio Server Session Description Protocol SDRAM Synchronous DRAM seconds Session Initiation Protocol Shared line appearance SLIC Subscriber Line Interface Circuit Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 111 Secure Socket Layer TFTP Trivial File Transfer Protocol Transmission Control Protocol User Agent Micro-controller User Datagram Protocol Uniform Resource Locator Voicemail VMWI Visual Message Waiting Indication/Indicator Voice Quality Wide Area Network Extensible Markup Language Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 112 Where to Go From Here Cisco provides a wide range of resources to help you and your customer obtain the full benefits of the Cisco Small Business IP Telephony Device. Product Resources Resource Location Technical Voice System (SPA9000 and SPA400): Documentation www.cisco.com/en/US/products/ps10030/...
  • Page 113 Resource Location Open Source www.cisco.com/go/osln License Notices Regulatory See the Technical Documentation pages listed above. Compliance and Safety Information Cisco Partner www.cisco.com/web/partners/sell/smb Central site for Small Business Cisco Small www.cisco.com/smb Business Home Cisco Small Business IP Telephony Devices Provisioning Guide...
  • Page 114 Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/ go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company.

This manual is also suitable for:

Spa9000Pap2tSpa2102Spa3102Spa8000Wrp400 ... Show all

Table of Contents