Cisco Unified CME Commands: I

This chapter contains commands to configure and maintain Cisco Unified Communications Manager Express (formally known as Cisco Unified CallManager Express). The commands are presented in alphabetical order. Some commands required for configuring Cisco Unified Communications Manager Express (Cisco Unified CME) may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.

id (voice register pool)

To explicitly identify a locally available individual Cisco SIP IP phone, or when running Cisco Unified Session Initiation Protocol (SIP) Survivable Remote Site Telephony (SRST), set of Cisco SIP IP phones, use the id command in voice register pool configuration mode. To remove local identification, use the no form of this command.

id {network address mask mask | ip address mask mask | mac address}

no id {network address mask mask | ip address mask mask | mac address}

Syntax Description


network address mask mask	The network address mask mask keyword/argument combination is used to accept SIP Register messages for the indicated phone numbers from any IP phone within the specified IP subnet.
ip address mask mask	The ip address mask mask keyword/argument combination is used to identify an individual phone.
mac address	The mac address keyword/argument combination is used to identify the MAC address of a particular Cisco IP phone.

Command Default

Command Modes

Command History


Release	Cisco Product	Modification
12.2(15)ZJ	Cisco SIP SRST 3.0	This command was introduced.
12.3(4)T	Cisco SIP SRST 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.
12.4(4)T	Cisco CME 3.4 Cisco SIP SRST 3.4	This command was added to Cisco CME.

Usage Guidelines

Configure the id (voice register pool) command before any other voice register pool commands.

The id command allows explicit identification of an individual Cisco SIP IP phone to support a degree of authentication, which is required to accept registrations, based upon the following:

•

Verification of the local Layer 2 MAC address using the router's Address Resolution Protocol (ARP) cache.

•

Verification of the known single static IP address (or DHCP dynamic IP address within a specific subnet) of the Cisco SIP IP phone.

When the mac address keyword and argument are used, the IP phone must be in the same subnet as that of the router's LAN interface, such that the phone's MAC address is visible in the router's ARP cache. Once a MAC address is configured for a specific voice register pool, remove the existing MAC address before changing to a new MAC address.

Note For Cisco Unified SIP SRST, this command also allows explicit identification of locally available set of Cisco SIP IP phones.

Examples

The following is partial sample output from the show running-config command. The id command identifies the MAC address of a particular Cisco IP phone. The output shows that voice register pool 1 has been set up to accept SIP Register messages from a specific IP phone through the use of the id command.

Related Commands


Command	Description
mode (voice register global)	Enables the mode for provisioning SIP phones in a Cisco Unified CallManager Express (Cisco Unified CME) system.
voice register pool	Enters voice register pool configuration mode for SIP phones.

intercom (ephone-dn)

To create an intercom by programming a pair of extensions (ephone-dns) to automatically call and answer each other, use the intercom command in ephone-dn configuration mode. To remove an intercom, use the no form of this command.

intercom extension-number [barge-in [no-mute] [label label] ] [ no-auto-answer] [label label] [no-mute]

Syntax Description


extension-number	Telephone number to which intercom calls are placed.
barge-in	(Optional) Allows inbound intercom calls to force an existing call into the call-hold state and allows the intercom call to be answered immediately.
label label	(Optional) Defines an alphanumeric label for the intercom, of up to 30 characters.
no-auto-answer	(Optional) Disables the intercom auto-answer feature.
no-mute	Allows an intercom call to be answered without deactivating a speaker's mute key.

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco CME Version	Modification
12.2(2)XT	2.0	This command was introduced on the following platforms: Cisco 1750, Cisco 1751, Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(8)T	2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T	2.01	This command was implemented on the Cisco 1760.
12.3(11)XL	3.2.1	The no-mute keyword was added.
12.3(14)T	3.3	This command was integrated into Cisco IOS Release 12.3(14)T.

Usage Guidelines

This command is used to dedicate a pair of Cisco ephone-dns for use as a "press to talk" two-way intercom between Cisco IP phones. Intercom lines cannot be used in shared-line configurations. If an ephone-dn is configured for intercom operation, it must be associated with one Cisco IP phone only. The intercom attribute causes an IP extension (ephone-dn) to operate in autodial fashion for outbound calls and auto answer-with-mute for inbound calls.

The barge-in keyword allows inbound intercom calls to force an existing call on the called phone into the call-hold state to allow the intercom call to be answered immediately. The no-auto-answer keyword creates for the IP phone line a connection that resembles a private line, automatic ringdown (PLAR). The label keyword defines a text label for the intercom.

