Table Of Contents

Cisco Unified CME Commands: A

addon

address (voice emergency response location)

after-hour exempt

after-hours block pattern

after-hours date

after-hours day

after-hours override-code

after-hours pstn-prefix

allow watch

anonymous block

application (telephony-service)

application (voice register global)

application (voice register pool)

authenticate (voice register global)

authentication credential

auth-mode

auto assign

auto logout

auto-answer

auto-line

auto-reg-ephone

Cisco Unified CME Commands: A

---

Revised: July 11, 2008

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 references. Use the reference master index or search online to find these commands.

addon

To define whether a phone type supports add-on modules, use the addon command in ephone-type configuration mode. To reset to the default value, use the no form of this command.

addon

no addon

Syntax Description

This command has no arguments or keywords.

Command Default

Disabled (phone type does not support add-on modules).

Command Modes

Ephone-type configuration (config-ephone-type)

Command History

Cisco IOS Release	Cisco Product	Modification
12.4(15)XZ	Cisco Unified CME 4.3 Cisco Unified SRST 4.3	This command was introduced.
12.4(20)T	Cisco Unified CME 7.0 Cisco Unified SRST 7.0	This command was integrated into Cisco IOS Release 12.4(20)T.

Usage Guidelines

This command specifies that add-on modules, such as the Cisco Unified IP Phone 7915 Expansion Module, are supported by the type of phone being added with the phone-type template.

Examples

The following example shows that expansion modules are supported for the phone being added with an ephone-type template:

Router(config)# ephone-type 7965

Router(config-ephone-type)# addon

Related Commands

Command	Description
device-id	Specifies the device ID for a phone type in an ephone-type template.
device-name	Assigns a name to a phone type in an ephone-type template.

address (voice emergency response location)

To define the civic address for an ERL that is used for the ALI database upload, use the address command in voice emergency response location mode. To remove this definition, use the no form of the command. This command is optional.

address string

no address

Syntax Description

string

String (1-247 characters) used to identify an ERL's civic address.

Command Default

The civic address is not defined.

Command Modes

Voice emergency response location configuration (cfg-emrgncy-resp-location)

Command History

Cisco IOS Release	Cisco Product	Modification
12.4(15)XY	Cisco Unified CME  4.2(1) Cisco Unified SRST 4.2(1) Cisco Unified SIP SRST 4.2(1)	This command was introduced.
12.4(20)T	Cisco Unified CME  7.0 Cisco Unified SRST 7.0 Cisco Unified SIP SRST 7.0	This command was integrated into Cisco IOS Release 12.4(20)T.

Usage Guidelines

Use this command to create a comma separated text entry of the ERL's civic address. The address information must be entered to conform with the NENA-2 Data Record specifications or the recommendations by the service provider.

Examples

In this example, a civic address is displayed for ERL 60.

voice emergency response location 60

subnet 1 209.165.200.224 255.255.0.0

elin 1 4085550100

name Cookies and More Incorporated,

address I,408,5550100,,11902,,,Main Street,Emerald City,CA,Idina Menzel,1,,,,,,

Related Commands

Command	Description
elin	Specifies a PSTN number that will replace the caller's extension.
name	Specifies a string (up to 30 characters) used internally to identify or describe the emergency response location.
subnet	Defines which IP phones are part of this ERL.

after-hour exempt

To specify that an individual IP phone in Cisco Unified CME does not have any of its outgoing calls blocked even though after-hour call blocking has been enabled, use the after-hour exempt command in ephone or ephone-template configuration mode. To remove the exemption, use the no form of this command.

after-hour exempt

no after-hour exempt

Syntax Description

This command has no arguments or keywords.

Command Default

The SCCP phone is not exempt from call blocking.

Command Modes

Ephone configuration (config-ephone)
Ephone-template configuration (config-ephone-template)

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.4(4)XC	Cisco Unified CME 4.0	This command was made available in ephone-template configuration mode.
12.4(9)T	Cisco Unified CME 4.0	This command in the ephone-template configuration mode was integrated into Cisco IOS 12.4(9)T.

Usage Guidelines

Use this command to exempt an individual SCCP phone from call blocking and enable the phone user to place outgoing calls regardless of whether the outgoing called number matches the defined pattern of digits during the call blocking periods.

