|
|
Table Of Contents
Cisco Unified CME Commands: L
Last Updated: September 14, 2007First 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.
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
Defaults
No label is defined.
Command Modes
Ephone-dn configuration
Command History
12.2(15)ZJ
3.0
This command was introduced.
12.3(4)T
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 10Router(config-ephone-dn)# label user10Router(config-ephone-dn)# exitRouter(config)# ephone-dn 20Router(config-ephone-dn)# label user20Router(config-ephone-dn)# exitRouter(config)# ephone-dn 30Router(config-ephone-dn)# label user30Router(config-ephone-dn)# exitRelated 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
Defaults
No default behavior or values
Command Modes
Voice register dn configuration
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 10Router(config-register-dn)# label user10Router(config-register-dn)# exitRouter(config)# voice register dn 20Router(config-register-dn)# label user20Router(config-register-dn)# exitRouter(config)# voice register dn 30Router(config-register-dn)# label user30Router(config-register-dn)# exitRelated 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
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 22number 4566ephone-dn 23number 4567ephone-dn 24number 4568ephone-hunt loginephone-dn 25number 4569ephone-hunt loginephone-dn 26number 4570ephone-hunt loginephone-hunt 1 peerlist 4566,4567,*,*final 7777Related Commands
list (voice hunt-group)
To create a list of extensions that are members of a Cisco CallManager Express (Cisco CME) 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
Defaults
No default behavior or values
Command Modes
Voice hunt-group configuration
Command History
Usage Guidelines
Use this command to create a list of numbers for defining a hunt group.
List must contain 2 to 10 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.
Examples
The following example shows how to create a sequential hunt group containing four directory numbers:
Router(config)# voice hunt-group 1 sequentialRouter(config-voice-hunt-group)# list 7711, 7712, 7713, 7714Related 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 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.
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.
When specifying the phone firmware filename in this command, for every phone type except ATA, do not use the .bin file extension. For example, if the firmware file for Cisco Unified IP Phone 7914 Expansion Modules is named W05473955.bin, enter the load 7914 W05473955 command.
Following the load command, you use the tftp-server command to enable TFTP access to the file by Cisco Unified IP phones. Note that the tftp-server command does require that you use the file extension as part of the filename.
The load command must be followed by a reboot of the phones using the reset command.
Examples
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 CME router flash memory as the location of the phone firmware file. Note that no file extension is used with the load command, and the file extension is used with the tftp-server command.
Router(config)# telephony-serviceRouter(config-telephony)# load 7960-7940 P00303020209Router(config-telephony)# load 7910 P00403020209Router(config-telephony)# exitRouter(config)# tftp-server flash:P00303020209.binRouter(config)# tftp-server flash:P00403020209.binRelated Commands
reset
Resets a Cisco Unified IP phone.
tftp-server
Enables TFTP access to firmware files on the TFTP server.
load (voice register global)
TTo 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
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 Phones 7940 and 7940G and Cisco Unified IP Phones 7960 and 7960G have the same phone firmware and share the 7960-7940 keyword.
For Java-based 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 SCCPnn.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 globalRouter(config-voice-register)# load 7960-7940 P00303020209Router(config-voice-register)# load 7912 P00403020209Router(config-voice-register)# load 7941 TERM41.7-0-3-0SRouter(config-voice-register)# exitRouter(config)# tftp-server flash:P00303020209.binRouter(config)# tftp-server flash:P00403020209.binRouter(config)# tftp-server flash:SIP41.8-0-3-0S.loadsRouter(config)# tftp-server flash:term61.default.loadstermRouter(config)# tftp-server flash:41.default.loadsRouter(config)# tftp-server flash:CVM41.2-0-2-26.sbnRouter(config)# tftp-server flash:cnu41.2-7-6-26.sbnRouter(config)# tftp-server flash:Jar41.2-9-2-26.sbnRelated 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
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 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.sbnlog 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
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-serviceRouter(config-telephony)# log password ewvpilRelated Commands
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
Defaults
max-size: 150
retain-timer: 15Command Modes
Telephony-service configuration
Command History
12.2(15)ZJ
3.0
This command was introduced.
12.3(4)T
3.0
This command was integrated into Cisco IOS Release 12.3(4)T.
Usage Guidelines
Cisco CallManager Express (Cisco 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-serviceRouter(config-telephony)# log table max-size 750Router(config-telephony)# log table retain-timer 30Related 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 and user login for all phones is deactivated at 24:00.
Command Modes
Telephony-service configuration (config-telephony)
Command History
Usage Guidelines
This command defines the after-hours login timer. Individual users on specified phones can override call blocking by logging in using a personal identification number (PIN). The after-hours login timer deactivates user login on all phones at a specific time and deactivates a login session automatically after a phone is idle for a specified period of time.
The login command applies only to IP phones that have soft keys, such as the Cisco Unified IP Phone 7940 and 7940G and the Cisco Unified IP Phone 7960 and 7960G.
For this command to take effect, fast reboot and reregister all phones in Cisco Unified CME by using the restart all command in telephony-service configuration mode.
When a Cisco Unified CME router is rebooted, the login status for all phones is reset to the default.
Examples
The following example sets the after-hours login timer to deactivate logged in phone users automatically after a 2-hour idle time and after 11:30 p.m.
Router(config)# telephony-serviceRouter(config-telephony)# login timeout 120 clear 2330Related Commands
logo (voice register global)
To specify a file to display on SIP phones, use the logo command in voice register global configuration mode. To disable the display of the file, use the no form of this command.
logo url
no logo
Syntax Description
Defaults
No file is specified for display on idle phones.
Command Modes
Voice register global configuration
Command History
Usage Guidelines
Use this command to define the URL for the file to be used by SIP phones connected in Cisco Unified CME. The file that is displayed must be encoded in eXtensible Markup Language (XML) by using the Cisco XML document type definition (DTD). For more information about Cisco DTD formats, see the Cisco IP Phone Services Application Development Notes.
After you configure this command, restart the phones by using the reset command.
Examples
The following example shows how to specify that the file logo.xml should be displayed on SIP phones:
Router(config)# voice register globalRouter(config-register-global)# logo http://mycompany.com/files/logo.xmlRelated Commands
logout-profile
To enable an IP phone for extension mobility and to apply a default logout profile to the phone, use the logout-profile command in ephone configuration mode. To disable extension mobility, use the no form of this command.
logout-profile profile-tag
no logout-profile profile-tag
Syntax Description
Command Default
IP phone is not enabled for extension mobility.
Command Modes
Ephone configuration (config-ephone)
Command History
12.5(11)XW
Cisco Unified CME 4.2
This command was introduced.
Usage Guidelines
Use this command in ephone configuration mode to enable a supported IP phone registered in Cisco Unified CME for extension mobility and to apply a default logout profile to the ephone being configured.
In Cisco Unified CME 4.2, extension mobility is supported only on SCCP IP phones.
Extension mobility is not supported on non-display IP phones.
Extension mobility is not supported for analog devices.
Before using this command, you must create a logout profile to be applied to this phone by using the voice logout-profile command.
You cannot apply more than one logout profile to an ephone. If you attempt to apply a second logout profile to an ephone to which a profile has already been applied, the second profile will overwrite the first logout profile configuration.
Examples
The following example shows the ephone configuration for three different Cisco Unified IP phones. All three phones are enabled for extension mobility and share the same logout profile number (1), to be downloaded when these phones boot and when no phone user is logged into these phones:
ephone 1mac-address 000D.EDAB.3566type 7960logout-profile 1ephone 2mac-address 0012.DA8A.C43Dtype 7970logout-profile 1ephone 3mac-address 1200.80FC.9B01type 7911logout-profile 1Related Commands
loopback-dn
To create a virtual loopback voice port (loopback-dn) to establish a demarcation point for VoIP calls and supplementary services, use the loopback-dn command in ephone-dn configuration mode. To delete a loopback-dn configuration, use the no form of this command.
loopback-dn dn-tag [forward number-of-digits | strip number-of-digits] [prefix prefix-digit-string] [suffix suffix-digit-string] [retry seconds] [auto-con] [codec {g711alaw | g711ulaw}]
no loopback-dn
Syntax Description
Defaults
All calls are set to forward all digits and not to strip any digits.
Prefix is not defined.
Suffix is not defined.
Retry is disabled.
Automatic connection is disabled.
RTP voice packets are passed through the loopback-dn without considering the G.711 coding type negotiated for the call.Command Modes
Ephone-dn configuration
Command History
Usage Guidelines
The loopback-dn command is used to configure two ephone-dn virtual voice ports as back-to-back-connected voice-port pairs. A call presented on one side of the loopback-dn pair is reoriginated as a new call on the opposite side of the loopback-dn pair. The forward, strip, prefix, and suffix keywords can be used to manipulate the original called number that is presented to the incoming side of the loopback-dn pair to generate a modified called number to use when reoriginating the call at the opposite side of the loopback-dn pair. For loopback-dn configurations, you must always configure ephone-dn virtual voice ports as cross-coupled pairs.
Note
Use of loopback-dn configurations within a VoIP network should be restricted to resolving critical network interoperability service problems that cannot otherwise be solved. Loopback-dn configurations are intended to be used in VoIP network interworking situations in which the only other alternative would be to make use of back-to-back-connected physical voice ports. Loopback-dn configurations emulate the effect of a back-to-back physical voice-port arrangement without the expense of the physical voice-port hardware. A disadvantage of loopback-dn configurations is that, because digital signal processors (DSPs) are not involved in a loopback-dn arrangement, the configuration does not support interworking or transcoding between calls that use different voice codecs. In many cases, the use of back-to-back physical voice ports that do use DSPs to resolve VoIP network interworking issues is preferred, because it introduces fewer restrictions in terms of supported codecs and call flows. Also, loopback-dns do not support T.38 fax relay.
Note
The loopback-dn arrangement allows an incoming telephone call to be terminated on one side of the loopback-dn port pair and a new pass-through outgoing call to be originated on the other side of the loopback-dn port pair. The loopback-dn port pair normally works with direct cross-coupling of their call states; the alerting call state on the outbound call segment is associated with the ringing state on the inbound call segment.
The loopback-dn mechanism allows for call operations (such as call transfer and call forward) that are invoked for the call segment on one side of the loopback-dn port pair to be isolated from the call segment that is present on the opposite side of the loopback-dn port pair. This approach is useful when the endpoint devices associated with the two different sides have mismatched call-transfer and call-forwarding capabilities. The loopback-dn arrangement allows for call-transfer and call-forward requests to be serviced on one side of the loopback-dn port pair by creating hairpin-routed calls when necessary. The loopback-dn arrangement avoids the propagation of call-transfer and call-forward requests to endpoint devices that do not support these functions.
The loopback-dn command provides options for controlling the called-number digits that are passed through from the incoming side to the outgoing side. The available digits can be manipulated with the forward, strip, prefix, and suffix keywords.
The forward keyword defines the number of digits in the original called number to forward to the other ephone-dn in the loopback-dn pair. The default is set to forward all digits. The strip keyword defines the number of leading digits to be stripped from the original called number before forwarding to the other ephone-dn in the loopback-dn pair. The default is set to not strip any digits. The forward and strip commands are mutually exclusive and can be used with any combination of the prefix and suffix keywords.
The prefix keyword defines a string of digits to add in front of the forwarded number.
The suffix keyword is most commonly used to add a terminating "#" (pound-sign) character to the end of the forwarded number to indicate that no more digits should be expected. The pound-sign character indicates to the call-routing mechanism that is processing the forwarded number that the forwarded number is complete. Providing an explicit end-of-number character also avoids a situation in which the call-processing mechanism waits for the interdigit timeout period to expire before routing the call onward using the forwarded number.
Note
The retry keyword is used to suppress a far-end busy indication on the outbound call segment. Instead of returning a busy signal to the call originator (on the incoming call segment), a loopback-dn presents an alerting or ringing tone to the caller and then periodically retries the call to the final far-end destination (on the outgoing call segment). This is not bidirectional. To prevent calls from being routed into the idle outgoing side of the loopback-dn port pair during the idle interval that occurs between successive outgoing call attempts, configure the outgoing side of the loopback-dn without a number so that there is no number to match for the inbound call.
The auto-con keyword is used to configure a premature trigger for a connected state for an incoming call segment while the outgoing call segment is still in the alerting state. This setup forces the voice path to open for the incoming call segment and support the generation of in-band call progress tones for busy, alerting, or ringback. The disadvantage of the auto-con keyword is premature opening of the voice path during the alerting stage and also triggering of the beginning of billing for the call before the call has been answered by the far end. These disadvantages should be considered carefully before you use the auto-con keyword.
The codec keyword is used to explicitly select the A-law or mu-law type of G.711 and to provide A-law to mu-law conversion if needed. Setting the codec type on one side of the loopback-dn forces the selection of A-law or mu-law for voice packets that are transmitted from that side of the loopback-dn. To force the A-law or mu-law G.711 codec type for both voice packet directions, set the codec type on both sides of the loopback-dn. Loopback-dn configurations are used only with G.711 calls. Other voice codec types are not supported.
Examples
The following example creates a loopback-dn configured with the forward and prefix keywords:
Router(config)# ephone-dn 7Router(config-ephone-dn)# loopback-dn 15 forward 5 prefix 41The following example creates a loopback-dn that appends the pound-sign (#) character to forwarded numbers to indicate the end of the numbers:
Router(config)# ephone-dn 7Router(config-ephone-dn)# loopback-dn 16 suffix "#"The following example shows a loopback-dn configuration that pairs ephone-dns 15 and 16. An incoming call (for example, from VoIP) to 4085550101 matches ephone-dn 16. The call is then reoriginated from ephone-dn 15 and sent to extension 50101. Another incoming call (for example, from a local IP phone) to extension 50151 matches ephone-dn 15. It is reoriginated from ephone-dn 16 and sent to 4085550151.
ephone-dn 15number 5015.loopback-dn 16 forward 5 prefix 40855caller-id localno huntstop!ephone-dn 16number 408555010.loopback-dn 15 forward 5caller-id localno huntstopRelated Commands
ephone-dn
Enters ephone-dn configuration mode.
show ephone-dn loopback
Displays information about loopback ephone-dns that have been created in a Cisco CME system.
Posted: Fri Sep 14 13:53:14 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
