Cisco Unified CME Commands: B

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.

b2bua

To configure a dial peer associated with an individual Session Initiation Protocol (SIP) phone in a Cisco Unified CallManager Express (Cisco Unified CME) environment or a group of phones in a Cisco Unified SIP Survivable Remote Site Telephony (SRST) environment to point to Cisco Unity Express, use the b2bua command in dial-peer configuration mode. To disable B2BUA call flow on the dial peer, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Cisco IOS Release	Cisco Product	Modification
12.4(4)T	Cisco CME 3.4 and Cisco SIP SRST 3.4	This command was introduced.

Use the b2bua command to set the Cisco Unified CME source address as the 302 redirect contact address for all calls forwarded to Cisco Unity Express.

Note Use the b2bua command to configure Cisco SIP SRST 3.4 only after using the allow-connections command to enable B2BUA call flow on the SRST gateway.

Examples

The following example shows b2bua included in the configuration for voice dial peer 1:

Related Commands


Command	Description
allow-connections	Enables calls between SIP endpoints in a VoIP network.
dial-peer voice	Defines a dial peer and enters dial-peer configuration mode.
mode (voice register global)	Enables the mode for provisioning SIP phones in a Cisco Unified CME system.
show dial-peer voice	Displays information for dial peers.
source-address (voice register global)	Identifies the IP address and port through which SIP phones communicate with a Cisco Unified CME router.

blf-speed-dial

To enable Busy Lamp Field (BLF) monitoring for a speed-dial number on a phone registered to Cisco Unified CME, use the blf-speed-dial command in ephone or voice register pool configuration mode. To disable BLF monitoring for speed-dial, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

tag	Number that identifies the speed-dial index. Range: 1 to 33 (SCCP); 1 to 7 (SIP).
number	Telephone number to speed dial.
label string	Alphanumeric label that identifies the speed-dial button. The string can contain a maximum of 30 characters.

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.

This command enables a phone to monitor the status of a line associated with a speed-dial number. The directory number associated with the speed-dial number must have presence enabled with the allow watch command.

For information on the BLF status indicators that display on specific types of phones, see the Cisco Unified IP Phone documentation for your phone model.

Examples

The following example shows the BLF speed-dial feature enabled for ephone 1. The line status of extensions 51212 and 51214 displays on the phone 1 provided that presence is enabled for those directory numbers.

Related Commands


Command	Description
allow watch	Allows a directory number on a phone registered to Cisco Unified CME to be watched in a presence service.
presence	Enables presence service and enters presence configuration mode.
presence call-list	Enables BLF monitoring for call lists and directories on phones registered to Cisco Unified CME.
sccp blf-speed-dial	Sets the retry timeout for BLF notification for speed-dial numbers on SCCP phones registered to an external Cisco Unified CME.
show presence global	Displays configuration information about the presence service.

bulk

To set bulk registration for E.164 numbers that will register with SIP proxy server, use the bulk command in voice register global configuration mode. To disable bulk registration, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

This command allows you to configure bulk registration for registering a block of phone numbers with an external registrar so that calls can be routed to Cisco CME from the SIP network.

number-pattern	A sequence of digits including wild card character.

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

Numbers that match the number pattern defined by using the bulk command register with the external registrar. The block of numbers that is registered can include any phone that is attached to Cisco CME using SIP or SCCP, or any analog phone that is directly attached to a Cisco router FXS port.

A number can contain one or more periods (.) as wildcard characters that will match any dialed number in that position. For example, 51.. rings when 5100 is dialed, when 5101 is dialed, and so forth.

The external registrar is configured by using the registrar server command under the SIP user-agent configuration mode.

Examples

The following example shows how to specify that numbers matching 1235 and any other dialed number in the next four positions, be routed to the Cisco CME from the SIP network.

Related Commands


Command	Description
mode (voice register global)	Enables the mode for provisioning SIP phones in a Cisco CallManager Express (Cisco CME) system.
no reg (voice register dn)	Specifies that a directory number in a SIP Cisco CallManager Express (Cisco CME) system not register with an external proxy server
no reg (voice hunt-group)	Specifies that a pilot number for a voice hunt group not register with an external proxy server
registrar	Enables SIP registrar functionality.

bulk-speed-dial list

To enable use of a bulk speed-dial list, use the bulk-speed-dial list command in ephone or telephony-service configuration mode. To remove the list, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

This command in telephony-service configuration mode enables a bulk speed-dial list on a per-system basis for all phones in Cisco Unified CME. This command in ephone configuration mode enables a bulk speed-dial list for a particular phone in Cisco Unified CME.