By default, all IP phones in a Cisco Unified CME system are subject to call blocking if the Call Blocking feature is configured.

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 shows how to configure this phone so that outgoing calls are not blocked:

Router(config)# ephone 23

Router(config-ephone)# mac 00e0.8646.9242

Router(config-ephone)# button 1:33

Router(config-ephone)# after-hour exempt

Related Commands

Command	Description
after-hours block pattern	Defines a pattern of digits for blocking outgoing calls from IP phones.
after-hours date	Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day	Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.

after-hours block pattern

To define a pattern of outgoing digits for Call Blocking from IP phones, use the after-hours block pattern command in telephony-service or ephone-template configuration mode. To delete a call-blocking pattern, use the no form of this command.

after-hours block pattern pattern-tag pattern [7-24]

no after-hours block pattern pattern-tag

Syntax Description

pattern-tag	Identifier for a call-blocking pattern. Up to 32 call-blocking patterns can be defined in separate commands.
pattern	Outgoing call digits to be matched for blocking.
7-24	(Optional) If the 7-24 keyword is specified, the pattern is always blocked, 7 days a week, 24 hours a day. If the 7-24 keyword is not specified, the pattern is blocked during the days and dates that are defined with the after-hours day and after-hours date commands.

Command Default

No pattern is defined.

Command Modes

Ephone-template (config-ephone-template)

Telephony-service configuration (config-telephony)

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.4(4)T	Cisco CME 3.4	Support for this command was extended to all SCCP, H.323, SIP, and POTS calls that go through the Cisco Unified CME router, including all incoming calls to the router, except calls from an exempt phone.
12.4(15)XY	Cisco Unified CME 4.2(1)	This command was added to ephone-template configuration mode.
12.4(15)XZ	Cisco Unified CME 4.3	This command was added to ephone-template configuration mode.
12.4(20)T	Cisco Unified CME 7.0	This command was integrated into Cisco IOS Release 12.4(20)T.

Usage Guidelines

Call Blocking on IP phones is defined in the following way. First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern command. Next, one or more time periods during which calls that match those patterns are to be blocked are defined using the after-hours date or after-hours day command or both. By default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined.

Before Cisco CME 3.4, Call Blocking is supported on IP phones and on analog phones connected to SCCP-controlled analog telephone adaptors (Cisco ATA) or SCCP-controlled foreign exchange station (FXS) ports. In Cisco CME 3.4 and later, the call-blocking configuration applies to all SCCP, H.323, SIP and POTS calls that go through the Cisco Unified CME router. All incoming calls to the router, except calls from an exempt phone, are also checked against the after-hours configuration.

Individual phones can be exempted from call blocking using the after-hour exempt or the after-hours override-code command.

Blocked calls return a fast-busy tone to the user for approximately 10 seconds before the call is terminated and the line is returned to on-hook status.

Examples

The following example defines pattern 1, which blocks international calls after hours for a Cisco Unified CME system that requires dialing 9 for external calls:

Router(config)# telephony-service

Router(config-telephony)# after-hours block pattern 1 9011

 

Related Commands

Command	Description
after-hour exempt	Specifies that an IP phone does not have any of its outgoing calls blocked although call blocking is defined.
after-hours date	Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day	Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours override-code	Specifies that call blocking on an IP phone can be overridden by entering a defined code.
after-hours pstn-prefix	Specifies that trunk lines on an IP phone are blocked similarly to that configured for nonPSTN lines.
ephone-template (ephone)	Applies template to a SCCP phone.

after-hours date

To define a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones, use the after-hours date command in ephone-template or telephony-service configuration mode. To delete a defined time period, use the no form of this command.

after-hours date month date start-time stop-time

no after-hours date month date

Syntax Description

month	Abbreviated month. The following abbreviations for month are valid: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.
date	Date of the month. Range is from 1 to 31.
start-time stop-time	Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time that is entered will be the next available time that follows the start time. The value 24:00 is not valid. If 00:00 is entered as a stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified date.

Command Default

No time period based on date is defined for call blocking.

Command Modes

Ephone-template configuration (config-ephone-temp)

