Cisco Unified IP Phone Model 7905G and 7912G Administration Guide for Cisco Unified CallManager Release 4.2 and later
Additional Configuration Methods and Parameters

Table Of Contents

Additional Configuration Methods and Parameters

TFTP Configuring

About Profile Files

Creating or Updating a Profile File

Web Page Configuring

Accessing the Web Page for a Phone

Disabling Web Page Access

Device Information

Network Configuration

Network Statistics

Device Logs

Configuration Parameters

Network Parameters

Tone Parameters

Audio Parameters

Profile File Parameters


Additional Configuration Methods and Parameters


The Cisco Unified IP Phone must be correctly configured before it will operate properly. When you configure a phone, you specify parameters and values that instruct the phone how to operate in your environment. Configuring provides the phone with instructions for many aspects of its operation, including how to interact with the network and how to handle IP telephony protocols.

In general, configuring the Cisco Unified IP Phone 7905G and 7912G can be accomplished through Cisco Unified CallManager and through the network configuration options on a phone. These processes are described in detail in this manual.

This appendix describes the following additional methods for configuring the Cisco Unified IP Phone 7905G and 7912G. These methods are optional and are available to help you configure your phones most efficiently and to provide certain configuration options that are not available through other methods.

Through a profile file—A profile file contains various parameters and values for phone and network settings. This file is stored on a Trivial File Transfer Protocol (TFTP) server and is downloaded to the phone.

Through the phone's web page—Each phone has a web page from which you can view and update many parameter values.

This section includes the following topics:

TFTP Configuring

Web Page Configuring

Configuration Parameters

TFTP Configuring

You can configure many parameters on the Cisco Unified IP Phone 7905G and 7912G using a profile file stored on the TFTP server. A profile file is a binary file that contains a list of tag, length, and value triplets (TLVs) that represent some of the configuration parameters for the Cisco Unified IP Phone. You can edit a text version of a profile file and then convert it to a binary file for the phone to download.

TFTP configuration works as follows:

1. A Cisco Unified IP Phone will try to download a phone-specific profile file from the TFTP server.

2. If the phone-specific profile file does not exist, the phone will try to download a common, or default, profile file.

Related Topics

About Profile Files

Creating or Updating a Profile File

Configuration Parameters

About Profile Files

A profile file is a binary-format file that is stored on the TFTP server. There are two types of profile files:

Phone-specific profile files— Used to configure a particular Cisco Unified IP Phone

Common profile files—Used to simultaneously configure multiple phones of the same model with the same information

Table A-1 explains how these profile files are named.

Table A-1 Cisco Unified IP Phone Profile File Naming Conventions

Cisco Unified IP Phone
Phone-Specific Profile File Name
Common Profile File Name
Phone-Specific Profile Name Notes

7905G

ldxxxxxxxxxxxx

lddefault.cfg

Each xx is the two-digit lowercase hexadecimal representation of each integer in the phone's MAC address

The file name must be exactly 14 characters

For the Cisco Unified IP Phone 7905G and 7912G, the profile file names begin with a lowercase "L" followed by a lowercase "D"

For example, if the MAC address is 0.1.45.2.10.20, the file name is ld00012d020a14

7912G

gkxxxxxxxxxxxx

gkdefault.cfg


You can edit a profile file in text format on the TFTP server and then convert it to the binary format required by the phone. See the "Creating or Updating a Profile File" section for more information.

Configuration parameters are entered in the format "Parameter:value." For example, the following entry specifies that the password for accessing a phone's web page or Network Configuration screen is 12345: UIPassword:12345. See the "Configuration Parameters" section for more information about parameters and values.

Use the file example_uprofile.txt as a template for creating the text version of your Cisco Unified IP Phone profile files. You can obtain the latest version of this file from the CCO website. It is included with the SCCP Software Package Zip file.


Note A profile file for your phone may contain some parameters that are not described in this manual. These parameters are reserved for future use or are configured with factory default settings and should not be changed.


Related Topic

Creating or Updating a Profile File

Creating or Updating a Profile File

Use the file example_uprofile.txt or an existing text profile file as a template for creating a text version of a Cisco Unified IP Phone profile file.

Profile File Conventions

