Table Of Contents

Cisco Unified CME Commands: E

ephone

ephone-dn

ephone-dn-template

ephone-dn-template (ephone-dn)

ephone-hunt

ephone-hunt login

ephone-hunt statistics write-all

ephone-template

ephone-template (ephone)

extension-assigner tag-type

external-ring (voice register global)

Cisco Unified CME Commands: E

---

Last Updated: June 20, 2007

First Published: February 27, 2006

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.

ephone

To enter Ethernet phone (ephone) configuration mode for an IP phone for the purposes of creating and configuring an ephone, use the ephone command in global configuration mode. To disable the ephone and remove the IP phone configuration, use the no form of this command.

ephone phone-tag

no ephone phone-tag

Syntax Description

phone-tag

Unique sequence number that identifies an ephone during configuration tasks. The maximum number is platform-dependent; refer to Cisco IOS command-line interface (CLI) help.

Defaults

No Cisco IP phone is configured.

Command Modes

Global configuration

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 2600-XM and Cisco 2691.
12.2(11)T	2.01	This command was implemented on the Cisco 1760.

Usage Guidelines

Use the ephone command to enter ephone configuration mode. Use ephone configuration mode to create and configure Cisco Unified IP phones in Cisco Unified CME.

Before this command can be used for the first time, you must set the maximum number of ephones using the max-ephones command in telephony-service configuration mode. The maximum number of ephones varies by router platform and software version. For more information, refer to Cisco IOS command-line interface (CLI) help by entering the command name and a question mark (?) at the telephony-service configuration mode prompt:

Router(config-telephony)# max-ephones ?




When you are in ephone configuration mode, extensions (ephone-dns) that have already been defined using the ephone-dn command can be assigned to buttons on phones using the button command. You can also specify the MAC address of the phone instrument using the mac-address command. Other commands that are used in ephone configuration mode are described in the appropriate version of the Cisco CallManager Express documentation. Note that many of the commands in ephone configuration mode must be followed by a restart of the phone using the restart (ephone) or restart all (telephony-service) command.

Examples

The following example enters ephone configuration mode for a phone with the identifier 4 and assigns ephone-dn 1 to button 1:

Router(config)# ephone 4

Router(config-ephone)# button 1:1




Related Commands

Command	Description
button	Assigns a button number to the Cisco IP phone directory number.
ephone-dn	Enters ephone-dn configuration mode.
mac-address	Configures the MAC address of a Cisco IP phone.
max-ephones	Configures the maximum number of Cisco IP phones that can be supported by a router.
restart (ephone)	Performs a fast reboot of a single phone associated with a Cisco CME router.
restart all (telephony-service)	Performs a fast reboot of all phones associated with a Cisco CME router.

ephone-dn

To enter ephone-dn configuration mode for the purposes of creating and configuring an extension (ephone-dn) for a Cisco Unified IP phone line, an intercom line, a paging line, a voice-mail port, or a message-waiting indicator (MWI), use the ephone-dn command in global configuration mode. To delete an ephone-dn, use the no form of this command.

ephone-dn dn-tag [dual-line]

no ephone-dn dn-tag

Syntax Description

dn-tag	Unique sequence number that identifies a particular ephone-dn during configuration tasks. Range is from 1 to the number set by the max-dn command.
dual-line	(Optional) Enables dual-line mode for the ephone-dn.

Defaults

No ephone-dn is configured.

Command Modes

Global configuration

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.2(15)ZJ	Cisco CME 3.0	The dual-line keyword was added.
12.3(4)T	Cisco CME 3.4	The dual-line keyword was integrated into Cisco IOS Release 12.3(4)T.

Usage Guidelines

Use the ephone-dn command to enter ephone-dn configuration mode. Use ephone-dn configuration mode to create extensions (ephone-dns) in a Cisco Unified CME system. In ephone-dn configuration mode, you assign to the extension a number using the number command, a name to appear in the local directory using the name command, and other parameters using various commands.

Before using the ephone-dn command, you must set the maximum number of ephone-dns to appear in your system by using the max-dn command. The maximum number of ephone-dns that you can create depends on the software version, router platform, and amount of memory that you have installed. For the maximum number of ephone-dns and recommended memory for each platform, see the Cisco  Unified CallManager Express Supported Firmware, Platforms, Memory, and Voice Products for your Cisco Unified CME version.