Telephony-service configuration (config-ephone)

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.4(15)XY	Cisco Unified CME 4.2(1)	This command was added to ephone-template configuration mode.
12.4(15)XZ	Cisco Unified CME 4.3	This command was added to ephone-template configuration mode.
12.4(20)T	Cisco Unified CME 7.0	This command was integrated into Cisco IOS Release 12.4(20)T.

Usage Guidelines

Use this command to define call blocking that recurs annually on the date specified in the command. Call blocking on IP phones is defined as follows:

•First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern command.

•Next, one or more time periods during which calls that match those patterns are to be blocked are defined using the after-hours date or after-hours day command or both.

By default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined. Individual IP phones can be exempted from call blocking using the after-hour exempt or after-hours override-code commands.

Examples

The following example defines January 1 as an entire day on which calls that match the pattern specified in the after-hours block pattern command are blocked:

Router(config)# telephony-service

Router(config-telephony)# after-hours date jan 1 00:00 00:00

 

Related Commands

Command	Description
after-hour exempt	Specifies that an IP phone does not have any of its outgoing calls blocked although call blocking is defined.
after-hours block pattern	Defines a pattern of digits (0-9) for blocking outgoing calls from IP phones.
after-hours day	Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours override-code	Specifies that call blocking on an IP phone can be overridden by entering a defined set of digits (0-9).
after-hours pstn-prefix	Specifies that trunk lines on an IP phone are blocked similarly to that configured for nonPSTN lines.
ephone-template (ephone)	Applies template to SCCP phone.

after-hours day

To define a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones, use the after-hours day command in ephone-template or telephony-service configuration mode. To delete a defined time period, use the no form of this command.

after-hours day day start-time stop-time

no after-hours day day

Syntax Description

day	Abbreviated day of the week. The following abbreviations for day of the week are valid: sun, mon, tue, wed, thu, fri, sat.
start-time stop-time	Beginning and ending times for call blocking, in an HH:MM format using a 24-hour clock. The stop time that is entered will be the next available time that follows the start time. The value 24:00 is not valid. If 00:00 is entered as a stop time, it is changed to 23:59. If 00:00 is entered for both start time and stop time, calls are blocked for the entire 24-hour period on the specified day.

Command Default

No time period based on day of the week is defined for call blocking.

Command Modes

Ephone-template configuration (config-ephone-template)

Telephony-service configuration (config-ephone)

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.4(15)XY	Cisco Unified CME 4.2(1)	This command was added to ephone-template configuration mode.
12.4(15)XZ	Cisco Unified CME 4.3	This command was added to ephone-template configuration mode.
12.4(20)T	Cisco Unified CME 7.0	This command was integrated into Cisco IOS Release 12.4(20)T.

Usage Guidelines

Use this command to define call blocking during the hours between the start time and stop time on the day of the week that is specified in this command. This time period recurs weekly unless it is removed using the no form of this command.

Call blocking on IP phones is defined as follows:

•First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern command.

•Next, one or more time periods during which calls that match those patterns are to be blocked are defined using the after-hours date or after-hours day command or both.

By default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined. Individual phones can be exempted from call blocking using the after-hour exempt or after-hours override-code commands.

Examples

The following example defines the period from Monday night at 7 p.m. to Tuesday morning at 7 a.m. as an after-hours call-blocking period:

Router(config)# telephony-service

Router(config-telephony)# after-hours day mon 19:00 07:00

 

Related Commands

Command	Description
after-hour exempt	Specifies that an IP phone does not have any of its outgoing calls blocked although call blocking is defined.
after-hours block pattern	Defines a pattern of digits (0-9) for blocking outgoing calls from IP phones.
after-hours date	Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours override-code	Specifies that call blocking on an IP phone can be overridden by entering a defined set of digits (0-9).
after-hours pstn-prefix	Specifies that trunk lines on an IP phone are blocked similarly to that configured for nonPSTN lines.
ephone-template (ephone)	Applies template to SCCP phone.

after-hours override-code

To specify that a defined blocking pattern can be overridden, use the after-hours override-code command in ephone-template or telephony-service configuration mode. To remove the exemption, use the no form of this command.

after-hours override-code pattern

no after-hours override-code pattern

Syntax Description

pattern

Specifies the pattern of digits (0-9) that must be dialed by the phone user to override the call blocking rules. The override code is provided to the phone user by the system administrator.

Command Default

No override is defined.

Command Modes

