Cisco Unified Communications Manager Express Command Reference
Cisco Unified CME Commands: V

Table Of Contents

Cisco Unified CME Commands: V

vad (voice register pool)

vad (voice register template)

video (ephone)

video (telephony-service)

vm-device-id (ephone)

vm-integration

voice-class codec (voice register pool)

voice emergency response location

voice emergency response settings

voice emergency response zone

voice-gateway system

voice hunt-group

voice logout-profile

voice-port (voice-gateway)

voice register dialplan

voice register dn

voice register global

voice register pool

voice register session-server

voice register template

voice user-profile

voicemail (telephony-service)

voicemail (voice register global)

voicemail (voice register template)


Cisco Unified CME Commands: V


Revised: February 27, 2009

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.

vad (voice register pool)

To enable voice activity detection (VAD) on a VoIP dial peer, use the vad command in voice register pool configuration mode. To disable VAD, use the no form of this command.

vad

no vad

Syntax Description

This command has no arguments or keywords.

Command Default

VAD is enabled.

Command Modes

Voice register pool configuration (config-register-pool)

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

VAD detects periods of silence in the voice signal and temporarily discontinues transmission of the signal during these periods to save bandwidth. Because VAD is enabled by default, there is no comfort noise during periods of silence. As a result, the call may seem to be disconnected and you may prefer to set no vad on the SIP phone pool.

Examples

The following example shows how to disable VAD for pool 1:

Router(config)# voice register pool 1

Router(config-register-pool)# no vad

 

vad (voice register template)

To enable voice activity detection (VAD) on SIP phones, use the vad command in voice register template configuration mode. To return to the default, use the no form of this command.

vad

no vad

Syntax Description

This command has no arguments or keywords.

Command Default

VAD is 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

VAD detects periods of silence in the voice signal and temporarily discontinues transmission of the signal during these periods to save bandwidth. To apply the template to a SIP phone, use the template command in voice register pool configuration mode.

Examples

The following example shows how to enable VAD:

Router(config)# voice register template 1
Router(config-register-temp)# vad

Related Commands

 
Description

template (voice register pool)

Applies a template to a SIP phone.


video (ephone)

To enable video capabilities for an SCCP phone in Cisco Unified CME, use the video command in ephone configuration mode. To reset to default, use the no form of this command.

video

no video

Syntax Description

This command has no arguments or keywords.

Command Default

Video capabilities are disabled.

Command Modes

Ephone configuration (config-ephone)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command enables video capabilities in the ephone configuration for a particular phone.

Video capabilities for SCCP phones in Cisco Unified CME must be enabled globally as well as for individual phones. You must enable video for all video-capable SCCP phones associated with a Cisco Unified CME router by configuring the videoCapability parameter of the service phone command.

Video parameters, such as maximum bit rate, are set at a system-level in video configuration mode.

Examples

The following example shows the ephone portion from the show running-configuration command:

router# show running-configuration

.

.

.

ephone 6

 video

 mac-address 000F.F7DE.CAA5

 type 7960

 button 1:6

 

Related Commands

service phone

Modifies the vendorConfig parameters in phone configuration files.

video (telephony-service)

Enters video configuration mode for modifying video parameters in Cisco Unified CME.


video (telephony-service)

To enter video configuration mode for setting video parameters for all video-capable phones in Cisco Unified CME, use the video command in telephony-service configuration mode. To reset global video parameters, use the no form of this command.

video

no video

Syntax Description

This command has no arguments or keywords.

Command Default

Defaults for global video parameters are configured.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)XC

Cisco Unified CME 4.0

This command was introduced.

12.4(9)T

Cisco Unified CME 4.0

This command was integrated into Cisco IOS Release 12.4(9)T.


Usage Guidelines

This command enters video configuration mode for setting video parameters for all video-capable Cisco Unified IP phones associated with a Cisco Unified CME router.

Examples

The following example shows how to enter video configuration mode for a Cisco Unified CME router. You must enter video configuration mode to set video parameters, such as maximum bit rate.

Router(config)# telephony-service

Router(config-telephony)# video

Router(config-tele-video)# maximum bit-rate 256

 

Related Commands

 
Description

maximum bit-rate

Sets the maximum video bandwidth for phones in Cisco unified CME.

show call active video

Displays call information for SCCP video calls in progress.

show call history video

Displays call history information for SCCP video calls.


vm-device-id (ephone)

To define a voice-messaging identification string, use the vm-device-id command in ephone configuration mode. To disable this feature, use the no form of this command.

vm-device-id id-string

no vm-device-id

Syntax Description

id-string

Voice-messaging device port identification (ID) string; for example, CiscoUM-VI1 for the first port and CiscoUM-VI2 for the second port. Note that the first two characters after the hyphen must be the uppercase letters V and I.


Command Default

No voice-mail identification string is defined.

Command Modes

Ephone configuration (config-ephone)

Command History

Cisco IOS Release
Cisco Product
Modification

12.2(2)XT

Cisco ITS 2.0

This command was introduced

12.2(8)T

Cisco ITS 2.0

This command was integrated into Cisco IOS Release 12.2(8)T.


