Cisco IOS Voice Command Reference
Commands: U

Table Of Contents

Cisco IOS Voice Commands:
U

unbundle vfc

url

url (SIP)

url (telephony-service)

url idle

usage-indication

use-proxy

user-locale

username (ephone)


Cisco IOS Voice Commands:
U


This chapter contains commands to configure and maintain Cisco IOS voice applications. The commands are presented in alphabetical order. Some commands required for configuring voice may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.

For detailed information on how to configure these applications and features, refer to the Cisco IOS Voice Configuration Guide.

unbundle vfc

To unbundle DSPWare from the VCWare and configure the default file and capability lists with default values, use the unbundle vfc command in privileged EXEC mode.

unbundle [high-complexity | medium-complexity] vfc slot-number

Syntax Description

high-complexity

(Optional) Unbundles the high-complexity firmware set.

medium-complexity

(Optional) Unbundles the medium-complexity firmware set.

slot-number

Voice feature card (VFC) slot number.


Defaults

No default behavior or values

Command Modes

Privileged EXEC

Command History

Release
Modification

11.3(2)NA

This command was introduced on Cisco AS5300.

12.0(2)XH

The high-complexity and medium-complexity keywords were added.

12.0(3)T

This command was integrated into Cisco IOS Release 12.0(3)T.


Usage Guidelines

VFCs come with a single bundled image, VCWare, stored in VFC Flash memory. Use the unbundle vfc command to unbundle this bundled image into separate files, which are then written to Flash memory. When VCWare is unbundled, it automatically adds DSPWare to Flash memory, creates both the capability and default file lists, and populates these lists with the default files for that version of VCWare. The default file list includes the files to be used to boot up the system. The capability list defines the available voice codecs for H.323 capability negotiation. These files are used during initial card configuration and for subsequent firmware upgrades.

Before unbundling a VFC software image that you have just copied over to VFC Flash, use the clear vfc command. Unbundling a DSP firmware set rewrites the default-file and capabilities lists. After unbundling, you must reload the router for any changes to take effect.

Examples

The following example unbundles the high-complexity firmware set into slot 2:

Router# unbundle high-complexity vfc 2

Related Commands

Command
Description

copy flash vfc

Copies a new version of VCWare from the Cisco AS5300 motherboard to VFC Flash memory.

copy tftp vfc

Copies a new version of VCWare from a TFTP server to VFC Flash memory.


url

To configure the Internet service provider (ISP) address, use the url command in settlement configuration mode. You can configure the address type multiple times. To disable the address, use the no form of this command.

url url-address

no url url-address

Syntax Description

url-address

URL address. A valid URL address is as follows:
http://fully qualified domain name[:port]/[URL]


Defaults

No default behavior or values

Command Modes

Settlement configuration

Command History

Release
Modification

12.0(4)XH1

This command was introduced on Cisco 2600 and Cisco 3600 series and Cisco AS5300.

12.1(1)T

This command was integrated into Cisco IOS Release 12.1(1)T.

12.2(11)T

The settlement configuration for this command was modified. The settlement provider must be shutdown before the url command is entered.


Usage Guidelines

You can configure the address type multiple times. If you configure multiple URLs for the settlement server, the gateway attempts to send the request to each URL in the order in which you configured these addresses.

If the first URL is unsuccessful, the gateway tries the next URL. If the first URL becomes available, the gateway does not switch back until it loops through the list of URLs, for example:

url http://servicepoint1.com

url http://servicepoint2.com

url http://servicepoint3.com

If http://servicepoint1.com fails, the gateway sends the request to http://servicepoint2.com. If http://servicepoint1.com comes back online, the gateway continues to send requests to http://servicepoint2.com. Later on, if http://servicepoint2 is down, the gateway sends requests to http://servicepoint3.com.

When http://servicepoint3.com is down does the gateway routes its requests back to http://servicepoint1.com.

Examples

The following example shows four URLs configured for the settlement server:

settlement 0
 url http://1.2.3.4/
 url http://1.2.3.4:80/
 url https://1.2.3.4:4444/
 url https://yourcompany.com:443/

Related Commands

Command
Description

connection-timeout

Sets the connection timeout.

customer-id

Sets the customer identification.

device-id

Sets the device identification.

encryption

Specifies the encryption method.

max-connection

Sets the maximum simultaneous connections.

response-timeout

Sets the response timeout.

retry-delay

Sets the retry delay.

retry-limit

Sets the connection retry limit.

session-timeout

Sets the session timeout.

settlement

Enters settlement configuration mode.

show settlement

Displays the configuration for all settlement server transactions.

shutdown/no shutdown