Ephone-template configuration (config-ephone-template)

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release	Cisco Product	Modification
12.4(15)XY	Cisco Unified CME 4.2(1)	This command was introduced.
12.4(15)XZ	Cisco Unified CME 4.3	This command was added to ephone-template configuration mode.
12.4(20)T	Cisco Unified CME 7.0	This command was integrated into Cisco IOS Release 12.4(20)T.

Usage Guidelines

Use this command to allow a phone user to override call blocking rules and enable the phone user to place outgoing calls regardless of whether the outgoing called number matches the defined pattern of digits during the call blocking periods.

By default, all IP phones in a Cisco Unified CME system are subject to call blocking if the Call Blocking feature is configured. By entering the override code as defined by the system administrator, the phone user can override all call blocking rules.

The after-hours override-code command, configured by either ephone-template or telephony-service, overrides any global telephony-service call block configuration. If the after-hour exempt command is configured, it has priority over the after-hours override-code command.

Examples

The following example defines a blocking pattern using telephony-service configuration which can be overridden using the override code of 1234:

Router(config)# telephony-service

Router(config-telephony)# after-hours block pattern 1 91900

Router(config-telephony)# after-hours day mon 19:00 07:00

Router(config-telephony)# after-hours date Jan 25 00:00 07:00

Router(config-telephony)# after-hours override-code 1234

Related Commands

Command	Description
after-hour exempt	Specifies that an IP phone does not have any of its outgoing calls blocked although call blocking is defined.
after-hours block pattern	Defines a pattern of digits (0-9) for blocking outgoing calls from IP phones.
after-hours date	Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day	Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours pstn-prefix	Specifies that trunk lines on an IP phone are blocked similarly to that configured for non PSTN lines.
ephone-template (ephone)	Applies a template to an ephone.

after-hours pstn-prefix

To specify that all configured blocking patterns apply to trunk or PSTN lines, use the after-hours pstn-prefix command in telephony-service configuration mode. To delete call blocking configuration for PSTN lines, use the no form of this command.

after-hours pstn-prefix tag pattern

no after-hours pstn-prefix tag pattern

Syntax Description

tag	Identifier for a PSTN call-blocking pattern. Up to 4 call-blocking patterns can be defined in separate commands.
pattern	Outgoing call digits (0-9) to be matched for PSTN blocking.

Command Default

No pattern is defined.

Command Modes

Telephony-service configuration

Command History

Cisco IOS Release	Cisco Product	Modification
12.4(15)XY	Cisco Unified CME 4.2(1)	This command was introduced.
12.4(15)XZ	Cisco Unified CME 4.3	This command was introduced.

Usage Guidelines

Use the after-hours pstn-prefix command to indicate that the after-hours call blocking patterns are configured to include one or more PSTN access digits that are normally dialed by phone users using regular ephone-dn lines. For example, the patterns are configured with a leading digit 9 to correspond to the conventional "dial 9 for outside line." The after-hours pstn-prefix command instructs the system to skip over the PSTN prefix digits (in the blocking patterns) for calls that are dialed directly to the PSTN on ephone-dns that are configured using the trunk feature. These lines do not require the user to dial a PSTN access code (for example, 9) because they are configured to directly connect to the PSTN FXO ports. For example, a user of a regular ephone-dn would dial 9-1-900-xxx-xxxx, whereas a user on a trunk ephone-dn would omit the leading 9 and dial only 1-900-xxx-xxxx. The blocking pattern would be configured as 91900 to restrict calls on regular ephone-dn lines, and this pattern would be interpreted as 1900 on ephone-dns configured using the trunk feature. If you do not specify the after-hours pstn-prefix command, then no blocking is performed on calls dialed on trunk ephone-dn lines.

Call blocking on IP phones is defined as follows:

•First, one or more patterns of outgoing digits (0-9) are defined using the after-hours block pattern command.

•Next, one or more time periods during which calls that match those patterns are to be blocked are defined using the after-hours date command, the after-hours day command, or both commands.

By default, all IP phones in a Cisco Unified CME system are restricted during the specified time if at least one pattern and at least one time period are defined.

Blocked calls return a fast-busy tone to the user for approximately 10 seconds before the call is terminated and the line is returned to on-hook status.

Examples

The following example defines a blocking pattern using telephony-service configuration which is applied to a PSTN line:

