-
Cisco IOS Voice Command Reference
-
About Cisco IOS Software Documentation
-
Using Cisco IOS Software
-
New and Modified Commands
-
Commands: A
-
Commands: B
-
Commands: cache --> call fallback jitter-probe num-packets
-
Commands: call fallback jitter-probe precedence --> ces connect
-
Commands: ces initial-delay --> codec preference
-
Commands: comfort-noise --> customer-id
-
Commands: default (MGCP profile) through direct-inward-dial
-
Commands: E
-
Commands: F
-
Commands: G
-
Commands: H
-
Commands: I
-
Commands: K
-
Commands: L
-
Commands: M
-
Commands: N
-
Commands: O
-
Commands: P through Q
-
Commands: R
-
Commands: SCCP through sgcp tse payload
-
Commands: show aal2 profile through show controllers timeslots
-
Commands: show controllers voice through show mgcp
-
Commands: show mgcp connection through show ss7 sm session
-
Commands: show ss7 sm set through shutdown (voice-port)
-
Commands: signal through suppress
-
Commands: T
-
Commands: U
-
Commands: V through W
-
Commands: Z
-
Feedback
Table Of Contents
max-conferences (telephony-service)
max-ephones (telephony-service)
mgcp modem passthrough voip redundancy
mgcp modem relay voip gateway-xid
mgcp modem relay voip sprt retries
mgcp quarantine persistent-event disable
mmoip aaa method fax accounting
mmoip aaa method fax authentication
mmoip aaa receive-accounting enable
mmoip aaa receive-authentication enable
mmoip aaa receive-id secondary
mmoip aaa send-accounting enable
mmoip aaa send-authentication enable
modem passthrough (voice-service)
mrcp client session history duration
mrcp client session history records
mta receive maximum-recipients
mwi expires (telephony-service)
mwi sip-server (telephony-service)
Cisco IOS Voice Commands:
M
This chapter contains commands to configure and maintain Cisco IOS voice applications. The commands are presented in alphabetical order. Some commands required for configuring voice may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.
For detailed information on how to configure these applications and features, refer to the Cisco IOS Voice Configuration Guide.
mac-address (ephone)
To configure the MAC address of a Cisco IP phone, use the mac-address command in ephone configuration mode. To disable the MAC address of a Cisco IP phone, use the no form of this command.
mac-address mac-address
no mac-address mac-address
Syntax Description
mac-address
A specific Cisco IP phone. The MAC address is typically found on a sticker located on the bottom of a Cisco IP phone.
Defaults
No default behavior or values
Command Modes
Ephone configuration
Command History
Usage Guidelines
Use this command to configure the MAC address of a specific Cisco IP phone to uniquely identify the Cisco IP phone. The MAC address of each Cisco IP phone is printed on a sticker and placed under the phone.
Examples
The following example configures the actual MAC address CCFBA.321B.96FA for a Cisco IP phone:
Router(config-ephone)# mac-address CFBA.321B.96FARelated Commands
max1 lookup
To enable Domain Name System (DNS) lookup for a new call-agent address when the suspicion threshold value is reached, use the max1 lookup command in MGCP profile configuration mode. To disable lookup, use the no form of this command.
max1 lookup
no max1 lookup
Syntax Description
This command has no arguments or keywords.
Defaults
Lookup is enabled.
Command Modes
MGCP profile configuration
Command History
Usage Guidelines
This command is used when configuring values for a Media Gateway Control Protocol (MGCP) profile.
Call-agent redundancy can be provided when call agents are identified by DNS name rather than by IP address in the call-agent command, because each DNS name can have more than one IP address associated with it.
When the active call agent does not respond to a message from the media gateway, the gateway tests to determine whether the call agent is out of service. The gateway retransmits the message to the call agent for the number of times specified in the max1 retries command; this is known as the suspicion threshold. If there is no response and the max1 lookup command is enabled, the gateway examines the DNS lookup table to find the IP address of another call agent. If a second call agent is listed, the gateway retransmits the message to the second call agent until a response is received or the number of retries specified in the max1 retries command is reached.
This process is repeated for each IP address in the DNS table until the final address is reached. For the final address, the number of retries is specified by the max2 retries command; this number is known as the disconnect threshold. If the number of retries specified in the max2 retries command is reached and there is still no response and the max2 lookup command is enabled, the gateway performs one final DNS lookup. If any new IP addresses have been added, the gateway starts the retransmission process again. Otherwise, the gateway places the endpoint in a disconnected state.
Examples
The following example enables DNS lookup and sets the suspicion retransmission counter to 7:
Router(config)# mgcp profile nyc-caRouter(config-mgcp-profile)# call-agent igloo.northpole.netRouter(config-mgcp-profile)# max1 lookupRouter(config-mgcp-profile)# max1 retries 7Related Commands
max1 retries
To set the Media Gateway Control Protocol (MGCP) suspicion threshold value (the number of attempts to retransmit messages to a call agent address before performing a new lookup for retransmission), use the max1 retries command in MGCP profile configuration mode. To reset to the default, use the no form of this command.
max1 retries number
no max1 retries
Syntax Description
Defaults
5 attempts
Command Modes
MGCP profile configuration
Command History
Usage Guidelines
This command is used when configuring values for an MGCP profile.
Call-agent redundancy can be provided when call agents are identified by Domain Name System (DNS) name rather than by IP address in the call-agent command, because each DNS name can have more than one IP address associated with it.
When the active call agent does not respond to a message from the media gateway, the gateway tests to determine whether the call agent is out of service. The gateway retransmits the message to the call agent for the number of times specified in the max1 retries command; this is known as the suspicion threshold. If there is no response and the max1 lookup command is enabled, the gateway examines the DNS lookup table to find the IP address of another call agent.
If a second call agent is listed, the gateway retransmits the message to the second call agent until a response is received or the number of retries specified in the max1 retries command is reached. This process is repeated for each IP address in the DNS table until the final address is reached. For the final address, the number of retries is specified by the max2 retries command; this is known as the disconnect threshold. If the number of retries specified in the max2 retries command is reached and there is still no response and the max2 lookup command is enabled, the gateway performs one final DNS lookup. If any new IP addresses have been added, the gateway starts the retransmission process again. Otherwise, the gateway places the endpoint in a disconnected state.
Examples
The following example enables DNS lookup and sets the suspicion retransmission counter to 7:
Router(config)# mgcp profile nyc-caRouter(config-mgcp-profile)# call-agent igloo.northpole.netRouter(config-mgcp-profile)# max1 lookupRouter(config-mgcp-profile)# max1 retries 7Related Commands
max2 lookup
To enable Domain Name System (DNS) lookup for a new call-agent address after the disconnect threshold timeout value is reached, use the max2 lookup command in MGCP profile configuration mode. To disable DNS lookup, use the no form of this command.
max2 lookup
no max2 lookup
Syntax Description
This command has no arguments or keywords.
Defaults
Lookup is enabled.
Command Modes
MGCP profile configuration
Command History
Usage Guidelines
This command is used when configuring values for a Media Gateway Control Protocol (MGCP) profile.
Call-agent redundancy can be provided when call agents are identified by DNS name rather than by IP address in the call-agent command, because each DNS name can have more than one IP address associated with it.
When the active call agent does not respond to a message from the media gateway, the gateway tests to determine whether the call agent is out of service. The gateway retransmits the message to the call agent for the number of times specified in the max1 retries command; this is known as the suspicion threshold. If there is no response and the max1 lookup command is enabled, the gateway examines the DNS lookup table to find the IP address of another call agent. If a second call agent is listed, the gateway retransmits the message to the second call agent until a response is received or the number of retries specified in the max1 retries command is reached.
This process is repeated for each IP address in the DNS table until the final address is reached. For the final address, the number of retries is specified by the max2 retries command; this is known as the disconnect threshold. If the number of retries specified in the max2 retries command is reached and there is still no response and the max2 lookup command is enabled, the gateway performs one final DNS lookup. If any new IP addresses have been added, the gateway starts the retransmission process again. Otherwise, the gateway places the endpoint in a disconnected state.
Examples
The following example enables DNS lookup and sets the disconnect retransmission counter to 9:
Router(config)# mgcp profile nyc-caRouter(config-mgcp-profile)# call-agent ca1@exp.example.comRouter(config-mgcp-profile)# max2 lookupRouter(config-mgcp-profile)# max2 retries 9Related Commands
max2 retries
To set the Media Gateway Control Protocol (MGCP) disconnect threshold value (the number of attempts to retransmit messages to a call agent address before performing a new lookup for further retransmission), use the max2 retries command in MGCP profile configuration mode. To disable the disconnect threshold or to return the number of retries to the default, use the no form of this command.
max2 retries number
no max2 retries
Syntax Description
Defaults
7 attempts
Command Modes
MGCP profile configuration
Command History
Usage Guidelines
This command is used when configuring values for an MGCP profile.
Call-agent redundancy can be provided when call agents are identified by Domain Name System (DNS) name rather than by IP address in the call-agent command, because each DNS name can have more than one IP address associated with it.
When the active call agent does not respond to a message from the media gateway, the gateway tests to determine whether the call agent is out of service. The gateway retransmits the message to the call agent for the number of times specified in the max1 retries command; this is known as the suspicion threshold. If there is no response and the max1 lookup command is enabled, the gateway examines the DNS lookup table to find the IP address of another call agent. If a second call agent is listed, the gateway retransmits the message to the second call agent until a response is received or the number of retries specified in the max1 retries command is reached.
This process is repeated for each IP address in the DNS table until the final address is reached. For the final address, the number of retries is specified by the max2 retries command; this is known as the disconnect threshold. If the number of retries specified in the max2 retries command is reached and there is still no response and the max2 lookup command is enabled, the gateway performs one final DNS lookup. If any new IP addresses have been added, the gateway starts the retransmission process again. Otherwise, the gateway places the endpoint in a disconnected state.
Examples
The following example sets the disconnect retransmission counter to 9:
Router(config)# mgcp profile nyc-caRouter(config-mgcp-profile)# call-agent igloo.northpole.netRouter(config-mgcp-profile)# max2 retries 9Related Commands
max-calls
To set the maximum number of calls that a trunk group can handle, use the max-calls command in trunk group configuration mode. To reset to the default, use the no form of this command.
max-calls {any | data | voice} number [direction [in | out]]
no max-calls {any | data | voice} number [direction [in | out]]
Syntax Description
Defaults
No limit when the command is not set.
Command Modes
Trunk group configuration
Command History
Usage Guidelines
Use this command to set the maximum number of calls to be handled by the trunk group. If the command is not set the maximum is infinite.
If the maximum is reached, the trunk group becomes unavailable for more calls. When the number of calls falls below the maximum, the trunk group will accept more calls.
Examples
The following example assigns a maximum number of 500 calls of any type to trunk group gw15:
Router(config)# trunk group gw15Router(config-trunk-group)# max-calls any 500The following example assigns a maximum of 200 data calls and 750 voice calls to trunk group 32:
Router(config)# trunk group 32Router(config-trunk-group)# max-calls data 200Router(config-trunk-group)# max-calls voice 750Related Commands
show trunk group
Displays the configuration of one or more trunk groups.
trunk group
Initiates a trunk group definition.
max-conferences (telephony-service)
To set the maximum number of three-party conferences simultaneous supported by a router, use the max-conferences command in telephony-service configuration mode. To reset to the default, use the no form of this command.
max-conferences max-conference-numbers
no max-conferences max-conference-numbers
Syntax Description
Defaults
Half of the maximum number of simultaneous three-party conferences for each platform
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
This command supports three-party conferences for local and on-net calls only when all conference participants are using G.711. Conversion between G.711 u-law and a-law is supported. Mixing of the media streams is supported by the Cisco IOS processor. The maximum number of simultaneous conferences is limited to the platform-specific maximum.
Examples
The following example sets the maximum number of conferences for a Cisco IP phone to 4:
Router(config)# telephony-serviceRouter(config-telephony-service)# max-conferences 4Related Commands
telephony-service
Enables Cisco IOS Telephony Service and enters telephony-service configuration mode.
max-conn
To specify the maximum number of connections for a particular Multimedia Mail over IP (MMoIP) or plain old telephone service (POTS) dial peer, use the max-conn command in dial-peer configuration mode. To set an unlimited number of connections for this dial peer, use the no form of this command.
max-conn number
no max-conn
Syntax Description
number
Maximum number of connections for this dial peer. Range is from 1 to 2147483647. Default is an unlimited number of connections.
Defaults
The no form of this command is the default, meaning an unlimited number of connections
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use this command to define the maximum number of connections used simultaneously to send fax-mail. This command applies to off-ramp store-and-forward fax functions.
Examples
The following example configures a maximum of 5 connections for MMoIP dial peer 10:
dial-peer voice 10 voipmax-conn 5Related Commands
mta receive maximum-recipients
Specifies the maximum number of recipients for all SMTP connections.
max-connection
To set the maximum number of simultaneous connections to be used for communication with a settlement provider, use the max-connection command in settlement configuration mode. To reset to the default, use the no form of this command.
max-connection number
no max-connection number
Syntax Description
Defaults
10 connections
Command Modes
Settlement configuration
Command History
Examples
The following command sets the maximum number of simultaneous connections to 10:
settlement 0max-connection 10Related Commands
max-dn (cm-fallback)
To set the maximum number of directory numbers (DN) or virtual voice ports that can be supported by a router, use the max-dn command in call-manager-fallback configuration mode. To reset to the default, use the no form of this command.
max-dn max-directory-numbers
no max-dn
Syntax Description
Defaults
0 directory numbers
Command Modes
Call-manager-fallback configuration
Command History
Usage Guidelines
The max-dn command limits the number of Cisco IP phone directory numbers or virtual voice ports available on the router.
Note
You can increase the directory numbers to the maximum allowable number; but after the maximum allowable number is configured, you cannot reduce the limit of the directory numbers without rebooting the router.
Examples
The following example sets the maximum number of directory numbers or virtual voice ports to 12:
Router(config)# call-manager-fallbackRouter(config-cm-fallback)# max-dn 12Related Commands
call-manager-fallback
SRS Telephony feature support and enters call-manager-fallback configuration mode.
max-dn (telephony-service)
To set the maximum number of directory numbers that can be supported by a router, use the max-dn command in telephony-service configuration mode. To reset to the default, use the no form of this command.
max-dn max-directory-numbers
no max-dn
Syntax Description
max-directory-numbers
Maximum number of extensions (ephone-dns) to allow in the Cisco CME system. The maximum you can set depends on the software version, router platform, and amount of memory that you have installed. The default is 0.
For the maximum number of ephone-dns and recommended memory for each platform, see the Cisco CallManager Express Supported Firmware, Platforms, Memory, and Voice Products for your Cisco CME version.
Defaults
0 directory numbers
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
The max-dn command limits the number of extensions (ephone-dns) available in a Cisco CME system. The maximum number of ephone-dns that you can create depends on the software version, router platform, and amount of memory that you have installed. For the maximum number of ephone-dns and recommended memory for each platform, see the Cisco CallManager Express Supported Firmware, Platforms, Memory, and Voice Products for your Cisco CME version.
Note
Examples
The following example sets the maximum number of directory numbers to 12:
Router(config)# telephony-serviceRouter(config-telephony-service)# max-dn 12Related Commands
max-ephones (cm-fallback)
To configure the maximum number of Cisco IP phones that can be supported by a router, use the max-ephones command in call-manager-fallback configuration mode. To reset to the default, use the no form of this command.
max-ephones max-phones
no max-ephones
Syntax Description
Defaults
0 IP Phones (allocated)
Command Modes
Call-manager-fallback configuration
Command History
Usage Guidelines
The max-ephones command limits the number of Cisco IP phones (ephones) available. The maximum number supported by a router is platform- and version-dependent. Use CLI help to determine the maximum number of ephones you can set using this command, as shown in this example:
Router(config-telephony-service)# max-ephones ?<1-48> Maximum phones to support
Note
Examples
The following example sets the maximum number to 24 Cisco IP phones for a Cisco router:
Router(config)# call-manager-fallbackRouter(config-cm-fallback)# max-ephones 24Related Commands
call-manager-fallback
SRS Telephony feature support and enters call-manager-fallback configuration mode.
max-ephones (telephony-service)
To configure the maximum number of Cisco IP phones that can be supported by a router, use the max-ephones command in telephony-service configuration mode. To reset to the default, use the no form of this command.
max-ephones max-phones
no max-ephones
Syntax Description
Defaults
0 phones
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
The max-ephones command limits the number of Cisco IP phones supported on the router.
Note
Examples
The following example sets the maximum number of 24 of Cisco IP phones for a Cisco router.
Router(config)# telephony-serviceRouter(config-telephony-service)# max-ephones 24Related Commands
max-forwards
To set the maximum number of proxy or redirect servers that can forward the request, use the max-forwards command in SIP user agent configuration mode. To reset to the default, use the no form of this command.
max-forwards number
no max-forwards
Syntax Description
Defaults
6 hops
Command Modes
SIP user agent configuration
Command History
Usage Guidelines
To reset this command to the default value, you can also use the default command.
Examples
The following is an example of setting the number of forwarding requests to proxy or redirect servers:
sip-uamax-forwards 2Related Commands
max-redirects
To set the maximum number of redirect servers that the user agent allows, use the max-redirects command in dial-peer configuration mode. To reset to the default, use the no form of this command.
max-redirects number
no max-redirects
Syntax Description
Maximum number of redirect servers that a call can traverse. Range is from 1 to 10. The default is 1.
Defaults
1 redirect
Command Modes
Dial-peer configuration
Command History
Examples
The following is an example of setting the maximum number of redirect servers that the user agent allows:
dial-peer voice 102 voipmax-redirects 2Related Commands
dial-peer voice
Enters dial-peer configuration mode and specifies the method of voice-related encapsulation.
mdn
To request that a message disposition notification (MDN) be generated when a message is processed (opened), use the mdn command in dial-peer configuration mode. To disable generation of an MDN, use the no form of this command.
mdn
no mdn
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Message disposition notification is an e-mail message that is generated and sent to the sender when the message is opened by the receiver. Use this command to request that an e-mail response message be sent to the sender when the e-mail that contains the fax TIFF image has been opened.
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example requests that a message disposition notification be generated by the recipient:
dial-peer voice 10 mmoipmdnRelated Commands
mta receive generate-mdn
Specifies that the off-ramp gateway process a response MDN from an SMTP server.
mta send return-receipt-to
Specifies the address to which MDNs are sent.
member (dial peer cor list)
See the Cisco IOS Dial Technologies Command Reference, Release 12.3 for a description of the member (dial peer cor list) command.
method
To set a specific accounting method list, use the method command in gateway accounting AAA configuration mode.
method acctMethListName
Syntax Description
Defaults
H.323 is the default accounting method list.
Command Modes
Gateway accounting AAA configuration
Command History
12.2(11)T
This command was introduced on the following platforms: Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
Usage Guidelines
•
•
•
Examples
The following example uses the method list named "klz_aaa6" that was previously defined using the AAA commands.
aaa new-model!aaa group server radius sg6server 1.6.30.70 auth-port 1708 acct-port 1709!aaa authentication login klz_aaa6 group sg6! klz_aaa6 is defined as the method list name.aaa authorization exec klz_aaa6 group sg6aaa accounting connection klz_aaa6 start-stop group sg6!gw-accounting aaamethod klz_aaa6! The same method list named klz_aaa6 is used.Related Commands
aaa accounting
Enables accounting of requested services for billing or security purposes.
gw-accounting aaa
Enables VoIP gateway accounting.
mgcp
To allocate resources for the Media Gateway Control Protocol (MGCP) and start the MGCP daemon, use the mgcp command in global configuration mode. To terminate all calls, release all allocated resources, and stop the MGCP daemon, use the no form of this command.
mgcp [port]
no mgcp
Syntax Description
port
(Optional) User Datagram Protocol (UDP) port for the MGCP gateway. Range is from 1025 to 65535. The default is UDP port 2427.
Defaults
UDP port 2427
Command Modes
Global configuration
Command History
Usage Guidelines
Once you start the MGCP daemon using the mgcp command, you can suspend it (for example, for maintenance) by using the mgcp block-newcalls command. When you are ready to resume normal MGCP operations, use the no mgcp block-newcalls command. Use the no mgcp command only if you intend to terminate all MGCP applications and protocols.
When the MGCP daemon is not active, all MGCP messages are ignored.
If you want to change the UDP port while MGCP is running, you must stop the MGCP daemon using the no mgcp command, and then restart it with the new port number using the mgcp port command.
Examples
The following example initiates the MGCP daemon:
Router(config)# mgcpThe following example enables the MGCP daemon on port 4204:
Router(config)# mgcp 4204Related Commands
mgcp bind
To configure the source address for signaling and media packets to the IP address of a specific interface, use the mgcp bind command in global configuration mode. To disable binding, use the no form of this command.
mgcp bind {control | media} source-interface interface-id
no mgcp bind {control | media}
Syntax Description
Defaults
Binding is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
If the mgcp bind command is not enabled, the IP layer still provides the best local address.
A warning message is displayed if any of the following situations occur:
•
•
•
•
•
Examples
The following example shows how the configuration of bind interfaces is shown when show running-config information is viewed:
...mgcp bind control source-interface FastEthernet0mgcp bind media source-interface FastEthernet0...Related Commands
mgcp block-newcalls
To block new calls while maintaining existing calls, use the mgcp block-newcalls command in global configuration mode. To resume media gateway control protocol (MGCP) operation, use the no form of this command.
mgcp block-newcalls
no mgcp block-newcalls
Syntax Description
This command has no arguments or keywords.
Defaults
New call are not blocked.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is valid only if the mgcp command is enabled.
Once you issue this command, all requests for new connections (CreateConnection requests) are denied. All existing calls are maintained until participants terminate them or you use the no mgcp command. When the last active call is terminated, the MGCP daemon is terminated and all resources that are allocated to it are released. The no mgcp block-newcalls command returns the router to normal MGCP operations.
Examples
The following example prevents the gateway from receiving new calls:
Router(config)# mgcp block-newcallsRelated Commands
mgcp call-agent
To configure the address and protocol of the call agent for Media Gateway Control Protocol (MGCP) endpoints on a media gateway, use the mgcp call-agent command in global configuration mode. To reset to the default, use the no form of this command.
mgcp call-agent {dns-name | ip-address} [port] [service-type type] [version protocol-version]
no mgcp call-agent
Syntax Description
Defaults
Call-agent UDP port: 2727 for MGCP 1.0, NCS 1.0, and TGCP 1.0
Call-agent UDP port: 2427 for MGCP 0.1 and SGCP
Call-agent UDP port: 2427 for Cisco CallManager
Service type and version: mgcp 0.1
Service type for Cisco CallManager: mgcpCommand Modes
Global configuration
Command History
Usage Guidelines
Global call-agent configuration (with this command) and call-agent configuration for an MGCP profile (with the mgcp profile call-agent command) are mutually exclusive; the first to be configured on an endpoint blocks configuration of the other on the same endpoint.
Identifying call agents by Domain Name System (DNS) name rather than by IP address in the mgcp call-agent and mgcp profile call-agent commands provides call-agent redundancy, because a DNS name can have more than one IP address associated with it. If a call agent is identified by DNS name and a message from the gateway fails to reach the call agent, the max1 lookup and max2 lookup commands enable a search from the DNS lookup table for a backup call agent at a different IP address.
The port argument configures the call-agent port number (the UDP port over which the gateway sends messages to the call agent). The reverse (the gateway port number, or the UDP port over which the gateway receives messages from the call agent) is configured by specifying a port number in the mgcp command.
When the service type is set to mgcp, the call agent processes the restart in progress (RSIP) error messages sent by the gateway if the mgcp sgcp restart notify command is enabled. When the service type is set to sgcp, the call agent ignores the RSIP messages.
Use this command on any platform and media gateway.
The mgcp service type supports the RSIP error messages sent by the gateway if the mgcp sgcp restart notify command is enabled.
Examples
The following examples illustrate several formats for specifying the call agent (use any one of these formats):
Router(config)# mgcp call-agent 209.165.200.225 service-type mgcp version 1.0Router(config)# mgcp call-agent igloo.northpole.net service-type ncsRouter(config)# mgcp call-agent igloo.northpole.net 2009 service-type sgcp version 1.5Router(config)# mgcp call-agent 209.165.200.225 5530 service-type tgcpRelated Commands
mgcp codec
To select the codec type and its optional packetization period value, use the mgcp codec command in global configuration mode. To set the codec to its default value of G711 u-law, use the no form of this command.
mgcp codec type [packetization-period value]
no mgcp codec
Syntax Description
Defaults
G711 u-law codec
Command Modes
Global configuration
Command History
Examples
The following example specifies the codec type:
Router(config)# mgcp codec g711alawThe following example sets the codec type and packetization period:
Router(config)# mgcp codec g729r8 packetization-period 150Related Commands
mgcp default-package
To configure the default package capability type for the media gateway, use the mgcp default-package command in global configuration mode. This command does not have a no form. To change the default package, use the mgcp default-package command with a different, actively supported package.
Residential Gateways
mgcp default-package {dt-package | dtmf-package | fxr-package | gm-package | hs-package | line-package | ms-package | rtp-package}
Business Gateways
mgcp default-package {atm-package | dt-package | dtmf-package | fxr-package | gm-package | hs-package | line-package | ms-package | rtp-package | trunk-package}
Trunking Gateways
mgcp default-package {as-package | atm-package | dt-package | dtmf-package | gm-package | hs-package | mo-package | ms-package | nas-package | rtp-package | script-package | trunk-package}
Syntax Description
Defaults
For residential gateways: line-package
For trunking gateways: trunk-packageCommand Modes
Global configuration
Command History
Usage Guidelines
This command is helpful when the Media Gateway Controller does not provide the package capability to be used for the given connection.
Before selecting a package as the default, use the show mgcp command to ensure that the package is actively supported. If the package you want does not appear in the display, use the mgcp package-capability command to add the package to the supported list.
Note
If only one package is actively supported, it becomes the default package.
When the FXR package is the default, the call agent omits the "fxr/" prefix on two types of requests in CRCX, MDCX, DLCX, and RQNT messages: requests to detect events ("R:<pkg>/<evt>") and requests to generate events ("S:<pkg>/<evt>"). For example, to ask for T.38 detection, the call agent sends "R:t38" in an RQNT message rather than "R:fxr/t38." Note that the "fxr/fx:" parameter to the Local Connection Options is not affected by selection of FXR as the default package and always needs the "fxr/" prefix.
Examples
The following example sets the default package:
Router(config)# mgcp default-package as-package! The announcement server package type will be the new default package type.Related Commands
mgcp
Starts the MGCP daemon.
mgcp package-capability
Includes a specific MGCP package that is supported by the gateway.
mgcp dtmf-relay
To ensure accurate forwarding of digits on compressed codecs, use the mgcp dtmf-relay command in global configuration mode. To disable this process for uncompressed codecs, use the no form of this command.
Voice over IP (VoIP)
mgcp dtmf-relay voip codec {all | low-bit-rate} mode {cisco | nse | out-of-band | nte-gw | nte-ca}
no mgcp dtmf-relay voip
Voice over AAL2 (VoAAL2)
mgcp dtmf-relay voaal2 codec [all | low-bit-rate]
no mgcp dtmf-relay voaal2
Syntax Description
Defaults
For the Cisco 7200 series router, the command is not enabled.
For all other platforms, noncompressed codecs are disabled.Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to access an announcement server or a voice-mail server that cannot decode RTP packets containing DTMF digits. When the mgcp dtmf-relay command is active, the DTMF digits are removed from the voice stream and carried so that the server can decode the digits.
Only VoIP supports the mode keyword for forwarding digits on codecs.
Examples
The following example removes the DTMF tone from the voice stream and sends FRF.11 with a special payload for the DTMF digits:
mgcp dtmf-relay codec mode ciscoThe following example configures a low-bit-rate codec using VoIP in NSE mode:
mgcp dtmf-relay voip codec low-bit-rate mode nseThe following example configures a codec for VoAAL2:
mgcp dtmf-relay voaal2 codec allThe following example configures a low-bit-rate codec using VoIP in NSE mode:
mgcp dtmf-relay voip codec low-bit-rate mode nseThe following example sets the dtmf-relay codec and mode to gateway:
mgcp dtmf-relay codec mode nte-gwRelated Commands
mgcp endpoint offset
To enable incrementing of the POTS or DS0 portion of an endpoint name when using the Network-based Call Signaling (NCS) 1.0 profile of Media Gateway Control Protocol (MGCP), use the mgcp endpoint offset command in global configuration mode. To reset to the default, use the no form of this command.
mgcp endpoint offset
no mgcp endpoint offset
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used with NCS 1.0 to increment the POTS or DS0 portion of an endpoint name by 1 to minimize potential interoperability problems with call agents (media gateway controllers).
NCS 1.0 mandates that the port number of an endpoint be based on 1, and port numbering on some gateway platforms is based on 0.
When this command is configured, it offsets all endpoint names on the gateway. For example, an endpoint with a port number of aaln/0 is offset to aaln/1, and a DS0 group number of 0/0:0 is offset to 0/0:1.
Examples
The following example enables incrementing the port number portion of an endpoint name:
Router(config)# mgcp endpoint offsetRelated Commands
mgcp explicit hookstate
To enable detection of explicit hookstates, use the mgcp explicit hookstate command in global configuration mode. To disable hookstate detection, use the no form of this command.
mgcp explicit hookstate
no mgcp explicit hookstate
Syntax Description
This command has no arguments or keywords.
Defaults
Hookstate detection is enabled.
Command Modes
Global configuration
Command History
Usage Guidelines
Explicit hookstate detection is enabled by default. In this state, the gateway returns a "401 endpoint already off hook" or "402 endpoint already on hook" NACK (Not Acknowledged) response to R:hu or R:hd event requests.
If you turn hookstate detection off with the no form of the mgcp explicit hookstate command, the hookstate is not checked when the gateway receives R:hu or R:hd event requests. The gateway acknowledges (ACK) these event requests.
Examples
The following example enables hookstate detection:
Router(config)# mgcp explicit hookstateRelated Commands
mgcp fax t38
To configure MGCP fax T.38 parameters, use the mgcp fax t38 command in global configuration mode. return a parameter to its default, use the no form of this command.
mgcp fax t38 {ecm | gateway force | hs_redundancy factor | inhibit | ls_redundancy factor | nsf hexcode}
no mgcp fax t38 {ecm | gateway force | hs_redundancy | inhibit | ls_redundancy | nsf}
Syntax Description
Defaults
ecm—disabled
gateway force—disabled
hs_redundancy—0
inhibit—disabled (T.38 is enabled)
ls_redundancy—0
nsf—not overriddenCommand Modes
Global configuration
Command History
Usage Guidelines
Nonstandard facilities (NSF) are capabilities a particular fax manufacturer has built into a fax machine to distinguish products from each other.
To disable T.38 fax relay, use the mgcp fax t38 inhibit command.
Some MGCP call agents do not properly pass those portions of Session Description Protocol (SDP) messages that advertise T.38 and NSE capabilities. As a result, gateways that are controlled by these call agents are unable to use NSEs to signal T.38 fax relay to other gateways that use NSEs. The mgcp fax t38 gateway force command provides a way to ensure gateway-controlled T.38 fax relay and use of NSEs between an MGCP gateway and another gateway. The other gateway can be an H.323, Session Initiation Protocol (SIP), or MGCP gateway. Both gateways must be configured to use NSEs to signal T.38 fax relay mode switchover. On H.323 and SIP gateways, use the fax protocol t38 nse force command to specify the use of NSEs for T.38 fax relay. On MGCP gateways, use the mgcp fax t38 gateway force command.
Examples
The following example configures the gateway to use NSEs for gateway-controlled T.38 fax relay signaling:
Router(config)# mgcp fax t38 gateway forceThe following example shows that MGCP T.38 fax relay and ECM are enabled, NSF override is disabled, and low- and high-speed redundancy are set to the default value of 0:
Router(config)# mgcp fax t38 ecmRouter(config)# exitRouter# show mgcpMGCP Admin State ACTIVE, Oper State ACTIVE - Cause Code NONEMGCP call-agent: 172.18.195.147 2436 Initial protocol service is MGCP 0.1MGCP block-newcalls DISABLEDMGCP send RSIP for SGCP is DISABLEDMGCP quarantine mode discard/stepMGCP quarantine of persistent events is ENABLEDMGCP dtmf-relay for VoIP disabled for all codec typesMGCP dtmf-relay for VoAAL2 disabled for all codec typesMGCP voip modem passthrough mode: CA, codec: g711ulaw, redundancy: DISABLED,MGCP voaal2 modem passthrough mode: NSE, codec: g711ulawMGCP TSE payload: 119MGCP T.38 Named Signalling Event (NSE) response timer: 200MGCP Network (IP/AAL2) Continuity Test timer: 200MGCP 'RTP stream loss' timer disabledMGCP request timeout 500MGCP maximum exponential request timeout 4000MGCP gateway port: 2427, MGCP maximum waiting delay 3000MGCP restart delay 0, MGCP vad DISABLEDMGCP rtrcac DISABLEDMGCP system resource check DISABLEDMGCP xpc-codec: DISABLED, MGCP persistent hookflash: DISABLEDMGCP persistent offhook: ENABLED, MGCP persistent onhook: DISABLEDMGCP piggyback msg ENABLED, MGCP endpoint offset DISABLEDMGCP simple-sdp DISABLEDMGCP undotted-notation DISABLEDMGCP codec type g729r8, MGCP packetization period 10MGCP JB threshold lwm 30, MGCP JB threshold hwm 150MGCP LAT threshold lmw 150, MGCP LAT threshold hwm 300MGCP PL threshold lwm 1000, MGCP PL threshold hwm 10000MGCP CL threshold lwm 1000, MGCP CL threshold hwm 10000MGCP playout mode is adaptive 60, 4, 200 in msecMGCP IP ToS low delay disabled, MGCP IP ToS high throughput disabledMGCP IP ToS high reliability disabled, MGCP IP ToS low cost disabledMGCP IP RTP precedence 5, MGCP signaling precedence: 3MGCP default package: dt-packageMGCP supported packages: gm-package dtmf-package trunk-package line-packagehs-package rtp-package as-package atm-package ms-packagedt-package mo-package res-package mt-packagedt-package mo-package res-package mt-packageMGCP Digit Map matching order: shortest matchSGCP Digit Map matching order: always left-to-rightMGCP VoAAL2 ignore-lco-codec DISABLEDMGCP T.38 Fax is ENABLEDMGCP T.38 Fax ECM is ENABLEDMGCP T.38 Fax NSF Override is DISABLEDMGCP T.38 Fax Low Speed Redundancy: 0MGCP T.38 Fax High Speed Redundancy: 0The following example shows that NSF is overridden:
MGCP T.38 Fax NSF Override is ENABLED: AC04D3Related Commands
Related Commands
Related CommandsRouter(config)# mgcp ip-tos signaling precedence 5
mgcp ip-tos
To enable or disable the IP type of service (ToS) for media gateway control protocol (MGCP) connections, use the mgcp ip-tos command in global configuration mode. To restore the default, use the no form of this command.
mgcp ip-tos {high-reliability | high-throughput | low-cost | low-delay | rtp precedence value | signaling precedence value}
no mgcp ip-tos {high-reliability | high-throughput | low-cost | low-delay | rtp precedence value | signaling precedence value}
Syntax Description
Defaults
Services are disabled.
RTP precedence: 3
Signaling precedence: 3Command Modes
Global configuration
Command History
Usage Guidelines
Only one of the keywords in the group high-reliability, high-throughput, low-cost, and low-delay can be enabled at any given time. Enabling one keyword disables any other that was active. Enabling one of these keywords has no effect on the precedence value.
The no form of the mgcp ip-tos command disables the first four keywords and sets the precedence value back to 3.
When you configure a new value for precedence, the old value is erased.
Examples
The following example activates the low-delay keyword and disables the previous three keywords:
Router(config)# mgcp ip-tos high-relRouter(config)# mgcp ip-tos high-throughputRouter(config)# mgcp ip-tos low-costRouter(config)# mgcp ip-tos low-delayRouter(config)# mgcp ip-tos rtp precedence 4Related Commands
Related CommandsRouter(config)# mgcp ip-tos signaling precedence 5
mgcp max-waiting-delay
To specify the media gateway control protocol (MGCP) maximum waiting delay (MWD), use the mgcp max-waiting-delay command in global configuration mode. To reset to the default, use the no form of this command.
mgcp max-waiting-delay milliseconds
no mgcp max-waiting-delay
Syntax Description
milliseconds
Time, in milliseconds, to wait after restart. Range is from 0 to 600000 (600 seconds). The default is 3000 (3 seconds).
Defaults
3000 ms
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to send out an Restart in Progress (RSIP) message to the call agent with the restart method. This command helps prevent traffic bottlenecks caused by MGCP gateways all trying to connect at the same time after a restart.
Examples
The following example sets the MGCP maximum waiting delay to 600 ms:
Router(config)# mgcp max-waiting-delay 600Related Commands
mgcp
Starts the MGCP daemon.
mgcp restart-delay
Configures the graceful teardown method sent in the RSIP message.
mgcp modem passthrough codec
To select the codec that enables the gateway to send and receive modem and fax data in VoIP and VoATM adaptation layer 2 (VoAAL2) configurations, use the mgcp modem passthrough codec command in global configuration mode. To disable support for modem and fax data, use the no form of this command.
mgcp modem passthrough {voip | voaal2} codec {g711alaw | g711ulaw}
no mgcp modem passthrough {voip | voaal2}
Syntax Description
Defaults
The g711 u-law codec for both VOIP and VOAAL2
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command for fax pass-through because the answer tone can come from either modem or fax transmissions. Selecting a codec dynamically changes the codec type and speed to meet network conditions.
Examples
The following example enables a gateway to send and receive VoAAL2 modem or fax data using the G711 a-law codec:
Router(config)# mgcp modem passthrough voaal2 codec g711alawRelated Commands
mgcp modem passthrough mode
To set the method for changing speeds that enables the gateway to send and receive modem and fax data in VoIP and VoATM adaptation layer 2 (VoAAL2) configurations, use the mgcp modem passthrough mode command in global configuration mode. To disable support for modem and fax data, use the no form of this command.
mgcp modem passthrough {voip | voaal2} mode {cisco | nse}
no mgcp modem passthrough {voip | voaal2}
Syntax Description
Defaults
NSE-based method
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command for fax pass-through because the answer tone can come from either modem or fax transmissions.
Upspeed is the method used to change the codec type and speed dynamically to meet network conditions.
If you use the nse keyword, you must also use the mgcp tse payload command.
If you use the default nse keyword and the voip or voaal2 keyword, the show run command does not display the mgcp modem passthrough mode command in the configuration output, although the command is displayed for the cisco keyword. The show mgcp command displays settings for both the nse and cisco keywords.
Examples
The following example enables a gateway to send and receive VoIP modem or fax data using the NSE modem-speed-changing method:
Router(config)# mgcp modem passthrough voip mode nseRelated Commands
mgcp modem passthrough voip redundancy
To enable redundancy on a gateway that sends and receives modem and fax data in VoIP configurations, use the mgcp modem passthrough voip redundancy command in global configuration mode. To disable redundancy, use the no form of this command.
mgcp modem passthrough voip redundancy
no mgcp modem passthrough voip redundancy
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled (no redundancy)
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command for fax pass-through because the answer tone can come from either modem or fax transmissions.
Upspeed is the method used to dynamically change the codec type and speed to meet network conditions.
Examples
The following example enables redundancy for VoIP modem and fax transmissions on a gateway:
Router(config)# mgcp modem passthrough voip redundancyRelated Commands
mgcp modem passthru
To enable the gateway to send and receive modem and fax data, use the mgcp modem passthru command in global configuration mode. To disable support for modem and fax data, use the no form of this command.
mgcp modem passthru {cisco | ca}
no mgcp modem passthru
Syntax Description
Defaults
ca
Command Modes
Global configuration
Command History
12.1(3)T
This command was added to MGCP.
12.2(11)T
This command was implemented on the Cisco AS5850.
Usage Guidelines
When the cisco keyword is activated and the gateway detects a modem/fax tone, the gateway switches the codec to G.711 then sends the analog data to a remote gateway. The remote gateway also switches the codec on its side of the call to G.711 to allow the analog data to pass through.
When the ca keyword is activated and the gateway detects a modem/fax tone, the gateway alerts the call agent to switch the codec to G.711 to allow the analog data to pass through. The call agent must send an MDCX signal to the G.711 codec for successful data pass-through.
Examples
The following example configures a gateway to send and receive modem or fax data:
Router(config)# mgcp modem passthru ciscoRelated Commands
mgcp modem relay voip gateway-xid
To enable in-band negotiation of compression parameters between two VoIP gateways using Media Gateway Control Protocol (MGCP), use the mgcp modem relay voip gateway-xid command in global configuration mode. To disable this function, use the no form of this command.
mgcp modem relay voip gateway-xid [compress {backward | both | forward | no}] [dictionary value] [string-length value]
no mgcp modem relay voip gateway-xid
Syntax Description
Defaults
Command: enabled
Compress: both
Dictionary: 1024
String length: 32Command Modes
Global configuration
Command 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.
This command affects only VoIP calls and not Voice over ATM adaption layer 2 (VoAAL2) calls. This is because MGCP supports VoAAL2 calls for voice and fax/modem, but not for modem relay.
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 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:
mgcp modem relay voip gateway-xid compress both dictionary 1024 string-length 32Related Commands
mgcp modem relay voip latency
To optimize the Modem Relay Transport Protocol and the estimated one-way delay across the IP network using Media Gateway Control Protocol (MGCP), use the mgcp modem relay voip latency command in global configuration mode. To disable this function, use the no form of this command.
mgcp modem relay voip latency value
no mgcp modem relay voip latency
Syntax Description
value
Estimated one-way delay across the IP network, in milliseconds. Range is from 100 to 1000. Default is 200.
Defaults
200 ms
Command Modes
Global configuration
Command 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.
mgcp modem relay voip latency 100Related Commands
mgcp modem relay voip mode
To enable modem relay mode in a gateway for Media Gateway Control Protocol (MGCP) VoIP calls, use the mgcp modem relay voip mode command in global configuration mode. To disable this function, use the no form of this command.
mgcp modem relay voip mode nse [codec {g711alaw | g711ulaw} [redundancy] | redundancy]
no mgcp modem relay voip mode
Syntax Description
Defaults
Modem relay mode is disabled. All modem calls go through as pass-through calls, which are less reliable and use more bandwidth.
The G.711 u-law codec is used for upspeeding.
Redundancy is disabled and no duplicate data packets are sent while in modem/fax passthrough mode.
Command Modes
Global configuration
Command History
12.2(11)T
This command was introduced on the following platforms: Cisco 2600 series, Cisco 3620, Cisco 3640, Cisco 3660, and Cisco 7200 series, and Cisco AS5300.
Usage Guidelines
This command enables modem relay mode for MGCP VoIP calls. By default, modem relay mode is disabled. In addition, the command configures upspeeding, which is needed because modem pass-through is an intermediate step while the gateway switches from handling voice calls to handling modem relay calls.
Redundancy causes the gateway to generate duplicate (redundant) data packets for fax/modem pass-through calls as per RFC 2198. For these calls to be more reliable, redundant packets transmission is needed to take care of excessive loss of packets in VoIP networks. Even if one of the gateways is configured with redundancy, calls go through. Gateways can handle asymmetric (one-way) redundancy.
Examples
The following example enables MGCP modem relay and specifies the following: NSE mode for upspeeding, G.711 u-law codec, and packet redundancy for modem traffic during modem pass-through:
mgcp modem relay voip mode nse codec g711ulaw redundancyRelated Commands
mgcp modem relay voip 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 mgcp modem relay voip sprt retries command in global configuration mode. To disable this function, use the no form of this command.
mgcp modem relay voip sprt retries value
no mgcp modem relay voip 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.
Defaults
12 times
Command Modes
Global configuration
Command 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:
mgcp modem relay voip sprt retries 15Related Commands
mgcp package-capability
To specify an MGCP package capability type for a media gateway, use the mgcp package-capacity command in global configuration mode. To remove a specific MGCP package capability from the list of capabilities, use the no form of this command.
mgcp package-capability package
no mgcp package-capability package
Syntax Description
Defaults
For residential gateways: line-package
For trunk gateways: trunk-packageCommand Modes
Global configuration
Command History
Usage Guidelines
Events specified in the MGCP messages from the call agent must belong to one of the supported packages. Otherwise, connection requests are refused by the gateway.
By default, certain packages are configured as supported on each platform type. Using this command, you can configure additional package capability only for packages that are supported by your call agent. You can also disable support for a package with the no form of this command. Enter each package you want to add as a separate command.
Use the show mgcp command to see the packages that are currently supported on the gateway.
Use this command before specifying a default package with the mgcp default-package command. Specify at least one default package.
Packages that are available to be configured with this command vary by platform and type of gateway. Use command-line interface (CLI) help to ascertain the packages available on your gateway. This example shows the CLI help output for a Cisco 3660:
Router# mgcp package-capability ?as-package Select the Announcement Server Packageatm-package Select the ATM Packagedtmf-package Select the DTMF Packagegm-package Select the Generic Media Packagehs-package Select the Handset Packageline-package Select the Line Packagemf-package Select the MF Packageres-package Select the RES Packagertp-package Select the RTP Packagetrunk-package Select the Trunk Package
Note
Examples
The following example enables the trunk package, DTMF package, and script package on the gateway, and then names the trunk package as the default package for the gateway:
Router(config)# mgcp package-capability trunk-packageRouter(config)# mgcp package-capability dtmf-packageRouter(config)# mgcp package-capability script-packageRouter(config)# mgcp default-package trunk-packageRelated Commands
mgcp
Starts the MGCP daemon.
mgcp default-package
Configures the default package capability type for the media gateway.
mgcp persistent
To configure the sending of persistent events from the Media Gateway Control Protocol (MGCP) gateway to the call agent, use the mgcp persistent command in global configuration mode. To reset to the default, use the no form of this command.
mgcp persistent {hookflash | offhook | onhook}
no mgcp persistent {hookflash | offhook | onhook}
Syntax Description
hookflash
Sends persistent hookflash events to the call agent.
offhook
Sends persistent off-hook events to the call agent.
onhook
Sends persistent on-hook events to the call agent.
Defaults
The hookflash keyword is disabled for persistence. The offhook keyword is enabled for persistence. The onhook keyword is disabled for persistence.
Command Modes
Global configuration
Command History
Usage Guidelines
Persistent events are those events that, once they are detected, are defined as reportable to the call agent whether or not the call agent has explicitly requested to be notified of their occurrence; that is, even if they are not included in the list of RequestedEvents that the gateway is asked to detect and report. Such events can include fax tones, continuity tones, and on-hook transition. Each event has an associated action for the gateway to take.
Use this command for each type of persistent event that should override the default behavior.
Examples
The following example configures the gateway to send persistent on-hook events to the call agent:
Router(config)# mgcp persistent onhookRelated Commands
mgcp piggyback message
To enable piggyback messages, use the mgcp piggyback message command in global configuration mode. To disable piggyback messages, use the no form of this command.
mgcp piggyback message
no mgcp piggyback message
Syntax Description
This command has no arguments or keywords.
Defaults
Piggyback messages are enabled
Command Modes
Global configuration
Command History
Usage Guidelines
If the network gateway cannot handle piggyback messages, us e the no form of this command to disable the piggyback messages and to enable Media Gateway Control Protocol (MGCP) 1.0, Network-based Call Signaling (NCS), and Trunking Gateway Control Protocol (TGCP). Piggyback messaging is not available to Simple Gateway Control Protocol (SGCP) and MGCP 0.1.
The term piggyback message refers to a situation in which a gateway or a call agent sends more than one MGCP message in the same User Datagram Protocol (UDP) packets. The recipient processes the messages individually, in the order received. However, if a message must be retransmitted, the entire datagram is resent. The recipient must be capable of sorting out the messages and keeping track of which messages have been handled or acknowledged.
Piggybacking is used during retransmission of a message to send previously unacknowledged messages to the call agent. This maintains the order of events the call agent receives and makes sure that RestartInProgress (RSIP) messages are always received first by a call agent.
Examples
The following example disables piggyback messages:
Router(config)# no mgcp piggyback messageRelated Commands
mgcp playout
To tune the jitter-buffer packet size attempted for MGCP-controlled connections, use the mgcp playout command in global configuration mode. To reset to the default, use the no form of this command.
mgcp playout {adaptive init-value min-value max-value | fixed init-value}
no mgcp playout {adaptive | fixed}
Syntax Description
Defaults
Adaptive: 60 4 200
Fixed: no default valueCommand Modes
Global configuration
Command History
Examples
The following example sets a jitter buffer to an initial playout of 100, minimum buffer size of 50, and maximum buffer size of 150:
Router(config)# mgcp playout adaptive 100 50 150The following example sets a jitter buffer to a fixed playout of 120:
Router(config)# mgcp playout fixed 120Related Commands
mgcp profile
To create and configure a Media Gateway Control Protocol (MGCP) profile to be associated with one or more MGCP endpoints or to configure the default MGCP profile, use the mgcp profile command in global configuration mode. To delete the profile, use the no form of this command.
mgcp profile {profile-name | default}
no mgcp profile {profile-name | default}
Syntax Description
profile-name
Identifying name for the user-defined profile to be configured. The name can be a maximum of 32 characters.
default
The default profile is to be configured.
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
An MGCP profile is a subset of endpoints on a media gateway. More than one MGCP profile can be configured on a gateway at the same time. The voice-port command in MGCP profile configuration mode associates endpoints with the profile.
There are two types of MGCP parameters, global and profile-related. The parameters that are configured in MGCP profile configuration mode are the profile-related parameters. However, endpoints do not need to belong to an MGCP profile. When endpoints are not associated with any MGCP profile, values for the profile-related MGCP parameters are provided by a default profile. Although all of the parameters for the default profile have default values, they can also be configured in the same way that an MGCP profile is configured by simply using the default keyword instead of a profile name. The main difference between a default profile and a user-defined profile is that there is no voice-port or call-agent association in the default profile, but they are required in user-defined profiles. When configuring the default profile, do not configure the call-agent command or the voice-port command.
The mgcp profile command initiates MGCP profile configuration mode, in which you create an MGCP profile for an endpoint or a set of endpoints on a media gateway, and you set parameters for that profile or for the default profile.
Examples
The following example shows the definition of the MGCP profile named newyork:
Router(config)# mgcp profile newyork Router(config-mgcp-profile)# call-agent 10.14.2.200 4000 service-type mgcp version 1.0Router(config-mgcp-profile)# voice-port 0:1Router(config-mgcp-profile)# package persistent mt-packageRouter(config-mgcp-profile)# timeout tsmax 100Router(config-mgcp-profile)# timeout tdinit 30Router(config-mgcp-profile)# timeout tcrit 600Router(config-mgcp-profile)# timeout tpar 600Router(config-mgcp-profile)# timeout thist 60Router(config-mgcp-profile)# timeout tone mwi 600Router(config-mgcp-profile)# timeout tone ringback 600Router(config-mgcp-profile)# timeout tone ringback connection 600Router(config-mgcp-profile)# timeout tone network congestion 600Router(config-mgcp-profile)# timeout tone busy 600Router(config-mgcp-profile)# timeout tone dial 600Router(config-mgcp-profile)# timeout tone dial stutter 600Router(config-mgcp-profile)# timeout tone ringing 600Router(config-mgcp-profile)# timeout tone ringing distinctive 600Router(config-mgcp-profile)# timeout tone reorder 600Router(config-mgcp-profile)# timeout tone cot1 600Router(config-mgcp-profile)# timeout tone cot2 600Router(config-mgcp-profile)# max1 retries 10Router(config-mgcp-profile)# no max2 lookupRouter(config-mgcp-profile)# max2 retries 10Router(config-mgcp-profile)# exitRelated Commands
mgcp quality-threshold
To set the jitter buffer size threshold, latency threshold, and packet-loss threshold parameters, use the mgcp quality-threshold command in global configuration mode. To reset to the defaults, use the no form of this command.
mgcp quality-threshold {hwm-cell-loss value | hwm-jitter-buffer value | hwm-latency value | hwm-packet-loss value | lwm-cell-loss value | lwm-jitter-buffer value | lwm-latency value | lwm-packet-loss value}
no mgcp quality-threshold {hwm-cell-loss value | hwm-jitter-buffer value | hwm-latency value | hwm-packet-loss value | lwm-cell-loss value | lwm-jitter-buffer value | lwm-latency value | lwm-packet-loss value}
Syntax Description
Defaults
High-water-mark cell loss count: 10000 cells
High-water-mark jitter buffer size: 150 ms
High-water-mark latency value: 300 ms
High-water-mark packet loss value: 10000 ms
Low-water-mark cell loss count: 1000 cells
Low-water-mark jitter buffer size: 30 ms
Low-water-mark latency value: 150 ms
Low-water-mark packet-loss value: 1000 msCommand Modes
Global configuration
Command History
Usage Guidelines
The following impact the quality of voice calls:
•
•
•
•
For good voice quality, the system should perform below the low water mark values. As the values go higher, voice quality degrades. The system generates a report when the values go above the high water marks levels. Set the high water marks and low water marks values sufficiently apart so that you receive reports on poor performance, but not so close together that you receive too much feedback.
Enter each parameter as a separate command.
Examples
The following example sets various keywords to new values:
Router(config)# mgcp quality-threshold hwm-jitter-buffer 100Router(config)# mgcp quality-threshold hwm-latency 250Router(config)# mgcp quality-threshold hwm-packet-loss 5000Related Commands
mgcp
Starts the MGCP daemon.
mgcp package-capability
Activates various packages on the gateway.
mgcp playout
Tunes the jitter buffer packet size.
mgcp quarantine mode
To configure the mode for Media Gateway Control Protocol (MGCP) quarantined events, use the mgcp quarantine mode command in global configuration mode. To reset to the default, use the no form of this command.
mgcp quarantine mode [discard | process] [loop | step]
no mgcp quarantine mode
Syntax Description
Defaults
If no event is specified the default is step.
Command Modes
Global configuration
Command History
Usage Guidelines
Quarantine events are defined as events that have been detected by the gateway before the arrival of the MGCP NotificationRequest command but that have not yet been notified to the call agent. They are held in the quarantine buffer until receipt of the MGCP NotificationRequest command, when the gateway is expected to generate either one notification (step by step) or multiple notifications (loop) in response to this request (the default is exactly one), based on the configuration of the mgcp quarantine mode command.
This command supports backward compatibility with SGCP implementations running under the MGCP application. SGCP does not have a way to allow the call agent to control the quarantine mode. MGCP has this functionality.
When the gateway is in the notification state, the interdigit timer (Tcrit) is not started.
When the gateway receives an unsuccessful NotificationRequest, the current RequestEventList and SignalEventList are emptied. The ObservedEventList and quarantine buffer are also emptied.
Changes to the quarantine mode only take effect when the gateway is rebooted or the MGCP application is restarted.
Examples
The following example starts the MGCP application:
Router(config)# mgcpThe following example stops the MGCP application:
Router(config)# no mgcpThe following example turns on processing of quarantined events and sends observed events to the call agent:
Router(config)# mgcp quarantine mode processThe following example turns off processing of quarantined events:
Router(config)# no mgcp quarantine mode discardThe following example sends observed events to the call agent in loop mode:
Router(config)# mgcp quarantine mode process loopRelated Commands
mgcp
Starts and allocates resources for the MGCP daemon.
mgcp quarantine persistent-event disable
Disables handling of persistent call events in the quarantine buffer.
mgcp quarantine persistent-event disable
To disable handling of persistent call events in the Media Gateway Control Protocol (MGCP) quarantine buffer, use the mgcp quarantine persistent-events disable command in global configuration mode. To reset to the default state, use the no form of this command.
mgcp quarantine persistent-event disable
no mgcp quarantine persistent-event disable
Syntax Description
This command has no arguments or keywords.
Defaults
Persistent events are held in the events buffer.
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables the reporting of persistent events immediately to the call agent rather than holding the events in quarantine. Persistent events are events defined as reportable whether or not the call agent explicitly has requested to be notified of their occurrence. Quarantining means that the gateway observes events but does not report them to the call agent until the call agent indicates readiness to receive notifications. By default, all events, including persistent events, are quarantined when they are detected, even when the gateway is in a notification state. When the mgcp quarantine persistent-event disable command is configured, however, persistent events are reported to the call agent immediately by an MGCP Notify command.
Examples
The following example disables quarantine buffer handling of persistent events:
Router(config)# mgcp quarantine persistent-event disableRelated Commands
mgcp
Starts and allocates resources for the MGCP daemon.
mgcp quarantine mode
Configures MGCP event quarantine buffer handling mode.
mgcp request retries
This command was added in Cisco IOS Release 12.1(1)T. Beginning in Cisco IOS Release 12.2(2)XA and Cisco IOS Release 12.2(4)T, this command is supported no longer. It has been replaced by the MGCP profile max1 retries and max2 retries commands.
mgcp request timeout
To specify how long a Media Gateway Control Protocol (MGCP) gateway waits for a call-agent response to a request before retransmitting the request, use the mgcp request timeout command in global configuration mode. To reset to the default, use the no form of this command.
mgcp request timeout {timeout-value | max maxtimeout-value}
no mgcp request timeout [max]
Syntax Description
timeout-value
Time, in milliseconds, to wait for a response to a request. Range is 1 to 10000. Default is 500.
max maxtimeout-value
Maximum timeout, in milliseconds. Default is 4000.
Defaults
timeout-value: 500 ms
maxtimeout-value: 4000 msCommand Modes
Global configuration
Command History
Usage Guidelines
The request timeout value sets the initial time period that an MGCP gateway waits for a response from the call agent before retransmitting the message. The interval doubles with each retransmission. The request timeout maximum value sets an upper limit on the timeout interval.
Examples
The following example sets a router to wait 40 ms for a reply to the first request before retransmitting and limits subsequent interval maximums to 10,000 ms (10 seconds):
Router(config)# mgcp request timeout 40Router(config)# mgcp request timeout max 10000Related Commands
mgcp
Starts the MGCP daemon.
mgcp request retries
Specifies the number of times to retry sending the mgcp command.
mgcp restart-delay
To select the delay value sent in the Restart in Progress (RSIP) graceful teardown, use the mgcp restart-delay command in global configuration mode. To reset to the default, use the no form of this command.
mgcp restart-delay value
no mgcp restart-delay
Syntax Description
Defaults
0 seconds
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to send an RSIP message indicating when the connection in the gateway is to be torn down.
Examples
The following example sets the restart delay to 30 seconds:
Router(config)# mgcp restart-delay 30Related Commands
mgcp
Starts the MGCP daemon.
mgcp max-waiting-delay
Specifies the MGCP maximum waiting delay after a restart.
mgcp rtp payload-type
To specify use of the correct RTP payload type for backward compatibility in Media Gateway Control Protocol (MGCP) networks, use the mgcp rtp payload-type command in global configuration mode.
Fax and modem codecs
mgcp rtp payload-type {cisco-pcm-switch-over-alaw 127 | cisco-pcm-switch-over-ulaw 126}
no mgcp rtp payload-type {cisco-pcm-switch-over-alaw | cisco-pcm-switch-over-ulaw}
Voice codecs
mgcp rtp payload-type {clear-channel | g726r16 | g726r24} static
no mgcp rtp payload-type {clear-channel | g726r16 | g726r24}
Syntax Description
Defaults
Fax and modem codecs: static RTP payload type
Voice codecs: dynamic RTP payload type from 96 to 127Command Modes
Global configuration
Command History
12.2(11)T
This command was introduced on the following platforms: Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5400HPX, and Cisco AS5850.
Usage Guidelines
Cisco IOS Release 12.2(11)T introduces a different RTP payload type negotiation for MGCP VoIP calls than was present in previous Cisco IOS images. To ensure interoperability between gateways using different Cisco IOS images, follow these guidelines:
•
•
If both the originating and terminating gateways are using Cisco IOS Release 12.2(11)T or a later version, this command is not required.
Examples
The following example specifies use of dynamic RTP payload type for fax and modem calls for mu-law PCM calls in an MGCP network in which the other gateway is running a version of Cisco IOS that is earlier than Release 12.2(11)T:
Router# mgcp rtp payload-type cisco-pcm-switch-over-ulaw 126The following example specifies use of a static RTP payload type for a G.726R16 codec in an MGCP network in which the other gateway is running a version of Cisco IOS that is earlier than Release 12.2(11)T:
Router# mgcp rtp payload-type g726r16 staticRelated Commands
mgcp codec
Select the default codec type and its optional packetization period value.
mgcp rtp unreachable timeout
To enable detection of an unreachable remote VoIP endpoint, use the mgcp rtp unreachable timeout command in global configuration mode. To disable detection, use the no form of this command.
mgcp rtp unreachable timeout timer-value
no mgcp rtp unreachable timeout
Note
Syntax Description
timer-value
Time, in milliseconds, that the system waits for voice packets from the unreachable endpoint. Range is 500 to 10000.
Defaults
Detection is disabled.
Command Modes
Global configuration
Command History
12.2(2)T
This command was introduced.
12.2(11)T
This command was implemented on the Cisco AS5300 and Cisco AS5850.
Usage Guidelines
This command is useful for preventing calls from remaining open when the remote endpoint is no longer available.
For example, suppose an IP phone makes a call through a gateway to another IP phone. During the call, the call agent goes down and the remote IP phone hangs up. Normally, the call agent would tell the gateway to tear down the call. In this case, the gateway continues to treat the call as active and sends more voice packets to the remote IP phone. The remote IP phone returns Internet Control Message Protocol (ICMP) port unreachable messages to the gateway. If the mgcp rtp unreachable timeout command is enabled, the gateway tears down the call. If the command is disabled, the call is left open.
The timer-value argument tells the gateway how long to wait before tearing down the call. After receiving the ICMP the unreachable message, the gateway starts a timer. If the gateway does not receive any voice packets by the end of the timer-value period, the gateway tears down the call. If some voice packets arrive before the end of the timer-value period, the gateway resets the timer and leaves the call in active state.
Examples
The following example sets the Real-Time Transport Protocol (RTP) unreachable timer to 1500 ms:
Router(config)# mgcp rtp unreachable timeout 1500Related Commands
mgcp
Initiates the MGCP daemon.
mgcp timer
Configures RTP stream host detection.
mgcp rtrcac
To enable Media Control Gateway Protocol (MGCP) Service Assurance (SA) Agent Call Admission Control (CAC) on an MGCP gateway supporting VoIP, use the mgcp rtrcac command in global configuration mode. To disable SA Agent checking on the gateway, use the no form of this command.
mgcp rtrcac
no mgcp rtrcac
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to initiate or disable MGCP SA Agent CAC on the MGCP gateway.
Examples
The following example enables MGCP SA Agent CAC:
Router(config)# mgcp rtrcacRelated Commands
mgcp sdp
To specify parameters for Session Definition Protocol (SDP) operation in Media Gateway Control Protocol (MGCP), use the mgcp sdp command in global configuration mode. To disable the parameters, use the no form of this command.
mgcp sdp {notation undotted | simple | xpc-codec}
no mgcp sdp {notation undotted | simple | xpc-codec}
Syntax Description
Defaults
notation undotted: disabled
simple: disabled
xpc-codec: disabledCommand Modes
Global configuration
Command History
Usage Guidelines
This command allows you to configure SDP fields to meet the requirements of your call agent.
The notation undotted keyword is for the G.726-16 and G.729 codecs. The codec strings G.726-16 and G.729 are dotted notation. The codec notation format is selected dynamically in the following order of preference:
1.
2.
3.
The simple keyword, when enabled, causes the gateway not to generate the following SDP fields: o (origin and session identifier), s (session name), and t (session start time and stop time). Certain call agents require this modified SDP to send data through the network.
The xpc-codec keyword, in TGCP and NCS, defines a new field (X-pc-codec) in the SDP for codec negotiation. To be backward compatible with non-packet-cable SDPs, the initial generation of the X-pc-codec field is suppressed by default. However, if a received SDP contains this field, the X-pc-codec field is read and generated in response to continue with the codec negotiation.
Examples
The following example configures simple mode for SDP:
Router(config)# mgcp sdp simpleRelated Commands
mgcp sgcp disconnect notify
To enable enhanced endpoint synchronization after a disconnected procedure in a Simple Gateway Control Protocol (SGCP) version 1.5 network, use the mgcp sgcp disconnect notify command in global configuration mode. To disable this feature, use the no form of this command.
mgcp sgcp disconnect notify
no mgcp sgcp disconnect notify
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used with SGCP version 1.5 to provide enhanced messaging capability for an endpoint that undergoes the disconnected procedure. It does not apply to gateways that run Media Control Gateway Protocol (MGCP) or other versions of SGCP.
An SGCP endpoint may lose communication with its call agent because the call agent is temporarily off line or because of faults in the network. When a gateway recognizes that an endpoint has lost its communication with the call agent (has become disconnected), it attempts to restore contact. If contact is not established before the disconnected timer expires, the disconnected procedure is initiated.
The disconnected procedure consists of the endpoint sending a Restart In Progress (RSIP) message to the call agent, stating that the endpoint was disconnected and is now trying to reestablish connectivity. If the mgcp sgcp disconnect notify command has been configured on the gateway, a special disconnected RSIP message is sent. When contact is reestablished, the call agent may decide to audit the endpoint using an Audit Endpoint (AUEP) command with additional I, ES, and RM parameters, which are defined as follows:
•
•
•
Endpoint synchronization with the call agent is achieved by the exchange of the disconnected RSIP message and the endpoint audit.
Examples
The following example enables disconnected RSIP messaging between SGCP endpoints and a call agent:
Router(config)# mgcp sgcp disconnect notifyRelated Commands
mgcp sgcp restart notify
Enables the MGCP application to process SGCP-type RSIP messages.
show mgcp
Displays information for MGCP and SGCP parameters.
mgcp sgcp restart notify
To trigger the Media Gateway Control Protocol (MGCP) application to process Simple Gateway Control Protocol (SGCP)-type restart in progress (RSIP) messages, use the mgcp sgcp restart notify command in global configuration mode. To cancel the trigger, use the no form of this command.
mgcp sgcp restart notify
no mgcp sgcp restart notify
Syntax Description
This command has no arguments or keywords.
Defaults
SGCP does not send any RSIP messages when the protocol type is configured as SGCP.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used to send RSIP messages from the router to the SGCP call agent. The RSIP messages are used to indicate whether the T1 controller is up or down so that the call agent can synchronize with the router. RSIP messages are also sent when the mgcp command is entered, enabling the MGCP daemon.
Examples
The following example specifies that the system sends an RSIP notification to the SGCP call agent when the T1 controller state changes:
Router(config)# mgcp sgcp restart notifyRelated Commands
mgcp src-cac
To enable System Resource Check (SRC) Call Admission Control (CAC) on a Media Gateway Control Protocol (MGCP) gateway supporting VoIP, use the mgcp src-cac command in global configuration mode. To disable system resource checking on the gateway, use the no form of this command.
mgcp src-cac
no mgcp src-cac
Syntax Description
This command has no arguments or keywords.
Defaults
System resource checking is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
When this command is entered, all system-resource checks of CPU utilization, memory utilization, and maximum number of calls are performed for every call setup or modification request received from the call agent.
Examples
The following example enables MGCP VoIP SRC CAC:
Router(config)# mgcp src-cacRelated Commands
call threshold global
Sets threshold values for SRC CAC parameters.
mgcp
Starts and allocates resources for the MGCP daemon.
mgcp timer
To configure how a gateway detects the Real-Time Transport Protocol (RTP) stream host, use the mgcp timer command in global configuration mode. To reset to the defaults, use the no form of this command.
mgcp timer {receive-rtcp timer | net-cont-test timer | nse-response t38 timer}
no mgcp timer {receive-rtcp | net-cont-test}
Syntax Description
Defaults
receive-rtcp timer: 5 ms
net-cont-test timer: 200 ms
nse-response t38 timer: 200 msCommand Modes
Global configuration
Command History
Usage Guidelines
Use this command to specify the RTP Control Protocol (RTCP) transmission interval for VoIP calls and the continuity-test timeout interval for VoIP and VoATM adaptation layer 2 (VoAAL2) calls.
The receive-rtcp keyword is the timer used by a gateway to disconnect a VoIP call when IP connectivity is lost with the remote gateway. After receiving each packet from the remote gateway, the receiving gateway starts a timer for the timed period. If the timer expires before the next packet is received from the remote gateway, the receiving gateway disconnects the call and notifies the call agent.
The net-cont-test keyword uses the terminating gateway to verify the network connectivity with the originating gateway before ringing the called party. To do this, the terminating gateway sends a command packet to the originating gateway and starts a timed for the timer period. If the timer expires before any acknowledgement from the originating gateway is received, the terminating gateway does not ring the called party, but instead disconnects the call and alerts the call agent.
The nse-response t38 option sets the timer for awaiting T.38 NSE responses. This timer is configured to tell the terminating gateway how long to wait for an NSE from a peer gateway. The NSE from the peer gateway can either acknowledge the switch and its readiness to accept packets or indicate that it cannot accept T.38 packets.
Examples
The following example sets the receive-rtcp timer to 25 ms:
Router(config)# mgcp timer receive-rtcp 25The following example sets the net-cont-test timer to 1500 ms (1.5 seconds):
Router(config)# mgcp timer net-cont-test 1500The following example enables MGCP fax relay and sets the gateway wait time to 300 ms for an NSE from a peer gateway:
Router(config)# mgcp timer nse-response t38 300Related Commands
mgcp tse payload
To enable inband telephony signaling events (TSEs) and specify the payload value to be used during fax and modem pass-through and network continuity tests, use the mgcp tse payload command in global configuration mode. To disable these signaling events, use the no form of this command.
mgcp tse payload value
no mgcp tse payload
Syntax Description
Defaults
100
Command Modes
Global configuration
Command History
Usage Guidelines
Because this command is disabled by default, you must specify a TSE payload value. Both gateways must have the same payload value.
If you configure the mgcp modem passthrough mode command using the nse keyword, you must configure this command.
Examples
The following example sets NSE mode for VoIP modem pass-through and sets the TSE payload:
Router(config)# mgcp modem passthrough voip mode nseRouter(config)# mgcp tse payload 100Related Commands
mgcp
Starts the MGCP daemon.
mgcp modem passthrough mode
Sets the method for changing speeds for modem and fax transmissions on the gateway.
mgcp vad
To enable voice activity detection (VAD) silence suppression for Media Gateway Control Protocol (MGCP), use the mgcp vad command in global configuration mode. To disable VAD silence suppression, use the no form of this command.
mgcp vad
no mgcp vad
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to tell the MGCP gateway to turn VAD silence suppression on or off.
If VAD silence suppression is turned on, silence is not sent over the network, only audible speech. Sound quality is slightly degraded but the connection monopolizes much less bandwidth.
Examples
The following example turns VAD silence suppression on:
Router(config)# mgcp vadRelated Commands
mgcp validate domain-name
To check if the domain name or host name and IP address received as part of the endpoint names in the Media Gateway Control Protocol (MGCP) messages match the ones configured on the gateway (GW), use the mgcp validate domain-name command in global configuration mode. To disable the checking feature, use the no form of this command.
mgcp validate domain-name
no mgcp validate domain-name
Syntax Description
This command has no arguments or keywords.
Defaults
Checking is enabled.
Command Modes
Global configuration
Command History
Usage Guidelines
This command checks to see if the domain name or host name and the IP address received as part of the endpoint names sent from the call agent (CA) or Cisco CallManager match the ones that have been configured on the GW. This check is valid for all the MGCP messages received from the CA or Cisco CallManager only.
Use the mgcp validate domain-name command first before configuring MGCP globally in a VoIP network.
This command is enabled by default. You can disable the command by using the no form of the command. If the command is disabled, the checking feature is not used, and the MGCP functionality is not changed.
This command is not visible when you enter the show running-config command unless you disable the command by using the no form.
1.
aaln/S4/SU1/0@gateway.cisco.comIf the endpoint name above is discovered, the configuration on the gateway should be as follows:
hostname gatewaydomain-name cisco.comIf another value is specified for gateway or cisco.com, a NACK message is sent to the CA.
2.
aaln/S4/SU1/0@<1.2.3.4>If the IP address following the endpoint name above is discovered, the IP address called <1.2.3.4> obtained in the message should be configured on one of the interfaces on the gateway.
Examples
The following example indicates that MGCP and IP address checks are turned on:
Router(config)# mgcp validate domain-nameThe following example indicates that MGCP and IP address checks are turned of:
Router(config)# no mgcp validate domain-nameRelated Commands
microcode reload controller
To reload the firmware and Field Programmable Gateway Array FPGA from the command-line interface (CLI) without reloading the Cisco IOS image, use the microcode reload controller command in privileged EXEC mode.
microcode reload controller {t1 | e1| j1} {x/y}
Syntax Description
Defaults
No microcode reload activity is initiated
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Loopbacks in the running configuration are restored after this command is entered. If the controller is in a looped state before this command is issued, the looped condition is dropped. You have to reinitiate the loopbacks from the remote end by entering the no loop command from the controller configuration.
Examples
The following example initiates microcode reload on the J1 controller:
Router# microcode reload controller j1 3/0TDM-connections and network traffic will be briefly disrupted.Proceed with reload microcode?[confirm]Router#*Mar 3 209.165.200.225: clk_src_link_up_down: Status of this CLK does not matter*Mar 3 209.165.200.226: clk_src_link_up_down: Status of this CLK does not matter*Mar 3 209.165.200.227: %CONTROLLER-5-UPDOWN: Controller J1 3/0, changed state to)*Mar 3 209.165.200.227: clk_src_link_up_down: Status of this CLK does not matter*Mar 3 209.165.200.228: clk_src_link_up_down: Status of this CLK does not matter*Mar 3 209.165.200.229: %CONTROLLER-5-UPDOWN: Controller J1 3/0, changed state top*Mar 3 209.165.200.229: clk_src_link_up_down: Status of this CLK does not matter*Mar 3 209.165.200.229: clk_src_link_up_down: Status of this CLK does not mattermin-se (SIP)
To change the minimum session expiration (Min-SE) header value for all calls that use the Session Initiation Protocol (SIP) session timer, use the min-se command in SIP configuration mode. To reset to the default, use the no form of this command.
min-se time
no min-se
Syntax Description
Defaults
1800 seconds (30 minutes)
Command Modes
SIP configuration
Command History
Usage Guidelines
A proxy, user-agent client, and user-agent server can all have a configured minimum value indicating the smallest session interval that they accept. If they all happen to have a different configured minimum value, the highest minimum value is used. This command sets the minimum timer that is conveyed in the Min-SE header in the initial INVITE request.
The recommended value for this command is 1800 seconds (30 minutes), which is the default value. The minimum value is 60 seconds. The value cannot be set below 60 seconds because excessive INVITEs create problems for routers. Once set, the value affects all calls originated by the router.
Examples
The following example sets the expiration timer to 1800 seconds:
Router(config)# voice service voipRouter(conf-voi-serv)# sipRouter(conf-serv-sip)# min-se 1800Related Commands
mmoip aaa global-password
To define a password to be used with CiscoSecure for Windows NT when using store and forward fax, use the mmoip aaa global-password command in global configuration mode. To reset to the default, use the no form of this command.
mmoip aaa global-password password
no mmoip aaa global-password password
Syntax Description
password
Password for CiscoSecure for Windows NT to be used with store and forward fax. The maximum length is 64 alphanumeric characters.
Defaults
No password is defined
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced on the Cisco AS5300.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
Usage Guidelines
CiscoSecure for Windows NT might require a separate password in order to complete authentication, no matter what security protocol you use. This command defines the password to be used with CiscoSecure for Windows NT. All records on the Windows NT server use this defined password.
This command applies to on-ramp store and forward fax functions when using a modem card. It is not used with voice feature cards.
Examples
The following example specifies a password (password) when CiscoSecure for Windows NT is used with store and forward fax:
mmoip aaa global-password passwordmmoip aaa method fax accounting
To define the name of the method list to be used for authentication, authorization, and accounting (AAA) accounting with store-and-forward fax, use the mmoip aaa method fax accounting command in global configuration mode. To reset to the undefined state, use the no form of this command.
mmoip aaa method fax accounting method-list-name
no mmoip aaa method fax accounting method-list-name
Syntax Description
Defaults
No AAA accounting method list is defined
Command Modes
Global configuration
Command History
Usage Guidelines
This command defines the name of the AAA accounting method list to be used with store-and-forward fax. The method list itself, which defines the type of accounting services provided for store-and-forward fax, is defined using the aaa accounting command in global configuration mode. Unlike standard AAA (in which each defined method list can be applied to specific interfaces and lines), the AAA accounting method lists used in store-and-forward fax are applied globally.
After the accounting method lists have been defined, they are enabled by using the mmoip aaa receive-accounting enable command.
This command applies to both on-ramp and off-ramp store-and-forward fax functions when a modem card is used. It is not used with voice feature cards.
Examples
The following example specifies a AAA accounting method list (called "list3") to be used with store-and-forward fax:
aaa new-modelmmoip aaa method fax accounting list3Related Commands
mmoip aaa method fax authentication
To define the name of the method list to be used for authentication, authorization, and accounting (AAA) authentication with store and forward fax, use the mmoip aaa method fax authentication command in global configuration mode. To reset to the default, use the no form of this command.
mmoip aaa method fax authentication method-list-name
no mmoip aaa method fax authentication method-list-name
Syntax Description
Defaults
No AAA authentication method list is defined
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced on the Cisco AS5300.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
Usage Guidelines
This command defines the name of the AAA authentication method list to be used with store and forward fax. The method list itself, which defines the type of authentication services provided for store and forward fax, is defined using the aaa authentication global configuration command. Unlike standard AAA (where each defined method list can be applied to specific interfaces and lines), AAA authentication method lists used with store and forward fax are applied globally on the Cisco AS5300 universal access server.
After the authentication method lists have been defined, they are enabled by using the mmoip aaa receive-authentication enable command.
This command applies to both on-ramp and off-ramp store and forward fax functions.
Examples
The following example specifies a AAA authentication method list (called xyz) to be used with store and forward fax:
aaa new-modelmmoip aaa method fax authentication xyzRelated Commands
mmoip aaa receive-accounting enable
To enable on-ramp authentication, authorization, and accounting (AAA) services, use the mmoip aaa receive-accounting enable command in global configuration mode. To disable on-ramp AAA services, use the no form of this command.
mmoip aaa receive-accounting enable
no mmoip aaa receive-accounting enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
12.2(4)T
This command was introduced on the Cisco 1750.
Usage Guidelines
This command enables AAA services if an accounting method list has been defined using both the aaa accounting command and the mmoip aaa method fax accounting command.
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example specifies an AAA method list (called xyz) to be used with inbound store-and-forward fax. In this example, store-and-forward fax is configured to track start and stop connection accounting records.
aaa new-modelmmoip aaa method fax accounting xyzaaa accounting connection sherman stop-only radiusmmoip aaa receive-accounting enableRelated Commands
mmoip aaa receive-authentication enable
To enable on-ramp authentication, authorization, and accounting (AAA) services, use the mmoip aaa receive-authentication enable command in global configuration mode. To disable on-ramp AAA services, use the no form of this command.
mmoip aaa receive-authentication enable
no mmoip aaa receive-authentication enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
12.2(4)T
This command was introduced on the Cisco 1750.
Usage Guidelines
This command enables AAA services if an AAA method list has been defined using both the aaa authentication command and the mmoip aaa method fax authentication command.
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example specifies an AAA method list (called xyz) to be used with inbound store-and-forward fax. In this example, RADIUS authentication (and if the RADIUS server fails, then local authentication) is configured for store-and-forward fax.
aaa new-modelmmoip aaa method fax authentication xyzaaa authentication login peabody radius localmmoip aaa receive-authentication enableRelated Commands
mmoip aaa receive-id primary
To specify the primary location from which the authentication, authorization, and accounting (AAA) protocol retrieves its account identification information for on-ramp faxing, use the mmoip aaa receive-id primary command in global configuration mode. To remove the definition of the account identification source, use the no form of this command.
mmoip aaa receive-id primary {ani | dnis | gateway | redialer-id | redialer-dnis}
no mmoip aaa receive-id primary {ani | dnis | gateway | redialer-id | redialer-dnis}
Syntax Description
Defaults
No account identification source is defined
Command Modes
Global configuration
Command History
Usage Guidelines
Normally, when AAA is being used for simple user authentication, AAA uses the username information defined in the user profile for authentication. With store-and-forward fax, you can specify that the ANI, DNIS, gateway ID, redialer ID, or redialer DNIS be used to identify the user for authentication. This command defines what AAA uses for the primary identifier for inbound or on-ramp user authentication with store-and-forward fax.
Store-and-forward fax allows you to define either a primary or a secondary identifier. You configure the secondary identifier using the mmoip aaa receive-id secondary command.
AAA does not use these methods sequentially. If the primary identifier is defined and AAA cannot authenticate the primary identifier information, it does not use the secondary identifier for authentication. Authentication simply fails.
Defining only the secondary identifier enables you to service two different scenarios simultaneously—for example, if you are offering fax services to two different companies, one of which uses redialers and the other does not. In this case, configure the mmoip aaa receive-id primary command to use the redialer DNIS, and configure the mmoip aaa receive-id secondary command to use ANI. With this configuration, when a user dials in and the redialer DNIS is not null, the redialer DNIS is used as the authentication identifier. If a user dials in and the redialer DNIS is null, ANI is used as the authentication identifier.
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example defines the DNIS captured by the redialer as the primary AAA authentication identifier for store-and-forward fax:
aaa new-modelmmoip aaa receive-id primary redialer-dnisRelated Commands
mmoip aaa receive-id secondary
To specify the secondary location where the authentication, authorization, and accounting (AAA) protocol retrieves its account identification information for on-ramp faxing if the primary identifier has not been defined, use the mmoip aaa receive-id secondary command in global configuration mode. To remove the definition of the account identification source, use the no form of this command.
mmoip aaa receive-id secondary {ani | dnis | gateway | redialer-id | redialer-dnis}
no mmoip aaa receive-id secondary {ani | dnis | gateway | redialer-id | redialer-dnis}
Syntax Description
Defaults
No account identification source is defined
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
12.2(4)T
This command was introduced on the Cisco 1750.
Usage Guidelines
Normally, when AAA is being used for simple user authentication, AAA uses the username information defined in the user profile for authentication. With store-and-forward fax, you can specify that the ANI, DNIS, gateway ID, redialer DNIS, or redialer ID be used to identify the user for authentication. This command defines what AAA uses for the secondary identifier for inbound or on-ramp user authentication with store-and-forward fax if the primary identifier has not been defined.
Store-and-forward fax allows you to define either a primary or a secondary identifier. You configure the primary identifier using the mmoip aaa receive-id primary command.
AAA does not use these methods sequentially—meaning that if the primary identifier is defined and AAA cannot match the primary identifier information, it does not use the secondary identifier for authentication. Authentication simply fails.
Defining only the secondary identifier enables you to service two different scenarios simultaneously—for example, if you are offering fax services to two different companies, one of which uses redialers and the other does not. In this case, configure the mmoip aaa receive-id primary command to use the redialer DNIS, and configure the mmoip aaa receive-id secondary command to use ANI. With this configuration, when a user dials in and the redialer DNIS is not null, the redialer DNIS is used as the authentication identifier. If a user dials in and the redialer DNIS is null, ANI is used as the authentication identifier.
This command applies to on-ramp store-and-forward fax functions.
Examples
The following example defines the DNIS captured by the redialer as the secondary AAA authentication identifier for store-and-forward fax:
aaa new-modelmmoip aaa receive-id secondary redialer-dnisRelated Commands
mmoip aaa receive-id primary
Specifies the primary location where AAA retrieves its account identification information for on-ramp faxing.
mmoip aaa send-accounting enable
To enable off-ramp authentication, authorization, and accounting (AAA) services, use the mmoip aaa send-accounting enable command in global configuration mode. To reset to the default, use the no form of this command.
mmoip aaa send-accounting enable
no mmoip aaa send-accounting enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
12.2(4)T
This command was implemented on the Cisco 1750.
Usage Guidelines
This command enables AAA services if an AAA method list has been defined using both the aaa accounting command and the mmoip aaa method fax accounting command.
This command applies to off-ramp store-and-forward fax functions when using a modem card. It is not used with voice feature cards.
Examples
The following example specifies an AAA method list (called xyz) to be used with outbound store-and-forward fax. In this example, store-and-forward fax is configured to track start and stop connection accounting records.
aaa new-modelmmoip aaa method fax accounting xyzaaa accounting connection sherman stop-only radiusmmoip aaa send-accounting enableRelated Commands
mmoip aaa send-authentication enable
To enable off-ramp authentication, authorization, and accounting (AAA) services, use the mmoip aaa send-authentication enable command in global configuration mode. To disable off-ramp AAA services, use the no form of this command.
mmoip aaa send-authentication enable
no mmoip aaa send-authentication enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
12.2(4)T
This command was implemented on the Cisco 1750.
Usage Guidelines
This command enables AAA services if an AAA method list has been defined using both the aaa authentication command and the mmoip aaa method fax authentication command.
This command applies to off-ramp store-and-forward fax functions.
Examples
The following example specifies an AAA method list (called xyz) to be used with outbound store-and-forward fax. In this example, RADIUS authentication (and if the RADIUS server fails, then local authentication) is configured for store-and-forward fax.
aaa new-modelmmoip aaa method fax authentication xyzaaa authentication login peabody radius localmmoip aaa send-authentication enableRelated Commands
mmoip aaa send-id primary
To specify the primary location where the authentication, authorization, and accounting (AAA) protocol retrieves its account identification information for off-ramp faxing, use the mmoip aaa send-id primary command in global configuration mode. To remove the definition of the account identification source, use the no form of this command.
mmoip aaa send-id primary {account-id | envelope-from | envelope-to | gateway}
no mmoip aaa send-id primary {account-id | envelope-from | envelope-to | gateway}
Syntax Description
Defaults
No account identification source is defined
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
12.2(4)T
This command was implemented on the Cisco 1750.
Usage Guidelines
Normally, when AAA is being used for simple user authentication, AAA uses the username information defined in the user profile for authentication. With store-and-forward fax, you can specify that the account ID, username, or recipient name from the e-mail header information be used to identify the user for authentication. This command defines what AAA uses for the primary identifier for outbound or off-ramp user authentication with store-and-forward fax.
Store-and-forward fax allows you to define either a primary or a secondary identifier. You configure the secondary identifier using the mmoip aaa send-id secondary command. AAA extracts the authentication identifier information from the defined sources. If the field is blank (meaning undefined), AAA uses the secondary identifier source if configured. The secondary identifier is used only when the primary identifier is null. In this case, when AAA sees that the primary identifier is null, it checks to see if a secondary identifier has been defined and use that value for user authentication.
AAA does not use these methods sequentially—meaning that if the primary identifier is defined and AAA cannot authenticate the primary identifier information, it does not use the secondary identifier for authentication. Authentication simply fails.
When you enable authentication, the on-ramp gateway inserts whatever value you configure for the mmoip aaa receive-id primary command in the X-account ID field of the e-mail header. This X-account ID field contains the value that is used for authentication and accounting by the on-ramp gateway. For example, if the mmoip aaa receive-id primary command is set to gateway, the on-ramp gateway name (for example, hostname.domain-name) is inserted in the X-account ID field of the e-mail header of the fax-mail message.
If you want to use this configured gateway value in the X-account ID field, you must configure the mmoip aaa send-id primary command with the account-id keyword. This particular keyword enables store-and-forward fax to generate end-to-end authentication and accounting tracking records. If you do not enable authentication on the on-ramp gateway, the X-account ID field is left blank.
This command applies to off-ramp store-and-forward fax functions.
Examples
The following example specifies the recipient name as defined in the envelope-to field of the e-mail header to be used as the AAA authentication identifier for store-and-forward fax:
aaa new-modelmmoip aaa send-id primary envelope-toRelated Commands
mmoip aaa send-id secondary
To specify the secondary location where the authentication, authorization, and accounting (AAA) protocol retrieves its account identification information for off-ramp faxing, use the mmoip aaa send-id secondary command in global configuration mode. To remove the definition of the account identification source, use the no form of this command.
mmoip aaa send-id secondary {account-id | envelope-from | envelope-to | gateway}
no mmoip aaa send-id secondary {account-id | envelope-from | envelope-to | gateway}
Syntax Description
Defaults
No account identification source is defined
Command Modes
Global configuration
Command History
12.0(4)XJ
This command was introduced.
12.1(1)T
This command was integrated into Cisco IOS Release 12.1(1)T.
12.2(4)T
This command was implemented on the Cisco 1750.
Usage Guidelines
Normally, when AAA is being used for simple user authentication, AAA uses the username information defined in the user profile for authentication. With store-and-forward fax, you can specify that the account ID, username, or recipient name from the e-mail header information be used to identify the user for authentication. This command defines what AAA uses for the secondary identifier for outbound or off-ramp user authentication with store-and-forward fax.
Store-and-forward fax allows you to define either a primary or a secondary identifier. You configure the primary identifier using the mmoip aaa send-id primary command. AAA extracts the authentication identifier information from the defined sources. If the field is blank (meaning undefined), AAA uses the secondary identifier source if configured. The secondary identifier is used only when the primary identifier is null. In this case, when AAA sees that the primary identifier is null, it checks to see if a secondary identifier has been defined and use that value for user authentication.
AAA does not use these methods sequentially—meaning that if the primary identifier is defined and AAA cannot match the primary identifier information, it does not use the secondary identifier for authentication. Authentication simply fails.
When you enable authentication, the on-ramp gateway inserts whatever value you configure for the mmoip aaa receive-id secondary command in the X-account ID field of the e-mail header (if store-and-forward fax uses the defined secondary identifier). This X-account ID field contains the value that is used for authentication and accounting by the on-ramp gateway. For example, if the mmoip aaa receive-id secondary command is set to gateway, the on-ramp gateway name (for example, hostname.domain-name) is inserted in the X-account ID field of the e-mail header of the fax-mail message.
If you want to use this configured gateway value in the X-account ID field, you must configure the mmoip aaa send-id secondary command with the account-id keyword. This particular keyword enables store-and-forward fax to generate end-to-end authentication and accounting tracking records. If you do not enable authentication on the on-ramp gateway, the X-account ID field is left blank.
This command applies to off-ramp store-and-forward fax functions.
Examples
The following example specifies the recipient name as defined in the envelope-to field of the e-mail header to be used as the AAA authentication identifier for store-and-forward fax:
aaa new-modelmmoip aaa send-id secondary envelope-toRelated Commands
mode (T1/E1 controller)
To set the mode of the T1/E1 controller and to enter specific configuration commands for each mode type, use the mode command in global configuration mode. To rest to the default, use the no form of this command.
mode {atm [aim aim-slot] | cas}
no mode {atm [aim aim-slot] | cas}
Syntax Description
Defaults
No mode is configured.
Command Modes
Global 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 VoATM:
controller T1 0mode 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:
controller T1 1/0mode atm aim 0The following example configures CAS mode on controller T1 1 on a Cisco MC3810:
controller T1 1mode casThe following example enters controller mode of single-pair high-bit-rate digital subscriber line (SHDSL) on controller number 0 and configures ATM mode on a Cisco IAD2420 series IAD:
controller shdsl 0mode atmRelated 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
Defaults
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 on a Cisco IAD2420 series:
voice service voatmsession protocol aal2mode blesThe following example configures slave mode in BLES mode on a Cisco IAD2420 series:
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.
Defaults
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 2691, 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
Defaults
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
Defaults
Disabled
payload-type number: 100
sample-duration: 10Command 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}
no modem relay {nse | system}
Syntax Description
Defaults
Disabled
Payload type: 100Command Modes
Dial-peer configuration
Command 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 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:
•
•
When the system keyword is enabled, the following parameters are not available: nse, payload-type, codec, and redundancy. 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.
Examples
The following example configures modem relay over VoIP in dial-peer configuration mode for a specific dial peer using the G.711 u-law codec and enabling redundancy.
modem relay nse codec g711ulaw redundancyRelated Commands
modem relay (voice-service)
Configures modem relay globally for all VoIP dial peers.
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]no modem relay nse
Syntax Description
Defaults
Disabled
Payload type: 100Command Modes
Voice-service configuration
Command 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 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 gateway.
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 is 16. The value can be set from 1 through 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 fax or 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 configures modem relay for NSE payload type 101 using the G.711 u-law codec:
modem relay nse payload-type 101 codec g711ulaw redundancy maximum-session 1Related Commands
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.
Defaults
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.
Defaults
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.
Defaults
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
moh (cm-fallback)
To configure music on hold (MOH), use the moh command in call-manager-fallback configuration mode. To disable MOH, use the no form of this command.
moh filename
no moh filename
Syntax Description
Defaults
Tone on hold (a periodic beep is played to the caller)
Command Modes
Call-manager-fallback configuration
Command History
Usage Guidelines
This command configures .au and .wav format music files. Music on hold works only for G.711 calls and on-net VoIP and PSTN calls. For all other calls, tone on hold works where a periodic beep is played to the caller. Internal calls between Cisco IP phones do not get music on hold; instead, the Cisco IP phones get tone on hold.
Note
Examples
The following example enables music on hold and sets the music files:
Router(config)# call-manager-fallbackRouter(config-cm-fallback)# moh minuet.wavRouter(config-cm-fallback)# moh minuet.auRelated Commands
call-manager-fallback
Enables SRS Telephony feature support and enters call-manager-fallback configuration mode.
moh (ephone-dn)
To enable music on hold from a external live audio feed (standard line level audio connection) connected directly to the router by an FXO or an E&M analog voice port for Cisco IP phones using Cisco IOS Telephony Service (ITS), use the moh command in ephone-dn configuration mode. To disable music on hold from a live feed, use the no form of this command
moh out-call outcall-number
no moh out-call outcall-number
Syntax Description
Defaults
No default behavior or values
Command Modes
Ephone-dn configuration
Command History
12.2(11)YT
This command was introduced.
12.2(15)T
This command was integrated into Cisco IOS Release 12.2(15)T.
Usage Guidelines
An MoH connection is established as an automatically connected voice call. The MoH call can be established either by the ITS MoH system itself, or by any external source directly calling into the MoH directory number (including calls over voice over IP (VoIP) if voice activity detection (VAD) is disabled). The typical operation is for the ITS MoH directory number to establish an MoH call to a local router E&M voice port.
Connection via E&M is the recommended mechanism because it requires minimal external components. The E&M port must be placed in 4-wire operation, using E&M immediate signaling and with the auto-cut-through option enabled.
The recommended interface for live feed MoH is an analog E&M port because it requires the minimum number of external components. You directly connect a line level audio feed (standard audio jack) to pins 3 and 6 of an E&M RJ-45 connector. The E&M WAN interface card (WIC) has a built-in audio transformer that provides appropriate electrical isolation for the external audio source. (The audio connection on the E&M port does not require loop-current). The signal immediate and auto-cut-through commands disable E&M signaling on this voice port. A G.711 audio packet stream is generated by the digital signal processor (DSP) on the E&M port.
If you are using an FXO voice port for live-feed MoH instead of an E&M port, connect the MoH source to the FXO voice port. This connection requires an external adapter device to supply normal telephone company (telco) battery voltage with the correct polarity to the tip and ring leads of the FXO port. The adapter device must also provide transformer-based isolation between the external audio source and the tip and ring leads of the FXO port.
Music from a live feed is continuously fed into the MoH playout buffer instead of being read from an audio file in Flash memory. There is typically a 2-second delay with live-feed MoH.
The outbound call to the MoH live-feed source is attempted (or re-attempted) every 30 seconds until connected by the directory number that has been configured for MoH.
If you also configure the moh command with the filename argument in telephony-service configuration mode, MoH will fall back to playing music from an audio file if the live music feed is interrupted.
Examples
The following example establishes a live music-on-hold source by setting up a call to extension 7777:
Router(config)# ephone-dn 55Router(config-ephone-dn)# moh out-call 7777Related Commands
moh (telephony-service)
To configure music on hold (MOH), use the moh command in telephony-service configuration mode. To disable MOH, use the no form of this command.
moh filename
no moh filename
Syntax Description
Defaults
Tone-on-hold (a periodic beep is played to the caller)
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
This command configures .au and .wav format music files. Music on hold only works for G.711 calls and on-net VoIP and PSTN calls. For all other calls, tone on hold works where a periodic beep is played to the caller. The internal calls between Cisco IP phones do not get music on hold, instead the IP phones get tone on hold. The MOH files are downloaded to the router's Flash memory.
Note
Examples
The following example enables music on hold and sets the music files:
Router(config)# telephony-serviceRouter(config-telephony-service)# moh minuet.wavRouter(config-telephony-service)# moh minuet.auRelated Commands
telephony-service
Enables Cisco IOS Telephony Service and enters telephony-service configuration mode.
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.
Defaults
3600 seconds (1 hour)
Command Modes
Global configuration
Command History
12.2(11)T
This command was introduced on the following platforms: Cisco 3640, Cisco 3660, Cisco AS5300, Cisco AS5350, and Cisco AS5400.
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):
mrcp client session history duration 7200Related Commands
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.
Defaults
50 records
Command Modes
Global configuration
Command History
12.2(11)T
This command was introduced on the following platforms: Cisco 3640, Cisco 3660, Cisco AS5300, Cisco AS5350, and Cisco AS5400.
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:
mrcp client history records 30Related Commands
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.
Defaults
MRCP client statistics are disabled.
Command Modes
Global configuration
Command History
12.2(11)T
This command was introduced on the following platforms: Cisco 3640, Cisco 3660, Cisco AS5300, Cisco AS5350, and Cisco AS5400.
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:
mrcp client statistics enableRelated Commands
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
How long, in seconds, the router waits to connect to the server before timing out. Range is 1 to 20.
Defaults
3 seconds
Command Modes
Global configuration
Command History
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:
mrcp client timeout connect 10Related Commands
mrcp 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
How long, in seconds, the router waits for a response from the server after making a request. Range is 1 to 20.
Defaults
3 seconds
Command Modes
Global configuration
Command History
Usage Guidelines
This command sets how long 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:
mrcp client timeout message 10Related Commands
mta receive aliases
To specify a host name 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
Defaults
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-mdn
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.
Defaults
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.
Defaults
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
Defaults
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
Defaults
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").
Defaults
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 -0800In other words, using 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.
Defaults
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
Defaults
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 {host-name | ip-address}
no mta send server {host-name | ip-address}
Syntax Description
host-name
Host name of the destination mail server.
ip-address
IP address of the destination mail server.
Defaults
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
Defaults
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 number
no music-threshold number
Syntax Description
Defaults
-38 dB
Command Modes
Voice-port configuration
Command History
11.3(1)T
This command was introduced on the Cisco 3600 series.
12.0(4)T
This command was implemented on the Cisco MC3810.
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 only affects the operation of voice activity detection (VAD) when 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 -35The following example sets the decibel threshold to -35 for the music played when calls are put on hold on a Cisco MC3810 multiservice concentrator:
voice-port 1/1music-threshold -35Related Commands
mwi (ephone-dn)
To configure specific Cisco IP phone directory numbers to receive message-waiting indication (MWI) from an external voice-mail system, use the mwi command in ephone-dn configuration mode. To disable this feature, use the no form of this command.
mwi {off | on | on-off}
no mwi {off | on | on-off}
Syntax Description
Defaults
No default behavior or values
Command Modes
Ephone-dn configuration
Command History
Usage Guidelines
This command configures a Cisco IP phone directory number to receive MWI from an external voice-mail system. The notification is set for all the Cisco IP phones connected to the Cisco IOS Telephony Service router. The external voice-mail systems are able to communicate MWI status by making telephone calls to dummy extension numbers, with the MWI information embedded in either the called or calling party IP phone number. This command cannot be configured unless the number command is configured under ephone-dn configuration mode.
Examples
The following example sets MWI to on:
Router(config)# ephone-dn 1Router(config-ephone-dn) number 8000Router(config-ephone-dn) mwi onThe following example sets MWI to off.Router(config)# ephone-dn 2Router(config-ephone-dn) number 8001Router(config-ephone-dn) mwi offThe following example sets MWI to on-off for the primary and secondary number, where the MWI information is embedded in the calling party number:
Router(config)# ephone-dn 3Router(config-ephone-dn) number 8002 secondary 8003Router(config-ephone-dn) mwi on-offIn the example above, a call placed by the voice-mail system to 8002 turns on the MWI light for the extension number indicated by the calling party number for the MWI call. A call placed to 8003 turns off the MWI light.
The following example sets MWI to on-off for the primary and secondary number, where the MWI information is embedded in the called party number:
Router(config)# ephone-dn 20Router(config-ephone-dn) number 8000*....*1 secondary 8000*....*2Router(config-ephone-dn) mwi on-offIn the example above, a call placed by the voice-mail system to 8000*5001*1 turns on the MWI light for extension 5001. A call to 8000*5001*2 turns off the MWI light.
Related Commands
mwi expires (telephony-service)
To set the expiration timer for registration for either the client or the server, use the mwi expires command in telephony-service configuration mode. To disable the timer, use the no form of this command.
mwi expires seconds
no mwi expires seconds
Syntax Description
Defaults
86,400 seconds (24 hours)
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
Use this command to set the expiration timer for registration for either the client or the server.
Examples
The following example sets the expiration timer to 10 seconds:
Router(config)# telephony-serviceRouter(config-telephony-service)# mwi expires 10Related Commands
mwi relay (telephony-service)
To enable the Cisco IOS Telephony Service router to relay message-waiting indicators (MWIs) to remote Cisco IP phones, use the mwi relay command in telephony-service configuration mode. To disable MWI relay, use the no form of this command.
mwi relay
no mwi relay
Syntax Description
This command has no arguments or keywords.
Defaults
MWI is not enabled
Command Modes
Telephony-service configuration
Command History
Usage Guidelines
Use this command to enable the Cisco IOS Telephony Service router to relay MWI to remote Cisco IP phones. The Cisco IOS Telephony Service router at the central site acts as a notifier after this command is entered.
Examples
The following example sets MWI relay:
Router(config)# telephony-serviceRouter(config-telephony-service)# mwi relayRelated Commands
mwi sip (ephone-dn)
To subscribe an extension in a Cisco IOS Telephony Service router to receive message-waiting indication (MWI) from a Session Initiation Protocol (SIP) protocol-based MWI server, use the mwi sip command in ephone-dn configuration mode. To remove the configuration, use the no form of this command.
mwi sip
no mwi sip
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Ephone-dn configuration
Command History
Usage Guidelines
Use this command to subscribe an extension in a Cisco IOS Telephony Service router to receive MWI notification from a SIP MWI server. This function integrates a Cisco IOS Telephony Service router with a SIP-protocol-based MWI service.
Examples
The following example subscribes MWI notification from an external SIP MWI server requests the SIP MWI server to send MWI notification messages to the Cisco IOS Telephony Service router for the extension number This command requests that the SIP server configured for the Cisco IOS Telephony Service router send MWI notification messages through the SIP protocol for extension 5001:
Router(config) ephone-dn 1Router(config-ephone-dn) number 5001Router(config-ephone-dn) name John SmithRouter(config-ephone-dn) mwi sipRouter(config) telephony-serviceRouter(config-telephony-service) mwi sip-server 173.223.0.5Related Commands
mwi sip-server (telephony-service)
To configure IP address and port for the external Session Initiation Protocol (SIP)-based message-waiting indication (MWI) server, use the mwi sip-server command in telephony-service configuration mode. To disable the MWI server, use the no form of this command.
mwi sip-server ip-address [[transport tcp | transport udp] | [port port-number] | [reg-e164]]
no mwi sip-server ip-address
Syntax Description
Defaults
Transport layer protocol: TCP
Port number: 5060 (SIP standard port)
Registration: with an extension numberCommand Modes
Telephony-service configuration
Command History
Usage Guidelines
Use this command to configure the IP address of an external SIP MWI server. This IP address is used with the mwi sip (ephone-dn) command to subscribe individual ephone-dn extension numbers to the MWI SIP server's notification list. SIP MWI client runs TCP as default.
The transport tcp keyword is the default setting. The transport udp keyword allows you to integrate with a SIP MWI client. The optional port keyword is used to specify a port number. The default SIP port number is 5060. The default registration is with an extension number, so the reg-e164 keyword allows you to register with an E.164 ten-digit number.
Examples
The following example sets MWI for the SIP server and sets individual ephone-dn extension numbers to the MWI SIP server's notification list:
Router(config) ephone-dn 1Router(config-ephone-dn) number 5001Router(config-ephone-dn) name John SmithRouter(config-ephone-dn) mwi sipRouter(config) telephony-serviceRouter(config-telephony-service) mwi sip-server 223.223.0.5 transport udpRelated Commands