Usage Guidelines

Use this command to define a voice-messaging device ID string. A voice-messaging port registers with a device ID instead of a MAC address. To distinguish among different voice-messaging ports, the value of the voice-messaging device ID is used. The voice-messaging device ID is configured to a Cisco IP phone port, which maps to a corresponding voice-messaging port.

Examples

The following example shows how to set the voice-messaging device ID to CiscoUM-VI1:

Router(config) ephone 1

Router(config-ephone) vm-device-id CiscoUM-VI1

 

Related Commands

 
Description

voicemail (telephony-service)

Configures the telephone number that is speed-dialed when the Messages button on a Cisco IP phone is pressed.


vm-integration

To enter voice-mail integration configuration mode and enable voice-mail integration with dual tone multifrequency (DTMF) and analog voice-mail systems, use the vm-integration command in global configuration mode. To disable voice-mail integration, use the no form of this command.

vm-integration

no vm-integration

Syntax Description

This command has no arguments or keywords.

Command Default

DTMF integration with voice-mail system is disabled.

Command Modes

Global configuration (config)

Command History

Cisco IOS Release
Cisco  Product
Modification

12.2(11)YT

Cisco SRST 2.1

This command was introduced for Cisco Survivable Remote Site Telephony (SRST).

12.2(2)XT

Cisco ITS  2.0

This command was introduced Cisco ITS.

12.2(8)T

Cisco ITS  2.0
Cisco SRST 2.1

This command was integrated into Cisco IOS Release 12.2(8)T.


Usage Guidelines

The vm-integration command is used to enter voice-mail integration configuration mode to enable in-band DTMF integration with a voice-mail system.

Examples

The following example shows how to enter the voice-mail integration configuration mode:

Router(config) vm-integration
Router(config-vm-integration) pattern direct 2 CGN *

Related Commands

 
Description

pattern direct (vm-integration)

Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system when a user presses the Messages button on a phone.

pattern ext-to-ext busy (vm-integration)

Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system once an internal extension reaches a busy extension and the call is forwarded to voice mail.

pattern ext-to-ext no-answer (vm-integration)

Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system once an internal extension fails to connect to an extension and the call is forwarded to voice mail.

pattern trunk-to-ext busy (vm-integration)

Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system once an external trunk call reaches a busy extension and the call is forwarded to voice mail.

pattern trunk-to-ext no-answer (vm-integration)

Configures the DTMF digit pattern forwarding necessary to activate the voice-mail system when an external trunk call reaches an unanswered extension and the call is forwarded to voice mail.


voice-class codec (voice register pool)

To assign a previously configured codec selection preference list, use the voice-class codec command in voice register pool configuration mode. To remove the codec preference assignment from the voice register pool, use the no form of this command.

voice-class codec tag

no voice-class codec

Syntax Description

tag

Unique number assigned to the voice class. Range is from 1 to 10000. The tag number maps to the tag number created by using the voice class codec command in dial-peer configuration mode.


Command Default

There is no codec preference assignment in the voice register pool configuration.

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 Session Initiation Protocol (SIP) Survivable Remote Site Telephony (SRST) or Cisco Unified CallManager Express (Cisco Unified CME) registration, a dial peer is created and that dial peer includes codec g729r8 by default. This command allows you to change the automatically selected default codec.

You can assign one voice class to each voice register pool. If you assign another voice class to a pool, the last voice class assigned replaces the previous voice class.


Note The id (voice register pool) command is required and must be configured before any other voice register pool commands. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.


Examples

The following partial sample output from the show running-config command shows that voice register pool 1 has been set up to use the previously configured codec voice class 1:

voice register pool 1

id mac 0030.94C2.A22A

preference 5

cor incoming call91 1 91011

translate-outgoing called 1

proxy 10.2.161.187 preference 1 monitor probe icmp-ping

alias 1 94... to 91011 preference 8

voice-class codec 1

 

Related Commands

 
Description

codec (voice register pool)

Specifies the codec supported by a single Cisco SIP phone or a VoIP dial peer in a Cisco Unified SIP SRST or a Cisco Unified CME 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.

voice class codec (dial-peer)

Assigns a previously configured codec selection preference list (codec voice class) to a VoIP dial peer.


voice emergency response location

To create a tag for identifying an emergency response location (ERL) for E911 services, use the voice emergency response location command in global configuration mode. To remove the ERL tag, use the no form of this command.

voice emergency response location tag

no voice emergency response location tag

Syntax Description

tag

Unique number that identifies this ERL tag.


Command Default

No ERL tag is created.

Command Modes

Global configuration (config)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(15)T

Cisco Unified CME  4.1
Cisco Unified SRST 4.1
Cisco Unified SIP SRST 4.1

This command was introduced. For Cisco Unified CME, this command is supported in SRST fallback mode only.

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 added for Cisco Unified CME.

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 an ERL that identifies an area where emergency teams can quickly locate a 911 caller. The ERL definition optionally includes which ELINs are associated with the ERL and which IP phones are located in the ERL. You can define two or fewer unique IP subnets and two or fewer ELINs. If you define one ELIN, this ELIN is always used for phones calling from this ERL. If you define two ELINs, the system alternates between using each ELIN. If you define zero ELINs and phones use this ERL, the outbound calls do not have their calling numbers translated. The PSAP sees the original calling numbers for these 911 calls. You can optionally add the civic address using the address command and an address description using the name command.

