Table of Contents
Managing Cisco SIP IP Phones
Changing Your Configuration
Modifying the Phone's Network Settings
Modifying the Phone's SIP Settings
Using the Command-Line Interface
Setting the Date, Time, and Daylight Saving Time
Erasing the Locally Defined Settings
Accessing Status Information
Upgrading the Cisco SIP IP Phone Firmware
Performing an Image Upgrade and Remote Reboot
Managing Cisco SIP IP Phones
This chapter provides information on the following:
Changing Your Configuration
You can change your Cisco SIP IP phone configuration by any of the following methods:
 |
Note Use the CLI only to debug and troubleshoot your Cisco SIP IP phone.
|
You can change the following parameters:
Modifying the Phone's Network Settings
You can display and configure the network settings of a Cisco SIP IP phone. The network settings include information such as the phone's Dynamic Host Configuration Protocol (DHCP) server, MAC address, IP address, and domain name.
Entering Configuration Mode
When you access the network configuration information on your Cisco SIP IP phone, you will notice that there is a padlock symbol located in the upper-right corner of your LCD. By default, the network configuration information is locked. Before you can modify any of the network configuration parameters, you must unlock the phone.
Unlocking Configuration Mode
To unlock the Cisco SIP IP phone, press **#.
 |
Note You have activated the configuration mode for your phone. There is no indication that an action has taken
place.
|
If the Network Configuration or SIP Configuration panel is displayed, the lock icon in the upper-right corner of your LCD changes to an unlocked state. If you are located elsewhere in the Cisco SIP IP phone menus, the next time you access the Network Configuration or the SIP Configuration panels, the lock icon will be displayed in an unlocked state.
The unlocked symbol indicates that you can modify the network and SIP configuration settings.
Locking Configuration Mode
To lock the Cisco SIP IP phone when you are done modifying the settings, press **#.
If the Network Configuration or SIP Configuration panel is displayed, the lock icon in the upper-right corner of your LCD changes to a locked state. If you are located elsewhere in the Cisco SIP IP phone menus, the next time you access the Network Configuration or the SIP Configuration panels, the lock icon will be displayed in a locked state.
The unlocked symbol indicates that you can modify the network and SIP configuration settings.
Changing the Network Settings
Before You Begin
When configuring network settings, remember the following:
Step 1 Press the settings key. The Settings menu is displayed.
Step 2 Highlight Network Configuration.
Step 3 Press the Select soft key.The Network Configuration menu is displayed.
Table 3-1 lists the network parameters available in the Network Configuration menu:
Table 3-1 Network Configuration Parameters
| Parameter
|
Can Edit?
|
Description
|
Admin. VLAN Id
|
Yes, but if you have an administrative VLAN assigned on the Catalyst switch, that setting overrides any changes made on the phone.
|
Unique identifier of the VLAN to which the phone is attached. The value in this field is used only in switched networks that are not Cisco networks.
|
Alternate TFTP
|
Yes
|
Whether to use an alternate TFTP server. This field enables an administrator to specify the remote TFTP server rather than the local one. Possible values for this parameter are Yes and No. The default is No. When Yes is specified, the IP address in the TFTP Address parameter must be changed to the address of the alternate TFTP server.
|
Default Routers 1 through 5
|
Yes, but DHCP must be disabled.
|
IP address of the default gateway used by the phone. Default Routers 2 through 5 are the IP addresses of the gateways that the phone attempts to use as an alternate gateway if the primary gateway is unavailable.
|
DHCP Address Released
|
Yes
|
Whether the IP address of the phone can be released for reuse in the network. When you set this field to Yes, the phone sends a DHCP release message to the DHCP server and goes into a release state. The release state provides enough time to remove the phone from the network before the phone attempts to acquire another IP address from the DHCP server. When moving the phone to a new network segment, you should first release the DHCP address.
|
DHCP Enabled
|
Yes
|
Whether the phone will use DHCP to configure network settings (IP address, subnet mask, domain name, default router list, DNS server list, and TFTP address). Valid values for this field are Yes and No. By default, DHCP is enabled on the phone. To manually configure your IP settings, you must first disable DHCP.
|
DHCP Server
|
No
|
IP address of the DHCP server from which the phone received its IP address and additional network settings.
|
DNS Servers 1 through 5
|
Yes, but DHCP must be disabled.
|
IP address of the DNS server used by the phone to resolve names to IP addresses. The phone attempts to use DNS servers 2 through 5 if DNS server 1 is unavailable.
|
Domain Name
|
Yes
|
Name of the DNS domain in which the phone resides.
|
Erase Configuration
|
Yes
|
Whether to erase all of the locally defined settings on the phone and reset the values to the defaults. Selecting Yes reenables DHCP. For more information on erasing the local configuration, see the "Erasing the Locally Defined Settings" section.
|
Host Name
|
No
|
Unique host name assigned to the phone. The value in this field is always SIPmac where mac is the MAC address of the phone.
|
IP Address
|
Yes, but DHCP must be disabled.
|
IP address of the phone that either was assigned by DHCP or was locally configured.
|
MAC Address
|
No
|
Factory-assigned unique 48-bit hexadecimal MAC address of the phone.
|
Network Media Type
|
Yes
|
Ethernet port negotiation mode. Valid values are:
- AutoPort is auto-negotiated. (This is the default value.)
- Full-100Port is configured to be a full-duplex, 100-MB connection.
- Half-100Port is configured to be a half-duplex, 100-MB connection.
- Full-10Port is configured to be a full-duplex, 10-MB connection.
- Half-10Port is configured to be a half-duplex, 10-MB connection.
|
Network Port 2 Device Type
|
Yes
|
The device type that is connected to port 2 of the phone. Valid values are:
Note If the value is PC, port 2 can be connected only to a PC. If you are not sure about the connection, use the default value. Using a value of "PC" and connecting port 2 to a switch results in spanning tree loops and network confusion.
|
Operational VLAN Id
|
No
|
Unique identifier of the VLAN of which the phone is a member. This identifier is obtained through Cisco Discovery Protocol (CDP).
|
Subnet Mask
|
Yes, but DHCP must be disabled.
|
IP subnet mask used by the phone. A subnet mask partitions the IP address into a network and a host identifier.
|
TFTP Server
|
Yes, but DHCP must be disabled.
|
IP address of the TFTP server from which the phone downloads its configuration files and firmware images.
|
Step 4 When done, press the Save soft key. The phone programs the new information into Flash memory and resets.
Modifying the Phone's SIP Settings
You can modify the SIP parameters of a Cisco SIP IP phone.
When modifying SIP parameters, remember the following:
- Parameters defined in the default configuration file override the values stored in Flash memory.
- Parameters defined in the phone-specific configuration file override the values specified in the default configuration file.
- Parameters entered locally are used by the phone until the next reboot if a phone-specific configuration file exists.
- If you choose not to configure the phone via a TFTP server, you must manage the phone locally.
Table 3-2 lists each of the SIP parameters that you can configure. In the Configuration column, the name of a parameter as you would specify it in a configuration file is listed. In the menu column (SIP Configuration, Network Configuration, and Services), the name of the same parameter as it would appear on the user interface is listed. If NA appears for a parameter name in a menu column, it can cannot be defined via that menu.
Table 3-2 SIP Parameters Summary
| Configuration File
|
SIP Configuration Menu
|
Network Configuration Menu
|
Services Menu
|
anonymous_call_block
|
NA
|
NA
|
Anonymous Call Block
|
autocomplete
|
NA
|
NA
|
Auto-Complete Numbers
|
callerid_blocking
|
NA
|
NA
|
Caller ID Block
|
call_waiting
|
NA
|
NA
|
Call Waiting
|
cnf_join_enable
|
NA
|
NA
|
NA
|
dial_template
|
NA
|
NA
|
NA
|
dnd_control
|
NA
|
NA
|
Do Not Disturb
|
dst_auto_adjust
|
NA
|
NA
|
NA
|
dst_offset
|
NA
|
NA
|
NA
|
dst_start_day
|
NA
|
NA
|
NA
|
dst_start_day_of_week
|
NA
|
NA
|
NA
|
dst_start_month
|
NA
|
NA
|
NA
|
dst_start_time
|
NA
|
NA
|
NA
|
dst_start_week_of_month
|
NA
|
NA
|
NA
|
dst_stop_day
|
NA
|
NA
|
NA
|
dst_stop_day_of_week
|
NA
|
NA
|
NA
|
dst_stop_month
|
NA
|
NA
|
NA
|
dst_stop_time
|
NA
|
NA
|
NA
|
dst_stop_week_of_month
|
NA
|
NA
|
NA
|
dtmf_avt_payload
|
NA
|
NA
|
NA
|
dtmf_db_level
|
NA
|
NA
|
NA
|
dtmf_inband
|
NA
|
NA
|
NA
|
dtmf_outofband
|
Out of Band DTMF
|
NA
|
NA
|
enable_vad
|
Enable VAD
|
NA
|
NA
|
end_media_port
|
End Media Port
|
NA
|
NA
|
image_version
|
NA
|
NA
|
NA
|
linex_authname (line1 to line6)
|
Authentication Name
|
NA
|
NA
|
linex_displayname (line1 to line6)
|
Display Name
|
NA
|
NA
|
linex_name (line1 to line6)
|
Name
|
NA
|
NA
|
linex_password (line1 to line6)
|
Authentication Password
|
NA
|
NA
|
linex_shortname (line1 to line6)
|
Shortname
|
NA
|
NA
|
messages_uri
|
Messages URI
|
NA
|
NA
|
nat_address
|
NAT WAN Address
|
NA
|
NA
|
nat_enable
|
NAT Enabled
|
NA
|
NA
|
nat_received_processing
|
NA
|
NA
|
NA
|
network_media_type
|
NA
|
Network Media Type
|
NA
|
network_port2_type
|
NA
|
Network Port 2 Device Type
|
NA
|
outbound_proxy
|
Outbound Proxy
|
NA
|
NA
|
outbound_proxy_port
|
Outbound Proxy Port
|
NA
|
NA
|
phone_label
|
Phone Label
|
NA
|
NA
|
phone_password
|
NA
|
NA
|
NA
|
phone_prompt
|
NA
|
NA
|
NA
|
preferred_codec
|
Preferred Codec
|
NA
|
NA
|
proxy_backup
|
Backup Proxy
|
NA
|
NA
|
proxy_backup_port
|
Backup Proxy Port
|
NA
|
NA
|
proxy_emergency
|
Emergency Proxy
|
NA
|
NA
|
proxy_emergency_port
|
Emergency Proxy Port
|
NA
|
NA
|
proxy_register
|
Register with Proxy
|
NA
|
NA
|
proxyN_address (N=1 to 6)
|
Proxy Address
|
NA
|
NA
|
proxyN_port (N=1 to 6)
|
Proxy Port
|
NA
|
NA
|
sip_invite_retx
|
NA
|
NA
|
NA
|
sip_retx
|
NA
|
NA
|
NA
|
sntp_mode
|
NA
|
NA
|
NA
|
sntp_server
|
NA
|
NA
|
NA
|
start_media_port
|
Start Media Port
|
NA
|
NA
|
sync
|
NA
|
NA
|
NA
|
tftp_cfg_dir
|
TFTP Directory
|
NA
|
NA
|
time_format_24hr
|
NA
|
NA
|
Time format 24hr
|
time_zone
|
NA
|
NA
|
NA
|
timer_invite_expires
|
NA
|
NA
|
NA
|
timer_register_expires
|
Register Expires
|
NA
|
NA
|
timer_t1
|
NA
|
NA
|
NA
|
timer_t2
|
NA
|
NA
|
NA
|
tos_media
|
NA
|
NA
|
NA
|
user_info
|
NA
|
NA
|
NA
|
voip_control_port
|
VoIP Control Port
|
NA
|
NA
|
Modifying SIP Parameters via a TFTP Server
If you have set up your phones to retrieve their SIP parameters via a TFTP server as described in the "Configuring SIP Parameters via a TFTP Server" section, you can also modify your SIP parameters using the configuration files.
As explained in the "Configuring SIP Parameters" section, there are two configuration files that you can use to define the SIP parameters; the default configuration file and the phone-specific configuration file. If used, the default configuration file must be stored in the root directory of your TFTP server. The phone-specific configuration file can be stored in the root directory of the TFTP server or a subdirectory in which phone-specific configuration files are stored.
While it is not required, Cisco recommends that you use the default configuration file to define values for SIP parameters that are common to all phones. Doing so will make controlling and maintaining your network easier. You can then define only those parameters that are specific to a phone in the phone-specific configuration file. Phone-specific parameters should be defined only in a phone-specific configuration file or should be manually configured. Phone-specific parameters should not be defined in the default configuration file.
Modifying the Default SIP Configuration File
In the default configuration file (SIPDefault.cnf), Cisco recommends that you maintain the SIP parameters that are common to all your phones.
By maintaining these parameters in the default configuration file, you can perform global changes, such as upgrading the image version, without having to modify the phone-specific configuration file for each phone.
Before You Begin
- Ensure that you have downloaded the SIPDefault.cnf file from Cisco.com to the root directory of your TFTP server.
- Review the guidelines and restrictions documented in the "Configuration File Guidelines" section.
Step 1 Using an ASCII editor, open the SIPDefault.cnf file and define or modify values for the SIP parameters shown in Table 3-3, as necessary.
Table 3-3 Default SIP Configuration File Parameters
| Parameter
|
Required or Optional
|
Description
|
anonymous_call_block
|
Optional
|
Whether the Anonymous Call Block feature is enabled or disabled by default on the phone. Valid values are:
- 0The Anonymous Call Blocking feature is disabled by default, but can be turned on and off via the phone's user interface. When disabled, anonymous calls are received.
- 1The Anonymous Call Blocking feature is enabled by default, but can be turned on and off via the phone's user interface. When enabled, anonymous calls are rejected
- 2The Anonymous Call Blocking feature is disabled permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
- 3The Anonymous Call Blocking feature is enabled permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
The default value is 0.
|
autocomplete
|
Optional
|
Whether to have numbers automatically completed when dialing. Valid values are 0 (disable auto completion) or 1 (enable auto completion). The default is 1.
|
call_waiting
|
Optional
|
Whether the call waiting feature is enabled or disabled by default on the phone. Valid values are:
- 0The call waiting feature is disabled by default, but can be turned on and off via the phone's user interface. When disabled, call waiting calls are not received.
- 1The call waiting feature is enabled by default, but can be turned on and off via the phone's user interface. When enabled, call waiting calls are accepted.
- 2The call waiting feature is disabled permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
- 3The call waiting feature is enabled permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
The default value is 1.
|
callerid_blocking
|
Optional
|
Whether the Caller ID Blocking feature is enabled or disabled by default on the phone. When enabled, the phone blocks its number or e-mail address from phones that have caller identification capabilities. Valid values are:
- 0The Caller ID Blocking feature is disabled by default, but can be turned on and off via the phone's user interface. When disabled, the caller identification is included in the Request-URI header field.
- 1The Caller ID Blocking feature is enabled by default, but can be turned on and off via the phone's user interface. When enabled, "Anonymous" is included in place of the user identification in the Request-URI header field.
- 2The Caller ID Blocking feature is disabled permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
- 3The Caller ID Blocking feature is enabled permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
The default value is 0.
|
cnf_join_enable
|
Optional
|
Specifies when the conference bridge hangs up whether or not it should attempt to join the two leaf nodes. Valid values are:
- 0Do not join two leaf nodes.
- 1Join two leaf nodes.
The default value is 1, or join two leaf nodes.
|
dnd_control
|
Optional
|
Whether the Do Not Disturb feature is enabled or disabled by default on the phone or whether the feature is permanently enabled. When the feature is permanently enabled, a phone is a "call out" phone only. When the Do Not Disturb feature is turned on, the phone blocks all calls placed to the phone and logs those calls in the Missed Calls directory. Valid values are:
- 0The Do Not Disturb feature is off by default, but can be turned on and off locally via the phone's user interface.
- 1The Do Not Disturb feature is on by default, but can be turned on and off locally via the phone's user interface.
- 2The Do Not Disturb feature is off permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
- 3The Do Not Disturb feature is on permanently and cannot be turned on and off locally via the phone's user interface. This setting sets the phone to be a "call out" phone only. If specifying this value, specify this parameter in the phone-specific configuration file.
The default value is 0.
|
dst_auto_adjust
|
Optional
|
See the "Setting the Date, Time, and Daylight Saving Time" section section for more information.
|
dst_offset
|
dst_start_day
|
dst_start_day_of_week
|
dst_start_month
|
dst_start_time
|
dst_start_week_of_month
|
dst_stop_day
|
dst_stop_day_of_week
|
dst_stop_month
|
dst_stop_time
|
dst_stop_week_of_month
|
dtmf_avt_payload
|
Optional
|
Payload type for Audio/Video Transport (AVT) packets. Possible range is 96 to 127. If the value specified exceeds 127, the phone defaults to 101.
|
dtmf_db_level
|
Optional
|
In-band DTMF digit tone level. Valid values are:
- 1 (6 db below nominal)
- 2 (3 db below nominal)
- 3 (nominal)
- 4 (3 db above nominal)
- 5 (6 db above nominal)
The default is 3.
|
dtmf_inband
|
Optional
|
Whether to detect and generate in-band signaling format. Valid values are 1 (generate DTMF digits in-band) and 0 (do not generate DTMF digits in-band). The default is 1.
|
dtmf_outofband
|
Optional
|
Whether to generate the out-of-band signaling (for tone detection on the IP side of a gateway) and if so, when. The Cisco SIP IP phone supports out-of-bound signaling via the AVT tone method. Valid values are:
- noneDo not generate DTMF digits out-of-band.
- avtIf requested by the remote side, generate DTMF digits out-of-band (and disable in-band DTMF signaling); otherwise, do not generate DTMF digits out-of-band.
- avt_alwaysAlways generate DTMF digits out-of-band. This option disables in-band DTMF signaling.
The default is avt.
|
enable_vad
|
Optional
|
Use 0 to disable VAD and 1 to enable VAD. Default is 0.
|
end_media_port
|
Optional
|
The end Real-Time Transport Protocol (RTP) range for media. Default is 32,766. Valid values are 16,384 to 32,766.
|
image_version
|
Required
|
Firmware version that the Cisco SIP IP phone should run. Enter the name of the image version (as it is released by Cisco). Do not enter the extension. You cannot change the image version by changing the file name, because the version is also built into the file header. Trying to change the image version by changing the file name causes the firmware to fail when it compares the version in the header against the file name.
|
messages_uri
|
Optional
|
Number to call to check voice mail. This number is called when the Messages key is pressed.
|
nat_address
|
Optional
|
The WAN IP address of the Network Address Translation (NAT) or firewall server. You can use either a dotted IP address or a DNS name (A record only).
|
nat_enable
|
Optional
|
Use 0 to disable NAT and 1 to enable NAT. Default is 0. When NAT is enabled, the Contact header appears like this:
Contact: sip:lineN_name@nat_address:voip_control_port
If nat_address is invalid or UNPROVISIONED, then the Contact header appears like this:
Contact: sip:lineN_name@phone_ip_address:voip_control_port
and the Via header appears like this:
Via: SIP/2.0/UDP phone_ip_address:voip_control_port
If NAT is enabled, the Session Description Protocol (SDP) message uses the nat_address and an RTP port between the start_media_port and the end_media_port range in the C and M fields. All RTP traffic is sourced from the port advertised in the SDP.
|
nat_received_processing
|
Optional
|
Use 0 to disable NAT received processing and 1 to enable NAT received processing. Default is 0.
If nat_received_processing is enabled, and received= tag is in the Via header of the 200 OK response from a REGISTER, the IP address in the received= tag is used instead of the nat_address in the Contact header. If this switch occurs, the phone unregisters the old IP address and reregisters with the new IP address.
|
network_media_type
|
Optional
|
Ethernet port negotiation mode. Valid values are:
- AutoPort is auto-negotiated.
- Full100Port is configured to be a full-duplex, 100-MB connection.
- Half100Port is configured to be a half-duplex, 100-MB connection.
- Full10Port is configured to be a full-duplex, 10-MB connection.
- Half10Port is configured to be a half-duplex, 10-MB connection.
The default is Auto.
|
network_port2_type
|
Optional
|
The device type that is connected to port 2 of the phone. Valid values are:
Note If the value is PC, port 2 can be connected only to a PC. If you are not sure about the connection, use the default value. Using a value of "PC" and connecting port 2 to a switch results in spanning tree loops and network confusion.
|
outbound_proxy
|
Optional
|
The IP address of the outbound proxy server. You can use either a dotted IP address or a DNS name.
|
outbound_proxy_port
|
Optional
|
The port number of the outbound proxy server. The default is 5060. When outbound proxy is enabled, all SIP requests are sent to the outbound proxy server instead of the proxyN_address. All responses continue to follow the using the normal Via processing rules. The media stream is not routed through the outbound proxy.
NAT and outbound proxy modes can be independently enabled or disabled. The received= tag is added to the Via header of all responses if there is no received= tag in the uppermost Via header and if the source IP address is different from the IP address in the uppermost Via header. Responses are sent back to the source under the following conditions:
- If a received= tag is in the uppermost Via header, the response is sent back to the IP address contained in the received= tag.
- If there is no received= tag and the IP address in the uppermost Via header is different than the source IP address, the response is sent back to the source IP. Otherwise, the response is sent back to the IP address in the uppermost Via header.
|
phone_password
|
Optional
|
Password to be used for console or Telnet access. The default password is "cisco."
|
phone_prompt
|
Optional
|
Prompt to be displayed when using Telnet or console access. The default phone prompt is "SIP Phone."
|
preferred_codec
|
Optional
|
Codec to use when initiating a call. Valid values are g711alaw, g711ulaw, and g729a. The default is g711ulaw.
|
proxy_backup
|
Optional
|
IP address of the backup proxy server or gateway. Enter this address in IP dotted-decimal notation.
|
proxy_backup_port
|
Optional
|
Port number of the backup proxy server. Default is 5060.
|
proxy_emergency
|
Optional
|
IP address of the emergency proxy server or gateway. Enter this address in IP dotted-decimal notation.
|
proxy_emergency_port
|
Optional
|
Port number of the emergency proxy server. Default is 5060.
|
proxy_register
|
Optional
|
Whether the phone must register with a proxy server during initialization. Valid values are 0 and 1. Specify 0 to disable registration during initialization. Specify 1 to enable registration during initialization. The default is 0.
After a phone has initialized and registered with a proxy server, changing the value of this parameter to 0 unregister s the phone from the proxy server. To reinitiate a registration, change the value of this parameter back to 1.
Note If you enable registration, and authentication is required, you must specify values for the linex_authname and linex_password parameters (where x is a number 1 through 6) in the phone-specific configuration file. For information on configuring the phone-specific configuration file, see the "Modifying the Phone-Specific SIP Configuration File" section.
|
proxy1_address
|
Required
|
IP address of the primary SIP proxy server that will be used by the phones. Enter this address in IP dotted-decimal notation.
|
proxy1_port
|
Optional
|
Port number of the primary SIP proxy server. This is the port on which the SIP client listens for messages. The default is 5060.
Note For additional phone lines, proxyN_address and proxyN_port parameters can be used to assign different proxy addresses to different phone lines. "N" in the parameters represents a phone line. The value of "N" can be from 2 to 6. If the value of "N" is not specified in the proxyN_address parameter, the phone uses the proxy1_address parameter as the default.
|
proxyN_address
|
Optional
|
IP address or DNS name of SIP proxy server that will be used by phone lines other than line 1. For IP address, use the IP dotted-decimal notation. If the proxyN_address parameter is provisioned with an FQDN, the phone sends REGISTER and INVITE messages by using the FQDN in the Req-URI, To, and From fields. If you want to use a dotted IP address, the proxyN_address parameters should be configured as dotted IP addresses.
|
proxyN_port
|
Optional
|
Port number of the SIP proxy server that will be used by phone lines other than line 1.
|
sip_invite_retx
|
Optional
|
Maximum number of times an INVITE request will be retransmitted. The valid value is any positive integer. The default is 6.
|
sip_retx
|
Optional
|
Maximum number of times a SIP message other than an INVITE request will be retransmitted. The valid value is any positive integer. The default is 10.
|
sntp_mode
|
Optional
|
See the "Setting the Date, Time, and Daylight Saving Time" section section for more information.
|
sntp_server
|
start_media_port
|
Optional
|
The start RTP range for media. Default is 16,384. Valid values are 16,384 to 32,766.
|
sync
|
Optional
|
Value against which to compare the value in the syncinfo.xml file before performing a remote reboot. Valid value is a character string up to 32 characters long.
|
tftp_cfg_dir
|
Required if phone-specific configuration files are located in a subdirectory.
|
Path to the TFTP subdirectory in which phone-specific configuration files are stored.
|
time_format_24hr
|
Optional
|
Whether a 12- or 24-hour time format is displayed by default on the phones' user interface. Valid values are:
- 0The 12-hour format is displayed by default but can be changed to a 24-hour format via the phone's user interface.
- 1The 24-hour format is displayed by default but can be changed to a 12-hour format via the phone's user interface.
- 2-The 12-hour format is displayed and cannot be changed to a 24-hour format via the phone's user interface.
- 3The 24-hour format is displayed and cannot be changed to a 12-hour format via the phone's user interface.
The default value is 1.
|
time_zone
|
Optional
|
See the "Setting the Date, Time, and Daylight Saving Time" section section for more information.
|
timer_invite_expires
|
Optional
|
The amount of time, in seconds, after which a SIP INVITE expires. This value is used in the Expire header field. The valid value is any positive number; however, Cisco recommends 180 seconds. The default is 180.
|
timer_register_expires
|
Optional
|
The amount of time, in seconds, after which a REGISTRATION request expires. This value is inserted into the Expire header field. The valid value is any positive number; however, Cisco recommends 3600 seconds. The default is 3600.
|
timer_t1
|
Optional
|
Lowest value (in milliseconds) of the retransmission timer for SIP messages. The valid value is any positive integer. The default is 500.
|
timer_t2
|
Optional
|
Highest value (in milliseconds) of the retransmission timer for SIP messages. The valid value is any positive integer greater than timer_t1. The default is 4000.
|
tos_media
|
Optional
|
Type of service (ToS) level for the media stream being used. Valid values are:
- 0 (IP_ROUTINE)
- 1 (IP_PRIORITY)
- 2 (IP_IMMEDIATE)
- 3 (IP_FLASH)
- 4 (IP_OVERIDE)
- 5 (IP_CRITIC)
The default is 5.
|
user_info
|
Optional
|
Configures the "user=" parameter in the REGISTER message. Valid values are:
- noneNo value is inserted.
- phoneThe value user=phone is inserted in the To, From, and Contact Headers for REGISTER.
- ipThe value user=ip is inserted in the To, From, and Contact Headers for REGISTER.
The default value is none.
|
voip_control_port
|
Optional
|
The UDP port used for SIP messages. Default is 5060. All SIP REQUESTS use voip_control_port as the UDP source port when nat_enable = 1. Valid values are 1025 to 65,535.
|
Step 2 Save the file with the same file name, SIPDefault.cnf, to the root directory of your TFTP server.
The following is a sample SIP default configuration file:
; sip default configuration file
image_version:P0S3-
xx-y-zz ;
preferred_codec :g711ulaw
timer_register_expires :3600 ;
proxy1_address: 192.168.1.1 ;
Modifying the Phone-Specific SIP Configuration File
In the phone-specific SIP configuration file, maintain those parameters that are specific to a phone such as the lines configured on a phone and the users defined for those lines.
Before You Begin
- Review the guidelines and restrictions documented in the "Configuration File Guidelines" section.
- Line parameters (those identified as linex) define a line on the phone. If you configure a line to use an e-mail address, that line can be called only by using an e-mail address. Similarly, if you configure a line to use a number, that line can be called only by using the number. Each line can have a different proxy configured.
Step 1 Using an ASCII editor, create a phone-specific configuration file for each phone that you plan to install. In the phone-specific configuration file, define values for SIP parameters shown in Table 3-4.
 |