Brings up the settlement provider and then shuts it down.

type

Specifies the provider type.


url (SIP)

To configure URLs to either the Session Initiation Protocol (SIP) or telephone (TEL) format for your VoIP SIP calls, use the url command in SIP configuration mode. To reset to the default, use the no form of this command.

url {sip | tel}

no url

Syntax Description

sip

Generate URLs in SIP format for VoIP calls.

tel

Generate URLs in TEL format for VoIP calls.


Defaults

SIP URLs

Command Modes

SIP configuration

Command History

Release
Modification

12.2(2)XB

This command was introduced.

12.2(2)XB1

This command was implemented on the Cisco AS5850.

12.2(8)T

This command was integrated into Cisco IOS Release 12.2(8)T. Support for the Cisco AS5300, Cisco AS5350, Cisco AS5400, and Cisco AS5850 is not included in this release.

12.2(11)T

This command was applicable to the Cisco AS5300, Cisco AS5350, and Cisco AS5400 in this release.


Usage Guidelines

This command affects only user-agent clients (UACs), because it causes the use of a TEL or SIP URL in the request line of outgoing SIP INVITE requests. SIP URLs indicate the originator, recipient, and destination of the SIP request; TEL URLs indicate voice call connections.

The voice-class sip url command, in dial-peer configuration mode, takes precedence over the url command in SIP global-configuration mode. However, if the voice-class sip url command is configured with the system keyword, the gateway uses what was globally configured under the url command.

Enter SIP configuration mode after entering voice-service VoIP configuration mode, as shown in the example.

Examples

The following example generates URLs in TEL format:

Router(config)# voice service voip
Router(config-voi-srv)# sip
Router(conf-serv-sip)# url tel

Related Commands

Command
Description

SIP

Enters SIP configuration mode from voice-service VoIP configuration mode.

voice-class sip url

Generates URLs in the SIP or TEL format in dial-peer configuration mode.


url (telephony-service)

To provision URLs for the Cisco IP phones connected to the Cisco IOS Telephony Service router, use the url command in telephony-service configuration mode. To remove URLs, use the no form of this command.

url {directory | information | messages | services} url

no url {directory | information | messages | services} url

Syntax Description

directory

Directory URL.

information

Information URL

messages

Messages URL.

services

Services URL.

url

A URL string.


Defaults

The router automatically uses the local directory service.

Command Modes

Telephony-service configuration

Command History

Release
Modification

12.2(2)XT

This command was introduced on the Cisco 1750, Cisco 1751, Cisco 2600, Cisco 3600, and Cisco IAD2420.

12.2(8)T

This command was integrated into Cisco IOS Release 12.2(8)T and implemented on Cisco 3725 and Cisco 3745 routers.

12.2(8)T1

This command was implemented on Cisco 2600-XM and Cisco 2691 routers.

12.2(11)T

This command was implemented on the Cisco 1760.


Usage Guidelines

This command provisions URLs for use by interconnected Cisco IP phones. You must reset the Cisco IP phones before the command can take effect.

The Cisco IP Phone 7960 and Cisco IP Phone 7940 can support four URLs in association with the four programmable feature keys on the IP phones. The four feature keys are directories, information, messages, and services. (The fifth key, settings, is managed entirely by the phone.) Operation of these services is determined by the Cisco IP phone capabilities and the content of the referenced URL.

The purpose of the url command is simply to provision the URLs through the SEPDEFAULT.cnf configuration file supplied by the Cisco IOS Telephony Service router to the Cisco IP phones during phone registration.

You can disable local directory by using the url directories none command.


Note Provisioning of the directory URL to select an external directory resource disables Cisco IOS Telephony Service local directory service.


Examples

The following example provisions the information, directories, and services keys:

Router(config) telephony-service
Router(config-telephony-service) url information 
http://1.4.212.4/CCMUser/GetTelecasterHelpText.asp
Router(config-telephony-service) url directories http://1.4.212.11/localdirectory
Router(config-telephony-service) url services http://1.4.212.4/CCMUser/123456/urltest.html

The messages key is configured by the voicemail command. This key acts like a redial key to retrieve messages from a specified telephone number.

Related Commands

Command
Description

telephony-service

Enables Cisco IOS Telephony Service and enters telephony-service configuration mode.


url idle

To specify a file to display on an IP phone that is not in use, use the url idle command in telephony-service configuration mode. To disable display of the file, use the no form of this command.

url idle url idle-timeout seconds

no url idle

Syntax Description

url

Uniform resource location as defined in RFC 2396.

idle-timeout seconds

Time interval between display refreshes, in seconds. Range is from 0 to 300.


Defaults

No default behavior or values