Examples

In the following example, all IP phones with the IP address of 10.X.X.X or 192.168.X.X are automatically associated with this ERL. If one of the phones dials 911, its extension is replaced with 408 555-0100 before it goes to the PSAP. The PSAP will see that the caller's number is 408 555-0100. The civic address, 410 Main St, Tooly, CA, and a descriptive identifier, Bldg 3 are included.

voice emergency response location 1
 elin 1 4085550100
 subnet 1 10.0.0.0 255.0.0.0
 subnet 2 192.168.0.0 255.255.0.0
 address 1,408,5550100,410,Main St.,Tooly,CA
 name Bldg 3

Related Commands

Command
Description

address

Specifies a comma separated text entry (up to 250 characters) of an ERL's civic address.

elin

Specifies a PSTN number that will replace the caller's extension.

name

Specifies a string (up to 32-characters) used internally to identify or describe the emergency response location.

subnet

Defines which IP phones are part of this ERL.


voice emergency response settings

To define 911 call behavior settings, use the voice emergency response settings command in global configuration mode. To remove the settings, use the no form of this command.

voice emergency response settings

no voice emergency response settings

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Global configuration (config)

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 enable definition of the following 911 call behavior settings:

elin: Default ELIN to use if a 911 caller's IP phone's address does not match the subnet of any location in any zone.

expiry: Number of minutes a 911 call is associated to an ELIN in the case of a callback from the 911 operator.

callback: Default number to contact if a 911 callback cannot find the last 911 caller.

logging: Syslog informational message that is printed to the console each time an emergency call is made. This feature is enabled by default, however you can disable this feature by entering the no form of this command.

Examples

In the following example, if the 911 caller's IP phone address does not match any of the voice emergency response locations, the ELIN defined in the voice emergency response settings configuration (4085550101) is used. After the 911 call is placed to the PSAP, the PSAP has 120 minutes (2 hours) to call back 408 555-0101 to reach the 911 caller. If during a callback, the last caller's extension number cannot be found, the call is routed to extension 7500. The outbound 911 calls do not cause a syslog message to the logging facility (for example, to the local buffer, console, or remote host).

voice emergency response settings
callback 7500
elin 4085550101
expiry 120
no logging

Related Commands

Command
Description

callback

Default phone number to contact if a 911 callback cannot find the last 911 caller from the ERL.

elin

E.164 number used as the default ELIN if no matching ERL to the 911 caller's IP phone address is found.

expiry

Number of minutes a 911 call is associated to an ELIN in the case of a callback from the 911 operator.

logging

Syslog informational message printed to the console every time an emergency call is made.


voice emergency response zone

To create an emergency response zone, use the voice emergency response zone command in global configuration mode. To remove the created voice emergency response zone, use the no form of this command.

voice emergency response zone tag

no voice emergency response zone tag

Syntax Description

tag

Identifier (1-100) for the voice emergency response zone.


Command Default

No default behavior or values

Command Modes

Global configuration (config)

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 voice emergency response zones that allow routing of 911 calls to different PSAPs.

Examples

The following example shows an assignment of ERLs to a voice emergency response zone. The calls have an ELIN from ERLs 8, 9, and 10. The locations for ERLs in zone 10 are searched in the order each CLI is entered for a phone address match because no priority order is assigned.

voice emergency response zone 10
location 8
location 9
location 10

Related Commands

Command
Description

location

Identifies locations within an emergency response zone and optionally assigns a priority order to the location.


voice-gateway system

To enter voice-gateway configuration mode and create a voice gateway configuration, use the voice-gateway system command in global configuration mode. To remove the configuration, use the no form of this command.

voice-gateway system tag

no voice-gateway system tag

Syntax Description

tag

Unique number that identifies the voice gateway. Range: 1 to 25. There is no default value.


Defaults

Gateway configuration is not defined.

Command Modes

Global configuration (config)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(22)YB

Cisco Unified CME 7.1

This command was introduced.

12.4(24)T

Cisco Unified CME 7.1

This command has been integrated into Cisco IOS Release 12.4(24)T.


Usage Guidelines

This command enters voice-gateway configuration mode to define the parameters for a voice gateway using the auto-configuration feature. Define a configuration for each Cisco voice gateway whose analog FXS ports you want under the control of this Cisco Unified CME router.

Examples

The following example shows a voice gateway configuration:

voice-gateway system 1

 network-locale FR

 type VG224

 mac-address 001F.A30F.8331

 voice-port 0-23

 create cnf-files

Related Commands

Command
Description

mac-address

Defines the MAC address of the Cisco voice gateway that downloads its configuration from Cisco Unified CME.

type

Defines the type of voice gateway to autoconfigure in Cisco Unified CME.

voice-port

Identifies the analog ports on the voice gateway that register to Cisco Unified CME.