Router(config)# telephony-service

Router(config-telephony)# after-hours block pattern 1 91900

Router(config-telephony)# after-hours pstn-prefix 1 9

Router(config-telephony)# after-hours day mon 19:00 07:00

Router(config-telephony)# after-hours date Jan 25 00:00 07:00

 

Related Commands

	Description
after-hour exempt	Specifies that an IP phone does not have any of its outgoing calls blocked although call blocking is defined.
after-hours block pattern	Defines a pattern of digits (0-9) for blocking outgoing calls from IP phones.
after-hours date	Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours day	Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.
after-hours override-code	Specifies that call blocking on an IP phone can be overridden by entering a defined series of digits (0-9).

allow watch

To allow a directory number on a phone registered to Cisco Unified CME to be watched in a presence service, use the allow watch command in ephone-dn, ephone-dn-template, or voice register dn configuration mode. To reset to the default condition, use the no form of this command.

allow watch

no allow watch

Syntax Description

This command has no arguments or keywords.

Command Default

Watching of the phone line is disabled.

Command Modes

Ephone-dn configuration (config-ephone)
Ephone-dn-template configuration (config-ephone-dn-template)
Voice register dn configuration (config-register-dn)

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

This command controls whether a phone line associated with a directory number can be watched as part of a presence service. The directory number is enabled as a presentity that can be watched by internal and external watchers. Presence service must be enabled on Cisco Unified CME. Another phone, acting as a watcher, can monitor the status of this phone line when the blf-speed-dial or presence call-list command is enabled for that phone.

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

Examples

The following example shows that the extension associated with voice register dn 2 can be watched by the phone associated with voice register pool 1:

Router(config)# voice register dn 2

Router(config-register-dn)# number 2102

Router(config-register-dn)# allow watch

Router(config)# voice register pool 1

Router(config-register-pool)# id mac 0015.6247.EF90

Router(config-register-pool)# type 7971

Router(config-register-pool)# number 1 dn 2

Router(config-register-pool)# blf-speed-dial 1 2102 label 2102

 

Related Commands

Command	Description
blf-speed-dial	Enables Busy Lamp Field (BLF) monitoring for a speed-dial number on a phone registered to Cisco Unified CME.
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.
presence enable	Allows the router to accept incoming presence requests.
show presence global	Displays configuration information about the presence service.
show presence subscription	Displays information about active presence subscriptions.

anonymous block

To enable anonymous call blocking in a SIP phone template, use the anonymous block command in voice register template configuration mode. To return to the default, use the no form of this command.

anonymous block

no anonymous block

Syntax Description

This command has no arguments or keywords.

Command Default

Disabled

Command Modes

Voice register template configuration (config-register-temp)

Command History

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

Usage Guidelines

This command blocks incoming calls in which the caller is not identified. To apply a template to a SIP phone, use the template command in voice register pool configuration mode.

Examples

The following example shows how to set anonymous call blocking in template 1:

Router(config)# voice register template 1

Router(config-register-temp)# anonymous block

 

Related Commands

Command	Description
caller-id block (voice register template)	Enables caller-ID blocking for outbound calls from a SIP phone.
template (voice register pool)	Applies a template to a SIP phone.

application (telephony-service)

To select a session-level application for all extensions (ephone-dns) in a Cisco Unified CME, use the application command in telephony-service configuration mode. To disable use of an application for all extensions, use the no form of this command.

application application-name

no application

Syntax Description

application-name

Interactive voice response (IVR) application name.

Command Default

No application is selected for all extensions.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release	Cisco Product	Modification
12.2(11)YT	Cisco ITS 2.1	This command was introduced.
12.2(15)T	Cisco ITS 2.1	This command was integrated into Cisco IOS Release 12.2(15)T.

Usage Guidelines

Use this command to assign a Tool Command Language (Tcl) IVR application to all extensions served by the CME router.

Use the show call application voice summary command to display a list of applications.

Examples

The following example sets the IVR application for all phones:

Router(config)# telephony-service

Router(config-telephony) application TCL IVR

 

Related Commands

Command	Description
show call application voice summary	Displays information about voice applications.

application (voice register global)

To select the session-level application for all dial peers associated with Session Initiation Protocol (SIP) phones, use the application command in voice register global configuration mode. To disable use of the application, use the no form of this command.

