|
|
Table Of Contents
fastdial (voice register pool)
file text (voice register global)
forwarding local (voice register global)
Cisco Unified CME Commands: F
Last Updated: June 20, 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.
fac
To enable all standard feature access codes (FACs) or to create and enable individual custom FACs, use the fac command in telephony-service configuration mode. To disable FACs, use the no form of this command.
fac {standard | custom {alias alias-tag custom-fac to existing-fac [extra-digits]} | feature custom-fac}}
no fac {standard | custom {alias alias-tag | feature}}
Syntax Description
Command Default
FACs are disabled on IP phones.
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
Use this command to enable all predefined standard feature access codes (FACs) or to create one or more custom FACs.
FACs enable phone users to use the keypad on an analog or IP phone registered in Cisco Unified CME to select or activate/deactivate a particular feature or function from a predefined set of features. For example, a phone user might press **1, then press 2345 to forward all incoming calls to extension 2345.
Standard FACs and custom FACs are mutually exclusive. You can enable all standard FACS or create and enable one or more custom FACs.
Most FACs are valid only immediately after a phone user goes off-hook. The only exception is the call-park FAC. The call-park FAC actually invokes a call transfer to a park slot. To use the call-park FAC, a phone user must have an active call and must press the Transfer soft key (IP phone) or hookflash (analog phone) before dialing the call-park FAC. Dialing the FAC for the Call Park feature does not use the Park soft key function.
Use the fac standard command to enable all predefined standard FACs for all SCCP phones registered in Cisco Unified CME.
Use the fac custom command to create an individual custom FAC for selecting a particular feature or function from the predefined feature set.
Use the fac custom command with the alias keyword to create an alternative (custom) FAC for dialing an existing FAC, or existing FAC plus extra digits without removing the existing FAC. For example, an alias can be created to allow the phone user press **1 to forward all incoming calls to a particular extension without requiring the phone user to dial the target extension number.
To disable all custom FACs, use the fac standard command, which enables all standard FACs. To disable all standard FACs or to disable an individual custom FAC, use the no form of the fac command.
Use the show telephony-service fac command to display a list of FACs that are configured on the Cisco Unified CME router.
Examples
The following example shows how to enable standard FACs for all phones:
Router# telephony-serviceRouter(config-telephony)# fac standardfac standard is set!Router(config-telephony)#The following example shows the output from the show telephony-service fac command when standard FACs are enabled:
Router# show telephony-service factelephony-service fac standardcallfwd all **1callfwd cancel **2pickup local **3pickup group **4pickup direct **5park **6dnd **7redial **8voicemail **9ephone-hunt join *3ephone-hunt cancel #3ephone-hunt hlog *4ephone-hunt hlog-phone *5The following example shows how the standard FAC for the Call Forward All feature is changed to a custom FAC (#45). Then an alias is created to map a second custom fac to #45 plus an extension (1111). The second custom FAC (#44) allows the phone user to press #44 to forward all calls all calls to extension 1111, without requiring the phone user to dial the extra digits that are the extension number.
Router# telephony-serviceRouter(config-telephony)# fac custom callfwd all #45fac callfwd all code has been configured to #45Router(config-telephony)# fac custom alias 0 #44 to #451111fac alias0 code has been configurated to #44!alias0 map code has been configurated to #451111!The following example shows how to create three aliases for the Group Pickup feature. The FAC for group pickup is **4. The three new custom FACs are #1, #2, and #4 to pickup groups 121, 122, and 124, respectively. This allows a phone user to press #1 to pick up calls in group 121, #2 to pick up calls in group 122, and #4 to pick up calls in group 124.
Router# telephony-serviceRouter(config-telephony)# fac custom pickup group **4fac pickup group code has been configured to **4Router(config-telephony)# fac custom alias 1 #1 to **4121fac alias1 code has been configurated to #1!alias1 map code has been configurated to **4121!Router(config-telephony)# fac custom alias 2 #2 to **4122fac alias2 code has been configurated to #2!alias2 map code has been configurated to **4122!Router(config-telephony)# fac custom alias 4 #4 to **4124fac alias4 code has been configurated to #4!alias4 map code has been configurated to **4124!Router(config-telephony)#The following example shows the output from the show telephony-service fac command when custom FACs are configured:
Router# show telephony-service factelephony-service fac customcallfwd all #45alias 0 #44 to #451111alias 1 #1 to **4121alias 2 #2 to **4122alias 4 #4 to **4124Router#Related Commands
show telephony-service fac
Displays list of feature access codes (FACs) that are configured on the Cisco Unified CME.
fastdial
To create an entry for a personal speed-dial number, use the fastdial command in ephone or ephone-template configuration mode. To delete a personal speed-dial number, use the no form of this command.
fastdial dial-tag number name name-string
no fastdial dial-tag
Syntax Description
Command Default
No personal speed-dial numbers are present.
Command Modes
Ephone configuration
Ephone-template configurationCommand History
Usage Guidelines
The fastdial command is supported only on the Cisco Unified IP Phone 7940s and 7940Gs and the Cisco Unified IP Phone 7960s and 7960Gs.
Phone users access personal speed-dial numbers through the Directories > Local Services > Personal Speed Dial menu. Personal speed-dial numbers appear on this menu in the order in which they are entered during configuration.
If you use an ephone template to apply a command to a phone and you also use the same command in ephone configuration mode for the same phone, the value that you set in ephone configuration mode has priority.
Examples
The following example creates a directory of five personal speed-dial numbers for an IP phone:
Router(config)# ephone 1Router(config-ephone)# fastdial 1 5001 name Front RegisterRouter(config-ephone)# fastdial 2 5002 name SecurityRouter(config-ephone)# fastdial 3 5003 name Rear RegisterRouter(config-ephone)# fastdial 4 5004 name OfficeRouter(config-ephone)# fastdial 5 912135550122 Accountingfastdial (voice register pool)
To create personal speed-dial numbers, use the fastdial command in voice register pool configuration mode. To delete a personal speed-dial number, use the no form of this command.
fastdial dial-tag number [name name-string]
no fastdial dial-tag
Syntax Description
Command Default
No personal speed-dial numbers are defined.
Command Modes
Voice register pool configuration
Command History
Usage Guidelines
This command creates personal speed-dial numbers through Cisco Unified CME. Support for this command depends on the model of SIP phone:
•
Cisco Unified IP Phone 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE—Personal speed-dial numbers can be created through Cisco Unified CME and not by the user on the phone.
•
Phone users access personal speed-dial numbers through the Directories > Personal Speed Dial menu. Personal speed-dial numbers display on this menu in alphabetical order.
Examples
The following example shows a directory of five personal speed-dial numbers defined for a SIP phone:
Router(config)# voice register pool 1Router(config-register-pool)# fastdial 1 5001 name Front RegisterRouter(config-register-pool)# fastdial 2 5002 name SecurityRouter(config-register-pool)# fastdial 3 5003 name Rear RegisterRouter(config-register-pool)# fastdial 4 5004 name OfficeRouter(config-register-pool)# fastdial 5 912135550122 AccountingRelated Commands
show voice register pool
Displays all configuration information associated with a particular voice register pool.
features blocked
To prevent one or more features from being used on a Cisco Unified CME phone, use the features blocked command in ephone-template configuration mode. To allow all features to be used, use the no form of this command.
features blocked [CFwdAll] [Confrn] [GpickUp] [Park] [PickUp] [Trnsfer]
no features blocked
Syntax Description
Command Default
Features are not blocked.
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
Use this command to specify one or more features to be blocked in an ephone template, then apply the template in ephone configuration mode to one or more ephones to prevent the use of the specified features by those ephones. This feature can be used on IP phones and analog phones. After applying the template, any soft keys associated with the blocked features will still be visible but will not have any effect.
Use the show telephony-service ephone-template command to display the contents of ephone templates.
Examples
In the following example, call park and call transfer are blocked on ephone 3.
ephone-template 1features blocked Park Trnsferephone-dn 2number 2333ephone 3button 1:2ephone-template 1The following example blocks the use of the conference feature on ephone 3, which is an analog phone.
ephone-template 1features blocked Confrnephone-dn 78number 2579ephone 3ephone-template 1mac-address C910.8E47.1282type anlbutton 1:78Related Commands
show telephony-service ephone-template
Displays the contents of ephone templates.
feed
To enable an audio stream for multicast from a external live audio feed connected directly to the router by a foreign exchange office (FXO) or an E&M analog voice port, use the feed command in ephone-dn configuration mode. To disable the multicast audio stream, use the no form of this command.
feed ip ip-address port port-number [route ip-address] [out-call outcall-number]
no feed ip
Syntax Description
Defaults
No multicast audio stream is enabled on an extension.
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
When this command is used, a connection for a live feed audio stream is established as an automatically connected voice call. If the out-call keyword is used, the Cisco CME system calls out to the specified number for the audio stream. If the out-call keyword is not used, it is assumed that the call is incoming to the ephone-dn. This includes VoIP calls if voice activity detection (VAD) is disabled. The typical operation is for the Cisco CME ephone-dn to establish a call to a local router E&M voice port.
Connection via E&M is the recommended mechanism because it requires minimal external components. The E&M port must be placed in 4-wire operation, using E&M immediate signaling and with the auto-cut-through option enabled. You directly connect a line-level audio feed (standard audio jack) to pins 3 and 6 of an E&M RJ-45 connector. The E&M WAN interface card (WIC) has a built-in audio transformer that provides appropriate electrical isolation for the external audio source. (The audio connection on the E&M port does not require loop current.) The signal immediate and auto-cut-through commands disable E&M signaling on this voice port. A G.711 audio packet stream is generated by the digital signal processor (DSP) on the E&M port.
If you are using an FXO voice port for live-feed audio stream instead of an E&M port, connect the source to the FXO voice port. This connection requires an external adapter to supply normal telephone company (telco) battery voltage with the correct polarity to the tip-and-ring leads of the FXO port. The adapter must also provide transformer-based isolation between the external audio source and the tip-and-ring leads of the FXO port.
If the out-call keyword is used, an outbound call to the live-feed source is attempted (or reattempted) every 30 seconds until the call is connected to the ephone-dn (extension) for which the feed command was configured. Note that this ephone-dn is not associated with a physical phone.
The related moh (ephone-dn) and multicast moh commands provide the ability to multicast an audio stream that is also being used as the source for Cisco CME system music on hold (MOH).
Note
Examples
The following example sets up a call to extension 7777 for a live audio stream and sends it via multicast:
Router(config)# ephone-dn 55Router(config-ephone-dn)# feed ip 239.1.1.1 port 2000 route 10.10.23.3 out-call 7777Related Commands
filename
To specify a custom XML file that contains the dial patterns to use for a SIP dial plan, use the filename command in voice register dialplan configuration mode. To remove the file, use the no form of this command.
filename filename
no filename
Syntax Description
Command Default
A custom file is not used for the dial plan.
Command Modes
Voice register dialplan configuration
Command History
Usage Guidelines
This command selects a custom XML file containing dial patterns for the SIP dial plan. The file specified with this command must be loaded into flash memory. You must use the type command to specify the type of phone for which the dial plan is being defined before you can use this command. After you define a dial plan, assign it to a SIP phone by using the dialplan command.
The pattern command and filename command are mutually exclusive. You can use either the pattern command to define dial patterns manually, or the filename command to select a custom dial pattern file that is loaded in system flash.
If the custom XML file contains any errors, the dial plan might not work properly on the phone.
To remove a dial plan that is created using a custom XML file, use the reset command after removing the dial plan from the phone and creating a new configuration profile. Removing a dial plan that uses a dial pattern XML file does not take effect if you restart the phone with the restart command.
Note
Examples
The following example shows that a custom file named sample.xml is specified for dial plan 2.
Router(config)# voice register dialplan 2Router(config-register-dialplan)# type 7940-7960-othersRouter(config-register-dialplan)# filename sample.xmlRelated Commands
file text (voice register global)
To generate ASCII text files of the configuration profiles for SIP phones, use the file text command in voice register global configuration mode. To return to the default, use the no form of this command.
file text
no file text
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Voice register global configuration
Command History
Usage Guidelines
Use this command to generate an ASCII text fils of the configuration profile for Cisco Unified IP Phone 7905s and 7905Gs, Cisco Unified IP Phone 7912s and 7912Gs, Cisco ATA-186s, or Cisco ATA-188s. By default, the system directly generates binary files to save disk space. Use this command if you prefer to generate ASCII text files.
Examples
The following example shows how to generate an ASCII text file version of the configuration profiles for Cisco Unified IP Phone 7905s and 7905Gs, Cisco Unified IP Phone 7912s and 7912Gs, Cisco ATA-186s, or Cisco ATA-188s:
Router(config)# voice register globalRouter(config-register-global)# mode cmeRouter(config-register-global)# file textRouter(config-register-global)# create profileRelated Commands
final
To define the last extension (ephone-dn) in an ephone hunt group, use the final command in ephone-hunt configuration mode. To remove this number from the hunt group, use the no form of this command.
final dn-number
no final dn-number
Syntax Description
dn-number
Ephone-dn number. Can be an ephone-dn primary or secondary number, voice-mail number, pilot number of another hunt group, or FXS caller-ID number.
Defaults
No final number is defined.
Command Modes
Ephone-hunt 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
If a final number in one hunt group is configured as a pilot number of another hunt group, the pilot number of the first hunt group cannot be configured as a final number in any hunt group.
Examples
The following example defines ephone-dn 6000 as the last number of hunt group number 1:
Router(config)# ephone-hunt 1 sequentialRouter(config-ephone-hunt)# final 6000Related Commands
final (voice hunt-group)
To define the last extension in a voice hunt group, use the final command in voice hunt-group configuration mode. To remove this number from the hunt group, use the no form of this command.
final directory-number
no final directory-number
Syntax Description
directory-number
Telephone or extension number. Can be an E.164 number, voice-mail number, pilot number of another hunt group, or FXS caller-ID number.
Defaults
This command has no arguments or keywords.
Command Modes
Voice hunt-group configuration
Command History
Usage Guidelines
If a final number in one hunt group is configured as a pilot number of another hunt group, the pilot number of the first hunt group cannot be configured as a final number in any other hunt group.
Examples
The following example shows how to define extension 6000 as the last number of hunt group 1:
Router(config)# voice hunt-group 1 sequentialRouter(config-voice-hunt-group)# final 6000Related Commands
forward local-calls
To allow internal (local) calls to be forwarded, use the forward local-calls command in ephone-dn or ephone-hunt configuration mode. To prevent internal calls from being forwarded, use the no form of this command.
forward local-calls
no forward local-calls
Syntax Description
This command has no arguments or keywords.
Command Default
Internal calls are forwarded as specified in the ephone-dn or ephone-hunt configuration of the called party.
Command Modes
Ephone-dn configuration
Ephone-hunt configurationCommand History
12.4(4)XC
Cisco Unified CME 4.0
This command was introduced.
Usage Guidelines
Internal, or local, calls are defined as those calls that originate from other ephone-dns in the same Cisco Unified CME system.
When the no forward local-calls command is used in ephone-dn configuration mode, internal calls to that ephone-dn are not forwarded if the ephone-dn is busy or does not answer. If the ephone-dn is busy, the caller hears a busy signal.If the ephone-dn does not answer, the caller hears a ringback signal. The call is not forwarded even if call forwarding is enabled for the ephone-dn.
When the no forward local-calls command is used in ephone-hunt configuration mode, internal calls to a hunt-group pilot number are sent only to the first member of the group. If the first group member is busy, the caller hears a busy signal. If the first group member does not answer, the caller hears a ringback signal. The call is not forwarded to subsequent hunt group members.
Examples
In the following example, extension 2222 dials the pilot number 3000 and is forwarded to extension 3011. If 3011 is busy, the caller hears a busy tone. If 3011 does not answer, the caller hears ringback. The call is not forwarded, even after the timeout expires.
ephone-hunt 17 sequentialpilot 3000list 3011, 3021, 3031timeout 10final 7600no forward local-callsIn the following example, extension 2222 calls extension 3675 and hears ringback or a busy signal. If an external caller reaches extension 3675 and there is no answer, the call is forwarded to extension 4000.
ephone-dn 25number 3675no forward local-callscall-forward noan 4000 timeout 30Related Commands
ephone-dn
Enters ephone-dn configuration mode.
ephone-hunt
Defines an ephone hunt group and enters ephone-hunt configuration mode.
forwarding local (voice register global)
To use the forwarding-party number and name (the local number and name) in calls forwarded using local hairpin call routing on a SIP phone, use the forwarding local command in voice register global configuration mode. To return to the default, use the no form of this command.
forwarding local
no forwarding local
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Voice register global configuration
Command History
Usage Guidelines
This command replaces a calling-party number and name with the local forwarding-party number and name in hairpinned forwarded calls.
Examples
The following example shows how to enable local forwarding:
Router(config)# voice register globalRouter(config-register-global)# forwarding localRelated Commands
from-ring
To specify that on-hook time stamps for ephone hunt group agents should be updated when calls ring as well as when calls are answered in a longest-idle ephone hunt group, use the from-ring command in ephone-hunt configuration mode. To return to the default, use the no form of this command.
from-ring
no from-ring
Syntax Description
This command has no keywords or arguments.
Command Default
On-hook time stamps are updated only when calls are answered by agents.
Command Modes
Ephone-hunt 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 only with longest-idle ephone hunt groups. In a longest-idle hunt group, the algorithm for choosing the the next agent to receive a call is based on a comparison of on-hook time stamps. The agent with the smallest on-hook time stamp value is chosen when the next call comes to the hunt group.
This command can be used to specify that on-hook time stamps should be updated when calls ring agents as well as when calls are answered by agents.
The show ephone-hunt command displays on-hook time stamps.
Examples
The following example defines longest-idle ephone hunt group 1 with a pilot number 7501, a final number 8000, and five numbers in the list. Because the from-ring command is used, on-hook time stamps will be recorded when calls ring agents as well as when calls are answered. After a call is redirected three times (makes six hops), it is redirected to the final number, 8000.
ephone-hunt 1 longest-idlepilot 7501list 7001, 7002, 7023, 7028, 7045final 8000from-ringhops 3timeout 20telephony-servicemax-redirect 8Related Commands
fwd-final
To specify the final destination of an unanswered call that has been transferred into a hunt group, use the fwd-final command in ephone-hunt configuration mode. To return to the default, use the no form of this command.
fwd-final {orig-phone | final}
no fwd-final {orig-phone | final}
Syntax Description
Command Default
Calls are sent to the final number that is specified in the hunt group configuration.
Command Modes
Ephone-hunt 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
The fwd-final command is used only for incoming calls to an ephone hunt group that have been previously answered by a Cisco Unified CME extension and transferred into the hunt group. If a transferred call is not answered by the hunt group, it is routed as specified in the fwd-final command. The orig-phone keyword specifies that an unanswered transferred call should be returned to the extension that originally answered the call and transferred it to the hunt group.
When you use the final keyword with the fwd-final command, unanswered calls that have been transferred into the hunt group are routed to the destination specified in the hunt-group final command. The final command specifies the last destination for incoming calls that dial the pilot number of the hunt group directly.
Examples
The following example sets up a peer hunt group with three ephone-dns to answer calls. A call that is unanswered will be returned to the ephone-dn that transferred it to the ephone hunt group pilot number. A DID call that dials the pilot number directly will be sent to extension 7600 if it is unanswered by the hunt group.
ephone-hunt 17 peerpilot 3000list 3011, 3021, 3031hops 3final 7600fwd-final orig-phoneRelated Commands
ephone-hunt
Defines an ephone hunt group and enters ephone-hunt configuration mode.
fxo hook-flash
To enable display of a flash soft key on a Cisco IP Phones 7940 and 7940G or Cisco IP Phones 7960 and 7960G in a Cisco CallManager Express (Cisco CME) system, use the fxo hook-flash command in telephony-service configuration mode. To disable display of the flash soft key, use the no form of this command.
fxo hook-flash
no fxo hook-flash
Syntax Description
This command has no arguments or keywords.
Defaults
The flash soft key is disabled.
Command 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
Certain public switched telephony network (PSTN) services, such as three-way calling and call waiting, require hookflash intervention from the phone user. A soft key labeled flash provides this functionality for the Cisco IP Phones 7940 and 7940G and the Cisco IP Phones 7960 and 7960G users on foreign exchange office (FXO) lines attached to the Cisco CME system. The flash soft key is enabled using the fxo hook-flash command.
Once a flash soft key has been enabled on an IP phone, it is available to provide hookflash functionality during all calls except local IP-phone-to-IP-phone calls. Note that hookflash-controlled services can be activated only if they are supported by the PSTN connection that is involved in the call. The availability of the flash soft key does not guarantee that hookflash-based services are actually accessible to the phone user.
The flash soft key display is automatically disabled for local IP-phone-to-IP-phone calls.
This command must be followed by a quick reboot of the phones using the restart all command.
Examples
The following example enables the flash soft key on the Cisco IP Phones 7940 and 7940G and the Cisco IP Phones 7960 and 7960G:
Router(config)# telephony-serviceRouter(config-telephony)# fxo hook-flashRelated Commands
Posted: Thu Jul 12 14:49:37 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.