Following this command, the intercom ephone-dns are assigned to ephones using the button command. Following the button command, the restart command must be used to initiate a quick reboot of the phones to which this intercom is assigned.

The default intercom command behavior is speakers are set to mute automatically when phones receive intercom calls. For example, if phone user 1 places an intercom call and connects to phone user 2, user 2 will hear user 1, but user 1 will not hear user 2. To be heard, user 2 must first disable the speaker's mute function. The benefit is people who receive intercom calls can use the mute button to control when they will be heard initially.

The no-mute keyword deactivates the speaker mute function when IP phones receive intercom calls. For example, if phone user 1 makes an intercom call to phone user 2, both users will hear each other upon connection. The benefit is that people who receive intercom calls do not have to disable their speaker's mute function to be heard, but their conversations and nearby background sounds will be heard the moment an intercom call to them is connected—regardless of whether they are ready to take a call or not.

Examples

In the example, ephone-dn 18 and ephone-dn 19 are set as an intercom pair. Ephone-dn 18 is associated with button 3 of Cisco IP phone (ephone) 4, and ephone-dn 19 is associated with button number 3 of Cisco IP phone (ephone) 5. Button 3 on Cisco IP phone 4 and button 3 on Cisco IP phone 5 are set as a pair to provide intercom service to each other.

The intercom feature acts as a combination speed-dial PLAR and auto answer-with-mute. If the barge-in keyword is set on the ephone-dn that receives the intercom call, the existing call is forced into the hold state, and the intercom call is accepted. If the phone user has the handset off hook (that is, not in speakerphone mode), the user hears a warning beep, and the intercom call is immediately connected with two-way audio. If the phone user is using speakerphone mode, the intercom connects with the microphone mute activated.

Note Any caller can dial in to an intercom extension, and a call to an intercom extension that is originated by a nonintercom caller triggers an automatic answer exactly like a legitimate intercom call. To prevent nonintercom originators from manually dialing an intercom destination, you can use alphabetic characters when you assign numbers to intercom extensions using the number command. These characters cannot be dialed from a normal phone but can be dialed by preprogrammed intercom extensions whose calls are made by the router.

Related Commands


Command	Description
button	Associates ephone-dns with individual buttons on Cisco IP phones and specifies ring behavior per button.
ephone-dn	Enters ephone-dn configuration mode.
number	Associates a telephone or extension number with an extension (ephone-dn).
restart (ephone)	Performs a fast reboot of a single phone associated with a Cisco CME router.
restart (telephony-service)	Performs a fast reboot of one or all phones associated with a Cisco CME router.

ip source-address (credentials)

To enable the Cisco Unified CME or SRST router to receive credential service messages through the specified IP address and port, use the ip source-address command in credentials configuration mode. To disable the router from receiving messages, use the no form of this command.

Syntax Description


ip-address	Router IP address, typically one of the addresses of the Ethernet port of the local router.
port port	(Optional) TCP port for credentials service communication. Range is from 2000 to 9999. Cisco Unified CME default is 2444. SRST default is 2445.

Command Default

Cisco Unified CME default port number: 2444
Cisco Unified SRST default port number: 2445

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.3(14)T	Cisco SRST 3.3	This command was introduced for Cisco SRST.
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced for Cisco Unified CME.
12.4(9)T	Cisco Unified CME 4.0	This command for Cisco Unified CME was integrated in Cisco IOS Release 12.4(9)T.

Usage Guidelines

This command is used with Cisco Unified CME phone authentication to identify a Cisco Unified CME router on which a CTL provider is being configured.

The ip source-address command is a mandatory command to enable secure SRST. If the port number is not provided, the default value (2445) is used. The IP address is usually the IP address of the secure SRST router.

Examples

The following example creates a CTL provider on a Cisco Unified CME router that is not running the CTL client.

The following example enters credentials configuration mode and sets the IP source address and port:

Related Commands


Command	Description
credentials	Enters credentials configuration mode to configure a Cisco Unified CME CTL provider certificate or an SRST router certificate.
ctl-service admin	Specifies a user name and password to authenticate the CTL client during the CTL protocol.
debug credentials	Sets debugging on the credentials service that runs between a Cisco Unified CME CTL provider and the CTL client or between an SRST router and Cisco Unified CallManager.
show credentials	Displays the credentials settings on a Cisco Unified CME or SRST router.
trustpoint (credentials)	Specifies the name of the trustpoint to be associated with a Cisco Unified CME CTL provider certificate or with an SRST router certificate.

ip source-address (telephony-service)

