-
Cisco IOS Voice Command Reference
-
About Cisco IOS Software Documentation
-
Using Cisco IOS Software
-
Commands: A
-
Commands: B
-
Commands:cac master through call application stats
-
Commands: call application voice through call-denial
-
Commands: call fallback through called-number (dial-peer)
-
Commands: caller-id (dial peer) through ccm-manager switchover-to-backup
-
Commands: ccs connect (controller) through clear vsp statistics
-
Commands: clid through cptone
-
Commands: default (MGCP profile) through direct-inward-dial
-
Commands: disable-early-media 180 through dualtone
-
Commands: E
-
Commands: F
-
Commands: G
-
Commands: H
-
Commands: icpif through irq global-request
-
Commands: isdn bind-l3 through ixi transport http
-
Commands: K
-
Commands: L
-
Commands: map q850-cause through mgcp package-capability
-
Commands: mgcp persistent through mmoip aaa send-id secondary
-
Commands: mode (ATM/T1/E1 controller) through mwi-server
-
Commands: N
-
Commands: O
-
Commands: package through pattern
-
Commands: permit hostname through proxy h323
-
Commands: Q
-
Commands: R
-
Commands: sccp through service-type call-check
-
Commands: session through sgcp tse payload
-
Commands: show aal2 profile through show call filter match-list
-
Commands: show call history fax through show debug condition
-
Commands: show dial-peer video through show gatekeeper zone status
-
Commands: show gateway through show modem relay statistics
-
Commands: show mrcp client session active through show sgcp statistics
-
Commands: show sip service through show trunk hdlc
-
Commands: show vdev through show voice statistics memory-usage
-
Commands: show voice translation-profile through shutdown (voice-port)
-
Commands: signal through srv version
-
Commands: ss7 mtp2-variant through switchover method
-
Commands: target carrier-id through threshold noise
-
Commands: timeout (auto-config application) through timing clear-wait
-
Commands:timing delay-duration through type (voice)
-
Commands: U
-
Commands: vad (dial peer) through voice class dualtone-detect-params
-
Commands: voice class h323 through vxml tree memory
-
Commands: W
-
Commands: Z
-
Feedback
Table Of Contents
caller-id alerting dsp-pre-alloc
caller-id alerting line-reversal
capacity update interval (dial peer)
capacity update interval (trunk group)
carrier-id (voice source group)
ccm-manager application redundant-link port
ccm-manager music-on-hold bind
ccm-manager shut-backhaul-interfaces
ccm-manager switchover-to-backup
caller-id (dial peer)
To enable caller ID, use the caller-id command in dial peer configuration mode. To disable caller ID, use the no form of the command.
caller-id
no caller-id
Syntax Description
This command contains no arguments or keywords.
Command Default
Caller ID is disabled
Command Modes
Dial peer configuration
Command History
12.1.(2)XF
This command was introduced on the Cisco 800 series routers.
12.1(5)T
This command was integrated into Cisco IOS Release 12.1(5)T.
Usage Guidelines
This command is available on Cisco 800 series routers that have plain old telephone service (POTS) ports. The command is effective only if you subscribe to caller ID service. If you enable caller ID on a router without subscribing to the caller ID service, caller ID information does not appear on the telephone display.
The configuration of caller ID must match the device connected to the POTS port. That is, if a telephone supports the caller ID feature, use the command caller-id to enable the feature. If the telephone does not support the caller ID feature, use the command default or disable the caller ID feature. Odd ringing behavior might occur if the caller ID feature is disabled when it is a supported telephone feature or enabled when it is not a supported telephone feature.
Note
Specific hardware is required to provide full support for the Caller ID features. To determine support for these features in your configuration, review the appropriate hardware documentation and data sheets. This information is available on Cisco.com.
Examples
The following example enables a router to use the caller ID feature:
dial-peer voice 1 potscaller-idRelated Commands
caller-id alerting dsp-pre-alloc
To statically allocate a digital signal processor (DSP) resource for receiving caller ID information for on-hook (Type 1) Caller ID at a receiving Foreign Exchange Office (FXO) voice port, use the caller-id alerting dsp-pre-alloc command in voice-port configuration mode. To disable the command's effect, use the no form of this command.
caller-id alerting dsp-pre-alloc
no caller-id alerting dsp-pre-alloc
Syntax Description
This command contains no keywords or arguments.
Command Default
No pre-allocation of DSP resources
Command Modes
Voice-port configuration
Command History
12.1(2)XH
This command was introduced on the Cisco MC3810, Cisco 2600 series, and Cisco 3600 series.
12.1(3)T
This command was integrated into Cisco IOS Release 12.1(3)T.
Usage Guidelines
The caller-id alerting dsp-pre-alloc command may be required on an FXO port if the central office uses line polarity reversal to signal the start of Caller-ID information transmission. Pre-allocating a DSP allows the DSP to listen for Caller-ID information continuously without requiring an alerting signal from the CO.
This command is the FXO counterpart to the caller-id alerting line-reversal command, which is applied to the Foreign Exchange Station (sending) end of the Caller-ID call.
Note
Examples
The following example configures a voice port where Caller-ID information is received:
voice-port 1/0/1cptone UScaller-id enablecaller-id alerting line-reversalcaller-id alerting dsp-pre-allocRelated Commands
caller-id alerting line-reversal
Sets the line-reversal method of Caller-ID call alerting.
caller-id alerting line-reversal
To set the line-reversal alerting method for Caller-ID information for on-hook (Type 1) Caller ID at a sending Foreign Exchange Station (FXS) voice port, use the caller-id alerting line-reversal command in voice-port configuration mode. To disable the command's effect, use the no form of this command.
caller-id alerting line-reversal
no caller-id alerting line-reversal
Syntax Description
This command has no keywords or arguments.
Command Default
No line-reversal alert
Command Modes
Voice-port configuration
Command History
12.1(2)XH
This command was introduced on the Cisco 2600 series, and Cisco 3600 series and Cisco MC3810.
12.1(3)T
This command was integrated into Cisco IOS Release 12.1(3)T.
Usage Guidelines
This command is only required when the telephone device attached to an FXS port requires the line-reversal method to signal the start of a Caller-ID transmission. Use it on FXS voice ports that send Caller-ID information.
This command is the FXS counterpart to the caller-id alerting dsp-pre-alloc command, which is applied to the FXO (receiving) end of the Caller-ID call with the line-reversal alerting method.
Note
Examples
The following example configures a voice port from which Caller-ID information is sent:
voice-port 1/0/1cptone USstation name A. Personstation number 4085551111caller-id alerting line-reversalcaller-id alerting dsp-pre-allocRelated Commands
caller-id alerting dsp-pre-alloc
At the receiving end of a line-reversal alerting Caller-ID call, pre-allocates DSPs for caller ID calls.
caller-id alerting pre-ring
To set a 250-millisecond pre-ring alerting method for caller ID information for on-hook (Type 1) Caller ID at a sending Foreign Exchange Station (FXS) voice port, use the caller-id alerting pre-ring command in voice-port configuration mode. To disable the command, use the no form of this command.
caller-id alerting pre-ring
no caller-id alerting pre-ring
Syntax Description
This command has no keywords or arguments.
Command Default
No pre-ring alert
Command Modes
Voice-port configuration
Command History
12.1(2)XH
This command was introduced on the Cisco MC3810, Cisco 2600 series, and Cisco 3600 series.
12.1(3)T
This command was integrated into Cisco IOS Release 12.1(3)T.
Usage Guidelines
This command is required only when the telephone device attached to an FXS port requires the pre-ring (immediate ring) method to signal the start of caller ID transmission. Use it on FXS voice ports that send caller ID information. This command allows the FXS port to send a short pre-ring preceding the normal ring cadence. On an FXO port, an incoming pre-ring (immediate ring) is simply counted as a normal ring using the caller-id alerting ring command.
Note
Examples
The following example configures a voice port from which caller ID information is sent:
voice-port 1/0/1cptone USstation name A. Personstation number 4085551111caller-id alerting pre-ringRelated Commands
caller-id alerting ring
To set the ring-cycle method for receiving caller ID information for on-hook (Type 1) Caller ID at a receiving Foreign Exchange Office (FXO) or a sending Foreign Exchange Station (FXS) voice port, use the caller-id alerting ring command in voice-port configuration mode. To set the command to the default, use the no form of this command.
caller-id alerting ring {1 | 2}
no caller-id alerting ring
Syntax Description
Command Default
1
Command Modes
Voice-port configuration
Command History
12.1(2)XH
This command was introduced on the Cisco 2600 series, Cisco 3600 series and Cisco MC3810.
12.1(3)T
This command was integrated into Cisco IOS Release 12.1(3)T.
Usage Guidelines
This setting is determined by the Bellcore/Telcordia or ETSI standard that your telephone service provider uses for caller ID. Use it on FXO loop-start and ground-start voice ports where caller ID information arrives and on FXS voice ports from which caller ID information is sent.
This setting must match on the sending and receiving ends on both ends of the telephone line connection.
Note
Examples
The following example configures a voice port where caller ID information is received:
voice-port 1/0/1cptone UScaller-id alerting ring 1The following example configures a voice port from which caller ID information is sent:
voice-port 1/0/1cptone northamericastation name A. Personstation number 4085551111caller-id alerting ring 1Related Commands
caller-id attenuation
To set the attenuation for caller ID at a receiving Foreign Exchange Office (FXO) voice port, use the caller-id attenuation command in voice-port configuration mode. To set the command to the default, use the no form of this command.
caller-id attenuation [attenuation]
no caller-id attenuation
Syntax Description
Command Default
The default value is 14 decibels (dB), signal level of -14 dBm
Command Modes
Voice-port configuration
Command History
12.1(2)XH
This command was introduced on and Cisco 2600 series, Cisco 3600 series and the Cisco MC3810.
12.1(3)T
This command was integrated into Cisco IOS Release 12.1(3)T.
Usage Guidelines
Use this setting to specify the attenuation for a caller ID FXO port. If the setting is not used, the attenuation is set to 14 decibels (dB), signal level of -14 dBm.
Note
Examples
The following example configures a voice port where caller ID information is received:
voice-port 1/0/1cptone UScaller-id attenuation 0caller-id block
To request the blocking of the display of caller ID information at the far end of a call from calls originated at a Foreign Exchange Station (FXS) port, use the caller-id block command in voice-port configuration mode at the originating FXS voice port. To allow the display of caller ID information, use the no form of this command.
caller-id block
no caller-id block
Syntax Description
This command has no keywords or arguments.
Command Default
No blocking of caller ID information
Command Modes
Voice-port configuration
Command History
12.1(2)XH
This command was introduced on and Cisco 2600 series, Cisco 3600 series and the Cisco MC3810.
12.1(3)T
This command was integrated into Cisco IOS Release 12.1(3)T.
Usage Guidelines
This command is used on FXS voice ports that are used to originate on-net telephone calls. This command affects all calls sent to a far-end FXS station from the configured originating FXS station. Calling number and called number are provided in the H.225 setup message for VoIP, through the H.225 Octet 3A field. Calling name information is included in a display information element.
Note
Note
Examples
The following example configures a voice port from which caller ID information is sent:
voice-port 1/0/1cptone USstation name A. Personstation number 4085551111caller-id blockRelated Commands
caller-id enable
To allow the sending or receiving of caller-ID information, use the caller-id enable command in voice-port configuration mode at the sending foreign exchange station (FXS) voice port or the receiving foreign exchange office (FXO) voice port. To disable the sending and receiving of caller-ID information, use the no form of this command.
caller-id enable [type {1 | 2}]
no caller-id enable [type {1 | 2}]
Syntax Description
Command Default
The sending and receiving of caller-ID information is disabled.
Command Modes
Voice-port configuration
Command History
Usage Guidelines
This command applies to FXS voice ports that send caller-ID information and to FXO ports that receive caller-ID information. Calling number and called number are provided in the H.225.0 setup message for VoIP through the H.225.0 Octet 3A field. Calling name information is included in a display information element.
Some users who do not have caller ID type II support on their phones hear noise when type II caller ID is enabled. The caller-id enable type 1 command allows only type I on the voice port and disables type II, so that the user does not hear this noise.
If this command is used without the optional type keyword, both type I and type II caller ID are enabled.
Note
If the station name, station number, or a caller-id alerting command is configured on the voice port, caller ID is automatically enabled, and the caller-id enable command is not necessary.
Note
Note
Examples
The following example configures a Cisco 2600 series or Cisco 3600 series router voice port at which caller-ID information is received:
voice-port 1/0/1cptone UScaller-id enableThe following example configures a Cisco 2600 series or Cisco 3600 series router voice port from which caller-ID information is sent:
voice-port 1/0/1cptone northamericastation name A. Personstation number 4085550111caller-id enableThe following example enables only type I caller ID on port 2/0:
voice-port 2/0caller-id enable type 1Related Commands
caller-number
To associate a type of ring cadence with a specific caller ID, use the caller-number command in dial peer voice configuration mode. To disable the type of ring cadence for a specific caller ID, use the no form of this command.
caller-number number ring cadence
no caller-number number ring cadence
Syntax Description
Command Default
The router does not associate any caller ID with a cadence level. Therefore, there is no distinctive ring.
Command Modes
Dial peer voice configuration
Command History
12.2(8)T
This command was introduced on the Cisco 803, Cisco 804, and Cisco 813 routers.
Usage Guidelines
You can enter the caller-number command for each POTS port. A maximum of 20 caller IDs can be associated with distinct ring cadences. After 20 numbers per port have been set, you cannot set more numbers (and their ring cadences) for that port until you have removed any of the numbers that have already been set. To remove already-set numbers and their ring cadences, use the no form of the caller-number command.
The command must be set within each dial peer. Six dial peers are available, you can specify 20 caller IDs per port, for a maximum of 120 caller ID numbers.
Note
To disable distinctive ringing based on a caller ID number, configure the no caller-number command. Disabling the ringing removes the specific cadence that has been set for that particular number. If you have set 20 numbers and their ring cadences, you need to set the no caller-number command for each of the 20 numbers.
Use the show running-config command to check distinctive ringing status.
Examples
The following output examples show that three caller ID numbers and their ring cadences have been set for POTS port 1 and that five caller ID numbers and their ring cadences have been set for POTS port 2:
dial-peer voice 1 potsdestination-pattern 5550102port 1no call-waitingring 0volume 4caller-number 1111111 ring 2caller-number 2222222 ring 1caller-number 3333333 ring 1dial-peer voice 2 potsdestination-pattern 5550110port 2no call-waitingring 0volume 2caller-number 4444444 ring 1caller-number 6666666 ring 2caller-number 7777777 ring 0caller-number 8888888 ring 1caller-number 9999999 ring 2Related Commands
call-waiting
Enables call waiting.
volume
Configures the receiver volume level in the router.
calling-info pstn-to-sip
To specify calling information treatment for public switched telephone network (PSTN) to Session Initiation Protocol (SIP) calls, use the calling-info pstn-to-sip command in SIP user agent configuration mode. To disable calling information treatment for PSTN-to-SIP calls, use the no form of this command.
calling-info pstn-to-sip {unscreened discard | {from | remote-party-id | asserted-id {name set name | number set number}}}
no calling-info pstn-to-sip
Syntax Description
Command Default
This command is disabled.
Command Modes
SIP UA configuration (config-sip-ua)
Command History
12.2(13)T
This command was introduced.
12.4(15)T
The asserted-id keyword was added.
Usage Guidelines
When a call exits the gateway, the calling-info pstn-to-sip treatments are applied.
Examples
The following example enables calling information treatment for PSTN-to-SIP calls and sets the company name and number:
Router(config-sip-ua)# calling-info pstn-to-sip from name set CompanyARouter(config-sip-ua)# calling-info pstn-to-sip from number set 5550101Router(config-sip-ua)# exitRouter(config)# exitRouter# show running-configBuilding configuration......!sip-uacalling-info pstn-to-sip from name set CompanyAcalling-info pstn-to-sip from number set 5550101no remote-party-id!...Related Commands
calling-info sip-to-pstn
To specify calling information treatment for Session Initiation Protocol (SIP) to public switched telephone network (PSTN) calls, use the calling-info sip-to-pstn command in SIP UA configuration mode. To disable calling information treatment for SIP-to-PSTN calls, use the no form of this command.
calling-info sip-to-pstn {unscreened discard | name set name | number set number}
no calling-info sip-to-pstn
Syntax Description
Command Default
This command is disabled.
Command Modes
SIP UA configuration
Command History
Usage Guidelines
When a call enters the gateway, the calling-info sip-to-pstn treatments are applied.
Examples
The following example enables calling information treatment for SIP-to-PSTN calls and sets the company name to CompanyA and the number to 5550100:
Router(config-sip-ua)# calling-info sip-to-pstn name set CompanyARouter(config-sip-ua)# calling-info sip-to-pstn number set 5550100Router(config-sip-ua)# exitRouter(config)# exitRouter# show running-configBuilding configuration......!sip-uacalling-info sip-to-pstn name set CompanyAcalling-info sip-to-pstn number set 5550100!...Related Commands
calling-number outbound
To specify automatic number identification (ANI) to be sent out when T1-channel-associated signaling (T1-CAS) Feature Group D-Exchange Access North American (FGD-EANA) is configured as the signaling type, use the calling-number outbound command in dial peer or voice-port configuration mode. To disable this command, use no form of this command.
calling-number outbound {range string1 string2 | sequence string1... string5 | null}
no calling-number outbound {range string1 string2 | sequence string1... string5 | null}
Syntax Description
Command Default
No outbound calling number is specified.
Command Modes
Dial peer configuration
Voice-port configurationCommand History
Usage Guidelines
This command is effective only for FGD-EANA signaling.
Examples
Use the calling-number outbound command to enable or disable the passing of ANI on a T1-CAS FGD-EANA configured T1 interface for outgoing calls. Syntax for this command is the same for both voice-port mode and dial peer mode. Examples are given for both modes.
calling-number outbound Range
calling-number outbound range string1 string2The values string1 and string2 are valid E.164 telephone number strings. Both strings must be of the same length and cannot be more than 32 digits long. Only the last four digits are used for specifying the range (string1 to string2) and for generating the sequence of ANI by rotating through the range until string2 is reached and then starting from string1 again. If strings are fewer than four digits in length, then entire strings are used.
ANI is generated by using the 408555 prefix and by rotating through 0100 to 0101 for each call using this peer.
Dial peer configuration mode:
dial-peer voice 1 potscalling-number outbound range 4085550100 4085550101calling Number Outbound is effective only for fgd_eana signalingVoice-port configuration mode:
voice-port 1:Dcalling-number outbound range 4085550100 4085550105Calling Number Outbound is effective only for fgd_eana signalingcalling-number outbound Sequence
calling-number outbound sequence string1 string2 string3 string4 string5This option configures a sequence of discrete strings (string1... string5) to be passed out as ANI for successive calls using the peer. The limit is five strings. All strings must be valid E.164 numbers, up to 32 digits in length.
Dial peer configuration mode:
dial-peer voice 1 potscalling-number outbound sequence 6000 6006 4000 5000 5025Calling Number Outbound is effective only for fgd_eana signalingVoice-port configuration mode:
voice-port 1:Dcalling-number outbound sequence 6000 6006 4000 5000 5025Calling Number Outbound is effective only for fgd_eana signalingcalling-number outbound Null
calling-number outbound nullThis option suppresses ANI. If used, no ANI is passed when this dial peer is selected.
Dial peer configuration mode:
dial-peer voice 1 potscalling-number outbound nullCalling Number Outbound is effective only for fgd_eana signalingVoice-port configuration mode:
voice-port 1:Dcalling-number outbound nullCalling Number Outbound is effective only for fgd_eana signalingRelated Commands
info-digits string1
Configures two information digits to be prepended to the ANI string.
capacity update interval (dial peer)
To change the capacity update for prefixes associated with this dial peer, use the capacity update interval command in dial peer configuration mode. To return to the default, use the no form of this command.
capacity update interval seconds
no capacity update interval seconds
Syntax Description
seconds
Interval, in seconds, between the sending of periodic capacity updates. This can be a number in the range 10 to 1000. The default value is 25 seconds.
Command Default
25 seconds
Command Modes
Dial peer configuration
Command History
Usage Guidelines
The update interval should be set depending how many updates that are sent. Updates are sent more often when more calls are coming in, which can lead to data getting out of synchrony. If the interval is too short for the number of updates, the location server can be overwhelmed.
If a dial peer gets too much traffic, set the seconds argument to a higher value.
Examples
The following example shows that POTS dial peer 10 is having the capacity update occur every 35 seconds:
Router(config)# dial-peer voice 10 potsRouter(config-dial-peer)# capacity update interval 35Related Commands
dial-peer voice
Enters dial-peer configuration mode and specifies the method of voice-related encapsulation.
capacity update interval (trunk group)
To change the capacity update for carriers or trunk groups, use the capacity update interval command in trunk group configuration mode. To return to the default, use the no form of this command.
capacity {carrier | trunk-group} update interval seconds
no capacity {carrier | trunk-group}
Syntax Description
Command Default
25 seconds
Command Modes
Trunk group configuration
Command History
Usage Guidelines
The update interval should be set depending how many updates that are sent. Updates are sent more often when more calls are coming in, which can lead to data getting out of synchrony. If the interval is too short for the number of updates, the location server can be overwhelmed.
If a dial peer gets too much traffic, set the seconds argument to a higher value.
Examples
The following example sets the capacity update for trunk group 101 to occur every 45 seconds:
Router(config)# trunk group 101Router(config-trunkgroup)# capacity trunk-group update interval 45Related Commands
cap-list vfc
To add a voice codec overlay file to the capability file list, use the cap-list vfc command in global configuration mode. To disable a particular codec overlay file that has been added to the capability list, use the no form of this command.
cap-list filename vfc slot-number
no cap-list filename vfc slot-number
Syntax Description
filename
Identifies the codec file stored in voice feature card (VFC) flash memory.
slot-number
Identifies the slot where the VFC is installed. Range is 0 to 2. There is no default value.
Command Default
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
When VCWare is unbundled, it automatically adds DSPWare to flash memory, creates both the capability and default file lists, and populates these lists with the default files for the particular version of VCWare. The capability list defines the available voice codecs for H.323 capability negotiation. Use the cap-list vfc command to add the indicated voice codec overlay file (defined by filename) to the capability file list in flash memory.
Examples
The following example adds the following codec to the list included in flash memory:
config terminalcap-list cdc-g711-1.0.14.0.bin vfc 0Related Commands
default-file vfc
Specifies an additional (or different) file from the ones in the default file list and stored in VFC Flash memory.
card type (t1/e1)
To configure the card type, use the card type command in global configuration mode. To restore the default value, use the no form of this command.
card type {t1 | e1} slot [bay]
no card type {t1 | e1} slot [bay]
Syntax Description
Command Default
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
Changes made using this command do not take effect unless the reload command is used or the router is rebooted.
Examples
The following example configures T1 data transmission on slot 1 (port 1) of the router:
card type t1 1Related Commands
controller
Configures a T1 or E1 controller and enters controller configuration mode.
reload
Reloads the operating system.
card type (t3/e3)
To configure the card type on the T3 or E3 controller, use the card type command in global configuration mode. To restore the default value, use the no form of this command.
card type {t3 | e3} slot
no card type {t3 | e3} slot
Syntax Description
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Once a card type is issued, the user can enter the no card type command and then another card type command to configure a new card type. The user must save the configuration to the NVRAM and reboot the router in order for the new configuration to take effect.
When the router comes up, the software comes up with the new card type. Note that the software will reject the configuration associated with the old controller and old interface. The user will now have to configure the new controller and serial interface and save it.
Examples
The following example shows T3 data transmission configured in slot 1:
card type t3 1Related Commands
controller
Configures a T3 or E3 controller and enters controller configuration mode.
reload
Reloads the operating system.
carrier-id (dial peer)
To specify the carrier associated with a VoIP call in a dial peer, use the carrier-id command in dial peer configuration mode. To delete the source carrier ID, use the no form of this command.
carrier-id {source | target} name
no carrier-id {source | target} name
Syntax Description
Command Default
No default behavior or values
Command Modes
Dial peer configuration
Command History
Usage Guidelines
A Gatekeeper Transaction Message Protocol (GKTMP) route server-based application at the terminating gateway uses the source carrier ID to select a target carrier that routes the call over a plain old telephone service (POTS) line.
The terminating gateway uses the target carrier ID to select a dial peer for routing the call over a POTS line.
Examples
The following example indicates that dial peer 112 should use carrier ID "east17" for outbound dial-peer matching in the terminating gateway:
Router(config)# dial-peer voice 112 potsRouter(config-dial-peer)# carrier-id target east17The following example indicates that dial peer 111 should use carrier ID "beta23" for inbound dial-peer matching in the terminating gateway:
Router(config)# dial-peer voice 111 voipRouter(config-dial-peer)# carrier-id source beta23Related Commands
carrier-id (global)
To set the carrier ID for trunk groups when a local carrier ID is not configured, use the carrier-id command in global configuration mode. To disable the carrier ID, use the no form of this command.
carrier-id name [cic]
no carrier-id name [cic]
Syntax Description
Command Default
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
To advertise the carrier as a TRIP carrier family, the cic keyword must be used. When the cic keyword is used, only numeric values can be accepted for the name value. If the cic keyword is not used, the name value can be alphanumeric but is not advertised to TRIP location servers.
Examples
The following example shows a carrier ID using the circuit identification code:
Router(config)# carrier-id 1234 cicRelated Commands
carrier-id (trunk group)
To specify the carrier associated with a trunk group, use the carrier-id command in trunk group configuration mode. To delete the source carrier ID, use the no form of this command.
carrier-id name [cic]
no carrier-id name [cic]
Syntax Description
Command Default
No default behavior or values
Command Modes
Trunk group configuration
Command History
Usage Guidelines
In a network, calls are routed over incoming trunk groups and outgoing trunk groups. The name arguments identifies the carrier that handles the calls for a specific trunk group. In some cases, the same trunk group may be used to carry both incoming calls and outgoing calls.
The carrier ID configured locally on the trunk group supersedes the globally configured carrier ID.
To advertise the carrier as a TRIP carrier family, the cic keyword must be used. When cic is used, only numeric values can be accepted for the name value. If cic is not used, the name value can be alphanumeric but is not advertised to TRIP location servers.
Examples
The following example indicates that carrier "alpha1" carries calls for trunk group 5:
Router(config)# trunk group 5Router(config-trunk-group)# carrier-id alpha1The following example shows that the carrier with circuit identification code 1234 carries calls for trunk group 101. This trunk group can carry TRIP advertisements.
Router(config)# trunk group 101Router(config-trunk-group)# carrier-id 1234 cicRelated Commands
carrier-id (voice source group)
To specify the carrier associated with a VoIP call, use the carrier-id command in voice source group configuration mode. To delete the source carrier ID, use the no form of this command.
carrier-id {source | target} name
no carrier-id {source | target} name
Syntax Description
Command Default
No default behavior or values
Command Modes
Voice source group configuration
Command History
Usage Guidelines
A Gatekeeper Transaction Message Protocol (GKTMP) server application at the terminating gateway uses the source carrier ID to select a target carrier that routes the call over a plain old telephone service (POTS) line. The terminating gateway uses the target carrier ID to select a dial peer for routing the call over a POTS line.
Note
Examples
The following example indicates that voice source IP group "group1" should use carrier ID named "source3" for incoming VoIP calls and carrier ID named "target17" for outbound dial-peer matching in the terminating gateway:
Router(config)# voice source-group group1Router(cfg-source-grp)# carrier-id source source3Router(cfg-source-grp)# carrier-id target target17Related Commands
cause-code
To represent internal failures with former and nonstandard H.323 or Session Initiation Protocol (SIP) cause codes, use the cause-code command in voice service VoIP configuration mode. To use standard cause-code categories, use the no form of this command.
cause-code legacy
no cause-code legacy
Syntax Description
Command Default
The default for SIP and H.323 is to use standard cause-code categories, so the command is disabled.
Command Modes
Voice service VoIP configuration
Command History
Usage Guidelines
This command is used for backward compatibility purposes.
Examples
The following example sets the internal cause codes to the former and nonstandard set of SIP and H.323 values for backward compatibility:
Router(config)# voice service voipRouter(config-voi-srv)# cause-code legacyRelated Commands
ccm-manager application redundant-link port
To configure the port number for the redundant link application, use the ccm-manager application redundant-link port command in global configuration mode. To disable the configuration, use the no form of this command.
ccm-manager application redundant-link port number
no ccm-manager application redundant-link port
Syntax Description
Command Default
Port number: 2428
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command only when defining an application-specific port other than the default.
Examples
In the following example, the port number of the redundant link application is 2429:
ccm-manager application redundant-link port 2429Related Commands
ccm-manager config
To specify the TFTP server from which the Media Gateway Control Protocol (MGCP) gateway downloads Cisco CallManager XML configuration files and to enable the download of the configuration, use the ccm-manager config command in global configuration mode. To disable the dial-peer and server configurations, use the no form of this command.
ccm-manager config [dialpeer-prefix prefix | server {ip-address | name}]
no ccm-manager config [dialpeer-prefix prefix | server]
Syntax Description
Command Default
The configuration download feature is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
The ccm-manager config command is required to enable the download of Cisco CallManager XML configuration files. If you separate the MGCP and H.323 dial peers under different dial-peer tags, ensure that the MGCP dial peers are configured before the H.323 dial peers. Direct-inward-dial (DID) is required for E1 PRI dial peers.
Note
Examples
The following example enables the automatic download of configuration files:
ccm-manager configIn the following example, the IP address of the TFTP server from which a configuration file is downloaded is identified:
ccm-manager config server 10.10.0.21Related Commands
ccm-manager download-tones
To configure a Cisco IOS gateway to download a XML configuration file that contains custom tone information from a TFTP server at the time of gateway registration, use the ccm-manager download-tones command in global configuration mode. To disable this functionality, use the no form of this command.
ccm-manager download-tones
no ccm-manager download-tones
Syntax Description
This command has no arguments or keywords.
Command Default
Cisco CallManager download tones are disabled.
Command Modes
Global configuration
Command History
12.2(15)ZJ
This command was introduced.
12.3(4)T
This command was integrated into Cisco IOS Release 12.3(4)T.
Examples
The following example shows a Cisco IOS gateway being configured to download an XML configuration file that contains custom tone information from a TFTP server:
Router(config)# ccm-manager download-tonesRelated Commands
ccm-manager fallback-mgcp
To enable the gateway fallback feature and allow a Media Gateway Control Protocol (MGCP) voice gateway to provide call processing services when Cisco CallManager is unavailable, use the ccm-manager fallback-mgcp command in global configuration mode. To disable fallback on the MGCP voice gateway, use the no form of this command.
ccm-manager fallback-mgcp
no ccm-manager fallback-mgcp
Syntax Description
This command has no arguments or keywords.
Command Default
The gateway fallback feature is enabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command causes the gateway to fall back and provide call processing services if connectivity is lost between the gateway and all Cisco CallManager servers. The mode and timing are set by default.
Examples
The following example enables fallback:
Router(config)# ccm-manager fallback-mgcpRelated Commands
ccm-manager fax protocol
To enable fax-relay protocol for endpoints on a gateway, use the ccm-manager fax protocol command in global configuration mode. To disable fax-relay protocol, use the no form of this command.
ccm-manager fax protocol cisco
no ccm-manager fax protocol cisco
Syntax Description
Command Default
Cisco-proprietary fax-relay protocol is enabled by default.
Command Default
protocol cisco
Command Modes
Global configuration
Command History
Usage Guidelines
Use the no form of this command to disable fax relay.
Because fax relay is enabled by default, the show running-config command does not explicitly show it to be enabled.
Fax over IP enables interoperability of traditional analog fax machines with IP telephony networks. In its original form, fax data is digital. For transmission across a traditional public switched telephone network (PSTN), it is converted to analog form. For transmission across the IP (packet) network, it is reconverted to digital form, and then, at the destination fax machine, converted again to analog form.
Most Cisco voice gateways support two methods of transmitting fax traffic across the IP network:
•
•
Examples
The following example configures a Media Gateway Control Protocol (MGCP) gateway for Cisco fax relay:
Router(config)# ccm-manager fax protocol ciscoRouter(config)# mgcp fax t38 inhibitThe following example configures an MGCP gateway for fax pass-through:
Router(config)# ccm-manager fax protocol ciscoRouter(config)# mgcp modem passthrough voip mode nseRouter(config)# mgcp modem passthrough voip codec g711ulawRelated Commands
ccm-manager mgcp
To enable the gateway to communicate with Cisco CallManager through the Media Gateway Control Protocol (MGCP) and to supply redundant control agent services, use the ccm-manager mgcp command in global configuration mode. To disable communication with Cisco CallManager and redundant control agent services, use the no form of this command.
ccm-manager mgcp
no ccm-manager mgcp
Syntax Description
This command has no arguments or keywords.
Command Default
Cisco CallManager does not communicate with the gateway through MGCP.
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables the gateway to communicate with Cisco CallManager through MGCP. This command also enables control agent redundancy when a backup Cisco CallManager server is available.
Examples
In the following example, support for Cisco CallManager and redundancy is enabled within MGCP:
ccm-manager mgcpRelated Commands
ccm-manager music-on-hold
To enable the multicast music-on-hold (MOH) feature on a voice gateway, use the ccm-manager music-on-hold command in global configuration mode. To disable the MOH feature, use the no form of this command.
ccm-manager music-on-hold
no ccm-manager music-on-hold
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Global configuration
Command History
Examples
The following example shows multicast MOH configured for a MGCP voice gateway:
mgcp call-agent 10.0.0.21 2427 service-type mgcp version 0.1mgcp dtmf-relay voip codec all mode out-of-bandmgcp rtp unreachable timeout 1000mgcp modem passthrough voip mode ciscomgcp package-capability rtp-packagemgcp package-capability sst-packageno mgcp timer receive-rtcpcall rsvp-sync!ccm-manager redundant-host 10.0.0.21ccm-manager mgcpccm-manager music-on-holdccm-manager config server 10.0.0.21!Related Commands
ccm-manager music-on-hold bind
To bind the multicast music-on-hold (MOH) feature to a designated interface, use the ccm-manager music-on-hold bind command in global configuration mode. To unbind the MOH feature on the voice gateway, use the no form of this command.
ccm-manager music-on-hold bind type slot/port
no ccm-manager music-on-hold bind type slot/port
Syntax Description
Command Default
Disabled
Command Modes
Global configuration
Command History
Examples
The following example shows multicast MOH bound to serial interface 0/0:
ccm-manager music-on-hold bind serial 0/0Related Commands
ccm-manager music-on-hold
Enables the MOH feature.
debug ccm-manager music-on-hold
Displays debugging information for MOH.
show ccm-manager music-on-hold
Displays MOH information.
ccm-manager redundant-host
To configure the IP address or the Domain Name System (DNS) name of one or two backup Cisco CallManager servers, use the ccm-manager redundant-host command in global configuration mode. To disable the use of backup Cisco CallManager servers as call agents, use the no form of this command.
ccm-manager redundant-host {ip-address | dns-name} [ip-address | dns-name]
no ccm-manager redundant-host {ip-address | dns-name} [ip-address | dns-name]
Syntax Description
ip-address
IP address of the backup Cisco CallManager server.
dns-name
DNS name of the backup Cisco CallManager server.
Command Default
If you do not configure a backup Cisco CallManager, the redundancy is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
The list of IP addresses or DNS names is an ordered and prioritized list. The Cisco CallManager server that was defined with the mgcp call-agent command has the highest priority—it is the primary Cisco CallManager server. The gateway selects a Cisco CallManager server on the basis of the order of its appearance in this list.
Examples
In the following example, the IP address 10.0.0.50 is configured as the backup Cisco CallManager :
ccm-manager redundant-host 10.0.0.50Related Commands
ccm-manager sccp
To enable Cisco CallManager autoconfiguration of the Cisco IOS gateway, use the ccm manager sccp command in global configuration mode. To disable autoconfiguration, use the no form of this command.
ccm-manager sccp
no ccm-manager sccp
Syntax Description
This command has no arguments or keywords.
Command Default
Autoconfiguration is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to trigger TFTP download of the eXtensible Markup Language (XML) configuration file. Issuing this command immediately triggers the download, and also enables the Skinny Client Control Protocol (SCCP) and SCCP Telephony Control Application (STCAPP), applications that enable Cisco CallManager control of gateway-connected telephony endpoints.
Examples
The following example enables autoconfiguration of gateway-connected endpoints:
Router(config)# ccm-manager sccpRelated Commands
ccm-manager sccp local
To select the local interface that the Skinny Client Control Protocol (SCCP) application uses to register with Cisco CallManager, use the ccm-manager sccp local command in global configuration mode. To deselect the interface, use the no form of this command.
ccm-manager sccp local interface-type interface-number
no ccm-manager sccp local interface-type interface-number
Syntax Description
interface-type
Interface type that the SCCP application uses for Cisco CallManager registration.
interface-number
Interface number that the SCCP application uses for Cisco CallManager registration.
Command Default
No local interface is selected.
Command Modes
Global configuration
Command History
Usage Guidelines
You must specify this interface before enabling the Cisco CallManager autoconfiguration process. The MAC address of this interface is used to identify gateway endpoints.
Examples
The following example configures a FastEthernet interface for SCCP application use for Cisco CallManager registration:
Router(config)# ccm-manager sccp local fastethernet 0/0Related Commands
show ccm-manager
Displays a list of Cisco CallManager servers and their current status and availability.
ccm-manager shut-backhaul-interfaces
To disable ISDN Layer 2 connectivity on a Cisco Call Manager Media Gateway Control Protocol (MGCP) PRI or BRI backhauled trunk when communication is lost between the Cisco Call Manager and the MGCP gateway, use the ccm-manager shut-backhaul-interfaces command in global configuration mode. To restore the default behavior, where ISDN Layer 2 is maintained between the MGCP gateway and the ISDN switch even when no connectivity exists between the MGCP gateway and any Cisco Call Manager, use the no form of this command.
ccm-manager shut-backhaul-interfaces
no ccm-manager shut-backhaul-interfaces
Syntax Description
This command has no arguments or keywords.
Command Default
The default behavior is for the ISDN Layer 2 connection to be maintained (to make the Cisco Call Manager MGCP PRI or BRI backhaul continue to function) between the MGCP gateway and the ISDN switch even if no connectivity exists between the MGCP gateway and any Cisco Call Manager.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command on Cisco IOS voice routers configured for Cisco Call Manager MGCP PRI or BRI backhaul.
Prior to the introduction of the ccm-manager shut-backhaul-interfaces command, a Cisco Call Manager MGCP PRI or BRI backhaul trunk would maintain ISDN Layer 2 connectivity between the MGCP gateway and the ISDN switch in a MULTIPLE_FRAMES_ESTABLISHED state even if Layer 3 Q.931 backhaul connectivity between the Cisco Call Manager and the MGCP gateway was unavailable. This causes problems because the ISDN switch interprets the PRI or BRI trunk as being active and continues to place calls to the MGCP gateway, even though all of the calls fail. After you enter the ccm-manager shut-backhaul-interfaces command, Layer 2 is disabled when connectivity between the Cisco Call Manager and the MGCP gateway is unavailable.
Examples
The following example disables ISDN Layer 2 connectivity on a Cisco Call Manager MGCP PRI or BRI backhauled trunk when communication is lost between Cisco Call Manager and the MGCP gateway:
ccm-manager shut-backhaul-interfacesThe following example restores the default behavior (functionality of the ccm-manager shut-backhaul-interfaces command is disabled) so that the ISDN Layer 2 connection is maintained between the MGCP gateway and the ISDN switch, even when no connectivity exists between the MGCP gateway and any Cisco Call Manager:
no ccm-manager mgcpno ccm-manager shut-backhaul-interfacesccm-manager mgcpRelated Commands
ccm-manager mgcp
Enables the gateway to communicate with the Cisco Call Manager through the MGCP and to supply redundant control agent services.
ccm-manager switchback
To specify the time when control is to be returned to the primary Cisco CallManager server once it becomes available, use the ccm-manager switchback command in global configuration mode. To reset to the default, use the no form of this command.
ccm-manager switchback {graceful | immediate | schedule-time hh:mm | uptime-delay minutes}
no ccm-manager switchback
Syntax Description
Command Default
Graceful switchback
Command Modes
Global configuration
Command History
Usage Guidelines
This command allows you to configure switchback to the higher priority Cisco CallManager when it becomes available. Switchback allows call control to revert to the original (primary) Cisco CallManager once service has been restored.
Examples
In the following example, the primary Cisco CallManager is configured to be used as soon as it becomes available:
ccm-manager switchback immediateRelated Commands
ccm-manager switchover-to-backup
To manually redirect a gateway to the backup Cisco CallManager server, use the ccm-manager switchover-to-backup command in privileged EXEC mode.
ccm-manager switchover-to-backup
Syntax Description
This command has no arguments or keywords.
Command Default
No default behavior or values
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Switchover to the backup Cisco CallManager server occurs immediately. This command does not switch the gateway to the backup Cisco CallManager server if you have the ccm-manager switchback command option set to "immediate" and the primary Cisco CallManager server is still running.
Examples
In the following example, the backup Cisco CallManager server is configured to be used as soon as it becomes available:
ccm-manager switchover-to-backupRelated Commands