Bulk speed-dial lists must contain only comma-separated data. Typically, speed-dial lists are text files saved with the.txt file extension or Microsoft� Office Excel tables saved as .csv files.

list-id	Digit that identifies the list to be used. Range is from 0 to 9.
location	Location of the bulk speed-dial list. Valid storage locations are TFTP, HTTP, and Flash memory.

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 12.4(9)T.

Each list contains entries of speed-dial codes and the associated phone numbers to be dialed. Each entry in a list must appear on a separate line. Fields in each entry are separated by commas (,). A line that begins with a semicolon (;) is a comment and is ignored by Cisco Unified CME. Each entry in a list can include the following fields. For information about each field, see Table 1.

Table 1 Bulk Speed-Dial List Entry
Field	Description
index	Zero-filled number that uniquely identifies this index entry. Maximum length: 4 digits. All index entries must be the same length.
digits	Telephone number to dialed. Represents a fully qualified E.164 number. Use a comma (,) to represent a one-second pause.
name	(Optional) Alphanumeric string to identify a name, up to 30 characters.
hide	(Optional) Enter hide to block the display of the dialed number.
append	(Optional) Enter append to allow additional digits to be appended to this number when dialed.

The software does not automatically detect changes to the list files. If you modify a bulk speed-dial list that is enabled at a global or phone level, explicitly disable the list using the no form of this command, then enable the modified list. If the same list is enabled for more than one phone, disable the list on each phone using the no form of this command in ephone configuration mode, then enable the modified list per phone.

Use the bulk speed-dial prefix command to change the prefix code that a phone user must dial to access speed-dial numbers from a bulk speed-dial list. The default prefix is # (pound sign).

If a bulk speed-dial list is enabled using this command in telephony-service configuration mode and is also enable using this command in ephone configuration mode, the list enabled in ephone configuration mode takes precedence over the list at the global level for a given prefix. However, if the prefix used at the global level is different than the prefix used at the phone level, the lists are treated as separate lists - each list being associated with a different prefix, and at the phone level, you can access both lists.

Use the show telephony-service bulk-speed-dial to display information about bulk speed-dial lists that are configured in Cisco Unified CME.

Examples

The following example shows that the default global bulk speed-dial prefix is changed to #7 and bulk speed-dial list 6 is enabled at a global level for all phones. To place a call to an entry in tise bulk speed-dial list, the phone user must first dial #7, followed by the list-id (6), then the index number for the entry to be called. This example also shows that bulk speed-dial list 7, with the default prefix unchanged, is enabled for ephone 2 only.

Related Commands

bulk-speed-dial prefix

Command	Description
bulk-speed-dial prefix	Sets the prefix code that phone users dial to access speed-dial numbers from a bulk speed-dial list that is enabled system-wide.
show telephony-service bulk-speed-dial	Displays information about bulk speed-dial lists that are configured in Cisco Unified CME.

To set the prefix code that phone users dial to access speed-dial numbers from a global bulk speed-dial list, use the bulk-speed-dial prefix command in telephony-service configuration mode. To return the prefix code to the default, use the no form of this command.

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

prefix-code	One to four-character access code for speed dial. Default is #.

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 12.4(9)T.

This command changes the prefix code that a phone user must dial to access speed-dial numbers from a speed-dial list that is enabled using the bulk-speed-dial list command in telephony-service configuration mode. The default prefix is # (pound sign).

Use the show telephony-service bulk-speed-dial to display information about bulk speed-dial lists that are configured in Cisco Unified CME.

Examples

The following example changes the default bulk speed-dial prefix to #7 and enables global bulk speed-dial list number 6 for all phones. It also enables a personal bulk speed-dial list for ephone 2. In this example, ephone 2 can access all of the numbers in both lists because each list is assigned a different prefix (# and #7).

Related Commands

button

Command	Description
bulk-speed-dial list	Enables a bulk speed-dial list.
show telephony-service bulk-speed-dial	Displays information about bulk speed-dial lists that are configured in Cisco Unified CME.

To associate ephone-dns with individual buttons on a Cisco Unified IP phone and to specify line type or ring behavior, use the button command in ephone configuration mode. To remove an ephone-dn association from a button, use the no form of this command.

button button-number {separator} dn-tag [,dn-tag...] [button-number{x}overlay-button-number] [button-number...]

no button button-number {separator} dn-tag [,dn-tag...] [button-number{x}overlay-button-number] [button-number...]

Syntax Description