Command Modes

Telephony-service configuration

Command History

Release
Modification

12.2(11)YT

This command was introduced.

12.2(15)T

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


Usage Guidelines

Use this command with Cisco IOS Telephony Service (ITS) V2.1 or a later version.

The file that is displayed must be encoded in XML using the Cisco XML DTD. For more information about Cisco DTD formats, refer to Cisco IP Phone Services Application Development Notes.

Examples

The following example specifies that the file logo.htm should be displayed on IP phones when they are not being used, and that the display should be refreshed every 12 seconds:

Router(config)# telephony-service
Router(config-telephony-service)# url idle http://mycompany.com/files/logo.xml 
idle-timeout 12

Related Commands

Command
Description

telephony-service

Enables Cisco ITS and enters telephony-service configuration mode.


usage-indication

To enter the Annex G neighbor usage mode used to configure optional usage indicators, use the usage-indication command in Annex G neighbor configuration mode. To return to the default setting, use the no form of this command.

usage-indication

no usage-indication

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Annex G neighbor

Command History

Release
Modification

12.2(11)T

This command was introduced.


Usage Guidelines

Use usage-indication command to enter the mode to set usage indication characteristics. Repeat this command for each border element neighbor that you configure.


Note The no shutdown command must be used to enable each service relationship.


Examples

The following example shows how to enter the Annex G neighbor usage mode:

doc-rtr3(config-nxg-neigh-usg)# usage-indication 

Related Commands

Command
Description

access-policy

Requires that a neighbor be explicitly configured.

inbound ttl

Sets the inbound time-to-live value.

outbound retry-interval

Defines the retry period for attempting to establish the outbound relationship between border elements.

retry interval

Defines the time between delivery attempts.

retry window

Defines for how long a border element will attempt delivery.

shutdown

Enables or disables the border element.


use-proxy

To enable proxy communications for calls between local and remote zones, use the use-proxy command in gatekeeper configuration mode. To either remove a proxy configuration entry for a remote zone or disable proxy communications between local and remote zones, use the no form of this command.

use-proxy local-zone-name {default | remote-zone remote-zone-name} {inbound-to | outbound-from} {gateway | terminal}

no use-proxy local-zone-name remote-zone remote-zone-name [{inbound-to | outbound-from} {gateway | terminal}]

Syntax Description

local-zone-name

Name or zone name of the gatekeeper, which is usually the fully domain-qualified host name of the gatekeeper.

default

Default proxy policy for all calls that are not defined by a use-proxy command with the remote-zone keyword.

remote-zone remote-zone-name

Proxy policy for calls to or from a specific remote gatekeeper or zone.

inbound-to

Proxy policy as it applies to calls that are inbound to the local zone from a remote zone. Each use-proxy command defines the policy for only one direction.

outbound-from

Proxy policy as it applies to calls that are outbound from the local zone to a remote zone. Each use-proxy command defines the policy for only one direction.

gateway

Type of local device to which the policy applies. The gateway option applies the policy only to local gateways.

terminal

Type of local device to which the policy applies. The terminal option applies the policy only to local terminals.


Defaults

The local zone uses proxy for both inbound and outbound calls to and from the local H.323 terminals only. Proxy is not used for both inbound and outbound calls to and from local gateways.

Command Modes

Gatekeeper configuration

Command History

Release
Modification

12.0(5)T

This command was introduced on Cisco AS5300.

12.1(5)XM2

The command was implemented on the Cisco AS5350 and Cisco AS5400.

12.2(4)T

This command was integrated into Cisco IOS Release 12.2(4)T. Support for the Cisco AS5300, Cisco AS5350, and Cisco AS5400 is not included in this release.

12.2(2)XB1

This command was implemented on the Cisco AS5850.

12.2(11)T

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


Usage Guidelines

This command replaces the zone access command used in previous versions of the gatekeeper. When a previous version of gatekeeper is upgraded, any zone access commands are translated to use-proxy commands. You can use the show gatekeeper zone status command to see the gatekeeper proxy configuration.

If the domain name is cisco.com, the gatekeeper name might be gk1.cisco.com. However, if the gatekeeper is controlling multiple zones, the name of the gatekeeper for each zone should be a unique mnemonic string.

Examples

In the following example, the local zone sj.xyz.com is configured to use a proxy for inbound calls from remote zones tokyo.xyz.com and milan.xyz.com to gateways in its local zone. The sj.xyz.com zone is also configured to use a proxy for outbound calls from gateways in its local zone to remote zones tokyo.xyz.com and milan.xyz.com.