A dual-line ephone-dn has one virtual voice port and two channels to handle two independent calls. This capacity allows call waiting, call transfer, and conference functions within a single ephone-dn. Dual-line mode is supported on all phone types, but is not appropriate for voice-mail numbers, intercoms, or ephone-dns used for message-waiting indicators, paging, loopback, or hunt groups. Overlays of single-line hunt groups onto dual-line buttons are supported.

Ephone-dns are created in single-line mode if the dual-line keyword is not used. Changing an ephone-dn from dual-line mode to single-line mode (and vice versa) requires that you delete the ephone-dn and then recreate it.

Examples

The following example enters ephone-dn configuration mode to create the ephone-dn 5576:

Router(config)# ephone-dn 1

Router(config-ephone-dn)# number 5576

Router(config-ephone-dn)# exit




The following example creates an ephone-dn with the number 1001 in dual-line mode. The no huntstop command allows calls to continue to hunt to other ephone-dns if this one is busy or does not answer. The huntstop channel command disables call hunting to the second channel of this ephone-dn if the first channel is busy or does not answer.

Router(config)# ephone-dn 10 dual-line

Router(config-ephone-dn)# number 1001

Router(config-ephone-dn)# no huntstop

Router(config-ephone-dn)# huntstop channel

Router(config-ephone-dn)# exit




Related Commands

Command	Description
huntstop	Sets the ephone-dn huntstop attribute or the ephone-dn dual-line channel huntstop attribute.
max-dn	Sets the maximum number of ephone-dns that can be supported by a router.
name	Associates a name with an extension (ephone-dn).
number	Associates a telephone or extension number with an extension (ephone-dn).

ephone-dn-template

To enter ephone-dn-template configuration mode and create an ephone-dn template containing a standard set of ephone-dn features, use the ephone-dn-template command in global configuration mode. To delete an ephone-dn template, use the no form of this command.

ephone-dn-template template-tag

no ephone-dn-template template-tag

Syntax Description

template-tag

Identifier for this ephone-dn template. Range is from 1 to 15.

Command Default

No ephone-dn template is created.

Command Modes

Global configuration

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

Use this command to create an ephone-dn template. An ephone-dn template contains a set of ephone-dn attributes that you can easily apply to one or more ephone-dns.

If you use an ephone-dn template to apply a command to an ephone-dn and you also use the same command in ephone-dn configuration mode for the same ephone-dn, the value that you set in ephone-dn configuration mode has priority.

Type? in ephone-dn-template configuration mode to see the commands that are available in this mode. The following example shows CLI help for ephone-dn-template configuration mode:

Router(config-ephone-dn-template)# ?




Ephone Dn template configuration commands:

call-forward Define E.164 telephone number for call forwarding

call-waiting Config call-waiting option

caller-id Configure port caller id parameters

corlist Class of Restriction on dial-peer for this dn

default Set a command to its defaults

description dn desc, for DN Qualified Display Name

exit Exit from ephone-dn-template configuration mode

hold-alert Set Call On-Hold timeout alert parameters

huntstop Stop hunting on Dial-Peers

mwi set message waiting indicator options (mwi)

no Negate a command or set its defaults

pickup-group set the call pickup group number for the DN

translate Translation rule

translation-profile Translation profile




After creating an ephone-dn template, apply the template to one or more ephone-dns using the ephone-dn-template command in ephone-dn configuration mode. Even though you can define up to 15 different ephone templates, you cannot apply more than one template to a particular ephone-dn.

If you try to apply a second ephone-dn template to an ephone-dn that already has a template applied to it, the second template will overwrite the first ephone-dn template configuration after you use the restart command to reboot the phone.

To view your ephone-dn-template configurations, use the show telephony-service ephone-dn-template command. To see which ephone-dns have templates applied to them, use the show running-config command.

Examples

The following example creates ephone-dn template 3, which sets call forwarding on busy and no answer to forward calls to extension 4000 and sets the pickup group to 4. Ephone-dn template 3 is then applied to ephone-dn 23 and ephone-dn 33, which appear on ephones 13 and 14, respectively.

ephone-dn-template 3

 call-forwarding busy 4000

 call-forwarding noan 4000 timeout 30

 pickup group 4




ephone-dn 23

 number 2323

 ephone-dn-template 3




ephone-dn 33

 number 3333

 ephone-dn-template 3




ephone 13

 button 1:23




ephone 14

 button 1:33




Related Commands