voice hunt-group

To create a hunt group for phones in a Cisco Unified CME system, use the voice hunt-group command in global configuration mode. To delete a hunt group, use the no form of this command.

voice hunt-group hunt-tag {longest-idle | parallel | peer | sequential}

no voice hunt-group hunt-tag

Syntax Description

hunt-tag

Unique sequence number that identifies the hunt group. Range: 1 to 100

longest idle

Hunt group in which calls go to the directory number that has been idle the longest.

parallel

Hunt group in which calls simultaneously ring multiple phones.

peer

Hunt group in which the first extension to ring is selected round-robin from the list. Ringing proceeds in a circular manner, left to right, for the number of hops specified when the hunt group is defined. The round-robin selection starts with the number left of the number that answered when the hunt-group was last called.

sequential

Hunt group in which extensions ring in the order in which they are listed, left to right, when the hunt group was defined.


Command Default

No voice hunt group is created.

Command Modes

Global configuration

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)T

Cisco CME 3.4

This command was introduced.

12.4(15)XZ

Cisco Unified CME 4.3

Support for SCCP phones was added.

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 enters voice hunt-group configuration mode to define a hunt group. A hunt group is a list of phone numbers that take turns receiving incoming calls to a specific number (pilot number), which is defined with the pilot command. The specific extensions included in the hunt group, and the order and maximum number of extensions allowed in the list is defined with 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 with the final command. If the number of times that a call is redirected to a new number exceeds 5, you must use the max-redirect command 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 hunt group configuration, the keyword is not required. To change the type of hunt group, for instance from peer to sequential or sequential to peer, you must remove the existing hunt group first by using the no form of this command and then re-create it.

The parallel keyword creates a dial peer to allow an incoming call to ring multiple phones simultaneously. The use of parallel hunt groups is also referred to as application-level forking because it enables the forking of a call to multiple destinations. A pilot dial peer cannot be used as a voice hunt group and a hunt group at the same time.

Examples

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

Router(config)# voice hunt-group 1 longest-idle

Router(config-voice-hunt-group)# pilot 7501

Router(config-voice-hunt-group)# list 7001, 7002, 7023, 7028, 7045, 7062, 7067, 7072, 7079 Router(config-voice-hunt-group)# final 8000

Router(config-voice-hunt-group)# hops 6

Router(config-voice-hunt-group)# timeout 20

Router(config-voice-hunt-group)# exit

 

The following example shows how to define a 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, for four hops. If none of those extensions answer before the hops limit is reached, the call is forwarded to extension 6000, which is the number for the voice-mail service.

The second time someone calls the hunt group, the first extension to ring is 5602 if 5601 was answered during the previous call.

Router(config)# voice hunt-group 2 peer

Router(config-voice-hunt-group)# pilot 5610

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

Router(config-voice-hunt-group)# final 6000

Router(config-voice-hunt-group)# hops 4

Router(config-voice-hunt-group)# timeout 30

Router(config-voice-hunt-group)# exit

 

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

Router(config)# voice hunt-group 3 sequential

Router(config-voice-hunt-group)# pilot 5601

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

Router(config-voice-hunt-group)# final 6000

Router(config-voice-hunt-group)# timeout 30

Router(config-voice-hunt-group)# exit

 

The following example shows how to define a parallel hunt group. When callers dial extension 1000, extension 1001, 1002, and so forth ring simultaneously. The first extension to answer is connected. All other call legs are disconnected. If none of the extensions answer, the call is forwarded to extension 2000, which is the number for the voice-mail service.

Router(config)# voice hunt-group 4 parallel

Router(config-voice-hunt-group)# pilot 1000

Router(config-voice-hunt-group)# list 1001, 1002, 1003, 1004

Router(config-voice-hunt-group)# final 2000

Router(config-voice-hunt-group)# timeout 20

Router(config-voice-hunt-group)# exit

Related Commands

 
Description

final (voice hunt-group)

Defines the last extension in a voice hunt group.

hops (voice hunt-group)

Defines the number of times that a call is redirected to the next phone number in a peer voice hunt-group list before proceeding to the final phone number.

list (voice hunt-group)

Defines the phone numbers that participate in a voice hunt group.

pilot (voice hunt-group)

Defines the phone number that callers dial to reach a voice hunt group.

timeout (voice hunt-group)

Sets the number of seconds after which a call that is not answered is redirected to the next number in the hunt-group list and defines the last phone number in the hunt group.


voice logout-profile

To enter voice logout-profile configuration mode to create a logout profile and define the default appearance for a Cisco Unified IP phone enabled for Extension Mobility, use the voice logout-profile command in global configuration mode. To delete an logout profile, use the no form of this command.

voice logout-profile profile-tag

no voice logout-profile profile-tag

Syntax Description

profile-tag

Unique number that identifies this profile during configuration tasks. Range: 1 to maximum number supported phones, where maximum is platform dependent.


Command Default

No logout profile is created.

Command Modes

Global configuration (config)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(11)XW

Cisco Unified CME 4.2

