Cisco Unified CME Commands: R

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

ences. Use the command reference master index or search online to find these commands.

refer-ood enable

To enable out-of-dialog refer (OOD-R) processing, use the refer-ood enable command in SIP user-agent configuration mode. To disable OOD-R, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Out of dialog Refer allows applications to establish calls using the SIP gateway or Cisco Unified CME. The application sets up the call and the user does not dial out from their own phone.

Examples

Related Commands

request-limit	(Optional) Maximum number of concurrent incoming OOD-R requests that the router can process. Range: 1 to 500. Default: 500.

Release	Modification
12.4(11)XJ	This command was introduced.
12.4(15)T	This command was integrated into Cisco IOS Release 12.4(15)T.


Command	Description
authenticate (voice global)	Defines the authenticate mode for SIP phones in a Cisco Unified CME or Cisco Unified SRST system.
credential load	Reloads a credential file into flash memory.
debug voip application	Displays all application debug messages.

refer target dial-peer

To populate the Refer To portion of a SIP Refer message with the address from the dial peer for the directory number being configured, use the refer target dial-peer command in voice register dn configuration mode. To return to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Use this command in voice register dn configuration mode to specify that the destination address for this directory number be the dial peer. If this command is not configured, Cisco IOS software will transfer the call to the destination in the SIP Refer message and if that destination address is Cisco Unified CME, call SIP will send out and route back to CME before sending to the directory number, creating two extra call legs.

Cisco IOS Release	Cisco Product	Modification
12.4(11)XW2	Cisco Unified CME 4.2	This command was introduced.

The following partial output from the show working-configuration command shows the configuration for three directory numbers. This configuration will populate the Refer To portion of the SIP Refer message with the address from the dial peer for each of the directory numbers.

regenerate (ctl-client)

To create a new CTLFile.tlv file after making changes to the CTL client configuration, use the regenerate command in CTL-client configuration mode. The no form of this command has no effect in the configuration.

Syntax Description

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Examples

The following example gives the instruction to regenerate the CTL file with the current information.

To create an ID for explicitly identifying an external feature server during Register requests, use the register-id command in voice register session-server configuration mode. To remove an ID, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Use this command to create an ID for identifying a route point during Register requests. Cisco Unified CME challenges and authenticates the initial keepalive Register request and issues a systemwide unique Cisco-referenceID to be included in the response to the Register request from this route point.

Examples

The following partial output shows the configuration of a session manager for an external feature server, including the register ID of CSR1:

Related Commands

registrar server (SIP)

name	String of up to 30 alphanumeric characters.

Cisco IOS Release	Cisco Product	Modification
12.4(11)XW2	Cisco Unified CME 4.2	This command was introduced.

Command	Description
keepalive	Duration for registration after which the registration expires unless the feature server reregisters before the registration expiry.

To enable SIP registrar functionality, use the registrar server command in SIP configuration mode. To disable SIP registrar functionality, use the no form of the command.

Syntax Description


expires	(Optional) Sets the active time for an incoming registration.
max sec	(Optional) Maximum expires time for a registration, in seconds. The range is from 600 to 86400. The default is 3600.
min sec	(Optional) Minimum expires time for a registration, in seconds. The range is from 60 to 3600. The default is 60.

Command Default

Command Modes

Command History


Cisco IOS 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 and Cisco SIP SRST 3.4	This command was added to Cisco CME.

Usage Guidelines

When this command is entered, the router accepts incoming SIP Register messages. If SIP Register message requests are for a shorter expiration time than what is set with this command, the SIP Register message expiration time is used.

This command is mandatory for Cisco Unified SIP SRST or Cisco Unified CME and must be entered before any voice register pool or voice register global commands are configured.

If the WAN is down and you reboot your Cisco Unified CME or Cisco Unified SIP SRST router, when the router reloads it will have no database of SIP phone registrations. The SIP phones will have to register again, which could take several minutes, because SIP phones do not use a keepalive functionality. To shorten the time before the phones re-register, the registration expiry can be adjusted with this command. The default expiry is 3600 seconds; an expiry of 600 seconds is recommended.