Command	Description
ephone-dn-template (ephone-dn)	Applies an ephone-dn template to an ephone-dn.
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 telephony-service ephone-dn-template	Displays ephone-dn-template configurations.

ephone-dn-template (ephone-dn)

To apply an ephone-dn template to an ephone-dn, use the ephone-dn-template command in ephone-dn configuration mode. To remove the ephone-dn template, use the no form of this command.

ephone-dn-template template-tag

no ephone-dn-template template-tag

Syntax Description

template-tag

The template tag for a template created with the ephone-dn-template command in global configuration mode. Range is from 1 to 15.

Command Default

No ephone-dn template is applied to the ephone-dn.

Command Modes

Ephone-dn configuration

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

Use the ephone-dn-template command in ephone-dn configuration mode to apply an ephone-dn template to an ephone. You cannot apply more than one ephone-dn template to an ephone-dn.

If you try to apply a second ephone-dn template to an ephone-dn that already has an ephone-dn template applied to it, the second template will overwrite the first ephone-dn template configuration.

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

Examples

The following example shows how to create ephone-dn template 3, which sets call forwarding on busy and no answer to forward calls to extension 4000 and sets the pickup group to 4, and apply the template to ephone-dn 23 and ephone-dn 33, which appear on ephones 13 and 14, respectively.

ephone-dn-template 3

 call-forwarding busy 4000

 call-forwarding noan 4000 timeout 30

 pickup group 4




ephone-dn 23

 number 2323

 ephone-dn-template 3




ephone-dn 33

 number 3333

 ephone-dn-template 3




ephone 13

 button 1:23




ephone 14

 button 1:33




Related Commands

Command	Description
ephone-dn	Enters ephone-dn configuration mode.
ephone-dn-template	Creates an ephone-dn template and enters ephone-dn-template configuration mode.
show telephony-service ephone-dn-template	Displays ephone-dn template configurations.

ephone-hunt

To enter ephone-hunt configuration mode for the purposes of creating and configuring a hunt group for use in a Cisco Unified CME system, use the ephone-hunt command in global configuration mode. To delete a hunt group, use the no form of this command.

ephone-hunt hunt-tag {longest-idle | peer | sequential}

no ephone-hunt hunt-tag

Syntax Description

hunt-tag	Unique sequence number that identifies the ephone hunt group during configuration tasks. Range is from 1 to 100.
longest-idle	Hunt group in which calls go to the ephone-dn that has been idle the longest.
peer	Hunt group in which the first extension to ring is the number to the right (in the list) of the extension that was the last one to ring when the hunt group was last called. Ringing proceeds in a circular manner, left to right, for the number of hops specified when the ephone hunt group is defined.
sequential	Hunt group in which extensions ring in the order in which they are listed, left to right, when the hunt group is defined.

Command Default

No hunt group is defined.

Command Modes

Global configuration

Command History

Cisco IOS Release	Cisco Product	Modification
12.2(15)ZJ	Cisco CME 3.0	This command was introduced.
12.3(4)T	Cisco CME 3.0	This command was integrated into Cisco IOS Release 12.3(4)T.
12.3(11)T	Cisco CME 3.2	The longest-idle keyword was added.
12.4(4)XC	Cisco Unified CME 4.0	The maximum number of hunt groups was increased from 10 to 100.
12.4(9)T	Cisco Unified CME 4.0	This command with the maximum number of hunt groups increased to 100 was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Use the ephone-hunt command to enter ephone-hunt configuration mode. Use ephone-hunt configuration mode to create ephone hunt groups in a Cisco Unified CME system.

A hunt group is a list of phone numbers that are assigned to take turns receiving incoming calls for one number, a pilot number that is defined with the pilot command. The list of numbers in the hunt group is defined using the list command. If a number in the list is busy or does not answer, the call is redirected to the next number in the list. The last number tried is the final number, which is defined using the final command.

The order in which the numbers are chosen can be longest-idle, peer, or sequential.

•If the order is longest-idle, each hop is directed to the ephone-dn that has been idle the longest. Idle time is determined from the last time that a phone registered, reregistered, or went on-hook.

•If the order is peer, the first number to which calls are directed is the number to the right of the number in the list that was the last number to ring on the previous occasion that the hunt group was called. If that number is busy or does not answer, the call is directed to the next number in the list and, in the process, circles back to the beginning of the list. In peer hunt groups, the hops command specifies how many times a call can hop from number to number before going to the final number, after which the call is no longer forwarded.