button-number	Number of a line button on a Cisco Unified IP phone that is to be associated with an extension (ephone-dn). The maximum number of button-ephone-dn pairs is determined by the phone type. Note The Cisco Unified IP Phone 7910G has only one physical line button, but you can assign it two button-ephone-dn pairs.
separator	Single character that denotes the characteristics to be associated with this phone button. Valid entries are as follows: •: (colon)—Normal ring. For incoming calls on this extension, the phone produces audible ringing, a flashing icon in the phone display, and a flashing red light on the handset. On the Cisco IP Phone 7914 Expansion Module, a flashing yellow light also accompanies incoming calls. •b—Beep but no ring. Audible ring is suppressed for incoming calls, but call-waiting beeps are allowed. Visible cues are the same as those described for a normal ring. •c—Call waiting. Provides call waiting for secondary calls to an overlaid ephone-dn. See also the o keyword. •f—Feature ring. Differentiates incoming calls on a special line from incoming calls on other lines on the phone. The feature-ring cadence is a triple pulse, as opposed to a single pulse for normal internal calls and a double pulse for normal external calls.
	•m—Monitor mode for a shared line. Visible line status indicates whether the line is in-use or not. Monitored lines cannot be used on this phone for incoming or outgoing calls. •o—Overlay line. Multiple ephone-dns share a single button, up to a maximum of 25 on a button. See also the c keyword. •s—Silent ring. Audible ring and call-waiting beep are suppressed for incoming calls. The only visible cue is a flashing ((< icon in the phone display. Note In Cisco IOS Release 12.4(4)XC and later releases, the silent ringing behavior is overridden during active night-service periods. Silent ringing does not apply during designated night-service periods when the s keyword is used. •w—Watch mode for all lines on the phone for which this directory number is the primary line. Visible line status indicates whether watched phone is idle or not.
dn-tag	Ephone-dn tag that was previously defined using the ephone-dn command. When used with the c and o keywords, the dn-tag argument can contain up to 25 individual dn-tags, separated by commas.
x	Separator that creates an overlay rollover button. When the overlay button specified in this command is occupied by an active call, a second call to one of its ephone-dns will appear on this button. This button is also known as an overlay expansion button.
overlay-button-number	Number of the overlay button that should overflow to this button.

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 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.2(11)YT	Cisco ITS 2.1	The b and s keywords were added.
12.2(15)ZJ	Cisco CME 3.0	The f, m, and o keywords were added.
12.3(4)T	Cisco CME 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.
12.3(11)XL	Cisco CME 3.2.1	The c keyword was added and the ability to use the m keyword to monitor call-park slots was added.
12.3(14)T	Cisco CME 3.3	This command was integrated into Cisco IOS Release 12.3(14)T.
12.4(4)XC	Cisco Unified CME 4.0	The x keyword was added and the number of ephone-dns that can be overlaid on a single button with the o or c keyword was increased from 10 to 25. The interaction between the keyword and night service was modified; silent ringing is overridden when night service is active.
12.4(9)T	Cisco Unified CME 4.0	The modifications made to this command were integrated into Cisco IOS Release 12.4(9)T.
12.4(11)XJ	Cisco Unified CME 4.1	The w keyword was added.
12.4(15)T	Cisco Unified CME 4.1	This command with the w keyword was integrated into Cisco IOS Release 12.4(15)T.

Usage Guidelines

The button command assigns telephone extensions to Cisco Unified IP phones by associating a button number with one or more directory numbers (ephone-dns).

Note After adding or changing a phone button configuration using this command, you must perform a quick reboot of the phone using the restart command.

Telephone services such as call waiting and three-party conferences require a minimum of two phone lines (ephone-dns defined with the ephone-dn command) to be available and configured on a Cisco IP phone.

The Cisco Unified IP Phone 7910G has only one physical line button. To support call waiting and three-party conferences on a Cisco Unified IP Phone 7910G, a second (hidden) line is required. This line cannot be selected directly using a line button. You can access the second line when you press the Conference button. You can also support multiple-call services using the ephone-dn dual-line configuration option.

A feature ring is a third type of ring cadence, in addition to the internal call and external call ring cadences. For example, an internal call in the United States rings for 2 seconds on and 4 seconds off (single-pulse ring), and an external call rings for 0.4 seconds on, 0.2 seconds off, 0.4 seconds on, and 0.2 seconds off (double-pulse ring). A feature ring is a triple-pulse ring. The purpose of associating a feature ring with a line button is to be able to identify from a distance a special line that is ringing on a multiline phone.

A line button set in monitor mode on one phone displays visual line status for a line that also appears on another phone. When monitor mode is set for a button with a shared line, the line status indicates that the shared line is either idle or in use. The line and line button are available in monitor mode for visual status only. Calls cannot be made or received using a line button that has been set in monitor mode. Incoming calls on a line button that is in monitor mode do not ring and do not display caller ID or call-waiting caller ID.

Monitor mode is intended for use only in the context of shared lines so that a receptionist can visually monitor the in-use status of several users' phone extensions (for example, as a busy-lamp field). To monitor all lines on an individual phone so that a receptionist can visually monitor the in-use status of that phone, see the "Watch Mode (w)" section.

The line button for a monitored line can also be used as a direct-station-select for a call transfer when the monitored line is in an idle state. In this case, the receptionist who transfers a call from a normal line can press the Transfer button and then press the line button of the monitored line, causing the call to be transferred to the phone number of the monitored line.

Overlay lines are ephone-dns that share a single button on a multibutton phone. When more than one incoming call arrives on lines that are set on a single button, the line (ephone-dn) that is the leftmost in the button command list is the primary line and is given the highest priority. If this call is answered by another phone or if the caller hangs up, the phone selects the next line in its overlay set to present as the ringing call. The caller ID display updates to show the caller ID for the currently presented call.

Ephone-dns that are part of an overlay set can be single-line ephone-dns or dual-line ephone-dns, but the set must contain either all single-line ephone-dns or all dual-line ephone-dns, and not a mixture of the two.

The primary ephone-dn on each phone in a shared-line overlay set should be unique to the phone being configured to guarantee that there is a line available for outgoing calls, and to ensure that the phone user can obtain dial-tone even when there are no idle lines available in the rest of the shared-line overlay set. Use a unique ephone-dn in this manner to provide for a unique calling party identity on outbound calls made by the phone so that the called user can see which specific phone is calling.

The name of the first ephone-dn in the overlay set is not displayed because it is the default ephone-dn for calls to the phone, and the name or number is permanently displayed next to the phone's button. For example, if there are ten ephone-dns in an overlay set, only the last nine ephone-dns are displayed when calls are made to them.

The configuration for the overlaid ephone-dns with call waiting (keyword c) and without call waiting (keyword o) is the same.

Ephone-dns accept call interruptions, such as call waiting, by default. For call waiting to work, the default must be active. To ensure thatthe default is active, remove the no call-waiting beep accept command from the configurations of ephone-dns for which you want to use call waiting.

In Cisco Unified CME 4.0(3), the Cisco Unified IP Phone 7931G cannot support overlays that contain ephone-dn configured for dual-line mode.

Note In general, all the ephone-dns within an overlay must be of the same type (dual-line or single line mode).

You can configure silent ring on any type of phone. However, you typically set silent ring only on buttons of a phone with multiple lines, such as a Cisco Unified IP Phone 7940, Cisco Unified IP Phones 7960 and 7960G, or a Cisco Unified IP Phone 7914 Expansion Module. The only visible cue is a flashing ((< icon in the phone display.

If you configure a button to have a silent ring, you will not hear a call-waiting beep or call-waiting ring regardless of whether the ephone-dn associated with the button is configured to generate a call-waiting beep or call-waiting ring.

In Cisco IOS Release 12.4(4)XC and later releases, the silent ringing behavior is overridden during active night-service periods. Silent ringing does not apply during designated night-service periods when the s keyword is used.

A line button that is configured for watch mode on one phone provides visual line status for all lines on another phone (watched phone) for which the watched directory number is the primary line. Watched mode allows a phone user, such as a receptionist, to visually monitor the in-use status of an individual phone. The line and line button on the watching phone are available in watch mode for visual status only. Calls cannot be made or received using a line button that has been set in watch mode. Incoming calls on a line button that is in watch mode do not ring and do not display caller ID or call-waiting caller ID.

If any of the following conditions are true, the status of the line button in watch mode is that the watched phone is in-use:

Note If the watched directory number is a shared line and the shared line is not idle on any phone with which it is associated, then in the context of watch mode, the status of the line button indicates that the watched phone is in use.

For best results in terms of monitoring the status of an individual phone based on a watched directory number, the directory number to be configured for watch mode should not be a shared line. To monitor a shared line so that a receptionist can visually monitor the in-use status of several users' phone extensions, see the "Monitor Mode (m)" section.

If the watched directory number is associated with several phones, then the watched phone is the one on which the watched directory number is on button 1 or the one on which the watched directory number is on the button that is configured by using the auto-line command, with auto-line having priority.

If more than one phone meets the criteria for primary line as described above, then the watched phone is the first phone that that meets the criteria. Typically, that is the phone with the lowest ephone tag value. However, if the watched directory number is configured on button 1 of ephone 1 and the same directory number is also configured on button 3 with "auto-line 3" of ephone 24, then ephone 24 is the watched phone because the auto-line configuration has priority.

The line button for a watched phone can also be used as a direct-station-select for a call transfer when the watched phone is idle. In this case, the phone user who transfers a call from a normal line can press the Transfer button and then press the line button of the watched directory number, causing the call to be transferred to the phone number associated with the watched directory number.

This feature works to expand coverage for an overlay button that has been configured using the o separator in the button command. Overlay buttons with call waiting that use the c separator in the button command are not eligible for overlay rollover.

Examples

The following example assigns four button numbers on the phone to ephone-dn tags. Button 4 is configured for a silent ring:

The following example shows three phones that each have three instances of extension number 1001 overlaid onto a single button, which allows three simultaneous calls to extension 1001. The first call arrives on ephone-dn 1 and rings button 1 on all three phones. The call is answered on ephone 10. A second call for 1001 hunts onto ephone-dn 2 and rings on the remaining two ephones, ephones 11 and 12, and is answered by ephone 12. A third call to 1001 hunts onto ephone-dn 3 and rings on ephone 12, where it is answered. This configuration creates a three-way shared line across three IP phones and can handle three simultaneous calls to the same telephone number. Note that if ephone 12 is busy, the third call will go to voice mail (7000). Note also that if you want to configure call waiting, you can use the same configuration, except use the c keyword instead of the o keyword. Ephone 10 uses call waiting.

The following is an example of a unique ephone-dn as the primary dn in a simple shared-line overlay configuration. The no huntstop command is configured for all the ephone-dns except ephone-dn 12, the last one in the overlay set. Because the ephone-dns are dual-line dns, the huntstop-channel command is also configured to ensure that the second channel remains free for outgoing calls and for conferencing.

Shared-line overlays can be constructed using the "button o" or "button c" formats, depending on whether call-waiting is desired. The following example shows an ephone configuration that enables call waiting (c) in a shared-line overlay:

The following example configures a "3x3" shared-line setup for three ephones and nine shared lines (ephone-dns 20 through 28). Each ephone has a unique ephone-dn for each of its three buttons (ephone-dns 1 to 3, ephone-dns 4 to 6, and ephone-dns 7 to 9). The remaining ephone-dns are shared among the three phones. Three phones with three buttons each can take nine calls. The overflow buttons provide the ability for an incoming call to ring on the first available button on each phone.

Related Commands


Command	Description
call-waiting beep	Allows phone buttons to accept or generate call-waiting beeps.
restart (ephone)	Performs a fast reboot of a single phone associated with a Cisco Unified CME router.
restart (telephony-service)	Performs a fast reboot of one or all phones associated with a Cisco Unified CME router.
show ephone	Displays information about ephones and the corresponding Cisco Unified IP phones.
show ephone overlay	Displays the configuration and current status of registered overlay ephone-dns.

button-layout

To configure a fixed set of line or feature buttons in an ephone-template which can then be applied to a supported IP phone in Cisco Unified CME, use the button-layout set command in ephone-template configuration mode. To disable the feature buttons set and change the action of the buttons on IP phones, use the no form of this command.

Syntax Description


phone-type	Type of IP phone. The following choices are valid: •7931—Cisco Unified IP Phone 7931.
1	Number of fixed line or feature set containing the following buttons: •Button 24—Menu. •Button 23—Headset.
2	Number of fixed line or feature set containing the following buttons: •Button 24—Menu. •Button 23—Headset. •Button 22—Directories. •Button 21—Messages.

Command Default

Command Modes

Command History

Usage Guidelines

Use this command to configure either Set 1 or Set 2 in an ephone-template which can then be applied to an individual Cisco Unified IP Phone 7931G in Cisco Unified CME.

Cisco IOS Release	Cisco Product	Modification
12.4(6)XE	Cisco Unified CME 4.0(2)	This command was introduced.
12.4(4)XC4	Cisco Unified CME 4.0(3)	This command was introduced.
12.4(11)T	Cisco Unified CME 4.0(3)	This command was integrated into Cisco IOS Release 12.4(11)T.

After a template has been created, you can apply it to an ephone using the ephone-template command in ephone configuration mode. You cannot apply more than one ephone template to an ephone.

To view your ephone-template configurations, use the show telephony-service ephone-template command.

Examples

The following example shows how to create ephone-template 12, containing set 2 feature buttons, and apply the template to ephone 36.

Table Of Contents