This command was introduced.

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.

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 create a logout profile containing a set of commands that define the default appearance for an IP phone that is registered in Cisco Unified CME and enabled for Extension Mobility, when the IP phone boots and no phone user is logged into the phone.

Type ? in voice profile configuration mode to see the commands that are available in this mode and that can be included in a logout profile. The following example shows a list of commands that were available in voice logout-profile configuration mode at the time that this document was written:

Router(config-logout-profile)#?

Logout profile configuration commands:
 number				Create ip-phone line definition
 pin					
 reset				Reset all phones associated with the profile being configured
 speed-dial				Define ip-phone speed-dial number
 username				Create authentication credential for TSP	

All directory numbers to be included in a logout profile or user profile must already be configured in Cisco Unified CME.

After creating a logout profile, assign the profile to one or more supported Cisco Unified IP phones by using the logout-profile command in ephone configuration mode to enable the IP phones for Extension Mobility.

The same logout profile can be assigned to more than one IP phone to create the appearance of shared lines. All IP phones on which the logout profile is downloaded will have the same directory numbers associated with the same buttons.

You cannot assign more than one logout profile to a particular IP phone. If you assign a second logout profile to a phone to which a logout profile is already applied, the second profile will overwrite the first profile configuration when you use the reset command or when the phone is powered off and then powered on.

After creating or modifying a profile, use the reset (voice logout-profile) command to reset all phones on which this profile is downloaded to propagate the modifications.

Examples

The following example shows the configuration for two logout profiles and the three different IP phones to which the profiles are assigned. All three phones are enabled for Extension Mobility. Two phones share logout profile 1, while the third phone is assigned logout profile 2. The logout profiles assigned to each phone are downloaded when these phones boot and when no phone user is logged into the phone.

voice logout-profile 1

 pin 12345

 user me password pass123

 number 2001 type silent-ring

 number 2002 type beep-ring

 number 2003 type feature-ring

 number 2004 type monitor-ring

 number 2005,2006 type overlay

 number 2007,2008 type cw-overly

 speed-dial 1 3001

 speed-dial 2 3002 blf

!

voice logout-profile 2

 speed-dial 1 9911

 speed-dial 2 2000

!

!

!

ephone 1

 mac-address 000D.EDAB.3566

 type 7960

 logout-profile 1


ephone 2

 mac-address 0012.DA8A.C43D

 type 7970

 logout-profile 1


ephone 3

 mac-address 1200.80FC.9B01

 type 7911

 logout-profile 2

 

Related Commands

Command
Description

logout-profile

Enables Cisco Unified IP phone for Extension Mobility and assigns a logout profile to this phone.

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

Performs a complete reboot of all IP phones on which a particular logout profile or user profile is downloaded.


voice-port (voice-gateway)

To identify the analog ports on the voice gateway that register to Cisco Unified CME, use the voice-port command in voice-gateway configuration mode. To remove the ports, use the no form of this command.

voice-port port-range

no voice-port

Syntax Description

port-range

Individual port number, or range of port numbers, on the voice gateway controlled by Cisco Unified CME. Enter individual port values separated by a comma (,) or enter a range using a hyphen (x-y). There is no default value.


Command Default

No voice ports are supported.

Command Modes

Voice-gateway configuration (config-voice-gateway)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(22)YB

Cisco Unified CME 7.1

This command was introduced.

12.4(24)T

Cisco Unified CME 7.1

This command has been integrated into Cisco IOS Release 12.4(24)T.


Usage Guidelines

This command sets the total number of analog endpoints on the voice gateway that you intend to register to the Cisco Unified CME router. The Cisco VG202 supports two ports, Cisco VG204 supports four ports, and the Cisco VG224 supports 24 ports, numbered 0 to 23.

Examples

The following example shows a configuration for a Cisco VG224 voice gateway with 24 ports:

voice-gateway system 1

 network-locale FR

 type VG224

 mac-address 001F.A30F.8331

 voice-port 0-23

 create cnf-files

Related Commands

Command
Description

network-locale (voice-gateway)

Selects a geographically specific set of tones and cadences for the voice gateway's analog endpoints that register to Cisco Unified CME.

type (voice-gateway)

Defines the type of voice gateway to autoconfigure in Cisco Unified CME.


voice register dialplan

To enter voice register dialplan configuration mode to define a dial plan for SIP phones, use the voice register dialplan command in global configuration mode. To remove the dialplan, use the no form of this command.

voice register dialplan dialplan-tag

no voice register dialplan dialplan-tag

Syntax Description

dialplan-tag

Number that identifies the dial plan. Range: 1 to 24.


Command Default

No dial plan is defined.

Command Modes

Global configuration (config)

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

A dial plan allows a SIP phone to determine when enough digits are collected for call processing to take place. You define a dial plan using this command and then apply the dial plan to a SIP phone by using the dialplan command.

Dial plans allow SIP phones to perform pattern recognition as user input is collected. After a defined pattern is recognized, a SIP INVITE message is automatically sent to Cisco Unified CME and the user does not have to press the Dial key or wait for the interdigit timeout.

This command creates a dial plan file that is downloaded to the phone when the phone is reset or restarted.