•If the order is sequential, the first number to which calls are directed is always the first number in the list. If that number is busy or does not answer, the call is redirected to the next available number in the list, from left to right.

---

Note If the number of times that a call is redirected to a new number exceeds 5, the max-redirect command must be used to increase the allowable number of redirects in the Cisco Unified CME system.

---

To configure a new hunt group, you must specify the longest-idle, peer, or sequential keyword. To change an existing ephone hunt group configuration, the keyword is not required. To change the type of hunt group from peer to sequential or sequential to peer, you must remove the existing hunt group first using the no form of the command and then recreate it.

Examples

The following example defines longest-idle ephone hunt group 1 with a pilot number 7501, a final number 8000, and 11 numbers in the list. After a call is redirected six times (makes six hops), it is redirected to the final number 8000.

ephone-hunt 1 longest-idle

 pilot 7501

 list 7001, 7002, 7023, 7028, 7045, 7062, 7067, 7072, 7079, 7085, 7099

 final 8000

 preference 1

 hops 6

 timeout 20

 no-reg




The following example defines peer hunt group number 2. Callers dial the pilot number 5610 to reach the hunt group. The first extension to ring the first time that this hunt group is called is 5601. If 5601 does not answer, the hunt proceeds from left to right, beginning with the extension directly to the right of 5601, for four hops. If none of those extensions answers before the hops limit is reached, the call is forwarded to extension 6000, which is the number for the voice-mail service.

If extension 5601 answers the first call, then the second time someone calls the hunt group, the first extension to ring is 5602. If this call hops until extension 5617 answers it, then the third time someone calls the hunt group, the first extension to ring is 5633. If extension 5633 does not answer, the call is redirected to extension 5601, and so forth.

Router(config)# ephone-hunt 2 peer

Router(config-ephone-hunt)# pilot 5610

Router(config-ephone-hunt)# list 5601, 5602, 5617, 5633

Router(config-ephone-hunt)# final 6000

Router(config-ephone-hunt)# hops 4

Router(config-ephone-hunt)# preference 1

Router(config-ephone-hunt)# timeout 30

Router(config-ephone-hunt)# exit




The following example defines sequential hunt group number 1. When callers dial extension 5601, the first phone to ring is 5001, then 5002, 5017, and 5028. If none of those extensions answers, the call is forwarded to extension 6000, which is the number for the voice-mail service.

Router(config)# ephone-hunt 1 sequential

Router(config-ephone-hunt)# pilot 5601

Router(config-ephone-hunt)# list 5001, 5002, 5017, 5028

Router(config-ephone-hunt)# final 6000

Router(config-ephone-hunt)# preference 1

Router(config-ephone-hunt)# timeout 30

Router(config-ephone-hunt)# exit




Related Commands

Command	Description
final	Defines the last ephone-dn in an ephone hunt group.
hops	Defines the number of times that a call is redirected to the next ephone-dn in a peer ephone-hunt-group list before proceeding to the final ephone-dn.
list	Defines the ephone-dns that participate in an ephone hunt group.
max-redirect	Changes the current number of allowable redirects in a Cisco Unified CME system.
no-reg (ephone-hunt)	Specifies that the pilot number of this ephone hunt group should not register with the H.323 gatekeeper.
pilot	Defines the ephone-dn that is dialed to reach an ephone hunt group.
preference (ephone-hunt)	Sets preference order for the ephone-dn associated with an ephone-hunt-group pilot number.
timeout (ephone-hunt)	Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list.

ephone-hunt login

To authorize an ephone-dn to dynamically join and leave an ephone hunt group, use the ephone-hunt login command in ephone-dn configuration mode. To disable this capability, use the no form of this command.

ephone-hunt login

no ephone-hunt login

Syntax Description

This command has no arguments or keywords.

Command Default

An ephone-dn is not allowed to dynamically join and leave ephone hunt groups.

Command Modes

Ephone-dn configuration

Command History

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

Usage Guidelines

Use the show ephone-hunt command to display current hunt group members, including those who joined the group dynamically.

Examples

The following example creates five ephone-dns and a hunt group that includes the first two ephone-dns and two wildcard slots. The last three ephone-dns are enabled for group hunt dynamic membership. Each of them can join and leave the hunt group whenever one of the slots is available.

ephone-dn 22

 number 4566




ephone-dn 23

 number 4567




ephone-dn 24

 number 4568

 ephone-hunt login