use-proxy sj.xyz.com remote-zone tokyo.xyz.com inbound-to gateway
use-proxy sj.xyz.com remote-zone tokyo.xyz.com outbound-from gateway
use-proxy sj.xyz.com remote-zone milan.xyz.com inbound-to gateway
use-proxy sj.xyz.com remote-zone milan.xyz.com outbound-from gateway

Because the default mode disables proxy communications for all gateway calls, only the gateway calls listed above can use the proxy.

In the following example, the local zone sj.xyz.com uses a proxy for only those calls that are outbound from H.323 terminals in its local zone to the specified remote zone germany.xyz.com:

no use-proxy sj.xyz.com default outbound-from terminal
use-proxy sj.xyz.com remote-zone germany.xyz.com outbound-from terminal

Note Any calls inbound to H.323 terminals in the local zone sj.xyz.com from the remote zone germany.xyz.com use the proxy because the default applies.


The following example removes one or more proxy statements for the remote zone germany.xyz.com from the proxy configuration list:

no use-proxy sj.xyz.com remote-zone germany.xyz.com

This command removes all special proxy configurations for the remote zone germany.xyz.com. After you enter a command like this, all calls between the local zone (sj.xyz.com) and germany.xyz.com are processed according to the defaults defined by any use-proxy commands that use the default option.

To prohibit proxy use for inbound calls to H.323 terminals in a local zone from a specified remote zone, enter a command similar to the following:

no use-proxy sj.xyz.com remote-zone germany.xyz.com inbound-to terminal

This command overrides the default and disables proxy use for inbound calls from remote zone germany.xyz.com to all H.323 terminals in the local zone sj.xyz.com.

Related Commands

Command
Description

show gatekeeper zone status

Displays the status of zones related to a gatekeeper.


user-locale

To set the language for displays on the Cisco IP Phone 7940 and Cisco IP Phone 7960, use the user-locale command in telephony-service configuration mode. To disable selection of a language, use the no form of this command.

user-locale language-code

no user-locale language-code

Syntax Description

language-code

The following ISO-3166 codes are valid entries:

FR—French

DE—German

IT—Italian

ES—Spanish

US—United States


Defaults

The default code is US (United States).

Command Modes

Telephony-service configuration

Command History

Release
Modification

12.2(11)YT

This command was introduced.

12.2(15)T

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


Usage Guidelines

Use this command with Cisco IOS Telephony Service (ITS) V2.1 or a later version.

The show telephony-service tftp-bindings command displays the locale dictionary and language files that are currently associated with the ITS phones.

Examples

The following example sets the IP phone display language to French:

Router(config)# telephony-service
Router(config-telephony-service)# user-locale FR

Related Commands

Command
Description

show telephony-service tftp-bindings

Displays the current configuration files that are accessible to IP phones.

telephony-service

Enables Cisco IOS Telephony Service and enters telephony-service configuration mode.


username (ephone)

To assign a login account username and password to a phone user so that the user can log in to the Cisco IOS Telephony Service router through a web browser, use the username command in ephone configuration mode. To disable the username and password, use the no form of this command.

username username password password

no username username password password

Syntax Description

username

Username of the local Cisco IP phone user. Default is Admin.

password

Enables password for the Cisco IP phone user.

password

Password string.


Defaults

The default username for the administrator is Admin.

Command Modes

Ephone configuration

Command History

Release
Modification

12.2(2)XT

This command was introduced on the Cisco 1750, Cisco 1751, Cisco 2600, Cisco 3600, and Cisco IAD2420.

12.2(8)T

This command was integrated into Cisco IOS Release 12.2(8)T and implemented on Cisco 3725 and Cisco 3745 routers.

12.2(8)T1

This command was implemented on Cisco 2600-XM and Cisco 2691 routers.

12.2(11)T

This command was implemented on the Cisco 1760.


Usage Guidelines

This command assigns a login account username and password for a phone user and establishes a login account for each Cisco IP phone (ephone).

You must also create a login account to allow Telephone Application Programming Interface (TAPI)-aware PC applications to register with the Cisco IOS Telephony Service router and exercise remote-control operation of a Cisco IP phone.


Note This configuration can be completed only by the local system administrator of the Cisco IOS Telephony Service router.


This configuration permits the phone user to log in to the Cisco IOS Telephony Service to view and change attributes associated only with the user's IP phone.

Examples

The following example shows how to set the username and password:

Router(config)# ephone 1
Router(config-ephone)# username smith password 9golf

Related Commands

Command
Description

admin-password

Sets a password for the local system administrator of the Cisco IOS Telephony Service.

admin-username

Sets the username for the local system administrator of the Cisco IOS Telephony Service router.

ephone

Enters ephone configuration mode.