To identify the IP address and port through which IP phones communicate with a Cisco Unified CME router, use the ip source-address command in telephony-service configuration mode. To disable the router from receiving messages from Cisco Unified IP phones, use the no form of this command.

ip source-address ip-address [port port] [secondary ip-address [rehome seconds]] [any-match | strict-match]

Syntax Description


ip-address	Preexisting router IP address, typically one of the addresses of the Ethernet port of the router.
port port	(Optional) TCP/IP port number to use for Skinny Client Control Protocol (SCCP). Range is from 2000 to 9999. Default is 2000.
secondary	(Optional) Second Cisco Unified CME router with which phones can register if the primary Cisco Unified CME router fails.
rehome seconds	(Optional) Used only by Cisco Unified IP phones that have registered with a Cisco Unified SRST router. This keyword defines a delay that is used by phones to verify the stability of their primary SCCP controller (Cisco Unified CallManager or Cisco Unified CME) before the phones reregister with it. This parameter is ignored by phones unless they are registered to a secondary Cisco Unified SRST router. The range is from 0 to 65535 seconds. The default is 120 seconds. Note The use of this parameter is a phone behavior and is subject to change, based on the phone type and phone firmware version.
any-match	(Optional) Disables strict IP address checking for registration. This is the default.
strict-match	(Optional) Requires strict IP address checking for registration.

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.1(5)YD	Cisco ITS 1.0	This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT	Cisco ITS 2.0	This command was implemented on the Cisco 1750 and Cisco 1751.
12.2(8)T	Cisco ITS 2.0	This command was integrated into Cisco IOS Release 12.2(8)T and implemented on the Cisco 3725 and Cisco 3745.
12.2(8)T1	Cisco ITS 2.0	This command was implemented on the Cisco 2600-XM and Cisco 2691.
12.2(11)T	Cisco ITS 2.01	This command was implemented on the Cisco 1760.
12.4(4)XC	Cisco Unified CME 4.0	The secondary ip-address and rehome seconds keyword-argument pairs were added.

Usage Guidelines

Note Prior to version 4.0, the name of this product was Cisco CallManager Express (Cisco CME). Prior to version 3.0, the name was Cisco IOS Telephony Services (Cisco ITS).

This mandatory command enables a router to receive messages from Cisco Unified IP phones through the specified IP address and port. The Cisco Unified CME router cannot communicate with the Cisco Unified CME phones if the IP address is not provided. If the port number is not provided, the default is port 2000. The IP address is usually the IP address of the Ethernet port to which the phones are connected.

Use the any-match keyword to instruct the router to permit Cisco Unified IP phone registration, and use the strict-match keyword to instruct the router to reject IP phone registration attempts if the IP server address used by the phone does not match the source address exactly.

Prior to Cisco IOS Telephony Services (Cisco ITS) V2.1, this command helped the router to automatically generate the SEPDEFAULT.cnf file, which was stored in the flash memory of the router. The SEPDEFAULT.cnf file contains the IP address of one of the Ethernet ports of the router to which the phone should register. In ITS V2.1, Cisco CME 3.0, and later versions, the configuration files have been moved to system:/its/. The file named Flash:SEPDEFAULT.cnf that was used with previous Cisco ITS versions is now obsolete, but is retained as system:/its/SEPDEFAULT.cnf to support upgrades from older phone firmware.

For systems using Cisco ITS V2.1, Cisco CME 3.0, or later versions, the IP phones receive their initial configuration information and phone firmware from the TFTP server associated with the router. In most cases, the phones obtain the IP address of their TFTP server using the option 150 command and Dynamic Host Configuration Protocol (DHCP). For Cisco ITS or Cisco CME operation, the TFTP server address obtained by the Cisco Unified IP phones should point to the router IP address. The Cisco IP phones attempt to transfer a configuration file called XmlDefault.cnf.xml. This file is automatically generated by the router through the ip source-address command and is placed in router memory. The XmlDefault.cnf.xml file contains the IP address that the phones use to register for service, using the Skinny Client Control Protocol (SCCP). This IP address should correspond to a valid Cisco CME router IP address (and may be the same as the router TFTP server address).

Similarly, when an analog telephone adapter (ATA) such as the ATA-186 is attached to the Cisco Unified CME router, the ATA receives very basic configuration information and firmware from the TFTP server XmlDefault.cnf.xml file. The XmlDefault.cnf.xml file is automatically generated by the Cisco Unified CME router with the ip source-address command and is placed in the router's flash memory.

By specifying a second Cisco Unified CME router in the ip source-address command, you improve the failover time for phones.

Examples

The following example establishes the router at 10.5.2.78 as a secondary router:

Table Of Contents