Examples

The following example shows how to create dial plan 10 for a Cisco Unified IP Phone 7905:

Router(config)# voice register dialplan 10

Router(config-register-dialplan)# type 7905-7912

Router(config-register-dialplan)# pattern 52...

Router(config-register-dialplan)# pattern 91.......

 


Related Commands

 
Description

dialplan

Assigns a dial plan to a SIP phone.

filename

Specifies a custom XML configuration file that contains the dial patterns to use for a SIP dial plan.

pattern (voice register dialplan)

Defines a dial pattern for a SIP dial plan.

show voice register dialplan

Displays all configuration information for a specific SIP dial plan.

type (voice register dialplan)

Defines a phone type for a SIP dial plan.


voice register dn

To enter voice register dn configuration mode to define an extension for a phone line, intercom line, voice-mail port, or a message-waiting indicator (MWI), use the voice register dn command in global configuration mode. To remove the directory number, use the no form of this command.

voice register dn dn-tag

no voice register dn dn-tag

Syntax Description

dn-tag

Unique sequence number that identifies a particular directory number during configuration tasks. Range is 1 to 150, or the maximum defined by the max-dn command.


Command Default

Directory number is not defined.

Command Modes

Global configuration (config)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

Use this command to create directory numbers for SIP IP phones directly connected in Cisco Unified CME. In voice register dn configuration mode, you assign an extension number by using the number command, a name to appear in the local directory by using the name command, and other provisioning parameters by using various commands.

Before using this command, set the maximum number of directory numbers to appear in your system by using the max-dn command in voice register global configuration mode.


Note This command can also be used for Cisco SIP SRST.


Examples

The following example shows how to enter voice register dn configuration mode for directory number 4 and forward calls to extension 8888 when extension 1001 does not answer:

Router(config)# voice register dn 4

Router(config-register-dn)# number 1001

Router(config-register-dn)# call-forward phone noan 8888

Router(config-register-dn)# call-forward b2bua all 5454

Router(config-register-dn)# call-forward b2bua busy 5705

Router(config-register-dn)# call-forward b2bua mbox 5550

Router(config-register-dn)# call-forward b2bua noan 5050 timeout 20

Router(config-register-dn)# after-hour exempt

 

Related Commands

 
Description

max-dn (voice register global)

Sets the maximum number of SIP phone directory numbers (extensions) supported by a Cisco CME router.

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco CallManager Express (Cisco CME) system.

number (voice register pool)

Configures a valid number for a SIP phone.


voice register global

To enter voice register global configuration mode in order to set global parameters for all supported Cisco SIP IP phones in a Cisco Unified CME or Cisco Unified Session Initiation Protocol (SIP) Survivable Remote Site Telephony (SRST) environment, use the voice register global command in global configuration mode. To remove the configuration, use the no form of this command.

voice register global

no voice register global

Syntax Description

This command has no arguments or keywords.

Command Default

There are no system-level parameters configured for SIP IP phones.

Command Modes

Global configuration (config)

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

Cisco Unified CME

Use this command to set provisioning parameters for all supported SIP phones in a Cisco Unified CME system.

Cisco Unified SIP SRST

Use this command to set provisioning parameters for multiple pools; that is, all supported Cisco SIP IP phones in a SIP SRST environment.

Examples

Cisco Unified CME

The following is partial sample output from the show voice register global command. All of the parameters listed were set under voice register global configuration mode:

Router# show voice register global

CONFIG [Version=4.0(0)]

========================

Version 4.0(0)

Mode is cme

Max-pool is 48

Max-dn is 48

Source-address is 10.0.2.4 port 5060

Load 7960-40 is P0S3-07-4-07

Time-format is 12

Date-format is M/D/Y

Time-zone is 5

Hold-alert is disabled

Mwi stutter is disabled

Mwi registration for full E.164 is disabled

Dst auto adjust is enabled

 start at Apr week 1 day Sun time 02:00

 stop at Oct week 8 day Sun time 02:00

 

Related Commands

 
Description

allow connections sip to sip

Allows connections between SIP endpoints in a Cisco multiservice IP-to-IP gateway.

application (voice register global)

Selects the session-level application for all dial peers associated with SIP phones.

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco Unified system.


voice register pool

To enter voice register pool configuration mode and create a pool configuration for a SIP IP phone in Cisco Unified CME or for a set of SIP phones in Cisco Unified SIP SRST, use the voice register pool command in global configuration mode. To remove the pool configuration, use the no form of this command.

voice register pool pool-tag

no voice register pool pool-tag

Syntax Description

pool-tag

Unique number assigned to the pool. Range is 1 to 100.

Note For Cisco Unified CME systems, the upper limit for this argument is defined by the max-pool command.


Command Default

There is no pool configured.

Command Modes

Global configuration (config)

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

Cisco Unified CME

Use this command to set phone-specific parameters for SIP phones in a Cisco Unified CME system. Before using this command, enable the mode cme command and set the maximum number of SIP phones supported in your system by using the max-pool command.

Cisco Unified SIP SRST