ephone-dn 25

 number 4569

 ephone-hunt login




ephone-dn 26

 number 4570

 ephone-hunt login




ephone-hunt 1 peer

 list 4566,4567,*,*

 final 7777




Related Commands

Command	Description
show ephone-hunt	Displays ephone-hunt group configuration, current status, and statistics.

ephone-hunt statistics write-all

To write ephone-hunt statistics information to a file, use the ephone-hunt statistics write-all command in privileged EXEC mode.

ephone-hunt statistics write-all location

Syntax Description

location

The URL or filename to which the statistics should be written.

Command Modes

Privileged EXEC

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

Use this command to write out, in hourly increments, all the ephone hunt group statistics for the past seven days. This command is intended be used when normal hunt group statistics collection is interrupted, perhaps due to TFTP server failure. The commands that are normally used to provide hunt-group statistics are hunt-group report delay hours, hunt-group report every hours, hunt-group report url, and statistics collect. These commands allow you to specify shorter, more precise reporting periods and file-naming conventions.

---

Note Each year on the day that daylight saving time adjusts the time back by one hour at 2 a.m., the original 1 a.m. to 2 a.m. statistics for that day are lost because they are overwritten by the new 1 a.m. to 2 a.m. statistics.

---

Examples

The following example writes the ephone hunt group statistics to a file in flash called "huntstats." See the hunt-group report url command for explanations of the output fields.

Router# ephone-hunt statistics write-all flash:huntstats




Writing out all ephone hunt statistics to tftp now.

11:13:58 UTC Fri Apr 29 2005,

, 01, Fri 11:00 - 12:00, HuntGp, 01, 01, 00000, 00000, 00000, 0000, 0000, 000000, 000000, 0000, 00000, 000000, 000000,

01, Fri 12:00 - 13:00, HuntGp, 00, 00, 00000, 00000, 00000, 0000, 0000, 000000, 000000, 0000, 00000, 000000, 000000,

01, Fri 13:00 - 14:00, HuntGp, 00, 00, 00000, 00000, 00000, 0000, 0000, 000000, 000000, 0000, 00000, 000000, 000000,

01, Fri 14:00 - 15:00, HuntGp, 00, 00, 00000, 00000, 00000, 0000, 0000, 000000, 000000, 0000, 00000, 000000, 000000,

01, Fri 15:00 - 16:00, HuntGp, 00, 00, 00000, 00000, 00000, 0000, 0000, 000000, 000000, 0000, 00000, 000000, 000000,

.

.

.




Related Commands

Command	Description
show ephone-hunt	Displays ephone hunt group information.
show ephone-hunt statistics	Displays ephone hunt group statistics.
hunt-group report delay hours	Delays hunt-group statistics collection for a specified number of hours.s
hunt-group report every hours	Sets the hourly interval at which Cisco Unified CME B-ACD call statistics are automatically transferred to a file.
hunt-group report url	Sets filename parameters and the URL path where Cisco Unified CME B-ACD call statistics are to be sent using TFTP.
statistics collection	Enables the collection of call statistics for an ephone hunt group.

ephone-template

To create an ephone template to configure a set of phone features and to enter ephone-template configuration mode, use the ephone-template command in global configuration mode. To delete an ephone template, use the no form of this command.

ephone-template template-tag

no ephone-template template-tag

Syntax Description

template-tag

Identifier for this ephone template. Range is from 1 to 20.

Command Default

No ephone template is created.

Command Modes

Global configuration

Command History

Cisco IOS Release	Cisco Product	Modification
12.3(11)T	Cisco CME 3.2	This command was introduced.
12.4(4)XC	Cisco Unified CME 4.0	The maximum number of templates that can be created was increased from 5 to 20.
12.4(9)T	Cisco Unified CME 4.0	The modification to increase the maximum number of templates that can be created from 5 to 20 was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Use this command to create an ephone template containing a set of ephone commands. The template can then be easily applied to one or more ephones.

If you use an ephone template to apply a command to a phone and you also use the same command in ephone configuration mode for the same phone, the value that you set in ephone configuration mode has priority.

Type ? in ephone-template configuration mode to see the commands that are available in this mode and that can be included in an ephone-template. The following example shows CLI help for ephone-template configuration mode at the time that this document was written:

Router(config-ephone-template)#?




Ephone template configuration commands:

after-hour ephone exempt from after-hour blocking

codec Set preferred codec for calls with other phones on this

