|
|
Table Of Contents
upgrade (voice register global)
user-locale (telephony-service)
username (voice register pool)
Cisco Unified CME Commands: U
Last Updated: September 7, 2006First Published: February 27, 2006
This chapter contains commands to configure and maintain Cisco Unified Communications Manager Express (formally known as Cisco Unified CallManager Express). The commands are presented in alphabetical order. Some commands required for configuring Cisco Unified Communications Manager Express (Cisco Unified CME) may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.
upgrade (voice register global)
To generate a OS79XX.TXT file for firmware upgrades, use the upgrade command in voice register global configuration mode. To return to the default, use the no form of this command.
upgrade
no upgrade
Syntax Description
This command has no arguments or keywords.
Defaults
No OS79XX.TXT file generated.
Command Modes
Voice register global configuration
Command History
Usage Guidelines
The upgrade command performs the TFTP server alias binding, which can be verified with the show voice register tftp-bind command.
Examples
The following example shows the use of the upgrade command to upgrade Cisco SIP phone firmware from SIP [456].x to SIP [567].y with comments:
Router(config)# voice register globalRouter(config-register-global)# load 7960-7940 P00x... !Do not use file extension.Router(config-register-global)# upgrade !Generates OS79XX.txt file.Router(config-register-global)# load 7960-7940 POSx... !Do not use file extension. This!command is only required if you!are upgrading to 7.y.Router(config-register-global)# create profile !Generates SIPDefault.cnf and other files.Router(config-register-global)# resetRouter(config-register-global)# no upgrade !Returns command to default condition.The P00x... and P0Sx... firmware filenames are required because the content in OS79XX.TXT is different from image_version tag in SIPDefault.cnf.
url (telephony-service)
To provision uniform resource locators (URLs) for Cisco Unified IP phones connected to the Cisco Unified CME router, use the url command in telephony-service configuration mode. To remove a URL association, use the no form of this command.
url {authentication | directories | information | messages | proxy-server | services} url
no url {authentication | directories | information | messages | proxy-server | services}
Syntax Description
Command Default
The router automatically uses the local directory service.
Command Modes
Telephony-service configuration
Command History
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
Cisco Unified IP Phones can support URLs in association with the four programmable feature buttons on those IP phones: Directories, Information, Messages, and Services. The fifth button, Settings, is managed entirely by the phone. Operation of these services is determined by the Cisco Unified IP phone capabilities and the content of the referenced URL.
This command provisions URLs through the configuration file supplied by the Cisco Unified CME router to the Cisco Unified IP phones during phone registration.
Note
Cisco Unified CME does not support provisioning an information URL to access help using the i or ? buttons on a phone.
To use a Cisco Unified CallManager directory as an external directory source for Cisco Unified CME phones, the Cisco Unified CallManager must be made aware of the phones. You must list the MAC addresses of the Cisco Unified CME phones in the Cisco Unified CallManager and reset the phones from the Cisco Unified CallManager. It is not necessary for you to assign ephone-dns to the phones or for the phones to register with Cisco Unified CallManager.
Note
You can disable the local directory by using the no service local-directory command.
The url (telephony-service) command must be followed by a complete phone reboot using the reset command.
Examples
The following example provisions the Directories and Services buttons. Note that the Messages button is configured by the voicemail command. The Messages button acts like a speed-dial key to retrieve messages from a specified telephone number.
Router(config)# telephony-serviceRouter(config-telephony)# url directories http://1.4.212.11/localdirectoryRouter(config-telephony)# url services http://1.4.212.4/CCMUser/123456/urltest.htmlRelated Commands
url (voice register global)
To provision uniform resource locators (URLs) for feature buttons on Cisco SIP IP phones connected to a Cisco CallManager Express (Cisco CME) router, use the url command in voice register global configuration mode. To remove a URL association, use the no form of this command.
url {directory | service} url
no url {directory | service}
Syntax Description
Defaults
The router automatically uses the local directory service.
Command Modes
Voice register global configuration
Command History
Usage Guidelines
The Cisco IP Phones 7940 and 7940G and Cisco IP Phones 7960 and 7960G can support two URLs in association with two programmable feature buttons: Directories and Services. Operation of these services is determined by the Cisco IP phone capabilities and the content of the specified URL. The Settings button is managed entirely by the phone. The Messages button is configured by the voicemail command.
The purpose of the url command is to provision the URLs through the configuration file supplied by the Cisco CallManager Express router to the SIP phones during phone registration.
You can disable the local directory by specifying the string "none" instead of a URL with the directory keyword, as shown in the following example:
Router(config)# voice register globalRouter(config-register-global)# url directory none
Note
After you configure this command, restart the phone by using the reset command.
Examples
The following example shows how to provision the Directories and Services buttons:
Router(config)# voice register globalRouter(config-register-global)# url directory http://1.4.212.11/localdirectoryRouter(config-register-global)# url service http://1.4.212.4/CCMUser/123456/urltest.htmlRelated Commands
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
URL as defined in RFC 2396.
idle-timeout seconds
Time interval between display refreshes, in seconds. Range is from 0 to 300.
Defaults
No file is specified for display on idle phones.
Command Modes
Telephony-service configuration
Command History
12.2(11)YT
2.1
This command was introduced.
12.2(15)T
2.1
This command was integrated into Cisco IOS Release 12.2(15)T.
Usage Guidelines
Use this command with Cisco IOS Telephony Services V2.1, Cisco Call Manager Express 3.0, or a later version.
The file that is displayed must be encoded in eXtensible Markup Language (XML) using the Cisco XML document type definition (DTD). For more information about Cisco DTD formats, refer to Cisco IP Phone Services Application Development Notes.
This command must be followed by a complete phone reboot using the reset command.
Examples
The following example specifies that the file logo.xml 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-serviceRouter(config-telephony)# url idle http://mycompany.com/files/logo.xml idle-timeout 12Related Commands
user-locale (ephone-template)
To specify a language tag identifier in an ephone template, use the user-locale command in ephone-template configuration mode. To use the default user locale, use the no form of this command.
user-locale language-tag
no user-locale
Syntax Description
language-tag
Language tag identifier that was assigned to an alternative user locale using the user-locale (telephony-service) command.
Command Default
The default user locale (user-locale 0) is used.
Command Modes
Ephone-template configuration
Command History
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
To apply user-locale language tag identifiers to individual ephones, you must specify per-phone configuration files using the cnf-file perphone command and define the language tags using the user-locale (telephony-service) command.
After creating an ephone template that contains a language tag identifier, use the ephone-template (ephone) command to apply the template to individual ephones.
Examples
The following example defines three alternative locales: JP (Japan), FR (France), and ES (Spain). The default is US for all phones that do not have the alternatives applied using ephone templates. In this example, ephone 11 uses JP for its locales, ephone 12 uses FR, ephone 13 uses ES, and ephone 14 uses the default, US.
telephony-servicecnf-file location flash:cnf-file perphoneuser-locale 1 JPuser-locale 2 FRuser-locale 3 ESnetwork-locale 1 JPnetwork-locale 2 FRnetwork-locale 3 EScreate cnf-filesephone-template 1user-locale 1network-locale 1ephone-template 2user-locale 2network-locale 2ephone-template 3user-locale 3network-locale 3ephone 11button 1:25ephone-template 1ephone 12button 1:26ephone-template 2ephone 13button 1:27ephone-template 3ephone 14button 1:28Related Commands
user-locale (telephony-service)
To set the language for displays on supported phone types, use the user-locale command in telephony-service configuration mode. To disable the selected setting, use the no form of this command.
user-locale [user-locale-tag [user-defined-code]] language-code
no user-locale [user-locale-tag] language-code
Syntax Description
Command Default
The default code is US (United States).
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
The show telephony-service tftp-bindings command displays the locale that has been set using this command. This locale is currently associated with the dictionary and language files.
This command must be followed by a complete phone reboot using the reset command.
Locale tag 0 always holds the default language, which is used for all phones that are not assigned alternative user locales or user-defined user locales. The system default is US, but you can define an different code to be the default, as shown in the " Examples" section.
Alternative User Locales
The user-locale-tag argument allows you to specify up to five alternative user locales in Cisco Unified CME 4.0 or a later release. For example, a company can specify French for phones A, B, and C; German for phones D, E, and F; and United States for phones G, H, and I.
Each of the five user locales that you can use in a multi-locale system is identified with the locale-tag argument. The identifier 0 always holds the default locale, although you can define this default to be any language code that is supported in the system and is listed in the CLI help for the command. For example, if you define user locale 0 to be JP (Japanese), the default user locale for the router is JP. If you do not specify a locale for identifier 0, the default is US (United States).
To apply alternative user locales to different phones, you must use the cnf-files command to specify per-phone configuration files. When you use per-phone configuration files, a phone's configuration file automatically uses the default locales in user locale 0 and network locale 0. You can override this default for individual ephones by assigning locale tags to the alternative language codes that you want to use and then creating ephone templates to assign the locale tag to individual ephones. For example, you can assign locale tag 2 to the language code RU (Russian).
Use the user-locale command in ephone-template mode to apply a locale tag to an ephone template. Use the ephone-template command in ephone configuration mode to apply the template to the phones that should use the alternative language. For an example, see the Alternative User Locale Example.
User-Defined User Locales
XML files for user locales and network locales that are not currently provided in the system must be downloaded in order to use this feature. In Cisco Unified CME 4.0 and later versions, you can install the files to support a particular user and network locale in slot 0, external TFTP, or flash memory. Note that these files cannot be installed in the system storage location. The user locales and network locales that are stored in this fashion can then be used as default or alternative entries for all or some phones.
For example, if you have a site at which the phones should use the displays and tones for Traditional Chinese, which is not one of the standard languages, you must download the XML files for Traditional Chinese to use this user-defined locale on a phone.
For an example, see the User-Defined User Locale Example.
Examples
The following example sets the default language tag for the IP phone display to French:
telephony-serviceuser-locale FRThe following example sets the default language tag for the IP phone display to French. It shows another way to change the default:
telephony-serviceuser-locale 0 FRThe following example sets the alternative language tag 1 to German:
telephony-serviceuser-locale 1 DEAlternative User Locale Example
The following example defines three alternative locales: JP (Japan), FR (France), and ES (Spain). The default is US for all phones that do not have the alternatives applied using ephone templates. In this example, ephone 11 uses JP for its locales, ephone 12 uses FR, ephone 13 uses ES, and ephone 14 uses the default, US.
telephony-servicecnf-file location flash:cnf-file perphoneuser-locale 1 JPuser-locale 2 FRuser-locale 3 ESnetwork-locale 1 JPnetwork-locale 2 FRnetwork-locale 3 EScreate cnf-filesephone-template 1user-locale 1network-locale 1ephone-template 2user-locale 2network-locale 2ephone-template 3user-locale 3network-locale 3ephone 11button 1:25ephone-template 1ephone 12button 1:26ephone-template 2ephone 13button 1:27ephone-template 3ephone 14button 1:28User-Defined User Locale Example
The following example applies locale tag 4 to the user-defined code U1, which is defined as ZH. ZH is the code that represents Traditional Chinese in ISO 639, the Language Code Reference. Because the code for Traditional Chinese is not one of those that is provided in the system, the user must download the appropriate XML files to support this language.
In addition to the user-defined code, the example defines three alternative locales: JP (Japan), FR (France), and ES (Spain). The default is US for all phones that do not have the alternatives applied using ephone templates. In this example, ephone 11 uses JP for its locales; ephone 12 uses FR; ephone 13 uses ES; ephone 14 uses the default, US; and ephone 15 uses the user-defined language, ZH (Traditional Chinese).
telephony-servicecnf-file location flash:cnf-file perphoneuser-locale 1 JPuser-locale 2 FRuser-locale 3 ESuser-locale 4 U1 ZHnetwork-locale 1 JPnetwork-locale 2 FRnetwork-locale 3 ESnetwork-locale 4 U1 ZHcreate cnf-filesephone-template 1user-locale 1network-locale 1ephone-template 2user-locale 2network-locale 2ephone-template 3user-locale 3network-locale 3ephone-template 4user-locale 4network-locale 4ephone 11button 1:25ephone-template 1ephone 12button 1:26ephone-template 2ephone 13button 1:27ephone-template 3ephone 14button 1:28ephone 15button 1:29ephone-template 4Related Commands
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
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). This configuration can be completed only by the local system administrator of the Cisco IOS Telephony Service router.
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.
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 1Router(config-ephone)# username smith password 9golfRelated Commands
user (voice logout-profile)
To create an authentication credential for use by Telephone Application Programming Interface (TAPI) phone devices and certain other applications to log into Cisco Unified CME, use the username command in voice logout-profile configuration mode. To remove the credential, use the no form of this command.
user username password password
no user name password password
Syntax Description
name
Alphanumeric string to be used by a TAPI phone device to log into Cisco Unified CME.
password
Password to be used with this username for authentication purposes.
password
Alphanumeric string.
Command Default
No authentication credential is created.
Command Modes
Voice logout-profile configuration (voice-logout-profile)
Command History
12.4(11)XW
Cisco Unified CME 4.2
This command was introduced.
Usage Guidelines
Use this command in voice logout-profile configuration mode to add an authentication credential to a logout profile for Extension Mobility. The authentication credential is used by TAPI phone devices and certain other applications to log into Cisco Unified CME via an IP phone that is enabled for Extension Mobility and on which the logout profile is downloaded.
Examples
The following example shows the configuration for a logout profile that defines the default appearance for a Cisco Unified IP phone that is enabled for Extension Mobility, including the username (23C2-8) and password (43214) to be used by a TAPI phone device to log into Cisco Unified CME:
pin 9999user 23C2-8 password 43214number 3001 type silent-ringnumber 3002 type beep-ringnumber 3003 type feature-ringnumber 3004 type monitor-ringnumber 3005,3006 type overlaynumber 3007,3008 type cw-overlyspeed-dial 1 2000speed-dial 2 2001 blfRelated Commands
logout-profile
Enables a Cisco Unified IP phone for extension mobility and assigns a logout profile to this phone.
username (voice register pool)
To assign an authentication credential to a phone user so that the SIP phone can register in Cisco CallManager Express (Cisco CME), use the username command in voice register pool configuration mode. To disable a 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: Admin.
password
Enables password for the Cisco IP phone user.
password
Password string.
Defaults
Disabled.
Command Modes
Voice register pool configuration
Command History
Usage Guidelines
Creates an authentication credential for SIP IP phone registration. This command is required if authentication is enabled with the authenticate command.
You must configure the voice register pool before configuring an authentication credential.
All lines in a phone share the same credential.
This configuration also permits the phone user to log in to Cisco Unified CME to view and change attributes associated only with the user's SIP IP phone.
Note
Examples
The following example shows how to set the username and password:
Router(config)# voice register pool 1Router(config-register-pool)# username smith password 9golfRelated Commands
authenticate (voice register global)
Enables authentication for registration requests in which the MAC address cannot be identified by using other methods
user (voice user-profile)
To create an authentication credential to be used by extension mobility services in Cisco Unified CME, use the username command in voice user-profile configuration mode. To remove the credential, use the no form of this command.
user name password password
no user name password password
name
Credential to be used by individual phone user to log into a Cisco Unified IP phone.
password
Password to be used with this user name for authentication purposes.
password
Alphanumeric string.
Command Default
Credential is not created.
Command Modes
Voice user-profile configuration (config-user-profile)
Command History
12.4(11)XW
Cisco Unified CME 4.2
This command was introduced.
Usage Guidelines
This command in voice user-profile configuration mode creates a credential to be authenticated by Cisco Unified CME before a phone user can log into a Cisco Unified IP phone that is enabled for extension mobility.
When a user logs into an extension mobility enabled phone, Cisco Unified CME retrieves the appropriate user profile, based on username and password match, and replace the phone's default logout profile with the user's profile.
Examples
The following example shows the configuration to be downloaded after a user enters the username and password configured in this profile, and Cisco Unified CME matches the entry to the credentials in a user profile database:
voice user-profile 1pin 12345user me password pass123number 2001 type silent-ringnumber 2002 type beep-ringnumber 2003 type feature-ringnumber 2004 type monitor-ringnumber 2005,2006 type overlaynumber 2007,2008 type cw-overlyspeed-dial 1 3001speed-dial 2 3002 blfRelated Commands
reset (voice logout-profile and voice user-profile)
Preforms complete reboot of all IP phones on which a particular logout-profile or user-profile is downloaded.
Posted: Fri Sep 7 08:09:14 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