Use this command to enable user control on which registrations are to be accepted or rejected by a SIP SRST device. The voice register pool command mode can be used for specialized functions and to restrict registrations on the basis of MAC, IP subnet, and number range parameters.

Examples

Cisco Unified CME

The following example shows how to enter voice register pool configuration mode and forward calls to extension 9999 when extension 2001 is busy:

Router(config)# voice register pool 10

Router(config-register-pool)# type 7960

Router(config-register-pool)# number 1 2001

Router(config-register-pool)# call-forward busy 9999 mailbox 1234

Cisco Unified SIP SRST

The following partial sample output from the show running-config command shows that several voice register pool commands are configured within voice register pool 3:

voice register pool 3

id network 10.2.161.0 mask 255.255.255.0

number 1 95... preference 1

 cor outgoing call95 1 95011

 max registrations 5

voice-class codec 1

 

Related Commands

 
Description

max-pool (voice register global)

Sets the maximum number of SIP phones that are supported by a Cisco Unified CME system.

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco Unified CME system.

number (voice register pool)

Configures a valid number for a SIP phone.

type (voice register pool)

Defines a Cisco IP phone type.


voice register session-server

To enter voice register session-server configuration mode to enable and configure a session manager in Cisco Unified CME for an external feature server, use the voice register session-server command in global configuration mode. To remove a session manager, use the no form of this command.

voice register session-server session-server-tag

no voice register session-server session-server-tag

Syntax Description

session-server-tag

Explicitly identifies a session manager for configuration tasks. Range: 1 to 8.


Command Default

No session manager is created.

Command Modes

Global configuration (config)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(11)XW2

Cisco Unified CME 4.2

This command was introduced.

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.

12.4(20)T

Cisco Unified CME 7.0

This command was integrated into Cisco IOS Release 12.4(20)T.


Usage Guidelines

Provisioning and configuration information in Unified CCX is automatically provided to Cisco United CME. Use this command to enter voice register session-server configuration mode and reconfigure and enable a session manager for Unified CCX on a Cisco CRS if the configuration from Unified CCX is deleted or must be modified.

A single Cisco Unified CME can support multiple session managers.

After creating one or more session managers, use the session-server command in voice register pool configuration mode to identify a session manager for controlling a route point.

After creating one or more session managers, use the session-server command in ephone-dn configuration mode to specify session managers for monitoring a directory numbers.

Examples

The following partial output from the show running-configuration command shows the configuration for session manager, session-server 1:

!

voice register session-server 1

keepalive 300

register-id SB-SJ3-UCCX1_1164774025000

!

 

Related Commands

Command
Description

session-server

Specifies a session server to manage and monitor registration and subscription messages for an external feature server.


voice register template

To enter voice register template configuration mode and define a template of common parameters for SIP phones, use the voice register template command in global configuration mode. To remove a template, use the no form of this command.

voice register template template-tag

no voice register template template-tag

Syntax Description

template-tag

Declares a template tag. Range: 1 to 10.


Command Default

No default behavior or values

Command Modes

Global configuration (config)

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

The maximum number of templates was increased from 5 to 10.

12.4(15)T

Cisco Unified CME 4.1

The increase in the template number was integrated into Cisco IOS Release 12.4(15)T.


Usage Guidelines

Up to ten different templates can be defined and applied to SIP phones. You create the template with this command and then apply the template to a phone by using the template command in voice register pool configuration mode.

Examples

In the following example, template 1 is created by using the voice register template command.

Router(config)# voice register template 1

Router(config-register-temp)# anonymous block

Router(config-register-temp)# caller-id block

Router(config-register-temp)# voicemail 5001 timeout 15

 

Related Commands

 
Description

anonymous block (voice register template)

Enables anonymous call blocking in a SIP phone template.

caller-id block (voice register template)

Enables caller-ID blocking for outbound calls from a specific SIP phone.

template (voice register pool)

Applies a template to a SIP phone.