router

default Set a command to its defaults

exit Exit from ephone-template configuration mode

fastdial Define ip-phone fastdial number

features define features blocked

keep-conference Do not disconnect conference when conference initiator

hangs-up.Connect remaining parties together directly using

call transfer.

keepalive Define keepalive timeout period to unregister IP phone

keyphone Identify an IP phone as keyphone

mtp Always send media packets to this router

network-locale Select the network locale for this template.

night-service Define night-service bell

no Negate a command or set its defaults

paging-dn set audio paging dn group for phone

service Service configuration in ephone template

softkeys define softkeys per state

speed-dial Define ip-phone speed-dial number

transfer transfer related configuration

transfer-park customized transfer to park configuration

transfer-pattern customized transfer-pattern configuration

type Define ip-phone type

user-locale Select the user locale for this template.




After creating an ephone template, apply the template to one or more ephones using the ephone-template command in ephone configuration mode. Even though you can define up to 20 different ephone templates, you cannot apply more than one template to a particular ephone.

After applying a template to an ephone or removing a template from an ephone, use the following commands:

•restart—Performs a fast reboot of the phone.

•create cnf-files—Rebuilds configuration files.

If you try to apply a second ephone template to an ephone that already has an ephone template applied to it, the second template will overwrite the first ephone template configuration after you use the restart command to reboot the phone.

To view your ephone-template configurations, use the show telephony-service ephone-template command. To see which ephones have templates applied to them, use the show running-config command.

Examples

The following example creates two ephone templates. The softkeys commands in ephone-template configuration mode define what soft keys are displayed and their order. Template 1 is applied to ephone 32, which has the extension 2555, and template 2 is applied to ephone 38, which has the extension 2666.

ephone-template 1

 softkeys idle Dnd Redial Newcall Pickup Login

 softkeys seized Redial Cfwdall Gpickup Pickup

 softkeys alerting Callback Endcall

 softkeys connected Confrn Hold Endcall




ephone-template 2

 softkeys idle Redial Pickup

 softkeys seized Redial Pickup

 softkeys connected Hold Endcall




ephone-dn 25

 number 2555




ephone-dn 26

 number 2666




ephone 32

 button 1:25

 ephone-template 1




ephone 38

 button 1:26

 ephone-template 2




The following example creates an ephone template to block the use of Park and Trnsfer soft keys. It is applied to extension 2333.

ephone-template 15

features blocked Park Trnsfer




ephone-dn 2

number 2333




ephone 3

button 1:2

ephone-template 15




Related Commands

Command	Description
create cnf-files	Builds phone configuration files.
ephone-template (ephone)	Applies an ephone template to an ephone.
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 telephony-service ephone-template	Displays ephone-template configurations.

ephone-template (ephone)

To apply an ephone template to an ephone, use the ephone-template command in ephone configuration mode. To remove the ephone template, use the no form of this command.

ephone-template template-tag

no ephone-template template-tag

Syntax Description

template-tag

The template tag for a template created with the ephone-template command in global configuration mode. Range is from 1 to 20.

Command Default

The default is that no ephone template is applied to an ephone.

Command Modes

Ephone configuration

Command History

Cisco IOS Release	Cisco Product	Modification
12.3(11)T	Cisco CME 3.2	This command was introduced.
12.4(4)XC	Cisco Unified 4.0	The maximum number of ephone templates that can be created was increased from 5 to 20.
12.4(9)T	Cisco Unified 4.0	The increased range for the template-tag argument was integrated into Cisco IOS Release 12.4(9)T.

Usage Guidelines

Use the ephone-template command in ephone configuration mode to apply an ephone template to an ephone. You cannot apply more than one ephone template to an ephone.

After applying a template to an ephone, use the restart command to perform a fast reboot of the phone.

If you try to apply a second ephone template to an ephone that already has an ephone template applied to it, the second template will overwrite the first ephone template configuration after you use the restart command to reboot the phone.

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

If you use an ephone template to apply a command to a phone and you also use the same command in ephone configuration mode for the same phone, the value that you set in ephone configuration mode has priority.

Examples

The following example defines ephone templates 1 and 2 and applies ephone template 1 to ephones 1 through 3 and ephone template 2 to ephone 4.

ephone-template 1

 softkeys idle Dnd Redial Newcall Pickup Login

 softkeys seized Redial Cfwdall Gpickup Pickup

 softkeys alerting Callback Endcall

 softkeys connected Confrn Hold Endcall

 softkeys hold Newcall Resume