Note For all variables, x is a number 1 through 6.
|
Table 3-4 Phone-Specific Configuration Parameters
| Parameter
|
Required or Optional
|
Description
|
linex_name
|
Required
|
Number or e-mail address used when registering. When entering a number, enter the number without any dashes. For example, enter 555-1212 as 5551212. When entering an e-mail address, enter the e-mail ID without the host name.
|
linex_shortname
|
Optional
|
Name or number associated with the linex_name as you want it to display on the phone's LCD if the linex_name length exceeds the allowable space in the display area. For example, if the linex_name value is the phone number 111-222-333-4444, you can specify 34444 for this parameter to have 3444 display on the LCD instead. Alternatively, if the value for the linex_name parameter is the e-mail address "username@company.com", you can specify the "username" to have just the user name appear on the LCD instead.
This parameter is used for display only. If a value is not specified for this parameter, the value in the linex_name variable is displayed.
|
linex_authname
|
Required for line 1 when registration is enabled and the proxy server requires authentication
|
Name used by the phone for authentication if a registration is challenged by the proxy server during initialization. If a value is not configured for the linex_authname parameter for a line when registration is enabled, the value defined for line 1 is used. If a value is not defined for line 1, the default line1_authname is UNPROVISIONED.
|
linex_password
|
Required for line 1 when registration is enabled and the proxy server requires authentication
|
Password used by the phone for authentication if a registration is challenged by the proxy server during initialization. If a value is not configured for the linex_password parameter for a line when registration is enabled, the value defined for line 1 is used. If a value is not defined for line 1, the default line1_password is UNPROVISIONED.
|
linex_displayname
|
Optional
|
Identification as it should appear for caller identification purposes. For example, instead of jdoe@company.com appearing on phones that have caller ID, you can specify John Doe in this parameter to have John Doe appear on the callee end instead. If a value is not specified for this parameter, nothing is used.
|
dnd_control
|
Optional
|
Whether the Do Not Disturb feature is enabled or disabled by default on the phone or whether the feature is permanently enabled, making the phone a "call out" phone only. When the Do Not Disturb feature is turned on, the phone blocks all calls placed to the phone and logs those calls in the Missed Calls directory. Valid values are:
- 0The Do Not Disturb feature is off by default, but can be turned on and off locally via the phone's user interface.
- 1The Do Not Disturb feature is on by default, but can be turned on and off locally via the phone's user interface.
- 2The Do Not Disturb feature is off permanently and cannot be turned on and off locally via the phone's user interface. If specifying this value, specify this parameter in the phone-specific configuration file.
- 3The Do Not Disturb feature is on permanently and cannot be turned on and off locally via the phone's user interface. This setting sets the phone to be a "call out" phone only. If specifying this value, specify this parameter in the phone-specific configuration file.
Note This parameter is best configured in the SIPDefault.dnf file unless configuring a phone to be a "call-out" phone only. When configuring a phone to be a "call-out" phone, define this parameter in the phone-specific configuration file.
|
phone_label
|
Optional
|
Label to display on the top status line of the LCD. This field is for end-user display only. For example, a phone's label can display "John Doe's phone." Up to 11 characters can be used when specifying the phone label.
Save the file to your TFTP server (in the root directory or a subdirectory containing all the phone-specific configuration files). Name the file SIPXXXXYYYYZZZZ.cnf where XXXXYYYYZZZZ is the MAC address of the phone. The MAC address must be in uppercase and the extension, cnf, must be in lower case (for example, SIP00503EFFD842.cnf).
|
The following is a sample configuration file:
; phone-specific configuration file sample
; Line 1 name for authentication with proxy server
; Line 1 authentication name password
line1_password : password
Modifying the SIP Parameters Directly on Your Phone
If you did not configure the SIP parameters via a TFTP server, you can configure them directly on your phone after you have connected the phone.
Before You Begin
- Unlock configuration mode as described in the "Unlocking Configuration Mode" section. By default, the SIP parameters are locked to ensure that end users cannot modify settings that might affect their call capabilities.
- Review the guidelines on using the Cisco SIP IP phone menus documented in the "Using the Cisco SIP IP Phone Menu Interface" section.
- Line parameters (those identified as linex) define a line on the phone. If you configure a line to use an e-mail address, that line can be called only by using an e-mail address. Similarly, if you configure a line to use a number, that line can be called only by using the number.
- When configuring the Preferred Codec and Out of Band DTMF parameters, press the Change soft key until the option you desire is displayed and then press the Save soft key.
- After making your changes, relock configuration mode as described in the "Locking Configuration Mode" section.
Step 1 Press the settings key. The Settings menu appears.
Step 2 Highlight SIP Configuration. The SIP Configuration menu appears.
Step 3 Highlight Line 1 Settings.
Step 4 Press the Select soft key. The Line 1 Configuration menu appears.
Step 5 Highlight and press the Select soft key to configure the parameters shown in Table 3-5, as necessary:
Table 3-5 SIP Configuration Parameters
| Parameter
|
Required or Optional
|
|
Name
|
Required
|
Number or e-mail address used when registering. When entering a number, enter the number without any dashes. For example, enter 555-1212 as 5551212. When entering an e-mail address, enter the e-mail ID without the host name.
|
Short Name
|
Optional
|
Name or number associated with the linex_name as you want it to display on the phone's LCD if the linex_name value exceeds the display area. For example, if the linex_name value is the phone number 111-222-333-4444, you can specify 34444 for this parameter to have 3444 display on the LCD instead. Alternatively, if the value for the linex_name parameter is the e-mail address "username@company.com", you can specify the "username" to have just the user name appear on the LCD instead. This parameter is used for display only. If a value is not specified for this parameter, the value in the Name variable is displayed.
|
Authentication Name
|
Required when registration is enabled
|
Name used by the phone for authentication if a registration is challenged by the proxy server during initialization.
|
Authentication Password
|
Required when registration is enabled
|
Password used by the phone for authentication if a registration is challenged by the proxy server during initialization. If a value is not configured for the Authentication Password parameter when registration is enabled, the default logical password is used. The default logical password is SIPmacaddress, where macaddress is the MAC address of the phone.
|
Display Name
|
Optional
|
Identification as it should appear for caller identification. For example, instead of jdoe@company.com appearing on phones that have caller ID, you can specify John Doe in this parameter to have John Doe appear on the callee end instead. If a value is not specified for this parameter, the Name value is used.
|
Proxy Address
|
Required
|
IP address of the primary SIP proxy server that will be used by the phone. Enter this address in IP dotted-decimal notation.
|
Proxy Port
|
Optional
|
Port number of the primary SIP proxy server. This is the port that the SIP client will use. The default is 5060.
|
Step 6 Press the Back soft key to exit the Line 1 Configuration menu.
Step 7 To configure additional lines on the phone, highlight the next Line x Settings, press the Select soft key and repeat Step 5 and Step 6, and then continue with Step 8.
Step 8 In addition to the line settings, you can highlight and press Select to configure the parameters on the SIP Configuration menu shown in Table 3-6:
Table 3-6 Additional SIP Configuration Parameters
| Parameter
|
Required or Optional
|
|
Messages URI
|
Optional
|
Number to call to check voice mail. This number is called when the Messages key is pressed.
|
Preferred Codec
|
Optional
|
Codec to use when initiating a call. Valid values are g711alaw, g711ulaw, and g729a. The default is g711ulaw.
|
Out of Band DTMF
|
Optional
|
Whether to detect and generate the out-of-band signaling (for tone detection on the IP side of a gateway) and if so, when. The Cisco SIP IP phone supports out-of-bound signaling via the AVT tone method. Valid values are:
- noneDo not generate DTMF digits out-of-band.
- avtIf requested by the remote side, generate DTMF digits out-of-band (and disable in-band DTMF signaling); otherwise, do not generate DTMF digits out-of-band.
- avt_alwaysAlways generate DTMF digits out-of-band. This option disables in-band DTMF signaling.
The default is avt.
|
Register with Proxy
|
Optional
|
Whether the phone must register with a proxy server during initialization. Valid values are Yes and No. Select the No soft key to disable registration during initialization. Select the Yes soft key to enable registration during initialization. The default is No. After a phone has initialized and registered with a proxy server, changing the value of this parameter to No unregisters the phone from the proxy server. To reinitiate a registration, change the value of this parameter back to Yes.
Note If you enable registration, and authentication is required, you must specify values for the Authentication Name and Authentication Password parameters.
|
Register Expires
|
Optional
|
The amount of time, in seconds, after which a REGISTRATION request expires. This value is used the Expire header field. The valid value is any positive number; however, Cisco recommends 3600 seconds. The default is 3600.
|
TFTP Directory
|
Required if phone-specific configuration files are located in a subdirectory
|
Path to the TFTP subdirectory in which phone-specific configuration files are stored.
|
Phone Label
|
Optional
|
Label to display on the top status line of the LCD. This field is for end-user display only. For example, a phone's label can display "John Doe's phone." Up to 11 characters can be used when specifying the phone label.
|
Enable VAD
|
Optional
|
Specifies whether VAD is enabled or disabled.
|
VoIP Control Port
|
Optional
|
The UDP port used for SIP messages. Default is 5060. All SIP REQUESTS use voip_control_port as the UDP source port when nat_enable = 1. Valid values are 1025 to 65535.
|
Start Media Port
|
Optional
|
The start RTP range for media. Default is 16,384. Valid values are 16,384 to 32,766.
|
End Media Port
|
Optional
|
The end RTP range for media. Default is 32,766. Valid values are 16,384 to 32,766.
|
Backup Proxy
|
Optional
|
IP address of the backup proxy server or gateway. Enter this address in IP dotted-decimal notation.
|
Backup Proxy Port
|
Optional
|
Port number of the backup proxy server. Default is 5060.
|
Emergency Proxy
|
Optional
|
IP address of the emergency proxy server or gateway. Enter this address in IP dotted-decimal notation.
|
Emergency Proxy Port
|
Optional
|
Port number of the emergency proxy. Default is 5060.
|
Outbound Proxy
|
Optional
|
The IP address of the outbound proxy server. You can use either a dotted IP address or a DNS name (A record only).
|
Outbound Proxy Port
|
Optional
|
The port number of the outbound proxy server. The default is 5060.
|
NAT Enabled
|
Optional
|
Choose No to disable NAT and Yes to enable NAT.
|
NAT Address
|
Optional
|
The WAN IP address of the NAT or firewall server. You can use either a dotted IP address or a DNS name (A record only).
|
Step 9 When done, press the Save soft key to save your changes and exit the SIP Configuration menu.
Using the Command-Line Interface
You can use Telnet or a console to connect to your Cisco SIP IP phone to debug or troubleshoot the phone. Table 3-7 shows the available CLI commands:
Table 3-7 CLI Commands
| Command
|
Purpose
|
SIP Phone> debug { console-stall | strlib | malloc |
malloc-table | sk-platform | flash | dsp | vcm |
dtmf | task-socket | lsm | fsm | auth | fim | g sm |
cc | cc-msg | softkeys | error | sip-task |
sip-state | sip-messages | sip-reg-state | dns |
config | sntp | sntp-packet}
|
Shows detailed debug output when used with the following keywords:
- console-stall: Shows debug output for the console-stall driver output mode.
- strlib: Shows debug output for the string library.
- malloc: Shows debug output for memory allocation.
- malloc-table: Shows debug output for the memory allocation table.
- sk-platform: Shows debug output for the platform.
- flash: Shows debug output for the Flash memory.
- dsp: Shows debug output for DSP accesses.
- vcm: Shows debug output for the voice channel manager (VCM), including tones, ringing, and volume.
- dtmf: Shows debug output for DTMF relay.
- task-socket: Shows socket task debug output.
- lsm: Shows debug output for the Line State Manager.
- fsm: Shows debug output for the Feature State Manager.
- auth: Shows debug output for the SIP authorization state machine.
- fim: Shows debug output for the Feature Interaction Manager.
- gsm: Shows debug output for the Global State Manager.
- cc: Shows debug output for call control.
- cc-msg: Shows debug output for the call control messages.
- softkeys: Displays the currently available soft key sets.
- error: Shows general error debug output.
- sip-task: Shows debug output for the SIP task.
- sip-state: Shows debug output for the SIP state machine.
- sip-messages: Shows debug output for SIP messaging.
- sip-reg-state: Shows debug output for the SIP registration state machine.
- dns: Shows the DNS command-line interface (CLI) configuration; allows you to clear the cache and set servers).
|
debug command keywords (continued)
|
- config: Shows output for the config system command.
- sntp: Shows debug output for Simple Network Time Protocol (SNTP).
- sntp-packet: Displays full SNTP packet data.
Note Do not use the debug all command, because it can cause the phone to become inoperable. This command is for use only by Cisco TAC personnel.
|
|