A text profile file must conform to the following conventions:

The characters #txt must appear at the beginning of the first line of the file so that the formatting tool, cfgfmt.exe, will treat the file as a text file

A pound sign (#) at the beginning of a line indicates a comment

Parameter/value pairs are entered in the form parameter:value, where parameter is the exact name of the parameter and value is a valid value

Each parameter/value pair must appear on a its own line

All parameter/value pairs are optional, but the Cisco Unified IP Phone 7905G might not function properly if some values are missing.

A parameter value is one of the following types:

Alphanumeric string

Numeric digit string

Array of short integers

IP address (for example, 192.168.2.170)

Extended IP address—IP address with port (for example, 192.168.2.170.9001)

Boolean (1 or 0)

Bitmap—unsigned hexadecimal integer (for specifying bits in 32-bit integer)

Integer (32-bit integer)

Editing a Profile File and Converting it to Binary Format

Before you can create a new binary profile file, you will need the cfgfmt.exe tool, which converts a text profile file to binary format.

The cfgfmt.exe tool requires a parameter tag file named ptag.dat. This file specifies the type and size of each parameter.

The cfgfmt.exe tool and the ptag.dat are bundled with the Cisco Unified IP Phone software. You can also obtain them from the CCO website. They are included with the SCCP Software Package Zip file.

To create or update a profile file, follow these steps:

Procedure


Step 1 Use a text editor to open the text version of the profile file on the TFTP server.

Step 2 Make changes as needed to the profile file, and save it.

For a description of profile file parameters, see the "Configuration Parameters" section.

Step 3 Open a command window and type the following command to generate the binary profile file from the text file:

cfgfmt [-tpTagFile] input-text-file output-binary-file

where:

pTagFile is an optional path to a folder containing the ptag.dat file. Specify this path if the ptag.dat file is not in the directory from which you are running the cfgfmt.exe tool.

input-text-file is the name of the text version of the profile file.

output-binary-file is the name of the binary file that the Cisco Unified IP Phone uses as the TFTP configuration profile file. See the "About Profile Files" section for profile file name requirements.

Step 4 Put the binary file in these locations:

The root directory on the TFTP server (C:\Program Files\cisco\tftppath)

The network locale directories on the TFTP server for each language that is supported by Cisco Unified CallManager.

The default network locale directory on the TFTP server is C:\Program Files\ cisco\tftppath\United_States.


Web Page Configuring

You can display and configure device and network information for a Cisco Unified IP Phone by accessing the phone's web page. You can access the web page using any graphically capable web browser.


Note It is recommended that you take care to prevent unauthorized access to a phone's web page. It is also recommended that you increase security by setting a password using the UIPassword parameter in the phone's profile file. For more information about this parameter, see Table A-8.


This section includes the following topics:

Accessing the Web Page for a Phone

Disabling Web Page Access

Device Information

Network Configuration

Network Statistics

Device Logs

Configuration Parameters

Accessing the Web Page for a Phone

To access the web page for a Cisco Unified IP Phone, perform the following steps.

If you want to edit parameters in the Network Parameters, Tone Parameters, or Audio Parameters areas, you must first set up a password with the UIPassword parameter in the profile file. If you do not set up a password, you will be able to view information in these areas, but you will not be able to change parameters, and Apply will not be available.

Procedure


Step 1 Display the Phone Configuration web page.

For instructions, see the "Accessing Network Settings through a Phone Configuration Web Page" section on page 4-2.

Step 2 From the phone's web page, choose the hyperlink for the information that you want to display or configure:

Device Information—Display only. For more information, see the "Device Information" section.

Network Configuration—Display only. For more information, see the "Network Configuration" section.

Network Statistics—Display only. For more information, see the "Network Statistics" section.

Device Logs—Display only. For more information, see the "Device Logs" section.

Network Parameters—Configurable parameters. For more information, see the Table A-4"Network Parameters" section.

Tone Parameters—Configurable parameters. For more information, see the Table A-4"Tone Parameters" section.

Audio Parameters—Configurable parameters. For more information, see the Table A-4"Audio Parameters" section.

Step 3 If you selected Network Parameters, Tone Parameters, or Audio Parameters, follow these steps:

a. If you have set up a password with the UIPassword parameter in the profile file, enter the password in the UIPassword field, and then click Apply. (If you want to change the password, enter the new password in the two ChangeUIPassword fields before clicking Apply.)

b. Make changes to parameters in the Network Parameters, Tone Parameters, and Audio Parameters areas as needed and lick Apply to save your changes.

Step 4 Close your web browser.


Related Topics

Disabling Web Page Access

Device Information

Network Configuration

Network Statistics

Device Logs

Network Parameters

Tone Parameters

Audio Parameters

Disabling Web Page Access

For security purposes, you may choose to prevent access to the web pages for a phone. If you do so, you will prevent access to the web pages that are described in this appendix and to the phone's User Options web pages.

To disable access to the web pages for a phone, follow these steps from Cisco Unified CallManager Administration:


Step 1 Choose Device > Phone.

Step 2 Specify the criteria to find the phone and click Find, or click Find to display a list of all phones.

Step 3 Click the device name to open the Phone Configuration web page for the device.

Step 4 From the Web Access drop-down list, choose Disabled.

Step 5 Click Update.


Note Some features, such as Cisco Quality Report Tool, do not function properly without access to the phone web pages. Disabling web access also affects any serviceability application that relies on web access, such as CiscoWorks.


To enable web page access when it is disabled, follow the preceding steps, but choose Enabled in Step 4.


Device Information

The Device Information area of the Cisco Unified IP Phone web page displays device settings and related information for the phone. Table A-2 describes these items.

To display the Device Information area, perform either of these steps:

Access the web page for the phone as described in the "Accessing Network Settings through a Phone Configuration Web Page" section on page 4-2 and then click the Device Information hyperlink.

In a web browser, enter this URL: ip-address/DeviceInformation, where ip-address is the IP address of the phone.

Table A-2 Device Information Area Items 

Item
Description

MAC address

Unique Media Access Control (MAC) address of the phone

Host name

Unique host name assigned to the phone

Phone DN

Directory number assigned to the phone

App Load ID

Identifier of the firmware running on the phone

Boot Load ID

Identifier of the factory-installed load running on the phone

Software version

Version of the software running on the phone

Hardware revision

Version of the phone hardware

Serial number

Serial number of the phone

Product ID

Product identifier of the phone

Hardware features

Reserved for future use

BTXML cards version

Version of the graphics card in the phone


Network Configuration

The Network Configuration area of the Cisco Unified IP Phone web page displays network configuration information and information about other phone settings. Table A-3 describes these items.


Note You can obtain and set many of these items from phone itself (Cisco Unified IP Phone 7905G and 7912G). For more information, see Chapter 4, "Configuring Network Settings on the Cisco Unified IP Phone."


To display the Network Configuration area, perform either of these steps:

Access the web page for the phone as described in the "Accessing Network Settings through a Phone Configuration Web Page" section on page 4-2 and then click the Network Configuration hyperlink.

In a web browser, enter this URL: ip-address/NetworkConfiguration, where ip-address is the IP address of the phone.

Table A-3 Network Configuration Area Items 

Item
Description

DHCP server

If DHCP is enabled, the DHCP server that the phone contacts

BOOTP server

Not used

MAC address

Unique MAC address of the phone

Host name

Unique host name assigned to the phone

Domain name

If DHCP is enabled, Domain Name System (DNS) in which the phone resides

IP address

If DHCP is enabled, Internet protocol (IP) address of the phone

Default gateway

If DHCP is enabled, default gateway used by the phone

Subnet mask

If DHCP is enabled, subnet mask used by the phone

TFTP server 1

If DHCP is enabled, IP address of the primary TFTP server used by the phone

TFTP server 2

If DHCP is enabled, IP address of the alternate TFTP server used by the phone

DNS server 1

If DHCP is enabled, IP address of the primary DNS server used by the phone

DNS server 2

If DHCP is enabled, IP address of the alternate DNS server used by the phone

Operational VLAN ID

Auxiliary Virtual Local Area Network (VLAN) configured on a Cisco Catalyst switch in which the phone is a member. If the phone has not received an auxiliary VLAN, this field reflects the Administrative VLAN

CallManager 1 - 4

Prioritized list of Cisco Unified CallManager systems that are available for processing calls from this phone. Possible states include:

Active—Cisco Unified CallManager server from which the phone is currently receiving call-processing services.

Standby—Cisco Unified CallManager server to which the phone switches if the current server goes down.

Blank—No TCP connection to this Cisco Unified CallManager server.

This field might also include the Survivable Remote Site Telephony (SRST) designation, indicating an SRST router that assumes control of call processing if all other Cisco Unified CallManager servers are unreachable.

DHCP enabled

1 if DHCP is enabled. 0 if not

DHCP address released

1 if the DCHP address is released. 0 if not

User Locale

User locale associated with the phone user. The user locale identifies a set of detailed information to support users, including language, font, date and time formatting, and alphanumeric keyboard text information.

User Locale Version

Version of the user locale loaded on the phone.

Network Locale

Network locale associated with the phone user. The network locale identifies a set of detailed information that supports the phone in a specific location, including definitions of the tones and cadences used by the phone.

Network Locale Version

Version of the network locale loaded on the phone.

GARP Enabled

Indicates whether the phone learns MAC addresses from Gratuitous ARP responses. Disabling the phone's ability to accept Gratuitous ARP will prevent applications that use this mechanism to monitor and record voice streams from working.

DSCP For Call Control

DSCP IP classification for call control signalling.

DSCP For Configuration

DSCP IP classification for any phone configuration transfer.

DSCP For Services

DSCP IP classification for phone-based services.

Handset Only Mode

Indicates whether the speaker is enabled.

Web Access Enabled

Indicates whether the phone's internal web server is enabled. When disabled, you cannot access a phone's web pages.


Network Statistics

The Network Statistics area of the Cisco Unified IP Phone web page displays provide information about network traffic on the phone. Table A-4 describes the items on this menu.

To display the Network Statistics area, perform either of these steps:

Access the web page for the phone as described in "Accessing Network Settings through a Phone Configuration Web Page" section on page 4-2 and then click the Network Statistics hyperlink.

In a web browser, enter this URL: ip-address/EthernetInformation, where ip-address is the IP address of the phone.

Table A-4 Network Statistics Area Items 

Item
Description

Elapsed time

Time that has elapsed since the phone or Cisco Unified CallManager was last reset

Receive packets

Number of packets that the phone has received during the elapsed time

Transmit packets

Number of packets that the phone has transmitted during the elapsed time

Broadcast

Number of packets that the network has broadcast during the elapsed time

Multicast

Number of multicast packets on the network during the elapsed time

Receive errors

Number receive errors that the phone has experienced during the elapsed time

Transmit errors

Number transmit errors that the phone has experienced during the elapsed time

Receive overflow

Number packet overflows that the phone has experienced during the elapsed time


Device Logs

The Device Logs area of the Cisco Unified IP Phone web page displays the name of the phone's profile file.


Note You can access the Device Logs area directly from a web browser by entering this URL: ip-address/DeviceLog, where ip-address is the IP address of your phone.


Configuration Parameters

This section provides information on the parameters that you can use to configure the Cisco Unified IP Phone 7905G and 7912G through a profile file or through a phone's web page.

These parameters are organized into the following categories:

Network parameters—Control various network-related activities of the phone. See the "Network Parameters" section.

Tone parameters—Control how the phone handles the various tones that it plays, and related options. See the "Tone Parameters" section.

Audio parameters—Control how the phone handles various audio-related activities. See the "Audio Parameters" section.

Profile file parameters—Parameters that are available only from the phone's profile file. See the "Profile File Parameters" section.

Network Parameters

Table A-5 describes the network parameters that you can configure through a phone's profile file or through its Network Parameters web page.

Table A-5 Network Parameters 

Parameter
Description
Usage

TftpServer1

IP address of the primary TFTP server from which the Cisco Unified IP Phone should download the .cnf or .cnf.xml file and the profile file.

Alphanumeric string up to 31 characters.

If specified, this TFTP server is used instead of the primary TFTP server provided by the DHCP server. If 0 is specified, the primary TFTP server provided by the DHCP server is used.

The default setting is 0.

Note Do not specify a port number. The Cisco Unified IP Phone always contacts the TFTP server at port 69.

TftpServer2

IP address of the secondary TFTP server from which the Cisco Unified IP Phone should download the .cnf or .cnf.xml file and the profile file.

Alphanumeric string up to 31 characters.

If specified, this TFTP server is used instead of the secondary TFTP server provided by the DHCP server. If 0 is specified, the alternate TFTP server provided by the DHCP server is used.

The default setting is 0.

Note Do not specify a port number. The Cisco Unified IP Phone always contacts the TFTP server at port 69.

Dhcp

Specifies whether the phone contacts the DHCP server to obtain values for various network parameters, including IP address, router IP address, and subnet mask.

Set to 0 (disable) if you are not using a DHCP server.

Set to 1 (enable) if you are using a DHCP server.

The default setting is 1.

StaticIP

Static IP address of the phone when DHCP is not used.

Enter the assigned IP address for the phone.

This value is ignored when the Dhcp parameter is enabled.

StaticRoute

Static IP address of the network router when DHCP is not used.

Enter the assigned IP address of the network router.

This value is ignored when the Dhcp parameter is enabled.

StaticNetMask

Static subnet mask of the phone when DHCP is not used.

Enter the subnet mask for the phone.

This value is ignored when the Dhcp parameter is enabled.

Domain

Domain name on the network in which the phone operates, used in the creation of the endpoint identifier.

Alphanumeric string up to 31 characters.

For example, if the name of the endpoint is aaln1 and the domain is cisco.com, the endpoint identifier is aaln1@cisco.com.

0—Use the DHCP-provided domain name if available; otherwise use the static IP address.

string—Use the specified domain name string and overwrite any DHCP-provided domain name.

The default setting is 0.

DnsServer1

IP address of the primary DNS server.

The address specified overwrites the primary DNS server address supplied by DHCP. Set 0 or 0.0.0.0 if you want the phone to use the address supplied by DHCP.

The default setting is 0.

Note Do not specify a port number. The Cisco Unified IP Phone uses the default DNS port.

DnsServer2

IP address of the secondary DNS server.

The address specified overwrites the secondary DNS server address supplied by DHCP. Set 0 or 0.0.0.0 if you want the phone to use the address supplied by DHCP.

The default setting is 0.

Note Do not specify a port number. The Cisco Unified IP Phone uses the default DNS port.

OpFlags

Enables or disables various features on the phone.

Bit map, as follows:

Bit 0—If 1, ignore the DHCP-assigned TFTP file name and use the following file name when using TFTP for configuring: ldxxxxxxxxxxxx (Cisco Unified IP Phone 7905G and 7912G), where each xx is the two-digit lowercase hexadecimal representation of each integer in the phone's MAC address.

Bit 1—If the phone is configured to use static IP (that is, the router and gateway addresses are statically assigned), set to 1 to prevent probing at boot time. Otherwise, the phone probes the route/gateway address to determine if there is network connectivity.

Bit 2—Reserved for future use.

Bit 3—If 1, do not request DHCP option 150 in the DHCP DISCOVERY message.

Bit 4—If 1, assume operation under VLAN. (The VLAN ID is specified in the VLANSetting parameter.)

Bit 5—If 1, turn off VLAN IP encapsulation.

Bit 6—If 1, do not perform CDP1 discovery.

Bit 7—If 1, do not allow web configuration of the phone.

Bit 8—Not used on the Cisco Unified IP Phone 7905G.

Bit 9—Not used on the Cisco Unified IP Phone 7905G.

The default value is 0x00000002.

VLANSetting

Specifies various VLAN settings.

Bit map, as follows:

Bits 0-2—Designate 802.1Q priority for signalling IP packets.

Bits 3-5—Designates 802.1Q priority for audio voice IP packets.

Bits 6-17—Reserved for future use.

Bits 18-29—User-specified 802.1Q VLAN id.

Bits 30-31—Reserved for future use.

The default setting is 0x0000002b.

Nprintf

IP address and port of a server to which Cisco Unified IP Phone troubleshooting messages are sent.

Enter the extended IP address of the server to which troubleshooting messages are sent and collected in a log file.

The default value is 0, which specifies that no messages are sent.

Note To collect troubleshooting messages, the prserv.exe tool must be running on the server specified with this parameter.

For more information about using Nprintf and preserv.exe to collect troubleshooting information, see the "Logging Information for Troubleshooting" section on page 7-14.

TraceFlags

Enables specific trace features.

Bit map

Bit 0-31—Reserved for future use.

Should be set to zero (0). The default setting is 0x00000000.

1 CDP = Cisco Discovery Protocol


Tone Parameters

Table A-6 describes the tone parameters that you can configure through a phone's profile file or through its Tone Parameters web page.

Table A-6 Tone Parameters 

Parameter
Description
Usage

SigTimer

Timeout values for signaling events.

Bit map, as follows:

Bits 0 - 7—Apply to the Cisco Unified IP Phone 7902G only.

Bits 8 - 27—Reserved for future use. Should be set to 0.

Bits 28 - 29—First repeat interval for the Volume and Navigation buttons. That is, the button takes effect the first time a user presses and holds down the button for the interval specified. The range is 0 to 3 (0 = one second; 2 = two seconds; 3 = three seconds; 1 disables the Volume and Navigation button repeat interval). The default value is 0.

Bits 30 - 31—Subsequent repeat interval for the Volume and Navigation buttons. For example, the volume increases or decreases when a user continues to hold down the Volume button for the interval specified. The range is 0 to 1 (0=0.25 seconds; 1 = 0.50 seconds; 2=0.75 seconds; 3 = one second). The default value is 0.


Audio Parameters

Table A-7 describes the network parameters that you can configure through a phone's profile file or through its Audio Parameters web page.

Table A-7 Audio Parameters 

Parameter
Description
Usage

AudioMode

Allows control of audio-related functions.

Bit map, as follows:

Bit 0—Reserved for future use.

Bit 1—If 0, use G.711 codec only; do not use low-bit-rate codec. If 1, use both G.711 and low-bit-rate codec.

Bits 2-31—Reserved for future use.

ConnectMode

Connection mode of the protocol used by the Cisco Unified IP Phone.

Bit map, as follows:

Bit 0-29—Reserved for future use. Must be set to 0.

Bit 30—If 1, enable Cisco IOS Telephony Solution (ITS) support to handle the differences between Cisco Unified CallManager and Cisco ITS. Cisco ITS runs on an IOS router and is a subset of Cisco Unified CallManager. If you have Cisco ITS, refer to the documentation for that product.

Bit 31—If 1, enable downloading and processing of .cnf.xml configuration file information sent by Cisco Unified CallManager.

TOS

UDP1 IP ToS2 . Determines the precedence and delay of sent IP packets.

Bit map, as follows:

Bit 0-7—UDPTOS bit.

Bit 8-15: SCCP TOS bit. If there is a DSCP for Call Control configuration set in Cisco Unified CallManager Administration, that value will overwrite the SCCP TOS setting.

The default setting is 0xB8.

MediaPort

Port number where the Cisco Unified IP Phone sends and receives RTP streams.

Enter an even number from 0 to 65535. Each connection uses the next available even-numbered port for RTP.

If set to 0, use the default value.

The default setting is 16384.

1 UDP = User Datagram Protocol

2 ToS = type of service


Profile File Parameters

Table A-8 describes the parameters that you can configure through a phone's profile file only.

Table A-8 Profile File Parameters 

Parameter
Description
Usage

UIPassword

Password for accessing the phone's Change Configuration web pages or to unlock the phone's Network Configuration screen for editing.

Alphanumeric string up to nine characters.

If set to 0, no password is required.

After a password is set with this parameter, the password can be changed from the phone's web page. For more information, see the "Web Page Configuring" section.

Note Changing a password from the phone's web page does not change the password in the profile file. If the phone downloads the profile file, the password will be reset as specified in the profile file.

upgradecode

Provides information for upgrading the firmware on the phone.

See Appendix D, "Updating Firmware for the Cisco Unified IP Phone."

upgradelogo

Allows you to specify the graphic that appears on the phone's phone screen.

See Appendix E, "Changing the Graphic on the Cisco Unified IP Phone Screen."