application application-name

no application

Syntax Description

application-name

Interactive voice response (IVR) application name.

Command Default

Default application on router

Command Modes

Voice register global configuration (config-register-global)

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

During Cisco Unified CallManager Express (Cisco Unified CME) or Cisco Unified Session Initiation Protocol (SIP) Survivable Remote Site Telephony (SRST) registration, a dial peer is created for each SIP phone and that dial peer includes the default session application. The application command allows you to change the default application for all dial peers associated with the Cisco SIP IP phones, if desired. The applied application (or TCL IVR script) must support call redirection. Use the show call application voice summary command to display a list of applications.

The application command in voice register pool configuration mode takes precedence over this command in voice register global configuration mode.

---

Note Configure the id (voice register pool) command before any other voice register pool commands, including the application command. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.

---

Examples

The following example shows how to set the Tcl IVR application globally for all SIP phones:

Router(config)# voice register global

Router(config-register-global)# mode cme

Router(config-register-global)# application sipapp2

 

Related Commands

Command	Description
application (dial-peer)	Enables a specific application on a dial peer.
application (voice register pool)	Selects the session-level application for the dial peer associated an individual SIP phone in a Cisco Unified CME environment or for a group of phones in a Cisco Unified SIP SRST environment.
id (voice register pool)	Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco Unified SIP SRST, set of Cisco SIP IP phones.
mode (voice register global)	Enables the mode for provisioning SIP phones in a Cisco Unified CME system.
show call application voice summary	Displays information about voice applications.
show dial-peer voice	Displays information for dial peers.
voice register pool	Enters voice register pool configuration mode for SIP phones.

application (voice register pool)

To select the session-level application for the dial peer associated with an individual Session Initiation Protocol (SIP) phone in a Cisco Unified CallManager Express (Cisco Unified CME) environment or for a group of phones in a Cisco Unified SIP Survivable Remote Site Telephony (SRST) environment, use the application command in voice register pool configuration mode. To disable use of the application, use the no form of this command.

application application-name

no application

Syntax Description

application-name

Name of the selected interactive voice response (IVR) application name.

Command Default

Default application on router

Command Modes

Voice register pool configuration (config-register-pool)

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

Usage Guidelines

During Cisco Unified CME or Cisco Unified SIP SRST registration, a dial peer is created for each SIP phone and that dial peer includes the default session application. The application command allows you to change the default application for all dial peers associated with the Cisco SIP IP phones, if desired. The applied application (or TCL IVR script) must support call redirection. Use the show call application voice summary command to display a list of applications.

The application command in voice register pool configuration mode takes precedence over this command in voice register global configuration mode.

---

Note Configure the id (voice register pool) command before any other voice register pool commands, including the application command. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.

---

Examples

The following example shows how to set the IVR application for the SIP phone specified by the voice register pool command:

Router(config)# voice register pool 1

Router(config-register-pool) application sipapp2

 

The following partial sample output from the show running-config command shows that voice register pool 1 has been set up to use the SIP.app application:

voice register pool 1

 id network 172.16.0.0 mask 255.255.0.0

 application SIP.app

 voice-class codec 1

Related Commands

Command	Description
application (dial-peer)	Enables a specific application on a dial peer.
application (voice register global)	Selects the session-level application for all dial peers associated with SIP phones.
id (voice register pool)	Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco Unified SIP SRST, set of Cisco SIP IP phones.
mode (voice register global)	Enables the mode for provisioning SIP phones in a Cisco Unified CME system.
show call application voice summary	Displays information about voice applications.
show dial-peer voice	Displays information for dial peers.

authenticate (voice register global)

To define the authenticate mode for SIP phones in a Cisco Unified CME or Cisco Unified SRST system, use the authenticate command in voice register global configuration mode. To return to the default, use the no form of this command.

Cisco IOS Release 12.4(11)XJ and later releases

authenticate {credential tag location | ood-refer | presence | realm string | register}

no authenticate {credential tag location | ood-refer | presence | realm string | register}

Cisco IOS Release 12.4(4)T

authenticate [all] [realm string]

no authenticate [all] [realm string]

Syntax Description