Examples

The following partial sample output from the show running-config command shows that SIP registrar functionality is set:

Related Commands


Command	Description
sip	Enters SIP configuration mode from voice service VoIP configuration mode.
voice register global	Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco Unified CME or Cisco Unified SIP SRST environment.
voice register pool	Enters voice register pool configuration mode for SIP phones.

reset (ephone)

To perform a complete reboot of a single phone associated with a Cisco CallManager Express (Cisco CME) router, use the reset command in ephone configuration mode.

Syntax Description

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco CME Version	Modification
12.1(5)YD	1.0	This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT	2.0	This command was implemented on the Cisco 1750 and Cisco 1751.
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 2600XM and Cisco 2691.
12.2(11)T	2.01	This command was implemented on the Cisco 1760.

Usage Guidelines

After you update information for one or more phones associated with a Cisco CME router, the phone or phones must be rebooted. There are two commands to reboot the phones: reset and restart. The reset command performs a "hard" reboot similar to a power-off-power-on sequence. It reboots the phone and contacts the Dynamic Host Configuration Protocol (DHCP) server and the TFTP server to update from their information as well. The restart command performs a "soft" reboot by simply rebooting the phone without contacting the DHCP and TFTP servers. The reset command takes significantly longer to process than the restart command when you are updating multiple phones, but it must be used after updating phone firmware, user locale, network locale, or URL parameters. For simple button, line, or speed-dial changes, you can use the restart command.

Use the reset (ephone) command to perform a complete reboot of an IP phone when you are in ephone configuration mode. This command has the same effect as a reset (telephony-service) command that is used to reset a single phone.

Examples

Related Commands


Command	Description
ephone	Enters ephone configuration mode.
reset (telephony-service)	Performs a complete reboot of one or all phones associated with a Cisco CME router.
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.

reset (telephony-service)

To perform a complete reboot of one or all phones associated with a Cisco CallManager Express (Cisco CME) router, use the reset command in telephony-service configuration mode. To interrupt and cancel a sequential reset cycle, use the no form of the command with the sequence-all keyword.

reset {all [time-interval] | cancel | mac-address | sequence-all}

no reset {all [time-interval] | cancel | mac-address | sequence-all}

Syntax Description


all	Resets all Cisco IP phones served by the Cisco CME router. The router pauses for 15 seconds between the reset starts for each successive phone unless the time-interval argument is used to change that value.
time-interval	(Optional) Time interval, in seconds, between each phone reset. Range is from 0 to 60. Default is 15.
cancel	Interrupts a sequential reset cycle that was started with a reset sequence-all command.
mac-address	MAC address of a particular Cisco IP phone.
sequence-all	Resets all phones in strict one-at-a-time order by waiting for one phone to reregister before starting the reset for the next phone. The sequencing of resets prevents possible conflicts between phones trying to access TFTP services simultaneously. There is a reset timeout of 4 minutes, after which the router stops waiting for the currently registering phone to complete registration and starts to reset the next phone.

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco CME Version	Modification
12.1(5)YD	1.0	This command was introduced on the Cisco 2600 series, Cisco 3600 series, and Cisco IAD2420 series.
12.2(2)XT	2.0	This command was implemented on the Cisco 1750 and Cisco 1751.
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 2600XM and Cisco 2691.
12.2(11)T	2.01	This command was implemented on the Cisco 1760.
12.2(11)YT	2.1	The time-interval range maximum was increased from 15 to 60 and the default was changed from 0 to 15.
12.2(11)YT1	2.1	The cancel and sequence-all keywords were introduced.
12.2(15)T	2.1	This command was integrated into Cisco IOS Release 12.2(15)T.

Usage Guidelines

