Page 1
Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide First Published: 2017-11-16 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883...
Page 2
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: 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.
Deployment and Provisioning C H A P T E R 1 Provisioning Overview Provisioning Guide Phone Support New and Changed Information New and Changed Information for Cisco IP Phone 6800 Series Multiplatform Phones Support TR69 Provisioning PRC Methods RPC Methods Supported...
Page 4
Upgrade Firmware by TFTP, HTTP, or HTTPS Upgrade Firmware With a Browser Command In-House Preprovisioning and Provisioning Servers C H A P T E R 3 In-House Preprovisioning and Provisioning Servers Server Preparation and Software Tools Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 5
Exercise: Basic HTTPS Resync HTTPS with Client Certificate Authentication Exercise: HTTPS with Client Certificate Authentication HTTPS Client Filtering and Dynamic Content HTTPS Certificates HTTPS Methodology SSL Server Certificate Obtain a Server Certificate Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 6
Related Documentation A P P E N D I X C Related Documentation Cisco IP Phone 6800 Series Documentation Cisco IP Phone Firmware Support Policy Documentation, Service Requests, and Additional Information Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Provisioning, page 7 Provisioning Overview Cisco IP Phones are intended for high-volume deployments by VoIP service providers to customers in home, business, or enterprise environments. Hence, provisioning the phone via remote management and configuration ensures the proper operation of the phone at the customer site.
Provisioning Guide Phone Support This document supports these phones: • Cisco IP Phone 6800 Series Multiplatform Phones In this document, the term phone or Cisco IP Phone refers to the above phones. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
This document is based on the document Cisco IP Phone 7800 Series and 8800 Series Multiplatform Phones Provisioning Guide for Firmware Release 11.0(1). The sections that are new or changed to support the Cisco IP Phone 6800 Series Multiplatform Phones are: •...
Cisco IP Phones provide convenient mechanisms for provisioning, based on these deployment models: • Bulk distribution—The service provider acquires Cisco IP Phones in bulk quantity and either preprovisions them in-house or purchases Remote Customization (RC) units from Cisco. The devices are then issued to the customers as part of a VoIP service contract.
Deployment and Provisioning Bulk Distribution • Retail distribution—The customer purchases the Cisco IP Phone from a retail outlet and requests VoIP service from the service provider. The service provider must then support the secure remote configuration of the device. Bulk Distribution In this model, the service provider issues phones to its customers as part of a VoIP service contract.
In this example, 1234abcd is the Customer ID number of the new account. The remote provisioning server associates the phone that is performing the resync request with the new account, based on the URL and the Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
If intermediate upgrades are required to reach a current upgrade state from an older release, the upgrade logic can automate multistage upgrades. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Phone Provisioning Practices Typically, the Cisco IP Phone is configured for provisioning when it first connects to the network. The phone is also provisioned at the scheduled intervals that are set when the service provider or the VAR preprovisions...
If no port is specified, the default port is used (69 for TFTP, 80 for HTTP, or 443 for HTTPS). Step 4 Press Resync. Related Topics Phone Provisioning Practices, on page 8 Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Only the UTF-8 charset is supported. If you modify the profile in an editor, do not change the encoding Note format; otherwise, the phone cannot recognize the file. Each phone has a different feature set and therefore, a different set of parameters. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
<flat-profile> element. • Element names are enclosed in angle brackets. • Most element names are similar to the field names in the administration web pages for the device, with the following modifications: Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
In the following example, the GPP_A parameter is set to an empty string. <flat-profile> <GPP_A> </GPP_A> </flat-profile> • Unrecognized element names are ignored. Related Topics Configuration Access Control, on page 8 Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
• The last profile processed takes precedence. If multiple profiles specify the same configuration parameter, the value of the latter profile takes precedence. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
The Open configuration profile can be compressed to reduce the network load on the provisioning server. The profile can also be encrypted to protect confidential information. Compression is not required, but it must precede encryption. Related Topics Configuration Profile Formats, on page 11 Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
A lowercase -k precedes the secret key, which can be any plain text phrase, and which is used to generate a random 64-bit salt. With the secret specified by the -k argument, the encryption tool derives a random 128-bit initial vector and the actual 256-bit encryption key. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
The resulting macro expansion for a device with MAC address 000E08012345 is: $STRANGE000E08012345.cfg Macro expansion is not applied recursively. For example, $$MAU” expands into $MAU” (the $$ is expanded), and does not result in the MAC address. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Open format profile. Operator Alternate Description Applicable to Integer Applicable to Quoted Syntax and Version Operands String Operands equal to not equal to < less than Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
If port is missing, the standard port for the specified scheme is used. (tftp uses UDP port 69, http uses TCP port 80, https uses TCP port 443.) A filepath must be present. It need not necessarily refer to a static file, but can indicate dynamic content obtained through CGI. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
$SA through $SD, only when they are used as key option arguments. See these examples: GPP_SA = MyUserID GPP_SB = MySecretPassword [--uid $SA -pwd $SB] https://provisioning_server_url/path_to_your_config/your_config.xml would then expand to: [--uid MyUserID -pwdMySecretPassword] https://provisioning_server_url/path_to_your_config/your_config.xml Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Step 1 Connect your PC to the LAN port of the phone. Step 2 Download the configuration file to the phone by entering the following cURL command: curl –d @my_config.xml “http://192.168.15.1/admin/config.xml&xuser=admin&xpassword=admin” Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
‘$’ character, such as $GPP_A. Using General Purpose Parameters For example, if GPP_A contains the string ABC, and GPP_B contains 123, the expression $A$B macro expands into ABC123. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
A resync operation can fail because the phone is unable to retrieve a profile from the server, the downloaded file is corrupt, or an internal error occurred. The device tries to resync again after a time that is specified in Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
In this example, the phone periodically resyncs every 2 hours. If a resync failure occurs, the device retries at these intervals: 30 minutes, 1 hour, 2 hours, 4 hours. The device continues to try at 4-hour intervals until it resyncs successfully. Resync_Periodic=7200 Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
URL, and any associated URL options. All these components are optional within each alternative. The following are the valid combinations, and the order in which they must appear, if present: [ conditional-expr ] [ assignment-expr ] [[ options ] URL ] Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
In this example, the profile that the server returns is assumed to contain XML element tags. These tags must be remapped to proper parameter names by the aliases map stored in GPP_B: [--alias b] https://p.tel.com/account/$PN$MA.xml Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
• For the Cisco IP 6800 Series: http://p.tel.com/firmware/sip68xx.11-1-0MPP-BN (BN==Build Number).loads In this example, the Upgrade_Rule upgrades the firmware to the image that is stored at the indicated URL. Here is another example for the Cisco IP Phone 6800 Series: (“$F” ne “beta-customer”)? http://p.tel.com/firmware/sip68xx.11-0-1MPP-BN (BN==Build Number).loads | http://p.tel.com/firmware/sip68xx.11-0-1MPP-BN (BN==Build Number).loads...
• FQDN—Fully Qualified Domain Name. It can contain up to 63 characters. Examples are as follows: • sip.Cisco.com:5060 or 109.12.14.12:12345 • sip.Cisco.com or 109.12.14.12 • FreqScript—A miniscript that specifics the frequency and level parameters of a tone. Contains up to 127 characters. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
• Phone—A phone number string, such as 14081234567, *69, *72, 345678; or a generic URL, such as, 1234@10.10.10.100:5068 or jsmith@Cisco.com. The string can contain up to 39 characters. • PhTmplt—A phone number template. Each template may contain one or more patterns that are separated by a comma (,).
• Uns<n>—Unsigned n-bit value, where n = 8, 16, or 32. It can be specified in decimal or hex format, such as 12 or 0x18, as long as the value can fit into n bits. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Allow and Configure Profile Updates, on page 31 Allow and Configure Profile Updates Profile updates can be allowed at specified intervals. Updated profiles are sent from a server to the phone by using TFTP, HTTP, or HTTPS. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Note notes for your phone and firmware version. Before You Begin The firmware load file must be downloaded to an accessible server. Procedure Step 1 Rename the image as follows: where: Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
The update is attempted automatically after the call is complete. Procedure To upgrade the phone with a URL in a web browser, enter this command: http://<phone_ip>/admin/upgrade?<schema>://<serv_ip[:port]>/filepath Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
To troubleshoot server configuration, it is helpful to install clients for each type of server on a separate server machine. This practice establishes proper server operation, independent of the interaction with the phones. We also recommend that you install these software tools: Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
In an RC distribution model, a customer purchases a phone that has already been associated with a specific Service Provider in the Cisco EDOS RC Server. The Internet Telephony Service Provider (ITSP) sets up and maintains a provisioning server, and registers their provisioning server information with the Cisco EDOS RC Server.
Acquired, the Customization State is set to Aborted and the Cisco EDOS Server will not be queried unless the phone is factory reset. Once the phone has been provisioned, the Cisco EDOS RC Server is not utilized unless the phone is factory reset.
NAT, a packet-filtering strategy that severely restricts the packets that are allowed to enter the protected network from the Internet. For this reason, remote provisioning by using TFTP is not recommended. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
1.1 is the negotiated transport protocol. HTTP Status Code Handling on Resync and Upgrade The phone supports HTTP response for remote provisioning (Resync). Current phone behavior is categorized in three ways: Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Phone behavior is C. 500 Internal Server Error 501 Not Implemented The server does not recognize the request Phone behavior is C. method, or it lacks the ability to fulfill the request. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
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 signed server certificate, the service provider must forward a certificate signing request to Cisco, which signs and returns the server certificate for installation on the provisioning server.
The signed server certificate is then either emailed to the email address previously provided or downloaded. Sipura CA Client Root Certificate Cisco also provides a Sipura CA Client Root Certificate to the service provider. This root certificate certifies the authenticity of the client certificate that each phone carries. The Multiplatform Phones also support third-party signed certificates such as those provided by Verisign, Cybertrust, and so on.
HTTPS servers can be configured to request SSL certificates from connecting clients. If enabled, the server can use the Sipura CA Client Root Certificate that Cisco supplies to verify the client certificate. The server can then provide the certificate information to a CGI for further processing.
See In-House Device Preprovisioning, on page 37 for more information on in-house preprovisioning. In the following procedure, a profile is modified after downloading a file from a TFTP server. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
(Admin Login > advanced > Voice > System, Syslog Server parameter). Configure the syslog server IP address into the device and observe the messages that are generated during the remaining procedures. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Define the Profile_Rule parameter. This example assumes a TFTP server IP address of 192.168.1.200. Step 3 In the Resync Periodic field, enter a small value for testing, such as 30 seconds. Step 4 Click Submit all Changes. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
$A through $P. For a complete list of variables that are available for macro expansion, see Macro Expansion Variables, on page In this exercise, a profile specific to a phone is provisioned on a TFTP server. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
To verify proper server installation and file access to basic.txt, access the profile with a web browser. Step 4 Modify the Profile_Rule of the test phone to point to the HTTP server in place of the TFTP server, so as to download its profile periodically. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Provisioning Through Cisco XML For each of the phones, designated as xxxx here, you can provision through Cisco XML functions. You can send an XML object to the phone by a SIP Notify packet or an HTTP Post to the CGI interface of...
HTTPS server, the phone should be able to do so as well. In addition to installing a HTTPS server, a SSL server certificate that Cisco signs must be installed on the provisioning server. The devices cannot resync to a server that is using HTTPS unless the server supplies a Cisco-signed server certificate.
The browser probably does not recognize the certificate as valid unless the browser has been pre-configured to accept Cisco as a root CA. However, the phones expect the certificate to be signed this way. Modify the Profile_Rule of the test device to contain a reference to the HTTPS server, for example: <Profile_Rule>...
If client certificate verification is properly enabled on the server, the ssldump trace shows the symmetric exchange of certificates (first server-to-client, then client-to-server) before the encrypted packets that contain the profile. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
The information contains generic strings if the unit was manufactured before firmware release 2.0. A similar script can determine information about the resyncing device and then provide the device with appropriate configuration parameter values. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
To use HTTPS with the phone, you must generate a Certificate Signing Request (CSR) and submit it to Cisco. The phone generates a certificate for installation on the provisioning server. The phone accepts the certificate when it seeks to establish an HTTPS connection with the provisioning server.
Obtain a Server Certificate Procedure Step 1 Contact a Cisco support person who will work with you on the certificate process. If you are not working with a specific support person, email your request to ciscosb-certadmin@cisco.com. Step 2 Generate a private key that will be used in a CSR (Certificate Signing Request). This key is private and you do not need to provide this key to Cisco support.
Each node has a public and private key. The public key encrypts data. The private key decrypts data. Because the nodes have obtained their certificates from the same source, they are assured of their respective identities. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
A configuration profile in XML format can become quite large if the profile specifies all parameters individually. To reduce the load on the provisioning server, the phone supports compression of the XML file, by using the deflate compression format that the gzip utility (RFC 1951) supports. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
TFTP or HTTP is used for communication between the phone and the provisioning server. The phone supports symmetric key encryption by using the 256-bit AES algorithm. This encryption can be performed by using the open source OpenSSL package. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Store the basic2.txt profile in the virtual root directory of the TFTP server. Step 3 Leave the first profile rule from the earlier exercises in the folder, but configure the second profile rule (Profile_Rule_B) to point to the new file: <Profile_Rule_B>tftp://192.168.1.200/basic2.txt </Profile_Rule_B> Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 67
The phone 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 IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 68
Provisioning Examples Create Partitioned Profiles Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Yes to enable remote provisioning. The default value is Yes. Resync On Reset Triggers a resync after every reboot except for reboots caused by parameter updates and firmware upgrades. The default value is Yes. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 70
If the delay is set to 0, the device does not try to resync again following a failed resync attempt. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 71
Log Request Msg This parameter contains the message that is sent to the syslog server at the start of a resync attempt. The default value is $PN $MAC –Requesting % $SCHEME://$SERVIP:$PORT$PATH. Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
443 for HTTPS). The default value is blank. Log Upgrade Request Msg Syslog message issued at the start of a firmware upgrade attempt. Default: $PN $MAC -- Requesting upgrade $SCHEME://$SERVIP:$PORT$PATH Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
• Partial string values, eventually combined into complete parameter values. The default value is blank. Macro Expansion Variables Certain macro variables are recognized within the following provisioning parameters: • Profile_Rule • Profile_Rule_* • Resync_Trigger_* • Upgrade_Rule • Log_* Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 74
IP address of the phone within its local subnet, for example 192.168.1.100. EXTIP External IP of the phone, as seen on the Internet, for example 66.43.16.52. SWVER Software version string. For example, sip78xx.11-0-1MPP. HWVER Hardware version string, for example 2.0.1 Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 75
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. UIDn The contents of the Line n UserID configuration parameter. Extension Mobility Status Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
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 IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Call Detail Record Caller ID CIDCW Call Waiting Caller ID Comfort Noise Generation Calling Party Control Customer Premises Equipment CWCID Call Waiting Caller ID Call Waiting Tone Digital to Analog Converter Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 100
ICMP Internet Control Message Protocol IGMP Internet Group Management Protocol ILEC Incumbent Local Exchange Carrier Internet Protocol Internet Service Provider ITSP Internet Telephony Service Provider Interactive Voice Response Local Area Network Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 101
Network Address Translation Out-of-band REQT (SIP) Request Message RESP (SIP) Response Message (SIP) Response Status Code, such as 404, 302, 600 Real Time Protocol Round Trip Time Streaming Audio Server Session Description Protocol Cisco IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Page 102
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 IP Phone 6800 Series Multiplatform Phones Provisioning Guide...
Documentation, Service Requests, and Additional Information For information about how to obtain documentation, submit a service request, and gather additional information, see the monthly publication What’s New in Cisco Product Documentation. This publication also lists all new and revised Cisco technical documentation at https://www.cisco.com/c/en/us/td/docs/general/whatsnew/...
Page 104
Documentation, Service Requests, and Additional Information Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed. Use a reader application to set content for direct delivery to your desktop. The RSS feeds are a free service, and Cisco currently supports RSS Version 2.0.
Need help?
Do you have a question about the 6800 Series and is the answer not in the manual?
Questions and answers