credential tag	Number that identifies the credential file to use for out-of-dialog REFER (OOD-R) or presence authentication. Range: 1 to 5.
location	Name and location of the credential file in URL format. Valid storage locations are TFTP, HTTP, and flash memory.
ood-refer	Incoming OOD-R requests are authenticated using RFC 2617-based digest authentication.
presence	Incoming presence subscription requests from an external presence server are authenticated.
realm string	Realm parameter for challenge and response as specified in RFC 2617 is authenticated.
register	All incoming registration requests are challenged and authenticated. Valid for Cisco Unified CME only.

Command Default

Authenticate mode is disabled.

Command Modes

Voice register global configuration (config-register-global)

Command History

Cisco IOS Release	Cisco Product	Modification
12.4(4)T	Cisco CME 3.4	This command was introduced.
12.4(11)XJ	Cisco Unified CME 4.1 Cisco Unified SRST 4.1	The credential, ood-refer, presence, and register keywords were added. The register keyword replaced the all keyword.
12.4(15)T	Cisco Unified CME 4.1 Cisco Unified SRST 4.1	The modifications to this command were integrated into Cisco IOS Release 12.4(15)T.

Usage Guidelines

The credential keyword allows OOD-R and presence service to use credential files for authentication. Up to five text files containing username and password pairs can be defined and loaded into the system. The contents of these five files are mutually exclusive; the username and password pairs must be unique across all the files. For Cisco Unified CME, the username and password pairs cannot be the same ones defined for SCCP or SIP phones with the username command.

The ood-refer keyword specifies that any OOD-R request that passes authentication is authorized to setup calls between referee and refer-target if OOD-R is enabled with the refer-ood enable command.

The presence keyword enables digest authentication for external watchers. Credentials are verified against a credential file stored in flash. This applies to both OOD-R and presence. The default is to authenticate all SUBSCRIBE requests from external watchers. An external watcher that passes authentication is authorized to subscribe to presence service for all lines allowed to be watched.

The register keyword enables authentication for registration requests in which the MAC address of the SIP phone cannot be identified by using other methods. All incoming register requests are challenged and authenticated. The realm keyword with the string argument specifies the character string to be included in the challenge.

Examples

The following example shows that all registration requests from SIP phones in a Cisco Unified CME system must be authenticated:

Router(config)# voice register global

Router(config-register-global)# mode cme

Router(config-register-global)# authenticate register

 

Related Commands

Command	Description
credential load	Reloads a credential file into flash memory.
mode cme	Enables the mode for provisioning SIP phones in a Cisco Unified CME system.
presence-enable	Allows incoming presence subscribe requests from SIP trunks.
refer-ood enable	Enables OOD-R processing.
username (ephone)	Defines a username and password for SCCP phones.
username (voice register pool)	Defines a username and password for authenticating SIP phones.

authentication credential

To create an entry for an application's credential in the database used by the Cisco Unified CME authentication server, use the authentication credential command in telephony-service configuration mode. To remove the credential, use the no form of this command.

authentication credential application-name password

no authentication credential application-name password

Syntax Description

application-name	String sent by application to identify itself to the server. Length of string: 1 to 15characters.
password	String sent by application to identify itself to the server. Length of string: 1 to 15 characters.

Command Default

The credential is not stored in the database.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Release	Cisco Product	Modification
12.4(15)XZ	Cisco Unified CME 4.3	This command was introduced.
12.4(20)T	Cisco Unified CME 7.0	This command was integrated into Cisco IOS Release 12.4(20)T.

Usage Guidelines

This command stores a credential in the database used by the Cisco Unified CME authentication server. The authentication server uses this data to authenticate and authorize HTTP requests from IP phones in Cisco Unified CME.

Up to eight credentials can be stored in the database for the Cisco Unified CME authentication server.

For applications other than Extension Mobility, the credential must be created in the application.

---

Note This command is not required for authorizing requests from Extension Mobility phones in Cisco Unified CME.

---

Examples

The following example shows how to configure IP phones in Cisco Unified CME to request authorization from the internal authentication server. When the IP phone receives a command from the application, the phone requests authorization from the Cisco Unified CME authentication server to execute that command. The authorization request from the phone includes the specified credential. The authentication server compares the credential in its database to the one in the request, and authorizes or rejects the request based on the results.

Router(config)# telephony-service

Router(config-telephony)# authentication credential att psswrd