-
Cisco Unified Communications Manager Express Command Reference
-
Preface
-
Commands List by Config Mode
-
New, Modified, and Removed Commands in Cisco Unified CME 4.0 and Later
-
Cisco Unified CME Commands: A
-
Cisco Unified CME Commands: B
-
Cisco Unified CME Commands: C
-
Cisco Unified CME Commands: D
-
Cisco Unified CME Commands: Debug
-
Cisco Unified CME Commands: E
-
Cisco Unified CME Commands: F
-
Cisco Unified CME Commands: G
-
Cisco Unified CME Commands: H
-
Cisco Unified CME Commands: I
-
Cisco Unified CME Commands: K
-
Cisco Unified CME Commands: L
-
Cisco Unified CME Commands: M
-
Cisco Unified CME Commands: N
-
Cisco Unified CME Commands: O
-
Cisco Unified CME Commands: P
-
Cisco Unified CME Commands: R
-
Cisco Unified CME Commands: sast1 trustpoint through show fb-its-log
-
Cisco Unified CME Commands: show presence global through system message
-
Cisco Unified CME Commands: T
-
Cisco Unified CME Commands: U
-
Cisco Unified CME Commands: V
-
Cisco Unified CME Commands: W
-
Cisco Unified CME Commands: X
-
Table Of Contents
location (voice emergency response zone)
logging (voice emergency response settings)
Cisco Unified CME Commands: L
Revised: October 10, 2008This 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.
label
To create a text identifier instead of a phone-number display for an extension on an IP phone console, use the label command in ephone-dn configuration mode. To delete a label, use the no form of this command.
label string
no label string
Syntax Description
Command Default
No label is defined.
Command Modes
Ephone-dn configuration (config-ephone)
Command History
12.2(15)ZJ
Cisco CME 3.0
This command was introduced.
12.3(4)T
Cisco CME 3.0
This command was integrated into Cisco IOS Release 12.3(4)T.
Usage Guidelines
One label is allowed per extension (ephone-dn). The ephone-dn must already have a number that was set using the number command before a label can be created for it.
This command must be followed by a quick reboot of the phone on which the label appears, using the restart command.
Examples
The following example creates three phone labels to appear in place of three phone numbers on IP phone console displays:
Router(config)# ephone-dn 10
Router(config-ephone-dn)# label user10
Router(config-ephone-dn)# exit
Router(config)# ephone-dn 20
Router(config-ephone-dn)# label user20
Router(config-ephone-dn)# exit
Router(config)# ephone-dn 30
Router(config-ephone-dn)# label user30
Router(config-ephone-dn)# exit
Related Commands
label (voice register dn)
To create a text identifier instead of a phone-number display for an extension on a SIP phone console, use the label command in voice register dn configuration mode. To delete a label, use the no form of this command.
label string
no label string
Syntax Description
Command Default
No label is created.
Command Modes
Voice register dn configuration (config-register-dn)
Command History
Usage Guidelines
One label is allowed per extension (directory number). The directory number must already have a number that was set by using the number command before a label can be created for it.
After you configure this command, restart the phone by using the reset command.
Examples
The following example shows how to create three phone labels to appear in place of three phone numbers on Cisco IP phone console displays:
Router(config)# voice register dn 10
Router(config-register-dn)# label user10
Router(config-register-dn)# exit
Router(config)# voice register dn 20
Router(config-register-dn)# label user20
Router(config-register-dn)# exit
Router(config)# voice register dn 30
Router(config-register-dn)# label user30
Router(config-register-dn)# exit
Related Commands
list (ephone-hunt)
To create a list of extensions that are members of a Cisco Unified CME ephone hunt group, use the list command in ephone-hunt configuration mode. To remove a list from the router configuration, use the no form of this command.
list number[, number...]
no list
Syntax Description
Command Default
No list is defined.
Command Modes
Ephone-hunt configuration (config-ephone)
Command History
Usage Guidelines
Use this command to create a list of member numbers for defining a hunt group.
List must contain 1 to 20 numbers.
A number cannot be added to a list unless it was already defined by using the number command.
Add or delete all numbers in a hunt group list at one time. You cannot add or single number to an existing list or remove one number from a list.
Any number in the list cannot be a pilot number of a parallel hunt group.
To allow dynamic membership in a hunt group, use asterisks to represent wildcard slots in the list command. To allow an ephone-dn to use one of the wildcard slots to dynamically join a hunt group, use the ephone-hunt login command under that ephone-dn. Ephone-dns are disallowed from joining hunt groups by default, so you have to explicitly allow this behavior for each ephone-dn that you want to be able to log into hunt groups.
The show ephone-hunt command displays the numbers associated to ephone-dns that are joined to groups at the time that the command is run, in addition to static members of the hunt group. Static hunt group members are the numbers that are explicitly named in the list command.
Examples
The following example creates sequential hunt group number 7, which contains four static members (ephone-dns):
Router(config)# ephone-hunt 7 sequentialRouter(config-ephone-hunt)# list 7711, 7712, 7713, 7714The following example creates five ephone-dns and a hunt group that includes the first two ephone-dns as static members and two wildcard slots for dynamic hunt group members. The last three ephone-dns are enabled for dynamic membership in the hunt group. Any of them can join the hunt group whenever one of the wildcard slots is available. Once an ephone-dn has joined a hunt group, it can leave at any time.
ephone-dn 22
number 4566
ephone-dn 23
number 4567
ephone-dn 24
number 4568
ephone-hunt login
ephone-dn 25
number 4569
ephone-hunt login
ephone-dn 26
number 4570
ephone-hunt login
ephone-hunt 1 peer
list 4566,4567,*,*
final 7777
Related Commands
list (voice hunt-group)
To define a list of extensions that are members of a voice hunt-group, use the list command in voice hunt-group configuration mode. To remove a list, use the no form of this command.
list number, number[, number...]
no list
Syntax Description
number
Extension or E.164 number assigned to a phone in Cisco Unified CME. List must contain 2 to 32 numbers.
Command Default
No hunt group list is defined.
Command Modes
Voice hunt-group configuration (config-voice-hunt-group)
Command History
Usage Guidelines
This command creates the list of numbers to include in a voice hunt-group. Phones with these numbers ring when the hunt group pilot number is dialed. The numbers must be assigned to directory numbers with the number command.
All numbers in a hunt group list are added or deleted at one time. You cannot add a number to an existing list or remove a number from a list.
The pilot number of a parallel hunt group and shared-line numbers are not supported.
A phone number associated with an FXO port is not supported in parallel hunt groups.
Examples
The following example shows how to create a sequential hunt group containing four extensions:
Router(config)# voice hunt-group 1 sequential
Router(config-voice-hunt-group)# list 7711, 7712, 7713, 7714
Related Commands
live-record
To define the extension number that is dialed when the LiveRcd soft key is pressed on a Cisco Unified IP Phone, use the live-record command in telephony-service configuration mode. To reset to the default value, use the no form of this command.
live-record phone-number
no live-record
Syntax Description
Command Default
Live record is disabled.
Command Modes
Telephony-service configuration (config-telephony)
Command History
Usage Guidelines
This command specifies the telephone number that is speed-dialed to access the Live Record feature when the LiveRcd soft key on a Cisco Unified IP phone is pressed. This telephone number is used for all Cisco Unified IP phones connected to the router.
This telephone number must match the Live Record number configured in Cisco Unity Express.
DISCLAIMER FOR RECORDING A CONVERSATION
The use of monitoring, recording, or listening devices to eavesdrop, monitor, retrieve, or record phone conversations or other sound activities, whether or not contemporaneous with transmission, may be illegal in certain circumstances under federal, state and/or local laws. Legal advice should be sought prior to implementing any practice that monitors or records any phone conversation. Some laws require some form of notification to all parties to a phone conversation, such as by using a beep tone or other notification method or requiring the consent of all parties to the phone conversation, prior to monitoring or recording the phone conversation. Some of these laws incorporate strict penalties. In cases where local laws require a periodic beep while a conversation is being recorded, the Cisco Unity Express voice-mail system provides a user with the option of activating "the beep." Prior to activating the Cisco Unity Express live record function, check the laws of all applicable jurisdictions. This is not legal advice and should not take the place of obtaining legal advice from a lawyer.
IN ADDITION TO THE GENERAL DISCLAIMER THAT ACCOMPANIES THIS CISCO PRODUCT, CISCO ADDITIONALLY DISCLAIMS ANY AND ALL LIABILITY, BOTH CIVIL AND CRIMINAL, AND ASSUMES NO RESPONSIBILITY FOR THE UNAUTHORIZED AND/OR ILLEGAL USE OF THIS CISCO UNITY EXPRESS PRODUCT. THIS DISCLAIMER OF LIABILITY INCLUDES, BUT IS NOT NECESSARILY LIMITED TO, THE UNAUTHORIZED AND/OR ILLEGAL RECORDING AND MONITORING OF TELEPHONE CONVERSATIONS IN VIOLATION OF APPLICABLE FEDERAL, STATE AND/OR LOCAL LAWS.
Examples
The following example shows that the phone number 914085550100 is speed-dialed to record a call when the LiveRcd button is pressed:
Router(config)# telephony-service
Router(config-telephony)# live-record 914085550100
Related Commands
load (telephony-service)
To associate a type of Cisco Unified IP phone with a phone firmware file, use the load command in telephony-service configuration mode. To disassociate a type of phone from a phone firmware file, use the no form of this command.
load phone-type firmware-file
no load phone-type
Syntax Description
Command Default
Firmware files are not associated with phone types.
Command Modes
Telephony-service configuration (config-telephony)
Command History
Usage Guidelines
This command updates the Cisco Unified CME configuration file for the specified type of Cisco Unified IP phone to add the name of the firmware file to be loaded by a particular phone type. The firmware filename also provides the version number for the phone firmware that is in the file. When a phone is started up or rebooted, the phone reads the configuration file to determine which firmware file it must load and then looks for that firmware file on the TFTP server.
If applicable, Cisco Unified IP phones update themselves with new phone firmware whenever they are started up or rebooted.
A separate load command is needed for each type of phone. The Cisco Unified IP Phones 7940 and 7940G and the Cisco Unified IP Phones 7960 and 7960G have the same phone firmware and share the 7960-7940 keyword.
In Cisco Unified CME 7.0 and earlier versions, do not include the file suffix (.bin, .sbin, .loads) for any phone type except Cisco ATA and Cisco Unified IP Phone 7905 and 7912 when you configure the load command in telephony-service configuration mode. For example:
Router(config-telephony)# load 7941 SCCP41.8-2-2SR2SRouter(config-telephony)#This command in Cisco Unified CME 7.0(1) parses new firmware-load text files and automatically creates TFTP aliases for the user locale (text displays) and network locale (tones) files in the TAR file. To use this feature in Cisco Unified CME 7.0(1) and later versions, you must use the complete filename, including the file suffix, when you configure the load command for phone firmware versions later than version 8-2-2 for all phone types. For example:
Router(config-telephony)# load 7941 SCCP41.8-3-3S.loadsRouter(config-telephony)#You must also configure the tftp-server command to enable TFTP access to the firmware files by Cisco Unified IP phones. You must use the complete filename, including the file suffix, when you configure the tftp-server command.
After associating a firmware files with a Cisco Unified IP phones, use the reset command to reboot the phones.
Examples
Cisco Unified CME 7.0 and Earlier Versions
The following example identifies the Cisco Unified IP phone firmware file that is used by the Cisco Unified IP Phones 7960 and 7960G and Cisco Unified IP Phone 7910G and then defines the Cisco Unified CME router flash memory as the location of the phone firmware file.
Router(config)# telephony-service
Router(config-telephony)# load 7960-7940 P00303020209
Router(config-telephony)# load 7910 P00403020209
Router(config-telephony)# exit
Router(config)# tftp-server flash:P00303020209.bin
Router(config)# tftp-server flash:P00403020209.bin
Related Commands
load (voice register global)
To associate a type of IP phone with a phone firmware file, use the load command in voice register global configuration mode. To disassociate a type of phone from a phone firmware file, use the no form of this command.
load phone-type firmware-file
no load phone-type
Syntax Description
Command Default
The firmware file is not associated with the type of phone.
Command Modes
Voice register global configuration (config-register-global)
Command History
Usage Guidelines
This command updates the Cisco Unified CME configuration file for the specified type of IP phone to add the name of the correct firmware file that the phone should load. This filename also provides the version number for the phone firmware that is in the file. Later, whenever a phone is started up or rebooted, the phone reads the configuration file to determine the name of the firmware file that it should load and then looks for that firmware file on the TFTP server.
A separate load command is needed for each type of phone. The Cisco Unified IP Phone 7940 and 7940G and Cisco Unified IP Phone 7960 and 7960G have the same phone firmware and share the 7960-7940 keyword. The Cisco Unified IP Phone 3911 and Cisco Unified IP Phone 3951 have the same phone firmware and share the 3951 keyword.
For certain IP phones, such as the Cisco Unified IP Phone 7906G, 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971G, there are multiple firmware files. For these phones, use the TERMnn.x-y-x-w.loads or SIPnn.x-y-x-w.loads firmware filename for the load command, without the .loads file extension. For these phones, you do not configure the load command for any firmware file other than the TERM.loads or SIP.loads firmware file.
Following the load command, use the tftp-server command to enable TFTP access to the file by Cisco Unified IP phones. The file extension is required when using the tftp-server command.
The load command must be followed by a reboot of the phones. Plug in a new IP phone or use the reset command to reboot an IP phone that is already connected to the Cisco router.
Examples
The following example shows how to configure the load command to indicate which phone firmware is to be used by a Cisco Unified IP Phone 7960 and 7960G, a Cisco Unified IP Phone 7912 and 7912G, and a Cisco Unified IP Phone 7941GEs. The tftp-server command is used to specify the location of the phone firmware files, including all firmware files for the Java-based Cisco Unified IP Phone 7941GE. Note that while no file extension is used with the load command, the file extension is required when using the tftp-server command.
Router(config)# voice register global
Router(config-register-global)# load 7960-7940 P00303020209
Router(config-register-global)# load 7912 P00403020209
Router(config-register-global)# load 7941 TERM41.7-0-3-0S
Router(config-register-global)# exit
Router(config)# tftp-server flash:P00303020209.bin
Router(config)# tftp-server flash:P00403020209.bin
Router(config)# tftp-server flash:SIP41.8-0-3-0S.loads
Router(config)# tftp-server flash:term61.default.loadsterm
Router(config)# tftp-server flash:41.default.loads
Router(config)# tftp-server flash:CVM41.2-0-2-26.sbn
Router(config)# tftp-server flash:cnu41.2-7-6-26.sbn
Router(config)# tftp-server flash:Jar41.2-9-2-26.sbn
Related Commands
load-cfg-file
To load configuration files on the TFTP server and to sign configuration files that are not created by Cisco Unified CME, use the load-cfg-file command in telephony-service configuration mode. To return to the default, use the no form of this command.
load-cfg-file file-url alias file-alias [sign] [create]
no load-cfg-file file-url alias file-alias
Syntax Description
Command Default
A file is not loaded on the TFTP server.
Command Modes
Telephony-service configuration (config-telephony)
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
This command is used with Cisco Unified CME phone authentication to sign configuration files that are not created by Cisco Unified CME. This command also loads the signed and unsigned versions of the file on the TFTP server. To simply serve an already signed file on the TFTP server, use this command without the sign and create keywords.
The create keyword should be used with the sign keyword the first time that this command is used for each file. The create keyword is not maintained in the running configuration; this command prevents signed files from being recreated during every reload.
Examples
The following example creates a file called ringlist.xml.sgn in slot0 and serves both ringlist.xml and ringlist.xml.sgn on the TFTP server.
telephony-serviceload-cfg-file slot0:Ringlist.xml alias Ringlist.xml sign createThe following example serves P00307010200.sbn on the TFTP server without creating a signed file.
telephony-serviceload-cfg-file slot0:P00307010200.sbn alias P00307010200.sbnlocation (voice emergency response zone)
To include a location within an emergency response zone, use the location command in voice emergency response zone mode. To assign specific priorites to the locations, use the priority tag. To remove the location, use the no form of this command.
location location-tag [priority <1-100>]
no location location-tag
Syntax Description
location-tag
Identifier for the emergency response zone location.
priority 1-100
Identifier (1-100) for the priority ranking of locations, 1 being the highest priority.
Command Modes
Voice emergency response zone configuration (cfg-emrgncy-resp-zone)
Command History
Usage Guidelines
Use this command to create locations within emergency response zones. The tag must be the same as the tag that is defined using the voice emergency response location command. This allows routing of 911 calls to different PSAPs. Priority is optional and allows searching locations in a specified priority order. If there are locations with assigned priorities and locations configured without priorities, the prioritized locations are searched before those without an assigned priority.
Examples
The following example shows an assignment of ERLs to two zones, 10 and 11, to route callers to two different PSAPs. The locations for ERLs in zone 10 are searched in sequential order for a phone address match. The calls from zone 10 have an ELIN from ERLs 8, 9, and 10. The calls from zone 11 have an ELIN from ERLs 2, 3, 4, and 5. The locations for ERLs in zone 11 have priorities assigned and is searched in order of the assigned priority and not the ERL tag number.
voice emergency response zone 10location 8location 9location 10voice emergency response zone 11location 5 priority 1location 3 priority 2location 4 priority 3location 2 priority 10Related Commands
log password
Effective with Cisco Unified CME 4.0, the log password command was replaced by the xml user command in telephony-service configuration mode. See the xml user command for more information.
For Cisco CME 3.4 and earlier versions, to set a local password for an eXtensible Markup Language (XML) Application Programming Interface (API) query, use the log password command in telephony-service configuration mode. To remove the password definition, use the no form of this command.
log password password-string
no log password password-string
Syntax Description
password-string
Character string that is a password for XML API queries. Maximum length is 28 characters. Longer strings are truncated.
Command Default
No password is defined.
Command Modes
Telephony-service configuration (config-telephony)
Command History
Usage Guidelines
The local password is used to authenticate XML API requests on the network management server. If the password is not set, an XML API query fails local authentication.
The password string is stored as plain text. No encryption is supported.
Examples
The following example defines a local password for XML API requests:
Router(config)# telephony-service
Router(config-telephony)# log password ewvpil
log table
To set parameters for the table used to capture phone events used for the eXtensible Markup Language (XML) Application Programming Interface (API), use the log table command in telephony-service configuration mode. To reset parameters to their default values, use the no form of this command.
log table {max-size entries | retain-timer minutes}
no log table {max-size | retain-timer}
Syntax Description
Command Default
Default number of entries in table is 150.
default number of minutes to retain entries in table is 15.Command Modes
Telephony-service configuration (config-telephony)
Command History
12.2(15)ZJ
Cisco CME 3.0
This command was introduced.
12.3(4)T
Cisco CME 3.0
This command was integrated into Cisco IOS Release 12.3(4)T.
Usage Guidelines
Cisco Unified CME captures and time-stamps events, such as phones registering and unregistering and extension status, and stores them in an internal buffer. This command sets the maximum number of events, or entries, that can be stored in the table. One event equals one entry. The retain-timer keyword sets the number of minutes that events are kept in the buffer before they are deleted.
The event table can be viewed using the show fb-its-log command.
Examples
The following example sets the maximum size of the table at 750 events and sets the retention time at 30 minutes:
Router(config)# telephony-service
Router(config-telephony)# log table max-size 750
Router(config-telephony)# log table retain-timer 30
Related Commands
show fb-its-log
Displays information about the Cisco CME XML API configuration, statistics on XML API queries, and event logs.
logging (voice emergency response settings)
To enable sylog messages to capture emergency call data, use the logging command in voice emergency response settings configuration mode. To disable logging, use the no form of this command.
logging
no logging
Syntax Description
This command has no arguments or keywords.
Command Default
This command is enabled by default.
Command Modes
Voice emergency response settings configuration (cfg-emrgncy-resp-settings)
Command History
Usage Guidelines
Use this command to enable syslog messages to be announced for every 911 emergency call that is made. The syslog messages can be used by third party applications to send pager or e-mail notifications to an in-house support number. This optional command is enabled by default.
Examples
In this example, the ELIN (4085550101) defined in the voice emergency response settings configuration is used if the 911 caller's IP phones address does not match any of the voice emergency response locations. After the 911 call is placed to the PSAP, the PSAP has 120 minutes to call back 408 555-0101 to reach the 911 caller. If the call history has expired (after 120 minutes), any callback is routed to extension 7500. The outbound 911 calls do not emit a syslog message to the logging facility (for example, a local buffer, console, or remote host).
voice emergency response settingscallback 7500elin 4085550101expiry 120no loggingRelated Commands
login (telephony-service)
To define the timer for automatically deactivating user login on SCCP phones in a Cisco Unified CME system, use the login command in telephony-service configuration mode. To revert to the default values for automatic logout, use the no form of this command.
login [timeout [minutes]] [clear time]
no login
Syntax Description
Command Default
User login is deactivated after a phone is idle for 60 minutes.
User login for all phones is deactivated at 24:00.Command Modes
Telephony-service configuration (config-telephony)
Command History
7902—Cisco Unified IP Phone 7902G.