ephone-template 2

 softkeys idle Redial Pickup

 softkeys seized Redial Pickup

 softkeys alerting Endcall

 softkeys connected Hold Endcall

 softkeys hold Resume




 ephone 1

 ephone-template 1




ephone 2

 ephone-template 1




 ephone 3

 ephone-template 1




Rephone 4

 ephone-template 2




ephone 5

 ephone-template 2




The following example creates an ephone template to block the use of Park and Transfer soft keys on extension 2333.

ephone-template 15

features blocked Park Trnsfer




ephone-dn 2

number 2333




ephone 3

button 1:2

ephone-template 15




Related Commands

Command	Description
ephone	Enters ephone configuration mode for an IP phone.
ephone-template	Creates an ephone template and enters ephone-template configuration mode.
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 telephony-service ephone-template	Displays ephone-template configurations.

extension-assigner tag-type

To enable provision tags for identifying ephone configurations when using the extension assigner application, use the extension-assigner tag-type command in telephony-service configuration mode. To return to the default setting of using the ephone tag, use the no form of this command.

extension-assigner tag-type {ephone-tag | provision-tag}

no extension-assigner tag-type

Syntax Description

ephone-tag	Ephone tags must be used to identify ephone configurations.
provision-tag	Provision tags must be used to identify ephone configurations.

Command Default

Ephone tags are used to identify ephone configurations for the extension assigner application.

Command Modes

Telephony-service configuration

Command History

Cisco IOS Release	Cisco Product	Modification
12.4(4)XC4	Cisco Unified CME 4.0(3)	This command was introduced.
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

This command enables you to use provision tags for identifying ephone configurations to be assigned by the extension application application.

A provision tag is an unique number other than an ephone tag, such as a jack number or an extension number, for identifying the ephone configuration to be assigned to a particular IP phone by the extension assigner application.

Use this command to specify which type of tag, ephone tag or provision tag, is to be used to identify ephone configurations for the extension assigner application. The default configuration is ephone tag.

If you use this command with the provision-tag keyword, use the provision-tag command to create provision tags.

Examples

The following example shows that this command is configured to enable provision tags to be used for identifying the ephone configurations to be assigned by the extension assigner application. Note that provision tag 1001 is configured for ephone 1. During phone installation, the installation technician can press 1001 on the telephone keypad to assign the ephone 1 configuration, with extension number 1001 on button 1, to the IP phone being installed.

Telephony-service

extension-assigner tag-type provision-tag

auto assign 101-102

auto-reg-ephone




Ephone-dn 101

number 1001




Ephone-dn 102

number 1002




Ephone 1

provision-tag 1001

mac-address 02EA.EAEA.0001

button 1:101




Ephone 2

provision-tag 1002

mac-address 02EA.EAEA.0002

button 1:102




Related Commands

Command	Description
ephone	Enters ephone configuration mode for the purposes of creating and configuring an ephone.
provision-tag	Creates a provision tag for identifying an ephone configuration.

external-ring (voice register global)

To specify the type of ring sound used on Cisco Session Initiation Protocol (SIP) or Cisco SCCP IP phones for external calls, use the external-ring command in voice register global configuration mode. To return to the default ring sound, use the no form of this command.

external-ring {bellcore-dr1 | bellcore-dr2 | bellcore-dr3 | bellcore-dr4 | bellcore-dr5}

no external-ring

Syntax Description

bellcore-dr1 bellcore-dr2 bellcore-dr3 bellcore-dr4 bellcore-dr5

Each bellcore-dr keyword supports standard distinctive ringing patterns as defined in the standard GR-506-CORE, LSSGR: Signaling for Analog Interfaces.

Command Default

The default ring sound is an internal ring pattern.

Command Modes

Voice register global configuration

Command History

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

Usage Guidelines

When set, this command defines varying ring tones so that you can discriminate between internal and external calls from Cisco SIP or Cisco SCCP IP phones.

Examples

The following example shows how to specify that Bellcore DR1 be used for external ringing on Cisco SIP IP phones:

Router(config)# voice register global

Router(config-register-global)# external-ring bellcore-dr1

Related Commands

Command	Description
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 CallManager Express (Cisco Unified CME) or Cisco Unified SIP Survivable Remote Site Telephony (SRST) environment.

Posted: Fri Sep 28 12:54:54 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.