voicemail (voice register template

Defines the extension that calls are forwarded to when an extension does not answer.


voice user-profile

To enter voice user-profile configuration mode and create a user profile for downloading by Extension Mobility for a particular individual phone user, use the voice user-profile command in global configuration mode. To delete an logout profile, use the no form of this command.

voice user-profile profile-tag

no voice user-profile profile-tag

Syntax Description

profile-tag

Unique number that identifies this profile during configuration tasks. Range: 1 to three times the maximum number supported phones, where maximum is platform and version dependent and defined by the max-ephone command.


Command Default

No user profile is created.

Command Modes

Global configuration (config)

Command History

Cisco IOS Release
Cisco Product
Modification

12.4(11)XW

Cisco Unified CME 4.2

This command was introduced.

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.

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 create a user profile containing a user's own personal settings, such as directory number, speed-dial lists, and services, for downloading to the IP phone when the individual phone user logs into a Cisco Unified IP phone that is registered in Cisco Unified CME and enabled for Extension Mobility.

Type ? in voice profile configuration mode to see the commands that are available in this mode and that can be included in a user profile. The following example shows a list of commands that were available in voice user-profile configuration mode at the time that this document was written:

Router(config-user-profile)#?

Logout profile configuration commands:
 name				Define username and password for Extension Mobility.
 number				Create ip-phone line definition
 pin					
 reset				Reset all phones associated with the profile being configured
 speed-dial				Define ip-phone speed-dial number	

All directory numbers to be included in a default logout profile or voice-user profile must already be configured in Cisco Unified CME.

After creating or modifying a profile, use the reset (voice user-profile) command to reset all phones on which this profile is downloaded to propagate the modifications.

Examples

The following example shows the configuration for a voice-user profile to be downloaded when a phone user logs into a Cisco Unified IP phone that is enabled for Extension Mobility. The lines and speed-dial buttons in this profile that are configured on a phone after the user logs in depend on the phone type. For example, if the user logs into a Cisco Unified IP Phone 7970, all buttons are configured according to voice-user profile1. However, if the phone user logs into a Cisco Unified IP Phone 7960, all six lines are mapped to phone buttons and the speed dial is ignored because no button is available for speed dial.

 pin 12345

 user me password pass123

 number 2001 type silent-ring

 number 2002 type beep-ring

 number 2003 type feature-ring

 number 2004 type monitor-ring

 number 2005,2006 type overlay

 number 2007,2008 type cw-overly

 speed-dial 1 3001

 speed-dial 2 3002 blf

 

Related Commands

Command
Description

logout-profile

Enables Cisco Unified IP phone for Extension Mobility and assigns a logout profile to this phone.

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

Performs a complete reboot of all IP phones on which a particular logout profile or user profile is downloaded.


voicemail (telephony-service)

To define the telephone number that is speed-dialed when the Messages button on a Cisco IP phone is pressed, use the voicemail command in telephony-service configuration mode. To disable the Messages button, use the no form of this command.

voicemail phone-number

no voicemail

Syntax Description

phone-number

Phone number that is configured as a speed-dial number for retrieving messages.


Command Default

No phone number is configure and the Messages button is disabled.

Command Modes

Telephony-service configuration (config-telephony)

Command History

Cisco IOS Release
Cisco Product
Modification

12.1(5)YD

Cisco ITS 1.0

This command was introduced.

12.2(8)T

Cisco ITS 2.0

This command was integrated into Cisco IOS Release 12.2(8)T.


Usage Guidelines

This command configures the telephone number that is speed-dialed when the Messages button on a Cisco IP phone is pressed. The same telephone number is configured for voice messaging for all Cisco IP phones connected to the router.

Examples

The following example sets the phone number 914085550100 as the speed-dial number that is dialed to retrieve messages when the Messages button is pressed:

Router(config)# telephony-service

Router(config-telephony)# voicemail 914085550100

 

Related Commands

 
Description

telephony-service

Enters telephony-service configuration mode.

vm-device-id (ephone)

Defines the voice-mail ID string.


voicemail (voice register global)

To define the telephone number that is speed-dialed when the Messages button on a Cisco IP phone is pressed, use the voicemail command in voice register global configuration mode. To disable the Messages button, use the no form of this command.

voicemail phone-number

no voicemail

Syntax Description

phone-number

Telephone number that is speed-dialed for retrieving messages.


Command Default

No phone number is configure and the Messages button 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.


Usage Guidelines

This command configures the telephone number that is speed-dialed when the Messages button on a Cisco IP phone is pressed. The same telephone number is configured for voice messaging for all Cisco IP phones connected to the router.

Examples

The following example shows how to set telephone number 914085550100 as the speed-dial number to retrieve messages when the Messages button is pressed:

Router(config)# voice register global

Router(config-register-global)# voicemail 914085550100

 

Related Commands

 
Description

url (voice register global)

Provision uniform resource locators (URLs) for feature buttons on Cisco IP phones.

voicemail (voice register template)

Defines the extension that calls are forwarded to when an extension does not answer.

voice register global

Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.


voicemail (voice register template)

To define the extension that calls are forwarded to when an extension does not answer, use the voicemail command in voice register template configuration mode. To disable the voicemail extension, use the no form of this command.

voicemail phone-number timeout timeout

no voicemail

Syntax Description

phone-number

Telephone number to which calls are forwarded when an extension does not answer.

timeout seconds

Duration that a call can ring with no answer before the call is forwarded to the voicemail extension. Range is 5 to 60000. There is no default value.


Command Default

This command has no default behavior or values.

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 defines the destination extension for voicemail when an extension on a SIP phone does not answer. To apply the template to a SIP phone, use the template command in voice register pool configuration mode.

Examples

The following example shows how to set telephone number 914085550100 as the number to be dialed to retrieve messages when the Messages button is pressed:

Router(config)# voice register template 1

Router(config-register-temp)# voicemail 50100 timeout 15

 

Related Commands

 
Description

template (voice register pool)

Applies a template to a SIP phone.

url (voice register global)

Provisions uniform resource locators (URLs) for feature buttons on Cisco IP phones.

voice register global

Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.

voice register template

Enters voice register template configuration mode and defines a template of common parameters for SIP phones.

voicemail (voice register global)

Defines the telephone number that is speed-dialed when the Messages button on a Cisco IP phone is pressed.