-
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
modem passthrough (voice-service)
monitor call application event-log
mrcp client session history duration
mrcp client session history records
mta receive maximum-recipients
mode (ATM/T1/E1 controller)
To set the DSL controller into ATM mode and create an ATM interface or to set the T1 or E1 controller into T1 or E1 mode and create a logical T1/E1 controller, use the mode command in controller configuration mode. To disable the current mode and prepare to change modes, use the no form of this command.
Cisco 1800, Cisco 2800, Cisco 3700, Cisco 3800 Series
mode atm
no mode atm
Cisco 1700 Series, Cisco 2600XM Platform,
mode {atm | t1 | e1}
no mode {atm | t1 | e1}
Cisco IAD2430
mode {atm [aim aim-slot] | cas | t1 | e1}
no mode {atm [aim aim-slot] | cas | t1 | e1}
Syntax Description
Command Default
The controller mode is disabled.
Command Modes
Controller configuration
Command History
Usage Guidelines
When a DSL controller is configured in ATM mode, the mode must be configured identically on both the CO and CPE sides. Both sides must be set to ATM mode.
Note
If using the no mode atm command to leave ATM mode, the router must be rebooted immediately to clear the mode.
When configuring a DSL controller in T1 or E1 mode, the mode must be configured identically on the CPE and CO sides.
Examples
ATM Mode Example
The following example configures ATM mode on the DSL controller.
Router(config)# controller dsl 3/0Router(config-controller)# mode atmT1 Mode Example
The following example configures T1 mode on the DSL controller.
Router(config)# controller dsl 3/0Router(config-controller)# mode t1Related Commands
mode (T1/E1 controller)
To set the T1 or E1 controller into asynchronous transfer mode (ATM) and create an ATM interface, to set the T1 or E1 controller into T1 or E1 mode and create a logical T1 or E1 controller, or to set the T1 or E1 controller into channel-associated signaling (CAS) mode, use the mode command in controller configuration mode. To disable the current mode and prepare to change modes, use the no form of this command.
mode {atm [aim aim-slot] | cas | t1 | e1}
no mode {atm [aim aim-slot] | cas | t1 | e1}
Syntax Description
Command Default
No controller mode is configured.
Command Modes
Controller configuration
Command History
Usage Guidelines
This command has the following platform-specific usage guidelines:
•
•
•
•
•
•
–
–
•
•
•
–
•
Examples
The following example configures ATM mode on controller T1 0. This step is required for Voice over ATM.
Router(config)# controller T1 0Router(config-controller)# mode atmThe following example configures ATM mode on controller T1 1/ 0 on a Cisco 2600 series router using an AIM in slot 0 for ATM segmentation and reassembly:
Router(config)# controller t1 1/0Router(config-controller)# mode atm aim 0The following example configures CAS mode on controller T1 1 on a Cisco 2600 series router:
Router(config)# controller T1 1Router(config-controller)# mode casThe following example configures ATM mode on the DSL controller.
Router(config)# controller dsl 3/0Router(config-controller)# mode atmThe following example configures T1 mode on the DSL controller.
Router(config)# controller dsl 3/0Router(config-controller)# mode t1Related Commands
mode bles
To set Broadband Loop Emulation Services (BLES) mode to independent or slave mode, use the mode bles command in dial peer configuration mode. To disable BLES mode, use the no form of this command.
mode bles [slave]
no mode bles
Syntax Description
Command Default
The default mode for this command is independent mode. Using the slave keyword sets the mode to slave mode.
Command Modes
Dial peer configuration
Command History
Usage Guidelines
This command activates BLES mode. BLES mode activates the dynamic call admission control (CAC) resource allocation and implicit channel activation and deactivation. Use the mode bles command to activate independent mode and the mode bles slave command to activate slave mode.
Examples
The following example configures BLES mode:
voice service voatmsession protocol aal2mode blesThe following example configures slave mode in BLES mode:
voice service voatmsession protocol aal2mode bles slaveRelated Commands
mode ccs
To configure the T1/E1 controller to support common channel signaling (CCS) cross-connect or CCS frame forwarding, use the mode ccs command in global configuration mode. To disable support for CCS cross-connect or CCS frame forwarding on the controller, use the no form of this command.
mode ccs {cross-connect | frame-forwarding}
no mode ccs {cross-connect | frame-forwarding}
Syntax Description
cross-connect
Enables CCS cross-connect on the controller.
frame-forwarding
Enables CCS frame forwarding on the controller.
Command Default
No CCS mode is configured
Command Modes
Global configuration
Command History
Usage Guidelines
On Cisco 2600 Series routers and Cisco 2600XM Series routers with the AIM-ATM, AIM-VOICE-30 or AIM-ATM-VOICE-30 module installed, the channel group configuration must be removed before the no mode ccs frame-forwarding command is entered. This restriction does not apply to the Cisco 3600 Series routers or the Cisco 3700 Series routers.
Examples
To enable CCS cross-connect on controller T1 1, enter the following commands:
controller T1 1mode ccs cross-connectTo enable CCS frame forwarding on controller T1 1, enter the following commands:
controller T1 1mode ccs frame-forwardingRelated Commands
ccs connect
Configures a CCS connection on an interface configured to support CCS frame forwarding.
modem passthrough (dial peer)
To enable modem pass-through over VoIP for a specific dial peer, use the modem passthrough command in dial peer configuration mode. To disable modem pass-through for a specific dial peer, use the no form of this command.
modem passthrough {system | nse [payload-type number] codec {g711ulaw | g711alaw} [redundancy]}
no modem passthrough
Syntax Description
Command Default
payload-type number:100
Command Modes
Dial peer configuration
Command History
Usage Guidelines
Use this command to enable fax pass-through over VoIP individually for a single dial peer. Use the same values for all options on originating and terminating gateways.
Fax pass-through occurs when incoming T.30 fax data is not demodulated or compressed for its transit through the packet network. On detection of a fax tone on an established VoIP call, the gateways switch into fax pass-through mode by suspending the voice codec and configuration and loading the pass-through parameters for the duration of the fax session. The switchover of codec is known as upspeeding, and it changes the bandwidth needed for the call to the equivalent of G.711.
The system keyword overrides the configuration for the dial peer and directs that the values from the global configuration are to be used for this dial peer. When the system keyword is used, the following parameters are not available: nse, payload-type, codec, and redundancy.
The modem passthrough (voice service) command can be used to set pass-through options globally on all dial peers at one time. If the modem passthrough (voice service) command is used to set pass-through options for all dial peers and the modem passthrough (dial peer) command is used on a specific dial peer, the dial peer configuration takes precedence over the global configuration for that dial peer.
Examples
The following example configures fax pass-through over VoIP for a specific dial peer:
dial-peer voice 25 voipmodem passthrough nse codec g711ulaw redundancyRelated Commands
dial-peer voice
Enters dial peer configuration mode.
modem passthrough (voice service)
Enables fax or modem pass-through over VoIP globally for all dial peers.
modem passthrough (voice-service)
To enable fax or modem pass-through over VoIP globally for all dial peers, use the modem passthrough command in voice-service configuration mode. To disable pass-through, use the no form of this command.
Cisco 2600 series, Cisco 3600 series, Cisco 3700 series, Cisco AS5300
modem passthrough nse [payload-type number] {codec {g711ulaw | g711alaw}} [redundancy [maximum-sessions sessions]]
no modem passthrough
Cisco AS5350, Cisco AS5400, Cisco AS5850
modem passthrough nse [payload-type number] {codec {g711ulaw | g711alaw}} [redundancy [maximum-sessions sessions] [sample-duration [10 | 20]]]
no modem passthrough
Syntax Description
Command Default
Disabled
Command Modes
Voice-service configuration
Command History
Usage Guidelines
Use this command to enable fax pass-through over VoIP globally for all dial peers. Use the same values for all options on originating and terminating gateways.
Fax pass-through occurs when incoming T.30 fax data is not demodulated or compressed for its transit through the packet network. On detection of a fax tone on an established VoIP call, the gateways switch into fax pass-through mode by suspending the voice codec and configuration and loading the pass-through parameters for the duration of the fax session. The switchover of codec is known as upspeeding, and it changes the bandwidth needed for the call to the equivalent of G.711.
When using the voice service voip and modem passthrough nse commands on a terminating gateway to globally set up fax or modem pass-through with NSEs, you must also ensure that each incoming call will be associated with a VoIP dial peer to retrieve the global fax or modem configuration. You associate calls with dial peers by using the incoming called-number command to specify a sequence of digits that incoming calls can match. You can ensure that all calls will match at least one dial peer by using the following commands:
Router(config)# dial-peer voice tag voipRouter(config-dial-peer)# incoming called-number .The modem passthrough (dial peer) command can be used to set pass-through options on individual dial peers. If the modem passthrough (voice service) command is used to set pass-through options for all dial peers and the modem passthrough (dial peer) command is used on a specific dial peer, the dial-peer configuration takes precedence over the global configuration for that specific dial peer.
Examples
The following example configures modem pass-through for NSE payload type 101 using the G.711 u-law codec:
voice service voipmodem passthrough nse payload-type 101 codec g711ulaw redundancy maximum-sessions 1Related Commands
modem relay (dial peer)
To configure modem relay over VoIP for a specific dial peer, use the modem relay command in dial peer configuration mode. To disable modem relay over VoIP for a specific dial peer, use the no form of this command.
modem relay {nse [payload-type number] codec {g711alaw | g711ulaw} [redundancy] | system} gw-controlled
no modem relay {nse | system}
Syntax Description
Command Default
Cisco modem relay is disabled.
Payload type: 100Command Modes
Dial peer configuration
Command History
Usage Guidelines
This command applies to VoIP dial peers. Use this command to configure modem relay over VoIP for a specific dial peer.
Use the same codec type for the originating and terminating gateway, as follows:
•
•
The system keyword overrides the configuration for the dial peer, and the values from the modem-relay command in voice-service configuration mode for VoIP are used.
When using the voice service voip and modem relay nse commands on a terminating gateway to globally set up modem relay with NSEs, you must also ensure that each incoming call will be associated with a VoIP dial peer to retrieve the global fax or modem configuration. You associate calls with dial peers by using the incoming called-number command to specify a sequence of digits that incoming calls can match. You can ensure that all calls will match at least one dial peer by using the following commands:
Router(config)# dial-peer voice tag voipRouter(config-dial-peer)# incoming called-number .Examples
The following example shows Cisco modem relay configured for a specific dial peer using the G.711 mu-law codec and enabling redundancy and gateway-controlled negotiation parameters:
Router(config-dial-peer)# modem relay nse codec g711ulaw redundancy gw-controlledRelated Commands
modem relay (voice-service)
To configure modem relay over VoIP for all connections, use the modem relay command in voice-service configuration mode. To disable modem relay over VoIP for all connections, use the no form of this command.
modem relay nse [payload-type number] codec {g711ulaw | g711alaw}
[redundancy[maximum-sessions value]] gw-controlledno modem relay nse
Syntax Description
Command Default
Cisco modem relay is disabled.
Payload type: 100.Command Modes
Voice-service configuration
Command History
Usage Guidelines
Use this command to configure modem relay over VoIP. The default behavior for this command is no modem relay. Configuration of modem relay for VoIP dial peers via the modem relay dial peer configuration command overrides this voice-service command for the specific VoIP dial peer on which the dial-peer command is configured.
Use the same payload-type number for both the originating and terminating gateways.
Use the same codec type for the originating and terminating gateway, as follows:
•
•
The maximum-sessions keyword is an optional parameter for the modem relay command. This parameter determines the maximum number of redundant, simultaneous modem relay sessions. The recommended value for the maximum-sessions keyword is 16. The value can be set from 1 to 10000. The maximum-sessions keyword applies only if the redundancy keyword is used.
When using the voice service voip and modem relay nse commands on a terminating gateway to globally set up modem relay with NSEs, you must also ensure that each incoming call will be associated with a VoIP dial peer to retrieve the global fax or modem configuration. You associate calls with dial peers by using the incoming called-number command to specify a sequence of digits that incoming calls can match. You can ensure that all calls will match at least one dial peer by using the following commands:
Router(config)# dial-peer voice tag voipRouter(config-dial-peer)# incoming called-number .Examples
The following example shows Cisco modem relay enabled with NSE payload type 101 using the G.711 mu-law codec, enabling redundancy and gateway-controlled negotiation parameters:
Router(conf-voi-serv)# modem relay nse payload-type 101 codec g711ulaw redundancy maximum-sessions 1 gw-controlledRelated Commands
incoming called-number
Defines an incoming called number to match a specific dial peer.
modem relay (dial peer)
Configures modem relay on a specific VoIP dial peer.
modem relay gateway-xid
To enable in-band negotiation of compression parameters between two VoIP gateways, use the modem relay gateway-xid command in dial peer or voice-service configuration mode. To disable this function, use the no form of this command.
modem relay gateway-xid [compress {backward | both | forward | no}] [dictionary value] [string-length value]}
no modem relay gateway-xid
Syntax Description
compress1
(Optional) Direction in which data flow is compressed. For normal dialup, compression should be enabled on both directions.
You may want to disable compression in one or more directions. This is normally done during testing and perhaps for gaming applications, but not for normal dialup when compression is enabled in both directions.
•
•
•
•
dictionary value
(Optional) V.42 bis parameter that specifies characteristics of the compression algorithm. Range is from 512 to 2048. Default is 1024.
Note
string-length value
(Optional) V.42 bis parameter that specifies characteristics of the compression algorithm. Range is from 16 to 32. Default is 32.
Note
1 The compress, dictionary, and string-length arguments can be entered in any order.
Command Default
Command: enabled
Compress: both
Dictionary: 1024
String length: 32Command Modes
Dial peer configuration
Voice-service configurationCommand History
12.2(11)T
This command was introduced on the following platforms: Cisco 2600 series, Cisco 3620, Cisco 3640, Cisco 3660, Cisco 7200 series, and Cisco AS5300.
Usage Guidelines
This command enables XID negotiation for modem relay. By default it is enabled.
If this command is enabled on both VoIP gateways of a network, the gateways determine whether they need to engage in in-band negotiation of various compression parameters. The remaining keywords in this command specify the negotiation posture of this gateway in the subsequent in-band negotiation (assuming that in-band negotiation is agreed on by the two gateways).
The remaining parameters specify the negotiation posture of this gateway in the subsequent inband negotiation step (assuming inband negotiation was agreed on by the two gateways).
The compress, dictionary, and string-length keywords are digital-signal-processor (DSP)-specific and related to xid negotiation. If this command is disabled, they are all irrelevant. The application (MGCP or H.323) just passes these configured values to the DSPs, and it is the DSP that requires them.
Examples
The following example enables in-band negotiation of compression parameters on the VoIP gateway, with compression in both directions, dictionary size of 1024, and string length of 32 for the compression algorithm:
modem relay gateway-xid compress both dictionary 1024 string-length 32Related Commands
modem relay latency
To optimize the Modem Relay Transport Protocol and the estimated one-way delay across the IP network, use the modem relay latency command in dial peer or voice-service configuration mode. To disable this function, use the no form of this command.
modem relay latency value
no modem relay latency
Syntax Description
value
Estimated one-way delay across the IP network, in milliseconds. Range is from 100 to 1000. Default is 200.
Command Default
200 ms
Command Modes
Dial peer configuration
Voice-service configurationCommand History
12.2(11)T
This command was introduced on the following platforms: Cisco 2600 series, Cisco 3620, Cisco 3640, Cisco 3660, Cisco 7200 series, and Cisco AS5300.
Usage Guidelines
Use this command to adjust the retransmission timer of the Simple Packet Relay Transport (SPRT) protocol, if required, by setting the value to the estimated one-way delay (in milliseconds) across the IP network. Changing this value may affect the throughput or delay characteristics of the modem relay call. The default value of 200 does not need to be changed for most networks.
Examples
The following example sets the estimated one-way delay across the IP network to 100 ms.
Router(config-dial-peer)# modem relay latency 100Related Commands
modem relay sprt retries
To set the maximum number of times that the Simple Packet Relay Transport (SPRT) protocol tries to send a packet before disconnecting, use the modem relay sprt retries command in dial peer or voice-service configuration mode. To disable this function, use the no form of this command.
modem relay sprt retries value
no modem relay sprt retries
Syntax Description
value
Maximum number of times that the SPRT protocol tries to send a packet before disconnecting. Range is from 6 to 30. The default is 12.
Command Default
12 times
Command Modes
Dial peer configuration
Voice-service configurationCommand History
12.2(11)T
This command was introduced on the following platforms: Cisco 2600 series, Cisco 3620, Cisco 3640, Cisco 3660, Cisco 7200 series, and Cisco AS5300.
Examples
The following example sets 15 as the maximum number of times that the SPRT protocol tries to send a packet before disconnecting.
modem relay sprt retries 15Related Commands
modem relay sprt v14
To configure V.14 modem-relay parameters for packets sent by the Simple Packet Relay Transport (SPRT) protocol, use the modem relay sprt v14 command in voice service configuration mode. To disable this function, use the no form of this command.
modem relay sprt v14 [receive playback hold-time milliseconds | transmit hold-time milliseconds | transmit maximum hold-count characters]
no modem relay sprt v14
Syntax Description
Command Default
V.14 modem-relay parameters are enabled by default, using default parameter values.
Command Modes
Voice service configuration
Command History
Usage Guidelines
SPRT packets are used to reliably transport modem signals between gateways. Use the modem relay sprt v14 command under the voice service voip command to configure parameters for SPRT packet transport. The maximum size of the receive buffers is set at 500 characters, a nonprovisionable limit. Use the modem relay sprt v14 receive playback hold-time command to configure the minimum holding time before characters can be removed from the receive queue. Characters received on the PSTN or ISDN interface may be collected for a configurable collection period before being sent out on SPRT channel 3, potentially resulting in variable size SPRT packets. To configure V.14 transmit parameters for SPRT packets, use the modem relay sprt v14 transmit hold-time milliseconds and the modem relay sprt v14 transmit maximum hold-count characters commands.
Parameter changes do not take effect during existing calls; they affect new calls only.
SPRT transport channel 1 is not supported.
Use the stcapp register capability voice-port modem-relay command to specify modem relay as the transport method for a specific device.
Examples
The following example shows the receive playback hold time, transmit hold time, and transmit hold count parameters:
Router(conf-voi-serv)# modem relay sprt v14 receive playback hold-time 200Router(conf-voi-serv)# modem relay sprt v14 transmit hold-time 25Router(conf-voi-serv)# modem relay sprt v14 transmit maximum hold-count 10Related Commands
modem relay sse
To enable V.150.1 modem-relay secure calls and configure state signaling events (SSE) parameters, use the modem relay sse command in voice service configuration mode. To disable this function, use the no form of this command.
modem relay sse [redundancy] [interval milliseconds] [packet number] [retries value] [t1 milliseconds]
no modem relay sse
Syntax Description
Command Default
Modem relay mode of operation, using the SSE protocol, is enabled by default using default parameter values.
Command Modes
Voice service configuration
Command History
Usage Guidelines
Use the modem relay sse command under the voice service voip command to configure SSE parameters used to negotiate the transition from voice mode to V.150.1 modem-relay mode on the digital signal processor (DSP). Secure voice and data calls through the SCCP Telephony Control Application (STCAPP) gateway connect Secure Telephone Equipment (STE) and IP-STE endpoints using the SSE protocol, a subset of the V.150.1 standard for modem relay. SSEs, which are Real-Time Transport Protocol (RTP) encoded event messages that use payload 118, are used to coordinate transitions between secure and non-secure media states.
Use the stcapp register capability command to specify modem transport method for secure calls.
Use the modem relay sprt v14 receive playback hold-time command to configure V.14 receive parameters for Simple Packet Relay Transport (SPRT) protocol packets in V.150.1 modem relay mode.
Use the modem relay sprt v14 transmit hold-time and modem relay sprt v14 transmit maximum hold-count commands to configure SPRT transmit parameters in V.150.1 modem relay mode.
Use the mgcp modem relay voip mode sse command to enable secure V.150.1 modem relay calls on trunk-side or non-STCAPP-enabled gateways. Use the mgcp modem relay voip mode nse command to enable nonsecure modem-relay mode; by default, NSE modem-relay mode is disabled.
Examples
The following example shows SSE parameters configured to support secure calls between IP-STE and STE endpoints:
Router(config-voi-serv)# modem relay sse redundancy interval 20Router(config-voi-serv)# modem relay sse redundancy packet 4Router(config-voi-serv)# modem relay sse retries 5Router(config-voi-serv)# modem relay sse t1 1000Related Commands
monitor call application event-log
To display the event log for an active application instance in real-time, use the monitor call application event-log command in privileged EXEC mode.
monitor call application event-log {app-tag application-name {last | next} | session-id session-id [stop] | stop}
Syntax Description
Command Modes
Privileged EXEC
Command History
Usage Guidelines
This command enables dynamic event logging so that you can view events as they happen for active application instances. You can view the most recent active instance or the next new instance of a specified application, or the specified active application instance, or it stops the display. To display event logs with this command, you must enable either the call application event-log command or the
call application voice event-log command.Examples
The following example displays the event log for the next active session of the application named sample_app:
Router# monitor call application event-log app-tag generic last5:1057278146:172:INFO: Prompt playing finished successfully.5:1057278151:173:INFO: Timed out waiting for user DTMF digits, no user input.5:1057278151:174:INFO: Script received event = "noinput"5:1057278151:175:INFO: Playing prompt #1: tftp://172.19.139.145/audio/ch_welcome.au5:1057278158:177:INFO: Prompt playing finished successfully.5:1057278163:178:INFO: Timed out waiting for user DTMF digits, no user input.5:1057278163:179:INFO: Script received event = "noinput"5:1057278163:180:INFO: Playing prompt #1: tftp://172.19.139.145/audio/ch_welcome.au5:1057278170:182:INFO: Prompt playing finished successfully.5:1057278175:183:INFO: Timed out waiting for user DTMF digits, no user input.5:1057278175:184:INFO: Script received event = "noinput"5:1057278175:185:INFO: Playing prompt #1: tftp://172.19.139.145/audio/ch_welcome.au5:1057278181:187:INFO: Prompt playing finished successfully.5:1057278186:188:INFO: Timed out waiting for user DTMF digits, no user input.5:1057278186:189:INFO: Script received event = "noinput"5:1057278186:190:INFO: Playing prompt #1: tftp://172.19.139.145/audio/ch_welcome.auRelated Commands
monitor call leg event-log
To display the event log for an active call leg in real-time, use the monitor call leg event-log command in privileged EXEC mode.
monitor call leg event-log {leg-id leg-id [stop] | next | stop}
Syntax Description
leg-id leg-id
Displays the event log for the identified call leg.
next
Displays the event log for the next active call leg.
stop
(Optional) Stops the monitoring session.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
This command enables dynamic event logging so that you can view events as they happen for active voice call legs. You can view the event log for the next new call leg, or the specified active call leg, or it stops the display. To display event logs with this command, you must enable the call leg event-log command.
Examples
The following is sample output from the monitor call leg event-log next command showing the event log for the next active call leg after a PSTN incoming call was made to the gateway:
Router# monitor call leg event-log next2B:1058571679:992:INFO: Call setup indication received, called = 4085550198, calling = 52927, echo canceller = enable, direct inward dialing2B:1058571679:993:INFO: Dialpeer = 12B:1058571679:998:INFO: Digit collection2B:1058571679:999:INFO: Call connected using codec None2B:1058571688:1007:INFO: Call disconnected (cause = normal call clearing (16))2B:1058571688:1008:INFO: Call releasedRelated Commands
mrcp client session history duration
To set the maximum number of seconds for which history records for Media Resource Control Protocol (MRCP) sessions are stored on the gateway, use the mrcp client session history duration command in global configuration mode. To reset to the default, use the no form of this command.
mrcp client session history duration seconds
no mrcp client session history duration
Syntax Description
seconds
Maximum time, in seconds, for which MRCP history records are stored. Range is from 0 to 99999999. The default is 3600 (1 hour). If 0 is configured, no MRCP records are stored on the gateway.
Command Default
3600 seconds (1 hour)
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command affects the number of records that are displayed when the show mrcp client session history command is used.
Active MRCP sessions are not affected by this command.
Examples
The following example sets the maximum amount of time for which MRCP history records are stored to 2 hours (7200 seconds):
Router(config)# mrcp client session history duration 7200Related Commands
show mrcp client session history
Displays information about past MRCP client sessions that are stored on the gateway.
mrcp client session history records
To set the maximum number of records of Media Resource Control Protocol (MRCP) client history that the gateway can store, use the mrcp client session history records command in global configuration mode. To reset to the default, use the no form of this command.
mrcp client session history records number
no mrcp client session history records
Syntax Description
number
Maximum number of MRCP history records to save. The maximum value is platform-specific. The default is 50. If 0 is configured, no MRCP records are stored on the gateway.
Command Default
50 records
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command affects the number of records that are displayed when the show mrcp client session history command is used.
Active MRCP sessions are not affected by this command.
Examples
The following example sets the maximum number of MRCP records to 30:
Router(config)# mrcp client history records 30Related Commands
show mrcp client session history
Displays information about past MRCP client sessions that are stored on the gateway.
mrcp client statistics enable
To enable Media Resource Control Protocol (MRCP) client statistics to be displayed, use the mrcp client statistics enable command in global configuration mode. To disable display, use the no form of this command.
mrcp client statistics enable
no mrcp client statistics enable
Syntax Description
This command has no arguments or keywords.
Command Default
MRCP client statistics are disabled.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command enables MRCP client statistics to be displayed when the show mrcp client statistics hostname command is used. If this command is not enabled, client statistics cannot be displayed for any host when the show mrcp client statistics hostname command is used.
Examples
The following example enables MRCP statistics to be displayed:
Router(config)# mrcp client statistics enableRelated Commands
show mrcp client statistics hostname
Displays statistics about MRCP sessions for a specific MRCP host.
mrcp client timeout connect
To set the number of seconds allowed for the router to establish a TCP connection to a Media Resource Control Protocol (MRCP) server, use the mrcp client timeout connect command in global configuration mode. To reset to the default, use the no form of this command.
mrcp client timeout connect seconds
no mrcp client timeout connect
Syntax Description
seconds
Amount of time, in seconds, the router waits to connect to the server before timing out. Range is 1 to 20.
Command Default
3 seconds
Command Modes
Global configuration (global)
Command History
12.2(11)T
This command was introduced.
12.4(15)T
This command was modified to support MRCP version 2 (MRCP v2).
Usage Guidelines
This command determines when the router abandons its attempt to connect to an MRCP server and declares a timeout error, if a connection cannot be established after the specified number of seconds.
Examples
The following example sets the connection timeout to 10 seconds:
Router(config)# mrcp client timeout connect 10mrcp client timeout message
To set the number of seconds that the router waits for a response from a Media Resource Control Protocol (MRCP) server, use the mrcp client timeout message command in global configuration mode. To reset to the default, use the no form of this command.
mrcp client timeout message seconds
no mrcp client timeout message
Syntax Description
seconds
Amount of time, in seconds, the router waits for a response from the server after making a request. Range is 1 to 20.
Command Default
3 seconds
Command Modes
Global configuration (config)
Command History
12.2(11)T
This command was introduced.
12.4(15)T
This command was modified to support MRCP version 2 (MRCP v2).
Usage Guidelines
This command sets the amount of time the router waits for the MRCP server to respond to a request before declaring a timeout error.
Examples
The following example sets the request timeout to 10 seconds:
Router(config)# mrcp client timeout message 10mta receive aliases
To specify a hostname accepted as a Simple Mail Transfer Protocol (SMTP) alias for off-ramp faxing, use the mta receive aliases command in global configuration mode. To disable the alias, use the no form of this command.
mta receive aliases string
no mta receive aliases string
Syntax Description
Command Default
Enabled with an empty string
Command Modes
Global configuration
Command History
Usage Guidelines
This command creates an accept or reject alias list. The first alias is used by the mailer to identify itself in SMTP banners and when generating its own RFC 822 Received: header.
Note
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example specifies the host name "seattle-fax-offramp.example.com" as the alias for the SMTP server:
mta receive aliases seattle-fax-offramp.example.comThe following example specifies IP address 172.16.0.0 as the alias for the SMTP server:
mta receive aliases [172.16.0.0]Related Commands
mta receive generate
Note
To specify the type of fax delivery response message that a T.37 fax off-ramp gateway should return, use the mta receive generate command in global configuration mode. To return to the default, use the no form of this command.
mta receive generate [mdn | permanent-error]
no mta receive generate [mdn | permanent-error]
Syntax Description
Command Default
MDNs are not generated and standard SMTP status messages are returned to the SMTP client with error classifications of permanent or transient.
Command Modes
Global configuration
Command History
Usage Guidelines
When the mdn keyword is used to enable MDN on a sending device, a flag is inserted in the off-ramp message e-mail header, requesting that the receiving device generate an MDN. The MDN is then returned to the sender when the e-mail message that contains the fax image is opened. Use this command to enable the receiving device—the off-ramp gateway—to process the response MDN.
Depending on the configuration, usage, and features of the mailers used at a site, it might be desirable to enable or disable MDN generation. Specifications for MDN are described in RFC 2298. Delivery status notification (DSN) generation cannot be disabled.
The permanent-error keyword directs the T.37 off-ramp fax gateway to classify all fax delivery errors as permanent so that they are forwarded in a DSN with descriptive error codes to the originating MTA. The descriptive error codes allow the MTA to control fax operations directly because the MTA can examine the error codes and make decisions about how to proceed with each fax (whether to retry or cancel, for example).
If this command is not used, the default is to return standard SMTP status messages to SMTP clients using both permanent and transient error classifications.
Examples
The following example allows a T.37 off-ramp gateway to process response MDNs:
Router(config)# mta receive generate mdnThe following example directs a T.37 off-ramp gateway to classify all fax delivery errors as permanent and forward the errors and descriptive text using SMTP DSNs to the MTA:
Router(config)# mta receive generate permanent-errorRelated Commands
mta receive generate-mdn
Note
To specify that the off-ramp gateway process a response message disposition notification (MDN) from a Simple Mail Transfer Protocol (SMTP) server, use the mta receive generate-mdn command in global configuration mode. To disable MDN generation, use the no form of this command.
mta receive generate-mdn
no mta receive generate-mdn
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
When MDN is enabled on a sending device, a flag is inserted in the off-ramp message e-mail header, requesting that the receiving device generate the MDN and return that message to the sender when the e-mail message that contains the fax image is opened. Use this command to enable the receiving device—the off-ramp gateway—to process the response MDN.
Depending on the configuration, usage, and features of the mailers used at a site, it might be desirable to enable or disable MDN generation. Specifications for MDN are described in RFC 2298. Delivery status notification (DSN) generation cannot be disabled.
This command applies to off-ramp store-and-forward fax functions.
Examples
The following example enables the receiving device to generate MDNs:
mta receive generate-mdnRelated Commands
mta receive maximum-recipients
To specify the maximum number of simultaneous recipients for all Simple Mail Transfer Protocol (SMTP) connections, use the mta receive maximum-recipients command in global configuration mode. To reset to the default, use the no form of this command.
mta receive maximum-recipients number
no mta receive maximum-recipients
Syntax Description
number
Maximum number of simultaneously recipients for all SMTP connections. Range is from 0 to 1024. The default is 0.
Command Default
0 recipients
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to configure the maximum number of resources that you want to allocate for fax usage at any one time. You can use this command to limit the resource usage on the gateway. When the value for the number argument is set to 0, no new connections can be established. Which is particularly useful when one is preparing to shut down the system.
This command applies to off-ramp store-and-forward fax functions.
The default of 0 recipients means that incoming mail messages are not accepted; therefore, no faxes are sent by the off-ramp gateway.
Note
Examples
The following example sets the maximum number of simultaneous recipients for all SMTP connections to 10:
mta receive maximum-recipients 10Related Commands
mta send filename
To specify a filename for a TIFF file attached to an e-mail, use the mta send filename command in global configuration mode. To disable the configuration after the command has been used, use the no form of this command.
mta send filename [string] [date]
no mta send filename
Syntax Description
Command Default
The formatted filename for TIFF attachments is "Cisco_fax.tif"
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to specify the filename for a TIFF file attached to an e-mail.
Examples
The following example specifies a formatted filename of "abcd.tif" for the TIFF attachment:
Router(config)# mta send filename abcdThe following example specifies a formatted filename and extension of "abcd.123" for the TIFF attachment:
Router(config)# mta send filename abcd.123The following example specifies a formatted filename "abcd_today's date" (so, for July 4, 2002, the filename would be "abcd_20020704.tif") for the TIFF attachment:
Router(config)# mta send filename abcd dateThe following example specifies a formatted filename and extension of "abcd_today's date.123" (so, for July 4, 2002, the filename would be "abcd_20020704.123") for the TIFF attachment:
Router(config)# mta send filename abcd.123 dateRelated Commands
mta send mail-from
To specify a mail-from address (also called the RFC 821 envelope-from address or the return-path address), use the mta send mail-from command in global configuration mode. To remove this return-path information, use the no form of this command.
mta send mail-from {hostname string | username string | username $s$}
no mta send mail-from {hostname string | username string | username $s$}
Syntax Description
Command Default
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to designate the sender of the fax TIFF attachment, which is equivalent to the return path in an e-mail message. If the mail-from address is blank, the postmaster address, configured with the mta send postmaster command, is used.
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example specifies that the mail-from username information is derived from the calling number of the sender:
mta send mail-from username $s$Related Commands
mta send origin-prefix
To add information to an e-mail prefix header, use the mta send origin-prefix command in global configuration mode. To remove the defined string, use the no form of this command.
mta send origin-prefix string
no mta send origin-prefix string
Syntax Description
string
Text string to add comments to the e-mail prefix header. If this string contains more than one word, the string value should be enclosed within quotation marks ("abc xyz").
Command Default
Null string
Command Modes
Global configuration
Command History
Usage Guidelines
Store-and-forward fax provides the slot and port number from which an e-mail comes. In the e-mail prefix header information, use this command to define a text string to be added to the front of the e-mail prefix header information. This text string is a prefix string that is added with the modem port and slot number and passed in the originator_comment field of the esmtp_client_engine_open() call. Eventually, this text ends up in the received header field of the fax-mail message; for example:
Received (test onramp Santa Cruz slot1 port15) by router-5300.cisco.com for <test-test@cisco.com> (with Cisco NetWorks); Fri, 25 Dec 1998 001500 -0800Using the command mta send origin-prefix dog causes the received header to contain the following information:
Received (dog, slot 3 modem 8) by as5300-sj.example.com ....This command applies to on-ramp store-and-forward fax functions.
Examples
The following example adds information to the e-mail prefix header:
mta send origin-prefix "Cisco-Powered Fax System"Related Commands
mta send postmaster
To specify the mail server postmaster account to which an e-mail message should be delivered if it cannot be delivered to the intended destination, use the mta send postmaster command in global configuration mode. To remove the specification, use the no form of this command.
mta send postmaster e-mail-address
no mta send postmaster e-mail-address
Syntax Description
e-mail-address
Address of the mail server postmaster account to which an e-mail message should be delivered if it cannot be delivered to its intended destination.
Command Default
No e-mail destination is defined
Command Modes
Global configuration
Command History
Usage Guidelines
If you have configured a router to generate delivery status notifications (DSNs) and message disposition notifications (MDNs), but you have not configured the sender information (using the mta send mail-from command) or the Simple Mail Transfer Protocol (SMTP) server, DSNs and MDNs are delivered to the e-mail address determined by this command.
It is recommended that an address such as "fax-administrator@example.com" be used to indicate fax responsibility. In this example, fax-administrator is aliased to the responsible person. At some sites, this could be the same person as the e-mail postmaster, but most likely is a different person with a different e-mail address.
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example configures the e-mail address "fax-admin@example.com" as the sender for all incoming faxes. Thus, any returned DSNs are delivered to "fax-admin@example.com" if the mail-from field is blank.
mta send postmaster fax-admin@example.comRelated Commands
mta send return-receipt-to
To specify the address to which message disposition notifications (MDNs) are sent, use the mta send return-receipt-to command in global configuration mode. To remove the address, use the no form of this command.
mta send return-receipt-to {hostname string | username string | $s$}
no mta send return-receipt-to {hostname string | username string | $s$}
Syntax Description
Command Default
No address is defined
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to specify where you want MDNs to be sent after a fax-mail is opened.
Note
Note
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example configures "xyz" as the user and "server.com" as the SMTP mail server to which MDNs are sent:
mta send return-receipt-to hostname server.commta send return-receipt-to username xyzRelated Commands
mta send server
To specify a destination mail server or servers, use the mta send server command in global configuration mode. To remove the specification, use the no form of this command.
mta send server {hostname | ip-address}
no mta send server {hostname | ip-address}
Syntax Description
hostname
Hostname of the destination mail server.
ip-address
IP address of the destination mail server.
Command Default
IP address defined as 0.0.0.0
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to provide a backup destination server in case the first configured mail server is unavailable. This command is not intended to be used for load distribution.
You can configure up to ten different destination mail servers using this command. If you configure more than one destination mail server, the router attempts to contact the first mail server configured. If that mail server is unavailable, it contacts the next configured destination mail server.
DNS mail exchange (MX) records are not used to look up host names provided to this command.
Note
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example defines the mail servers "xyz.example.com" and "abc.example.com" as the destination mail servers:
mta send server xyz.example.commta send server abc.example.comRelated Commands
mta send subject
To specify the subject header of an e-mail message, use the mta send subject command in global configuration mode. To remove the string, use the no form of this command.
mta send subject string
no mta send subject string
Syntax Description
Command Default
Null string
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to on-ramp store-and-forward fax functions.
Note
Examples
The following example defines the subject header of an e-mail message as "fax attachment":
mta send subject fax attachmentRelated Commands
music-threshold
To specify the threshold for on-hold music for a specified voice port, use the music-threshold command in voice-port configuration mode. To disable this feature, use the no form of this command.
music-threshold decibels
no music-threshold decibels
Syntax Description
decibels
On-hold music threshold, in decibels (dB). Range is from -70 to -10 (integers only). The default is -38 dB.
Command Default
-38 dB
Command Modes
Voice-port configuration
Command History
Usage Guidelines
Use this command to specify the decibel level of music played when calls are put on hold. This command tells the firmware to pass steady data above the specified level. It affects the operation of voice activity detection (VAD) only when the voice port is receiving voice.
If the value for this command is set too high, VAD interprets music-on-hold as silence, and the remote end does not hear the music. If the value for this command is set too low, VAD compresses and passes silence when the background is noisy, creating unnecessary voice traffic.
Examples
The following example sets the decibel threshold to -35 for the music played when calls are put on hold:
voice port 0:Dmusic-threshold -35The following example sets the decibel threshold to -35 for the music played when calls are put on hold on a Cisco 3600 series router:
voice-port 1/0/0music-threshold -35mwi
To enable message-waiting indication (MWI) for a specified voice port, use the mwi command in voice-port configuration mode. To disable MWI for a specified voice port, use the no form of this command.
mwi
no mwi
Syntax Description
This command has no arguments or keywords.
Command Default
MWI is disabled by default.
Command Modes
Voice-port configuration
Command History
Usage Guidelines
Use the mwi command to enable MWI functionality on the voice port and the mwi-server command to configure the voice-mail server to send MWI notifications. If the voice port does not have MWI enabled, the voice gateway returns a 481 Call Leg/Transaction Does Not Exist message to the voice-mail server. If there are multiple dial peers associated with the same FXS voice port, multiple subscriptions are sent to the voice-mail server.
Examples
The following example shows MWI set on a voice port.
voice-port 2/2cptone usmwiRelated Commands
mwi-server
To specify voice-mail server settings on a voice gateway or user agent (UA), use the mwi-server command in SIP UA configuration mode. To reset to the default, use the no form of this command.
mwi-server {ipv4:destination-address | dns:host-name} [expires seconds] [port port]
[transport {tcp | udp}] [unsolicited]no mwi-server
Syntax Description
Command Default
Voice-mail server settings are disabled by default.
Command Modes
SIP UA configuration
Command History
Usage Guidelines
Using the mwi-server command a user can request that the UA subscribe to a voice-mail server requesting notification of mailbox status. When there is a status change, the voice-mail server notifies the UA. The UA then indicates to the user that there is a change in mailbox status with an MWI tone when the user takes the phone off-hook.
Only one voice-mail server can be configured per voice gateway. Use the mwi-server command with the mwi command to enable MWI functionality on the voice port. If the voice port does not have MWI enabled, the voice gateway returns a 481 Call Leg/Transaction Does Not Exist message to the voice-mail server. MWI status is always reset after a router reload.
Examples
The following example specifies voice-mail server settings on a voice gateway. The example includes the unsolicited keyword, enabling the voice-mail server to send a SIP notification message to the voice gateway or UA if the mailbox status changes.
sip-uamwi-server dns:test.cisco.com expires 60 port 5060 transport udp unsolicitedFor unsolicited Notify, the Contact header derives the voice-mail server address. If the unsolicited MWI message does not contain a Contact header, configure the voice-mail server on the gateway with the following special syntax to accept MWI Notify messages.
sip-uamwi-server ipv4:255.255.255.255 unsolicitedRelated Commands
mwi
Enables MWI for a specified voice port.
sip-us
Enables SIP UA configuration mode.
voice-port
Enters voice-port configuration mode.