After you update information for one or more phones associated with a Cisco CME router, the phone or phones must be rebooted using either the reset command or the restart command. The reset command performs a "hard" reboot similar to a power-off-power-on sequence and contacts the Dynamic Host Configuration Protocol (DHCP) server and the TFTP server for updated information as well. The restart command performs a "soft" reboot by simply rebooting the phone without contacting the DHCP and TFTP servers. The reset command takes significantly longer to process than the restart command when you are updating multiple phones, but it must be used after you make changes to phone firmware, user locale, network locale, or URL parameters. For simple button, line, or speed-dial changes, you can use the restart command.

When you use the reset command, the default time interval of 15 seconds is recommended so that phone reset operations are staggered in order to avoid all phones attempting to access router system resources at the same time. A shorter interval may be used on systems with only a small number of phones or for cases where a simple reset of the phones is desired that does not result in the phones downloading updates to the phone firmware (using the router's TFTP service).

When you use the reset sequence-all command, the router waits for one phone to complete its reset and reregister before starting to reset the next phone. The delay provided by this command prevents multiple phones from attempting to access the TFTP server simultaneously and therefore failing to reset properly. Each reset operation can take several minutes when you use this command. There is a reset timeout of 4 minutes, after which the router stops waiting for the currently registering phone to complete registration and starts to reset the next phone.

If the router configuration is changed so that the eXtensible Markup Language (XML) configuration files for the phones are modified (changes are made to user locale, network locale, or phone firmware), then whenever you use the reset all or restart all command, the router automatically executes the reset sequence-all command instead. The reset sequence-all command resets phones one at a time in order to prevent multiple phones from trying to contact the TFTP server simultaneously. This one-at-a-time sequencing can take a long time if there are many phones. To avoid this automatic behavior, use the reset all time-interval command or the restart all time-interval command with an explicit argument that is not equal to the default 15-second time interval; for example, set a time interval of 14 seconds. If a reset sequence-all command has been started in error, use the reset cancel command to interrupt and cancel the sequence of resets.

The restart command allows the system to perform quick phone resets in which only the button template, line information, and speed-dial information is updated. See the documentation for the restart command for more information.

The no form of the command has an effect only when used with the all or sequence-all keyword, when it interrupts and cancels the sequential resetting of phones.

Examples

The following example resets the Cisco IP phone with the MAC address CFBA.321B.96FA:

Related Commands


Command	Description
reset (ephone)	Performs a complete reboot of a single phone associated with a Cisco CME router.
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.
telephony-service	Enters telephony-service configuration mode.

reset (voice logout-profile and voice user-profile)

To perform a complete reboot of all IP phones on which a particular extension-mobility profile is downloaded, use the reset command in voice register logout-profile configuration mode or voice register user-profile configuration mode.

Syntax Description

Command Default

Command Modes

Voice register logout-profile configuration (voice-logout-profile)
Voice register user-profile configuration (voice-user-profile)

Command History

Usage Guidelines

Use this command to perform a "hard" reboot similar to a power-off-power-on sequence, which includes downloading updated information from the Dynamic Host Configuration Protocol (DHCP) server and the TFTP server.

Configure this command in voice register logout-profile configuration mode after creating or modifying a logout profile for extension mobility.

Configure this command in voice register user-profile configuration mode after creating or modifying an individual user's profile for extension mobility.

Examples

The following example shows how to modify a logout profile by adding speed-dial definitions and then reset all IP phones on which this logout profile is downloaded to propagate the modification:

reset (voice register global)

Cisco IOS Release	Cisco Product	Modification
12.4(11)XW2	Cisco Unified CME 4.2	This command was introduced.

To perform a complete reboot of all SIP phones associated with a Cisco CallManager Express (Cisco CME) router, use the reset command in voice register global configuration mode.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Cisco IOS Release	Version	Modification
12.4(4)T	Cisco CME 3.4	This command was introduced.

After you update information for one or more SIP phones associated with a Cisco CME router, reboot the phones by using the reset command. The reset command performs a "hard" reboot similar to a power-off-power-on sequence and contacts the Dynamic Host Configuration Protocol (DHCP) server and the TFTP server for updated information as well. Configure the reset command after you make changes to phone firmware, user locale, network locale, or URL parameters.

The time interval between each phone reset is 15 seconds, thereby avoiding an attempt by all phones to access router system resources at the same time.

Examples

The following example shows how to reset all SIP phones served by the Cisco CME router:

Related Commands


Command	Description
reset (voice register pool)	Performs a complete reboot of a single SIP phone associated with a Cisco CME router.
voice register global	Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.
voice register pool	Enters voice register pool configuration mode for SIP phones.

reset (voice register pool)

To perform a complete reboot of a specific SIP phone associated with a Cisco CallManager Express (Cisco CME) router, use the reset command in voice register pool configuration mode. To interrupt a reset cycle, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Cisco IOS Release	Version	Modification
12.4(4)T	Cisco CME 3.4	This command was introduced.

After you update information for one or more phones associated with a Cisco CME router, the phones must be rebooted by using the reset command. The reset command performs a "hard" reboot similar to a power-off-power-on sequence and contacts the Dynamic Host Configuration Protocol (DHCP) server and the TFTP server for updated information as well. Configure the reset command after you make changes to phone firmware, user locale, network locale, or URL parameters.

Use this command to perform a complete reboot of an individual SIP phone when you are in voice register pool configuration mode. To reset all SIP phones, use the reset (voice register global) command.

Examples

The following example shows how to reset SIP phone 1 served by the Cisco CME router:

Related Commands


Command	Description
reset (voice register global)	Performs a complete reboot of all SIP phones associated with a Cisco CME router.
voice register global	Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.
voice register pool	Enters voice register pool configuration mode for SIP phones.

restart (ephone)

To perform a fast reboot of an IP phone associated with a Cisco CallManager Express (Cisco CME) router, use the restart command in ephone configuration mode. To cancel the reboot, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco CME Version	Modification
12.2(11)YT1	2.1	This command was introduced.
12.2(15)T	2.1	This command was integrated into Cisco IOS Release 12.2(15)T.

Usage Guidelines

This command causes the system to perform a fast phone reboot in which only the button template, lines, and speed-dial numbers are updated on the phone. For updates related to phone firmware, user locale, network locale, or URL parameters, use the reset command. The restart command is much faster than the reset command because the phone does not need to access the DHCP or TFTP server.

To restart all phones in a Cisco CME system for quick changes to buttons, lines, and speed-dial numbers, use the restart command in telephony-service configuration mode.

Examples

Related Commands


Command	Description
reset (ephone)	Performs a complete reboot of a Cisco IP phone associated with a Cisco CME router.
reset (telephony-service)	Performs a complete reboot of one or all phones associated with a Cisco CME router.
restart (telephony-service)	Performs a fast reboot of one or all phones associated with a Cisco CME router.

restart (telephony-service)

To perform a fast reboot of one or all phones associated with a Cisco CallManager Express (Cisco CME) router, use the restart command in telephony-service configuration mode. To cancel the reboot, use the no form of this command.

Syntax Description


all	Restarts all phones associated with the Cisco CME router.
time-interval	(Optional) Time between each phone restart, in seconds. Range is from 0 to 60. Default is 15.
mac-address	MAC address of the phone to be restarted.

Defaults

Command Modes

Command History


Cisco IOS Release	Cisco CME Version	Modification
12.2(11)YT1	2.1	This command was introduced.
12.2(15)T	2.1	This command was integrated into Cisco IOS Release 12.2(15)T.

Usage Guidelines

This command causes the system to perform a fast phone reset in which only the button template, lines, and speed-dial numbers are updated on the phone. For updates related to phone firmware, user locale, network locale, or URL parameters, use the reset command.

Use the restart command to reboot IP phones after quick changes to buttons, lines, and speed-dial numbers. This command is much faster than the reset command because the phone does not access the DHCP or TFTP server.

To restart a single phone, use the restart command with the mac-address argument or use the restart command in ephone configuration mode.

If the router configuration is changed so that the eXtensible Markup Language (XML) configuration files for the phones are modified (changes are made to user locale, network locale, or phone firmware), then whenever you use the reset all or restart all command, the router automatically executes the reset sequence-all command instead. The reset sequence-all command resets phones one at a time in order to prevent multiple phones trying to contact the TFTP server simultaneously. This one-at-a-time sequencing can take a long time if there are many phones. To avoid this automatic behavior, use the reset all time-interval command or the restart all time-interval command with an explicit argument that is not equal to the default 15-second time interval; for example, set a time interval of 14 seconds. If a reset sequence-all command has been started in error, use the reset cancel command to interrupt and cancel the sequence of resets.

The no form of the command has an effect only when used with the all keyword, when it interrupts and cancels the sequential restarting of phones.

Examples

The following example performs a quick restart of all phones in a Cisco CME system:

Related Commands


Command	Description
reset (ephone)	Performs a complete reboot of a Cisco IP phone associated with a Cisco CME router.
reset (telephony-service)	Performs a complete reboot of one or all phones associated with a Cisco CME router.
restart (ephone)	Performs a fast reboot of a single phone associated with a Cisco CME router.
telephony-service	Enters telephony-service configuration mode.

restart (voice register)

To perform a fast reset of one or all SIP phones associated with a Cisco Unified CME router, use the restart command in voice register global or voice register pool configuration mode. To cancel the reboot, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(11)XJ	Cisco Unified CME 4.1	This command was introduced.
12.4(15)T	Cisco Unified CME 4.1	This command was integrated into Cisco IOS Release 12.4(15)T.

Usage Guidelines

Use this command to reboot SIP phones after quick changes to buttons, lines, and speed-dial numbers. This command is much faster than the reset command because the phone does not access the DHCP or TFTP server.

To restart a single SIP phone, use the restart command in voice register pool configuration mode. To restart all SIP phones in a Cisco Unified CME system, use the restart command in voice register global configuration mode.

Note This command requires firmware load 8-0-2-14 or later versions; it is not supported in older SIP phone loads. To support this command on SIP phones using older firmware, you must upgrade all your phone firmware.

Examples

The following example performs a quick restart of all SIP phones in a Cisco Unified CME system:

Related Commands


Command	Description
reset (voice register pool)	Performs a complete reboot of a single SIP phone associated with a Cisco Unified CME router.
reset (voice register global)	Performs a complete reboot of all SIP phones associated with a Cisco Unified CME router.

ring (ephone-dn)

o set the ring pattern for all incoming calls to an ephone-dn, use the ring command in ephone-dn configuration mode. To return to the standard ring pattern, use the no form of this command.

ring {external | feature | internal} [primary | secondary]

Syntax Description


external	External ring pattern is used for all incoming calls.
feature	Feature ring pattern is used for all incoming calls.
internal	Internal ring pattern is used for all incoming calls.
primary	(Optional) Ring pattern is used on primary number only.
secondary	(Optional) Ring pattern is used on secondary number only.

Command Default

Command Modes

Command History


Cisco IOS Release	Cisco Product	Modification
12.4(4)XC	Cisco Unified CME 4.0	This command was introduced.
12.4(9)T	Cisco Unified CME 4.0	This command was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

This command allows you to select one of the three ring styles supported by SCCP—internal, external, or feature ring. The ring pattern is used for all types of incoming calls to this directory number, on all phones on which the directory number appears. If the phone is already in use, an incoming call is presented as a call-waiting call and uses the distinctive call-waiting beep.

If the primary or secondary keyword is used, the distinctive ring is used only if the incoming called number matches the primary number or secondary number defined for the ephone-dn. If there is no secondary number defined for the ephone-dn, the secondary keyword has no effect.

By default, Cisco Unified CME uses the internal ring pattern for calls between local IP phones and uses the external ring pattern for all other types of calls.

You can associate the feature ring pattern with a specific button on a phone by using the button f command. This assigns the ring pattern to the button on the phone so that different phones that share the same directory number can use a different ring style.

Examples

The following example sets external ringing for all incoming calls on extension 2389.

Table Of Contents