-
Cisco IOS Multiservice Applications Command Reference, Release 12.1
-
About the Cisco IOS Software Documentation
-
Using Cisco IOS Software
-
Multiservice Application Commands: A through Ca
-
Multiservice Applications Commands: Cb through D
-
Multiservice Applications Commands: E through P
-
Multiservice Applications Commands: R through Sh
-
Multiservice Applications Commands: Si through Z
-
Table Of Contents
Multiservice Applications Commands:
E through Pfax send coverpage e-mail-controllable
fax send coverpage show-detail
fax send transmitting-subscriber
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
mta receive maximum-recipients
pots distinctive-ring-guard-time
Multiservice Applications Commands:
E through P
This book documents commands used to configure Voice over ATM, Voice over Frame Relay, Voice over HDLC, Voice over IP, video, head-end universal broadband features, and subscriber-end universal broadband features. Commands in this book are listed alphabetically. For information on how to configure Voice over ATM, Voice over Frame Relay, Voice over HDLC, Voice over IP, video, head-end universal broadband features, and subscriber-end universal broadband features, refer to the Cisco IOS Multiservice Applications Configuration Guide.
echo-cancel coverage
To adjust the size of the echo canceller, use the echo-cancel coverage command in voice-port configuration mode. Use the no form of this command to reset this command to the default value.
echo-cancel coverage {8 | 16 | 24 | 32}
no echo-cancel coverage {8 | 16 | 24 | 32}
Syntax Description
Defaults
16 milliseconds
Command Modes
Voice-port configuration
Command History
11.3(1)T
The command was introduced.
12.0(5)XK and 12.0(7)T
The command was modified to add the 8-millisecond option.
Usage Guidelines
Use the echo-cancel coverage command to adjust the coverage size of the echo canceller. This command enables cancellation of voice that is sent out the interface and received back on the same interface within the configured amount of time. If the local loop (the distance from the interface to the connected equipment producing the echo) is longer, the configured value of this command should be extended.
If you configure a longer value for this command, it takes the echo canceller longer to converge; in this case, the user might hear slight echo when the connection is initially set up. If the configured value for this command is too short, the user might hear some echo for the duration of the call because the echo canceller is not cancelling the longer delay echoes.
There is no echo or echo cancellation on the network (for example, non-POTS) side of the connection.
Note
This command is valid only if the echo cancel feature has been enabled. For more information, see the echo-cancel enable command.
Examples
The following example adjusts the size of the echo canceller to 8 milliseconds on the Cisco 3600 series:
voice-port 1/0:0echo-cancel enableecho-cancel coverage 8Related Commands
echo-cancel enable
Enables the cancellation of voice that is sent out the interface and is received on the same interface.
echo-cancel enable
To enable the cancellation of voice that is sent out the interface and is received back on the same interface, use the echo-cancel enable command in voice-port configuration mode. Use the no form of this command to disable echo cancellation.
echo-cancel enable
no echo-cancel enable
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled for all interface types.
Command Modes
Voice-port configuration
Command History
Usage Guidelines
This command applies to both the Cisco 3600 series and the Cisco MC3810.
The echo-cancel enable command enables cancellation of voice that is sent out the interface and is received back on the same interface; sound that is received back in this manner is perceived by the listener as an echo. Disabling echo cancellation might cause the remote side of a connection to hear an echo. Because echo cancellation is an invasive process that can minimally degrade voice quality, this command should be disabled if it is not needed.
The echo-cancel enable command does not affect the echo heard by the user on the analog side of the connection.
There is no echo path for a 4-wire E&M interface. The echo canceller should be disabled for that interface type.
Note
Examples
The following example enables the echo cancellation feature and adjusts the size of the echo canceller to 16 milliseconds on the Cisco 3600 series:
voice-port 1/0/0echo-cancel enableecho-cancel coverage 16The following example enables the echo cancellation feature and adjusts the size of the echo canceller to 16 milliseconds on the Cisco MC3810:
voice-port 1/1echo-cancel enableecho-cancel coverage 16Related Commands
Adjusts the size of the echo canceler.
non-linear
Enables nonlinear processing in the echo canceler.
encapsulation atm-ces
To enable circuit emulation service (CES) ATM encapsulation on the Cisco MC3810, use the encapsulation atm-ces command in interface configuration mode. Use the no form of this command to disable CES ATM encapsulation.
encapsulation atm-ces
no encapsulation atm-ces
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Interface configuration
Command History
Usage Guidelines
This command applies to ATM configuration on the Cisco MC3810.
This command is only supported on serial ports 0 and 1.
Examples
The following example enables CES ATM encapsulation on serial port 0 on the Cisco MC3810:
interface serial 0encapsulation atm-cesRelated Commands
encapsulation ftc-trunk
This command is not supported in this release.
encryption
To set the encryption method to be negotiated with the provider, use the encryption command in settlement configuration mode. Use the no form of this command to reset to the default value of this command.
encryption {des-cbc-sha | des40-cbc-sha | dh-des-cbc-sha | dh-des40-cbc-sha | null-md5 | null-sha}
no encryption {des-cbc-sha | des40-cbc-sha | dh-des-cbc-sha | dh-des40-cbc-sha | null-md5 | null-sha}
Syntax Description
Defaults
The default encryption method is all.
Command Modes
Settlement configuration
Command History
Usage Guidelines
If none of the encryption methods are configured, then the system configures to use all of the encryption methods in the SSL session negotiation.
Examples
The following example configures the encryption type SSL_RSA_with_DES_CBC_SHA cipher suite:
settlement 0encryption des-cbc-shaRelated Commands
erase vfc
To erase the Flash memory of a specified voice feature card (VFC), use the erase vfc command in privileged EXEC mode.
erase vfc slot
Syntax Description
slot
Specifies the slot on the Cisco AS5300 where the specified VFC resides. Valid entries are from 0 to 2.
Defaults
No default behavior or values
Command Modes
Privileged EXEC
Command History
Usage Guidelines
Use the erase vfc command to erase the contents of the Flash memory (thereby freeing space in VFC Flash memory) for a specified VFC, including the default file list and the capability file list.
Examples
The following example erases the Flash memory on the VFC located in slot 0:
erase vfc 0Related Commands
expect-factor
To specify when the router will generate an alarm to the network manager, indicating that the expected quality of voice has dropped, use the expect-factor command in dial-peer configuration mode. Use the no form of this command to reset the default value.
expect-factor value
no expect-factor value
Syntax Description
value
Integers that represent the ITU specification for quality of voice as described in G.113. Valid entries are from 0 to 20, with 0 representing toll quality.
Defaults
10
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
This command applies to Cisco 3600 series VoIP peers.
Voice over IP monitors the quality of voice received over the network. Use the expect-factor command to specify when the router will generate an SNMP trap to the network manager.
Examples
The following example configures toll quality of voice when connecting to a dial peer:
dial-peer voice 10 voipexpect-factor 0fax-rate
To establish the rate at which a fax will be sent to the specified dial peer, use the fax-rate command in dial-peer configuration mode. Use the no form of this command to reset the dial peer for voice calls.
fax-rate {1200 | 2400 | 4800 | 7200 | 9600 | 14400 | disable | voice} bytes
no fax-rate
Syntax Description
Defaults
voice
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(2)XH
The fax transmission rate of 12000 was added.
12.0(4)T
This command was first supported on the Cisco MC3810.
Usage Guidelines
Use this command to specify the fax transmission rate to the specified dial peer.
The values for this command apply only to the fax transmission speed and do not affect the quality of the fax itself. The higher values provide a faster transmission speed but monopolize a significantly larger portion of the available bandwidth. Slower transmission speeds use less bandwidth.
If the fax-rate transmission speed is set higher than the codec rate in the same dial peer, the data sent over the network for fax transmission will be above the bandwidth reserved for RSVP. Because more network bandwidth will be monopolized by the fax transmission, Cisco does not recommend setting the fax-rate value higher than the value of the selected codec. If the fax-rate value is set lower than the codec value, faxes will take longer to send but will use less bandwidth.
Examples
The following example configures a transmission speed of 9600 bps for faxes sent to a dial peer:
dial-peer voice 100 voipfax-rate 9600The following example sets the fax rate at 12000 bits per second and the size of the fax-data frame to 200 bytes:
fax-rate 12000 bytes 200Related Commands
fax receive called-subscriber
To define the called subscriber identifier (CSI), use the fax receive called-subscriber command in global configuration mode. Use the no form of this command to disable the configured number.
fax receive called-subscriber {$d$| string}
no fax receive called-subscriber {$d$| string}
Syntax Description
Defaults
Enabled with a null string.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the fax called-subscriber command to define the number displayed in the LCD of the sending fax device when you are sending a fax to a recipient. Typically, with a standard Group 3 fax device, this is the telephone number associated with the receiving fax device. The command defines the CSI.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example configures 555-1234 as the called-subscriber number:
configure terminalfax receive called-subscriber 5551234fax send center-header
To specify the data that will appear in the center position of the fax header information, use the fax send center-header command in global configuration mode. Use the no form of this command to disable the selected options.
fax send center-header {$a$| $d$| $p$| $s$| $t$| string}
no fax send center-header {$a$| $d$| $p$| $s$| $t$| string}
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the Cisco AS5300's text-to-fax converter. When this conversion is performed, this fax send center-header command is used to indicate what header information should be added to the center top those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers, and the Cisco AS5300 software does not modify TIFF attachments.
Note
This command lets you configure multiple options at once—meaning that you can combine one or more wild cards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example selects the transmission time of the fax as the center fax header information:
configure terminalfax send center-header $t$The following example configures the company name Widget and its address as the center fax header information:
configure terminalfax send center-header widget $s$Related Commands
fax send coverpage comment
To define personalized text for the title field of a fax cover sheet, use the fax send coverpage comment command in global configuration mode. Use the no form of this command to disable the defined comment.
fax send coverpage comment string
no fax send coverpage comment string
Syntax Description
string
Text string that adds personalized text in the title field of the fax cover sheet. Valid characters are any ASCII characters.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
The fax send coverpage comment command can be overridden by the fax send coverpage e-mail controllable command.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures an individualized title comment of Acme Fax Services for generated fax cover sheets:
configure terminalfax send coverpage enablefax send coverpage comment Acme Fax ServicesRelated Commands
fax send coverpage e-mail-controllable
To defer to the cover page setting in the e-mail header to generate a standard fax cover sheet, use the fax send coverpage e-mail-controllable command in global configuration mode. Use the no form of this command to disable standard fax sheet generation.
fax send coverpage e-mail-controllable
no fax send coverpage e-mail-controllable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
You can also use the destination address of an e-mail message to control the cover page generation on a per-recipient basis. Use the fax send coverpage e-mail-controllable command to configure the router to defer to the cover page setting in the e-mail header.
In essence, the off-ramp router defers to the setting configured in the e-mail address itself. For example, if the address has a parameter set to cover=no, this parameter will override the setting for the fax send coverpage enable command and the off-ramp gateway will not generate and send a fax cover page. If the address has a parameter set to cover=yes, the off-ramp gateway will defer to this and generate and send a fax cover page.
This command applies to off-ramp Store and Forward Fax functions.
Table 12 shows examples of what the user would enter in the To: field of the e-mail message.
Examples
The following example enables standard generated fax cover sheets:
configure terminalfax send coverpage enablefax send coverpage e-mail-controllableRelated Commands
fax send coverpage enable
To enable the Cisco AS5300 to generate fax cover sheets for faxes that originate from e-mail messages, use the fax send coverpage enable command in global configuration mode. Use the no form of this command to disable fax cover sheet generation functionality.
fax send coverpage enable
no fax send coverpage enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example enables Cisco AS5300-generated fax cover sheets:
configure terminalfax send coverpage enableRelated Commands
fax send coverpage show-detail
To print all of the e-mail header information as part of the fax cover sheet, use the fax send coverpage show-detail command in global configuration mode. Use the no form of this command to disable the e-mail header information being displayed.
fax send coverpage show-detail
no fax send coverpage show-detail
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to off-ramp Store and Forward Fax functions.
Note
Examples
The following example configures an individualized generated fax cover sheet that contains the e-mail header text:
configure terminalfax send coverpage enableno fax send coverpage e-mail-controllablefax send coverpage show-detailRelated Commands
fax send left-header
To specify the data that will appear on the left in the fax header, use the fax send left-header command in global configuration mode. Use the no form of this command to disable the selected options.
fax send left-header {$a$| $d$| $p$| $s$| $t$| string}
no fax send left-header {$a$| $d$| $p$| $s$| $t$| string}
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the AS5300's text-to-fax converter. When this conversion is performed, this fax send left-header command is used to indicate what header information should be added to the left top of those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers and the AS5300's software does not modify TIFF attachments.
This command lets you configure multiple options at once—meaning that you can combine one or more wild cards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example selects the transmission time of the fax as the left fax header information:
configure terminalfax send left-header $t$The following example configures the company name Widget and its address as the left fax header information:
configure terminalfax send left-header widget $s$Related Commands
fax send max-speed
To specify the maximum speed at which an outbound fax will be sent, use the fax send max-speed command in global configuration mode. Use the no form of this command to disable the selected speed.
fax send max-speed {12000 | 14400 | 2400 | 4800 | 7200 | 9600}
no fax send max-speed {12000 | 14400 | 2400 | 4800 | 7200 | 9600}
Syntax Description
Defaults
14400
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example sets the outbound fax transmission rate at 2400 bps:
configure terminalfax send max-speed 2400fax send right-header
To specify the data that will appear on the right in the fax header information, use the fax send right-header command in global configuration mode. Use the no form of this command to disable the selected options.
fax send right-header {$a$| $d$| $p$| $s$| $t$| string}
no fax send right-header {$a$| $d$| $p$| $s$| $t$| string}
Syntax Description
Defaults
No connection
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the AS5300's text-to-fax converter. When this conversion is performed, this fax send right-header command is used to indicate what header information should be added to right top of those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers and the AS5300's software does not modify TIFF attachments.
This command lets you configure multiple options at once—meaning that you can combine one or more wildcards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example selects the date of the fax as the right fax header information:
configure terminalfax send right-header $a$The following example configures the company name Widget and its address as the right fax header information:
configure terminalfax send right-header widget $s$Related Commands
fax send transmitting-subscriber
To define the transmitting subscriber identifier (TSI), use the fax send transmitting-subscriber command in global configuration mode. Use the no form of this command to disable the configured value.
fax send transmitting-subscriber {$s$| string}
no fax send transmitting-subscriber {$s$| string}
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
The transmitting subscriber number is the number displayed in the LCD of the receiving fax device. Typically, with a standard Group 3 fax device, this is the telephone number associated with the transmitting or sending fax device. This command defines the TSI.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures the company name (as captured by the on-ramp from the sending fax machine as +18005551234) as the TSI:
configure terminalfax send transmitting-subscriber +14085551234forward-digits
To configure forward digits for voice calls on the Cisco MC3810, use the forward-digits command in dial-peer configuration mode. Use the no form of this command to restore the default value.
forward-digits {num-digit | all | implicit}
no forward-digits {num-digit | all | implicit}
Syntax Description
Defaults
No digits are forwarded.
Command Modes
Dial-peer configuration
Command History
11.3(1)MA
This command was introduced.
12.0(2)T
The implicit option was added.
12.0(4)T
This command was modified to support ISDN PRI QSIG signalling calls.
Usage Guidelines
This command applies only to the Cisco MC3810.
This command applies only to POTS dial peers.
Forwarded digits are always right-justified so that extra leading digits are stripped.
For QSIG ISDN connections, entering the forward-digits all command implies that all of the digits of the called party number are sent to the ISDN connection. When you enter the forward-digits num-digit command and enter a number between 1 and 32, the number of digits specified (right justified) of the called part number are sent to the ISDN connection. When you enter the forward-digits implicit command, then the number of matched digits matching the wildcard for the called party number are sent to the ISDN connection. For example, if the called part number is 51234, the digits being sent to the ISDN connection is 1234.
Examples
The following example configures forward digits for a POTS dial peer on a Cisco MC3810:
dial-peer voice 1 pots destination-pattern 8... forward-digits allRelated Commands
destination pattern
Specifies either the prefix, the full E.164 telephone number, or an ISDN directory number (depending on the dial plan) to be used for a dial peer.
frame-relay voice bandwidth
To specify how much bandwidth should be reserved for voice traffic on a specific data-link connection identifier (DLCI), use the frame-relay voice bandwidth map-class configuration command. Use the no form of this command to release the bandwidth previously reserved for voice traffic.
frame-relay voice bandwidth bps_reserved [queue depth]
no frame-relay voice bandwidth bps_reserved [queue depth]
Syntax Description
Defaults
Disabled (zero)
Command Modes
Map-class configuration
Command History
12.0(4)T
This command was introduced.
12.0(5)T
The queue depth keyword and argument were added.
Usage Guidelines
To use this command, you must first associate a Frame Relay map class with a specific DLCI, then enter map-class configuration mode and set the amount of bandwidth to be reserved for voice traffic for that map class.
If a call is attempted and there is not enough remaining bandwidth reserved for voice to handle the additional call, the call will be rejected. For example, if 64 kbps is reserved for voice traffic, and a codec and payload size is being used that requires 10 kbps of bandwidth for each call, then the first six calls attempted will be accepted, but the seventh call will be rejected.
Reserve queues are not required for Voice over Frame Relay.
Note
When you set the queue depth option, keep the depth small. Queueing packets on the voice queue indicates that there is some congestion on the PVC. Queueing too many packets on this queue indicates that there are more voice calls allowed on this PVC than it can handle. In this situation, it is recommended that you decrease the number of calls allowed on the PVC. Note that heavy data congestion may cause some voice packets to be queued, but given the priority of servicing the voice queue, the congestion will not cause the voice queue to be too deep.
Calculating Required Bandwidth
The bandwidth required for a voice call depends on the bandwidth of the codec, the voice packetization overhead, and the voice frame payload size. The smaller the voice frame payload size, the higher the bandwidth required for the call. To make the calculation, use the following formula:
required_bandwidth = codec_bandwidth x (1 + overhead / payload_size)
As an example, the overhead for VoFR voice packet is between 6 and 8 bytes: a 2-byte Frame Relay header, a 1- or 2-byte FRF.11 header (depending on the CID value), a 2-byte CRC, and a 1-byte trailing flag. If voice sequence numbers are enabled in the voice packets, there is an additional 1-byte sequence number. Table 13 shows the required voice bandwidth for the G.729 8000 bps speech coder for various payload sizes.
To configure the payload size for the voice frames, use the codec command from dial-peer configuration mode.
Examples
The following example shows how to reserve 64 kbps for voice traffic for the "vofr" Frame Relay map class on a Cisco 2600 series, 3600 series, or 7200 series router or on an MC3810 concentrator:
interface serial 1/1frame-relay interface-dlci 100class vofrexitmap-class frame-relay vofrframe-relay voice bandwidth 64000Related Commands
ftc-trunk frame-relay-dlci
This command is not supported in this release.
ftc-trunk management-dlci
This command is not supported in this release.
ftc-trunk management-protocol
This command is not supported in this release.
ftc-trunk voice-dlci
This command is not supported in this release.
gatekeeper
To enter gatekeeper configuration mode, use the gatekeeper command in global configuration mode.
gatekeeper
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Press Ctrl-Z or use the exit command to exit gatekeeper configuration mode.
Examples
The following example brings the gatekeeper online:
configure terminalgatekeeperno shutdowngateway
To enable the H.323 Voice over IP gateway, use the gateway command in global configuration mode. Use the no form of this command to unregister this gateway with the gatekeeper.
gateway
no gateway
Syntax Description
This command has no keywords or arguments.
Defaults
The gateway is unregistered.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the gateway command to enable H.323 VoIP gateway functionality. After you enable the gateway, it will attempt to discover a gatekeeper by using the H.323 RAS GRQ message. If you enter no gateway voip, the VoIP gateway will unregister with the gatekeeper via the H.323 RAS URQ message.
Examples
The following example enables the gateway:
configure terminalgatewaygw-accounting
To enable gateway-specific accounting, use the gw-accounting command in global configuration mode. Use the no form of this command to disable gateway specific accounting.
gw-accounting {h323 | syslog | vsa}
no gw-accounting {h323 | syslog | vsa}
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
11.3(6)NA2
This command was introduced.
12.0(7)T
The vsa field was added to this command.
Usage Guidelines
To collect basic start-stop connection accounting data, the gateway must be configured to support gateway-specific H.323 accounting functionality. The gw-accounting command enables you to send accounting data to the RADIUS server in one of four ways:
•
For more information about RADIUS and the use of IETF-defined attributes, refer to the Cisco IOS Security Configuration Guide.
•
<session id>/<call leg setup time>/<gateway id>/<connection id>/<call origin>/ <call type>/<connect time>/disconnect time>/<disconnect cause>/<remote ip address>Table 15 shows the field attributes that you use with the Overloaded Session-ID method and a brief description of each.
Because of the limited size of the Acct Session Id string, it is not possible to embed very many information elements in it. Therefore, this feature supports only a limited set of accounting information elements.
Use the gw-accounting h323 command to configure the overloaded session ID method of applying H.323 gateway-specific accounting.
•
protocol: attribute sep value *"Protocol" is a value of the Cisco "protocol" attribute for a particular type of authorization. "Attribute" and "value" are an appropriate attribute/value (AV) pair defined in the Cisco TACACS+ specification, and "sep" is "=" for mandatory attributes and "*" for optional attributes. This allows the full set of features available for TACACS+ authorization to also be used for RADIUS.
The VSA fields and their ASCII values are listed in Table 16.
Use the gw-accounting h323 vsa command to configure the VSA method of applying H.323 gateway-specific accounting.
•
<server timestamp> <gateway id> <message number> : <message label> : <list of AV pairs>The syslog messages fields are listed in Table 17.
Use the gw-accounting h323 syslog command to configure the syslog record method of gathering H.323 accounting data.
Examples
The following example configures the basic H.323 accounting using IETF RADIUS attributes:
gw-accounting h323The following example configures H.323 accounting using the VSA RADIUS attributes:
gw-accounting vsagw-type-prefix
To configure a technology prefix in the gatekeeper, use the gw-type-prefix command in gatekeeper configuration mode. To remove the technology prefix, use the no form of the command.
gw-type-prefix type-prefix [hopoff gkid][default-technology][gw ipaddr ipaddr [port]]
no gw-type-prefix type-prefix [hopoff gkid][default-technology][gw ipaddr ipaddr [port]]
Syntax Description
Defaults
No technology prefix is defined.
Command Modes
Gatekeeper configuration
Command History
Usage Guidelines
More than one gateway can register with the same technology prefix. In such cases, a random selection is made of one of them.
You do not have to define a technology prefix to a gatekeeper if there are gateways configured to register with that prefix, and if there are no special flags (hopoff gkid or default-technology) that you want to associate with that prefix.
You need to configure the gateway type prefix of all remote technology prefixes that will be routed through this gatekeeper.
Examples
The following example specifies 4# as the default technology prefix:
default-technologyRelated Commands
zone prefix
Configures the gatekeeper with knowledge of its own prefix and the prefix of any remote zone.
h323 asr
To enable application-specific routing (ASR), use the h323 asr command in interface configuration mode. Use the no form of this command to disable ASR.
h323 asr
no h323 asr
Syntax Description
There are no arguments or keywords for this command.
Defaults
ASR is disabled.
Command Modes
Interface configuration
Command History
Usage Guidelines
This command is independent of the h323 interface command.
This command is not supported on Frame Relay or ATM interfaces for the Cisco MC3810 platform.
Note
Examples
The following example enables ASR:
h323 asrh323 asr bandwidth
To specify the maximum bandwidth for a proxy, use the h323 asr bandwidth command in interface configuration mode. Use no form of this command to remove a bandwidth setting but keep ASR enabled.
h323 asr [bandwidth max-bandwidth]
no h323 asr [bandwidth max-bandwidth]
Syntax Description
Defaults
ASR is disabled.
Command Modes
Interface configuration
Command History
Usage Guidelines
This command is independent of the h323 interface command.
This command is not supported on Frame Relay or ATM interfaces for the Cisco MC3810 platform.
Note
Examples
The following example enables ASR and specifies a maximum bandwidth of 10,000 kbps:
h323 asr bandwidth 10000h323 gatekeeper
To specify the gatekeeper associated with aproxy and control how the gatekeeper is discovered, use the h323 gatekeeper command in interface configuration mode. Use the no form of this command to disassociate the gatekeeper.
h323 gatekeeper [id gatekeeper-id] {ipaddr ipaddr [port] | multicast}
no h323 gatekeeper [id gatekeeper-id] {ipaddr ipaddr [port] | multicast}
Syntax Description
Defaults
No gatekeeper is configured for the proxy.
Command Modes
Interface configuration
Command History
Usage Guidelines
You must enter the h323 interface and h323 h323-id commands before using this command. The h323 gatekeeper command must be specified on your Cisco IOS platform or the proxy will not go online. The proxy will use the interface's address as its RAS signalling address.
Examples
The following example sets up a unicast discovery to a gatekeeper whose name is unknown:
h323 gatekeeper ipaddr 191.7.5.2The following example sets up a multicast discovery for a gatekeeper of a particular name:
h323 gatekeeper id gk.zone5.com multicastRelated Commands
Registers an H.323 proxy alias with a gatekeeper.
Specifies the interface from which the proxy will take its IP address.
h323-gateway voip h323-id
To configure the H.323 name of the gateway identifying this gateway to its associated gatekeeper, use the h323-gateway voip h.323-id command in interface configuration mode. Use the no form of this command to disable this defined gateway name.
h323-gateway voip h323-id interface-id
no h323-gateway voip h323-id interface-id
Syntax Description
Defaults
No gateway identification is defined.
Command Modes
Interface configuration
Command History
Examples
The following example configures Ethernet interface 0/0 as the gateway interface. In this example, the gateway ID is GW13@cisco.com.
interface Ethernet0/0ip address 172.9.53.13 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719h323-gateway voip h323-id GW13@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323-gateway voip id
To define the name and location of the gatekeeper for a specific gateway, use the h323-gateway voip id command in interface configuration mode. Use the no form of this command to disable this gatekeeper identification.
h323-gateway voip id gatekeeper-id {ipaddr ip-address [port-number] | multicast}
no h323-gateway voip id gatekeeper-id {ipaddr ip-address [port-number] | multicast}
Syntax Description
Defaults
No gatekeeper identification is defined.
Command Modes
Interface configuration
Command History
Usage Guidelines
This command tells the H.323 gateway associated with this interface which H.323 gatekeeper to talk to and where to locate it. The gatekeeper ID configured here must exactly match the gatekeeper ID in the gatekeeper configuration.
Examples
The following example configures Ethernet interface 0/0 as the gateway interface. In this example, the gatekeeper ID is GK15.cisco.com and its IP address is 172.9.53.15 (using port 1719).
interface Ethernet0/0ip address 172.9.53.13 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719h323-gateway voip h323-id GW13@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323-gateway voip interface
To configure this interface as an H.323 gateway interface, use the h323-gateway voip interface command in interface configuration mode. Use the no form of this command to disable H.323 functionality for this interface.
h323-gateway voip interface
no h323-gateway voip interface
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Interface configuration
Command History
Examples
The following example configures Ethernet interface 0.0 as the gateway interface. In this example, the h323-gateway voip interface command configures this interface as an H.323 interface.
interface Ethernet0/0ip address 172.9.53.15 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719h323-gateway voip h323-id GW15@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323-gateway voip tech-prefix
To define the technology prefix that the gateway will register with the gatekeeper, use the h323-gateway voip tech-prefix command in interface configuration mode. Use the no form of this command to disable this defined technology prefix.
h323-gateway voip tech-prefix prefix
no h323-gateway voip tech-prefix prefix
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
This command defines a technology prefix that the gateway will then register with the gatekeeper. Technology prefixes can be used as a discriminator so that the gateway can tell the gatekeeper that a certain technology is associated with a particular call (for example, 15# could mean a fax transmission), or it can be used like an area code for more generic routing. No standard currently defines what the numbers in a technology prefix mean. By convention, technology prefixes are designated by a pound (#) symbol as the last character.
Note
Examples
The following example configures Ethernet interface 0.0 as the gateway interface. In this example, the technology prefix is defined as 13#.
interface Ethernet0/0ip address 172.9.53.15 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719h323-gateway voip h323-id GW15@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323 h323-id
To register an H.323 proxy alias with a gatekeeper, use the h323 h323-id command in interface configuration mode. To remove an H.323 alias, use the no form of this command.
h323 h323-id h323-id
no h323 h323-id h323-id
Syntax Description
h323-id
Specifies the name of the proxy. It is recommended that this be a fully qualified e-mail ID, with the domain name being the same as that of its gatekeeper.
Defaults
No h323-id proxy alias is registered.
Command Modes
Interface configuration
Command History
Usage Guidelines
Each entry registers a specified H.323 ID proxy alias to a gatekeeper. Typically, these aliases are either simple text strings or legitimate e-mail IDs.
Note
Examples
The following example registers an H.323 proxy alias called proxy1@zone5.com with a gatekeeper:
h323 h323-id proxy1@zone5.comRelated Commands
h323 interface
To specify the interface from which the proxy will take its IP address, use the h323 interface command in interface configuration mode. To disable the interface, use the no form of this command.
h323 interface
no h323 interface
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
For non-ASR configurations, any interface on the Cisco IOS platform will work well as the proxy interface. For ASR configurations, the proxy interface should be a loopback interface, so that routing updates and packet switching are appropriately isolated between the ASR and non-ASR interfaces.
Examples
The following example specifies the interface from which the proxy will take its IP address:
interface Loopback0ip address 173.0.0.1 255.0.0.0h323 interfaceRelated Commands
h323 qos
To enable quality of service (QoS) on the proxy, use the h323 qos command in interface configuration mode. To disable QoS, use the no form of this command.
h323 qos {ip-precedence value | rsvp {controlled-load | guaranteed-qos}}
no h323 qos {ip-precedence value | rsvp {controlled-load | guaranteed-qos}}
Syntax Description
Defaults
No QoS is configured.
Command Modes
Interface configuration
Command History
Usage Guidelines
You must execute the h323 interface command before using this command.
Both IP precedence and RSVP QoS can be configured by invoking this command twice with the two different QoS forms.
Examples
The following example enables QoS on the proxy:
interface Ethernet0ip address 172.21.127.38 255.255.255.192no ip redirectsip rsvp bandwidth 7000 7000ip route-cache same-interfacefair-queue 64 256 1000h323 interfaceh323 qos rsvp controlled-loadh323 h323-id px1@zone1.comh323 gatekeeper ipaddr 172.21.127.39Related Commands
huntstop
To disable all further dial-peer hunting if a call fails when using hunt groups, enter the huntstop dial-peer configuration command. To reenable dial peer call hunting, enter the no form of this command.
huntstop
no huntstop
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Once you enter this command, no further hunting is allowed if a call fails on the specified dial peer.
Note
Examples
The following example shows how to disable dial-peer hunting on a specific dial peer:
dial peer voice 100 vofrhuntstopThe following example shows how to reenable dial-peer hunting on a specific dial peer:
dial peer voice 100 vofrno huntstopRelated Commands
dial-peer voice
Enters dial-peer configuration mode and specifies the method of voice-related encapsulation.
icpif
To specify the Calculated Planning Impairment Factor (ICPIF) for calls sent by a dial peer, use the icpif command in dial-peer configuration mode. Use the no form of this command to restore the default value.
icpif number
no icpif number
Syntax Description
number
Integer, expressed in equipment impairment factor units, specifying the ICPIF value. Valid entries are 0 to 55. The default is 30.
Defaults
30
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
This command is applicable only to VoIP dial peers.
Use the icpif command to specify the maximum acceptable impairment factor for the voice calls sent by the selected dial peer.
Examples
The following example disables the icpif command:
dial-peer voice 10 voipicpif 0ignore
To specify the E&M or E&M MEL CAS voice port on the Cisco MC3810 to ignore specific receive bits, use the ignore command in voice-port configuration mode. Use the no form of this command to restore the default value.
ignore {rx-a-bit | rx-b-bit | rx-c-bit | rx-d-bit}
no ignore {rx-a-bit | rx-b-bit | rx-c-bit | rx-d-bit}
Syntax Description
rx-a-bit
Ignores the receive A bit.
rx-b-bit
Ignores the receive B bit.
rx-c-bit
Ignores the receive C bit.
rx-d-bit
Ignores the receive D bit.
Defaults
The default is mode-dependent:
E&M:
no ignore rx-a-bit
ignore rx-b-bit, rx-c-bit, rx-d-bitE&M MEL CAS:
no ignore rx-b-bit, rx-c-bit, rx-d-bit
Command Modes
Voice-port configuration
Command History
Usage Guidelines
This command applies only to digital voice ports on the Cisco MC3810.
Use this command with the define command.
Examples
To configure voice-port 1/1 to ignore receive bits b, c, and d, enter the following commands:
voice-port 1/1ignore rx-b-bitignore rx-c-bitignore rx-d-bitRelated Commands
image encoding
To select a specific encoding method for fax images associated with an MMoIP dial peer, use the image encoding command in dial-peer configuration mode. Use the no form of this command to restore the default value.
image encoding{mh | mr | mmr | passthrough}
no image encoding{mh | mr | mmr | passthrough}
Syntax Description
Defaults
Passthrough
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the image encoding command to specify an encoding method for e-mail fax TIFF images for a specific MMoIP dial peer. This command applies primarily to the on-ramp MMoIP dial peer. Although you can optionally create an off-ramp dial peer and configure a particular image encoding value for that off-ramp call leg, Store and Forward Fax ignores the off-ramp MMoIP setting and sends the file using Modified Huffman encoding.
There are four available encoding methods:
•
•
•
•
The IETF standard for sending fax TIFF images is Modified Huffman encoding with fine or standard resolution. RFC 2301 requires compliant receivers support TIFF images with MH encoding and fine or standard resolution. If a receiver supports features beyond this minimal requirement, you might want to configure the Cisco AS5300 to send enhanced-quality documents to that receiver.
The primary reason to use a different encoding scheme from MH is to save network bandwidth. MH ensures interoperability with all Internet fax devices but it is the least efficient of the encoding schemes for sending fax TIFF images. For most images, MR is more efficient than MH and MMR is more efficient than MR. If you know the recipient is capable of receiving more efficient encodings than just MH, Store and Forward Fax allows you to send the most efficient encoding the recipient can process. For end-to-end closed networks, you can choose any encoding scheme because the off-ramp gateway can process MH, MR, and MMR.
Another factor to take into account is the viewing software. Many viewing applications (for example, those that come with Windows 95 or Windows NT) are able to display MH, MR, and MMR. Therefore you should decide, based on the viewing application and the available bandwidth, which encoding scheme is right for your network.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example selects Modified Modified Read as the encoding method for fax TIFF images sent by MMoIP dial peer 10:
dial-peer voice 10 mmoipimage encoding mmrRelated Commands
image-resolution
Specifies a particular fax image resolution for a specific MMoIP dial peer.
image resolution
To specify a particular fax image resolution for a specific MMoIP dial peer, use the image resolution command in dial-peer configuration mode. Use the no form of this command to restore the default value.
image resolution {fine | standard | superfine | passthrough}
no connection {fine | standard | superfine | passthrough}
Syntax Description
Defaults
Passthrough
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the image resolution command to specify a specific resolution (in pixels per inch) for e-mail fax TIFF images sent by the specified MMoIP dial peer. This command applies primarily to the on-ramp MMoIP dial peer. Although you can optionally create an off-ramp dial peer and configure a particular image resolution value for that off-ramp call leg, Store and Forward Fax ignores the off-ramp MMoIP setting and sends the file using fine resolution.
This command enables you to increase or decrease the resolution of a fax TIFF image, thereby changing not only the resolution but the size of the fax TIFF file. The IETF standard for sending fax TIFF images is Modified Huffman encoding with fine or standard resolution. The primary reason to configure a different resolution is to save network bandwidth.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example selects the resolution fine (meaning 204-by-196 pixels per inch) for e-mail fax TIFF images associated with MMoIP dial peer 10:
dial-peer voice 10 mmoipimage encoding mhimage resolution fineRelated Commands
image encoding
Selects a specific encoding method for fax images associated with an MMoIP dial peer.
impedance
To specify the terminating impedance of a voice port interface, use the impedance command in voice-port configuration mode. Use the no form of this command to restore the default value.
impedance {600c | 600r | 900c | complex1 | complex2}
no impedance {600c | 600r | 900c | complex1 | complex2}
Syntax Description
600c
Specifies 600 ohms complex.
600r
Specifies 600 ohms real.
900c
Specifies 900 ohms complex.
complex1
Specifies Complex 1.
complex2
Specifies Complex 2.
Defaults
600r
Command Modes
Voice-port configuration
Command History
Usage Guidelines
Use the impedance command to specify the terminating impedance of an FXO voice-port interface. The impedance value selected needs to match the specifications from the specific telephony system to which it is connected. Different countries often have different standards for impedance. CO switches in the United States are predominantly 600r. PBXs in the United States are normally either 600r or 900c.
If the impedance is set incorrectly (if there is an impedance mismatch), there will be a significant amount of echo generated (which could be masked if the echo-cancel command has been enabled). In addition, gains might not work correctly if there is an impedance mismatch.
Configuring the impedance on a voice port will change the impedance on both voice ports of a VPM card. This voice port must be shut down and then opened for the new value to take effect.
This command is applicable to FXS, FXO, and E&M voice ports on both the Cisco 3600 series and the Cisco MC3810.
Examples
The following example configures an FXO voice port on the Cisco 3600 series for a terminating impedance of 600 ohms (real):
voice-port 1/0/0impedance 600rThe following example configures an E&M voice port on the Cisco MC3810 for a terminating impedance of 900 ohms (complex):
voice-port 1/1impedance 900cincoming called-number
To specify an incoming called number of an MMoIP or POTS dial peer, use the incoming called-number command in dial-peer configuration mode. Use the no form of this command to reset the default value for this command.
incoming called-number string
no incoming called-number string
Syntax Description
string
Specifies the incoming called telephone number. Valid entries are any series of digits that specify the E.164 telephone number.
Defaults
No incoming called number is defined.
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)XJ
This command was modified for Store and Forward Fax.
Usage Guidelines
When a Cisco device (such as a Cisco AS5300 or Cisco AS5800) is handling both modem and voice calls, it needs to be able to identify the service type of the call—meaning whether the incoming call to the server is a modem or a voice call. When the access server handles only modem calls, the service type identification is handled through modem pools. Modem pools associate calls with modem resources based on the called number (DNIS). In a mixed environment, where the server receives both modem and voice calls, you need to identify the service type of a call by using the incoming called-number command.
If you do not use the incoming called-number command, the server attempts to resolve whether an incoming call is a modem or voice call based on the interface over which the call comes. If the call comes in over an interface associated with a modem pool, the call is assumed to be a modem call; if a call comes in over a voice port associated with a dial peer, the call is assumed to be a voice call.
By default, there is no called number associated with the dial peer, which means that incoming calls will be associated with dial peers based on matching calling number with answer address, call number with destination pattern, or calling interface with configured interface.
Use the incoming-called number command to define the destination telephone number for a particular dial peer. For the on-ramp POTS dial peer, this telephone number is the DNIS number of the incoming fax call. For the off-ramp MMoIP dial peer, this telephone number is the destination fax machine telephone number.
This command applies to both VoIP and POTS dial peers and applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example configures calls coming in to the server with a called number of 3799262 as being voice calls:
dial peer voice 10 potsincoming called-number 3799262The following example configures the number (310)555-9261 as the incoming called number for MMoIP dial peer 10:
dial-peer voice 10 mmoipincoming 3105559261information-type
To select a particular information type for either an MMoIP or a POTS dial peer, use the information-type command in dial-peer configuration mode. Use the no form of this command to reset the default value for this command.
information type {fax | voice}
no information type {fax | voice}
Syntax Description
fax
Indicates that the information type has been set to store and forward fax.
voice
Indicates that the information type has been set to voice.
Defaults
Voice
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)XJ
This command was modified for Store and Forward Fax.
Usage Guidelines
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example sets the information type for MMoIP dial peer 10 to fax:
dial-peer voice 10 mmoipinformation-type fax
input gain
To configure a specific input gain value, use the input gain command in voice-port configuration mode. Use the no form of this command to disable the selected amount of inserted gain.
input gain value
no input gain value
Syntax Description
value
Specifies, in decibels, the amount of gain to be inserted at the receiver side of the interface. Acceptable value is any integer from -6 to 14.
Defaults
0
Command Modes
Voice-port configuration
Command History
Usage Guidelines
A system-wide loss plan must be implemented using both input gain and output attenuation commands. Other equipment (including PBXs) in the system must be taken into account when creating a loss plan. This default value for this command assumes that a standard transmission loss plan is in effect, meaning that normally, there must be -6 dB attenuation between phones. Connections are implemented to provide -6 dB of attenuation when the input gain and output attenuation commands are configured with the default value of 0.
Please note that you cannot increase the gain of a signal going out into the PSTN, but you can decrease it. Therefore, if the voice level is too high, you can decrease the volume by either decreasing the input gain value or by increasing the output attenuation.
You can increase the gain of a signal coming in to the router. If the voice level is too low, you can increase the input gain.
Examples
The following example configures a 3-decibel gain to be inserted at the receiver side of the interface in the Cisco 3600 series:
port 1/0/0input gain 3The following example configures a 3-decibel gain to be inserted at the receiver side of the interface in the Cisco MC3810:
port 1/1input gain 3Related Commands
output attenuation
Configures a specific output attenuation value for a voice port.
ip precedence (dial-peer)
To set IP Precedence (priority) for packets sent by the dial peer, use the ip precedence command in dial-peer configuration mode. To restore the default value for this command, use the no form of this command.
ip precedence number
no ip precedence number
Syntax Description
number
Integer specifying the IP Precedence value. Valid entries are from 0 to 7. A value of 0 means that no precedence (priority) has been set.
Defaults
The default value for this command is 0.
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the ip precedence (dial-peer) command to configure the value set in the IP Precedence field when voice data packets are sent over the IP network. This command should be used if the IP link utilization is high and the quality of service for voice packets needs to have a higher priority than other IP packets. The ip precedence (dial-peer) command should also be used if RSVP is not enabled and the user would like to give voice packets a higher priority over other IP data traffic.
This command applies to VoIP peers.
Examples
The following example sets the IP Precedence to 5:
dial-peer voice 10 voipip precedence 5ip udp checksum
To calculate the UDP checksum for voice packets sent by the dial peer, use the ip udp checksum command in dial-peer configuration mode. Use the no form of this command to disable this feature.
ip udp checksum
no ip udp checksum
Syntax Description
This command has no arguments or keywords.
Defaults
disabled
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the ip udp checksum command to enable UDP checksum calculation for each of the outbound voice packets. This command is disabled by default to speed up the transmission of the voice packets. If you suspect that the connection has a high error rate, you should enable ip udp checksum to prevent corrupted voice packets forwarded to the digital signal processor (DSP).
This command applies to VoIP peers.
Examples
The following example calculates the UDP checksum for voice packets sent by this dial peer:
dial-peer voice 10 voipip udp checksumRelated Commands
loop-detect
Enables loop detection for T1 for Voice over ATM, Voice over Frame Relay, and Voice over HDLC.
ivr autoload
To load files from a particular TFTP server (as indicated by a defined URL), use the ivr autoload command in global configuration mode. To disable this function, use the no form of this command.
ivr autoload url location
no ivr autoload url location
Syntax Description
Defaults
No URL is defined.
Command Modes
Global configuration
Command History
Usage Guidelines
The index file contains a list of audio files (URL) that can be downloaded from the TFTP server. Use the ivr autoload command to download audio files from TFTP to memory. The command only starts up a background process. The background process (loader) does the actual down-loading of the files.
The background process first reads the index file from either Flash or TFTP. It parses the files line by line looking for the URL. It ignores lines which starts with # as comment lines. Once it has a correct URL, it tries to read that .au file into memory and creates a media object. If there are any errors during the reading of the file, it retries the configured number of times. If mode is set to 'verbose' the loader logs the transaction to console. Once parsing has reached the end of the index file, the background process exits out of memory.
Perform the following checks before initiating the background process. If one of the checks fail, it indicates the background process is not started, and instead you will see an error response to the command.
•
command is not allowed when prompts are active
•
previous autoload command is still in progress
•
previous command is being replaced
•
The audio files (prompts) loaded using the ivr autoload command are not dynamically swapped out of memory. They are considered as autoloaded prompts as opposed to "dynamic" prompts. (See the ivr prompt memory command for details on dynamic prompts.)
Examples
The following example loads audio files from the TFTP server (located at //jurai/mgindi/tclware/index4):
ivr autoload url tftp://jurai/mgindi/tclware/index4The index file for this example index4 is shown as:
Router# more index4tftp://jurai/mgindi/tclware/au/en/en_one.au#tftp://jurai/mgindi/tclware/au/ch/ch_one.autftp://jurai/mgindi/tclware/au/ch/ch_one.auRelated Commands
ivr prompt memory
Configures the maximum amount of memory you wish to allow the dynamic audio files (prompts) to occupy in memory.
ivr autoload retry
To specify the number of times the system will try to load audio files from TFTP to memory when there is an error, use the ivr autoload retry command in global configuration mode. To disable this function, use the no form of this command.
ivr autoload retry number
no ivr autoload retry number
Syntax Description
Defaults
ivr autoload retry 3
Command Modes
Global configuration
Command History
Examples
The following example configures the system to try three times to load audio files:
ivr autoload retry 3Related Commands
ivr prompt memory
Configures the maximum amount of memory you wish to allow the dynamic audio files (prompts) to occupy in memory.
ivr autoload mode
To load files from TFTP to memory using either silent or verbose mode, use the ivr autoload mode command in global configuration mode. To disable this function, use the no form of this command.
ivr autoload mode {verbose url location [retry number]} | {silent url location [retry number]}
no ivr autoload mode {verbose url location [retry number]} | {silent url location
[retry number]}Syntax Description
Defaults
ivr autoload silent
Command Modes
Global configuration
Command History
Usage Guidelines
The index file contains a list of audio files (URL) that can be downloaded from the TFTP server. Use the ivr autoload command to download audio files from TFTP to memory. The command only starts up a background process. The background process (loader) does the actual downloading of the files.
The background process first reads the index file from either Flash or TFTP. It parses the files line by line looking for the URL. It ignores lines which starts with # as comment lines. Once it has a correct URL, it tries to read that .au file into memory and creates a media object. If there are any errors during the reading of the file, it retries the configured number of times. If mode is set to verbose, the loader logs the transaction to console. Once parsing has reached the end of the index file, the background process exits out of memory.
Perform the following checks before initiating the background process. If one of the checks fail, it indicates the background process is not started, and instead you will see an error response to the command.
•
command is not allowed when prompts are active
•
previous autoload command is still in progress
•
previous command is being replaced
•
The audio files (prompts) loaded using the ivr autoload command are not dynamically swapped out of memory. They are considered as autoloaded prompts as opposed to "dynamic" prompts. (See the ivr prompt memory command for details on dynamic prompts.)
Examples
The following example configures verbose mode:
ivr autoload mode verbose retry 3 url tftp://jurai/mgindi/tclware/index4The index file for this example index4 is shown as:
Router# more index4tftp://jurai/mgindi/tclware/au/en/en_one.au#tftp://jurai/mgindi/tclware/au/ch/ch_one.autftp://jurai/mgindi/tclware/au/ch/ch_one.auRelated Commands
ivr prompt memory
Configures the maximum amount of memory you wish to allow the dynamic audio files (prompts) to occupy in memory.
ivr prompt memory
To configure the maximum amount of memory for the dynamic audio files (prompts) to occupy in memory, use the ivr prompt memory command in global configuration mode. Use the no form of this command to disable the maximum memory size.
ivr prompt memory size files number
no ivr prompt memory size files number
Syntax Description
Command Modes
Global configuration
Command History
Usage Guidelines
When both the number and size parameters are specified, the minimum memory out of the two will be used for memory calculations.
All the prompts which are not autoloaded or fixed are considered as dynamic. Dynamic prompts are loaded in to memory from TFTP or Flash, as and when they are needed. When they are actively used for playing prompts they are considered to be in 'active' state. However, once the prompt playing is complete, these prompts are no more active and are considered to be in 'free' state.
The free prompts either stay in memory or removed out of memory depending on the availability of space in memory for these free prompts. The prompt-mem command essentially specifies a maximum memory to be used for these free prompts.
The free prompts are saved in the memory and are queued in a waitQ. When the waitQ is full (either because the totally memory occupied by the free prompts exceeds the max. configured value or the number of files in the waitQ exceeds max. configured), oldest free prompts are removed out of memory.
Examples
The following example shows how to use the ivr prompt memory command:
ivr prompt memory 2048 files 500Related Commands
ivr autoload
Loads files from TFTP to memory.
show call prompt-mem-usage
Displays the memory site use by prompts.
loopback (T1 controller)
To set the loopback method for testing the T1 interface, enter the loopback command in controller configuration mode. Use the no form of this command to restore the default value.
loopback {diagnostic | local {payload | line} | remote {iboc | esf {payload | line}}
no loopback
Syntax Description
Defaults
No loopback is configured.
Command Modes
Controller configuration
Command History
Usage Guidelines
You can use a loopback test on lines to detect and distinguish equipment malfunctions caused either by line and channel service unit/digital service unit (CSU/DSU) or by the interface. If correct data transmission is not possible when an interface is in loopback mode, the interface is the source of the problem.
Examples
The following example shows how to set the diagnostic loopback method on controller T1 0/0:
Router(config)# controller t1 0/0loopback diagnosticloop-detect
To enable loop detection for T1, use the loop-detect command in controller configuration mode. Use the no form of the command to cancel the loop detect operation.
loop-detect
no loop-detect
Syntax Description
This command has no arguments or keywords.
Defaults
Loop detection is disabled.
Command Modes
Controller configuration
Command History
Usage Guidelines
This command applies to Voice over Frame Relay, Voice over ATM, and Voice over HDLC on the Cisco MC3810.
Examples
The following example configures loop detection for controller T1 0:
controller t1 0loop-detectRelated Commands
loopback (interface)
Diagnoses equipment malfunctions between an interface and a device.
loss-plan
To specify the analog-to-digital gain offset for an analog FXO or FXS voice port, enter the loss-plan command in voice-port configuration mode. Use the no form of this command to restore the default value.
loss-plan {plan1 | plan2 | plan5 | plan6 | plan7}
no loss-plan
Syntax Description
Defaults
FXO: A-D gain = 0 db, D-A gain = 0 db (loss plan 1)
FXS: A-D gain = -3 db, D-A gain = -3 db (loss plan 1)
Command Modes
Voice-port configuration
Command History
Usage Guidelines
This command applies to the Cisco MC3810 only.
This command sets the analog signal level difference (offset) between the analog voice port and the digital signal processor (DSP). Each loss plan specifies a level offset in both directions—from the analog voice port to the DSP (A-D) and from the DSP to the analog voice port (D-A).
Use this command to obtain the required levels of analog voice signals to and from the DSP.
Examples
The following example configures FXO voice port 1/6 for a -3 db offset from the voice port to the DSP and a 0 db offset from the DSP to the voice port:
voice-port 1/6loss-plan plan3The following example configures FXS voice port 1/1 for a 0 db offset from the voice port to the DSP and a -7 db offset from the DSP to the voice port:
voice-port 1/1loss-plan plan6Related Commands
lrq forward-queries
To enable a gatekeeper to forward Location Requests (LRQs) that contain E.164 addresses that match zone prefixes controlled by remote gatekeepers, use the lrq forward-queries command in gatekeeper configuration mode. To disable this function, use the no form of this command.
lrq forward-queries
no lrq forward-queries
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Gatekeeper configuration
Command History
Usage Guidelines
LRQ forwarding is dependent on a Cisco non-standard field that first appeared in Cisco IOS Release 12.0(3)T. This means that any LRQ received from a non-Cisco gatekeeper or any gatekeeper running a Cisco IOS software image prior to Cisco IOS Release 12.0(3)T will not be forwarded.
The routing of E.164-addressed calls is dependent on the configuration of zone prefix tables (for example, area code definitions) on each gatekeeper. Each gatekeeper is configured with a list of prefixes controlled by itself and by other remote gatekeepers. Calls are routed to the zone that manages the matching prefix. Thus, in the absence of a directory service for such prefix tables, you, the network administrator, may have to define extensive lists of prefixes on all the gatekeepers in your administrative domain.
To simplify this task, you can select one of your gatekeepers as the "directory" gatekeeper and configure that gatekeeper with the complete list of prefixes and the lrq forward-queries command. You can then simply configure all the other gatekeepers with their own prefixes and the wildcard prefix "*" for your directory gatekeeper.
This command only affects the forwarding of LRQs for E.164 addresses. LRQs for H.323-ID addresses are never forwarded.
Examples
The following example shows how this command is used to simplify configuration by selecting one gatekeeper as the directory gatekeeper. Refer to Figure 3.
Figure 3 Example Scenario with Directory Gatekeeper and Two Remote Gatekeepers
Configuration on gk-directory
On the directory gatekeeper called gk-directory, identify all the prefixes for all the gatekeepers in your administrative domain:
gk-directory(config-gk)# zone local gk-directory cisco.com gk-directory(config-gk)# zone remote gk-west cisco.com 172.0.1.1gk-directory(config-gk)# zone remote gk-east cisco.com 172.0.2.1gk-directory(config-gk)# zone prefix gk-west 1408.......gk-directory(config-gk)# zone prefix gk-west 1415.......gk-directory(config-gk)# zone prefix gk-west 1213.......gk-directory(config-gk)# zone prefix gk-west 1650.......gk-directory(config-gk)# zone prefix gk-east 1212.......gk-directory(config-gk)# zone prefix gk-east 1617.......gk-directory(config-gk)# lrq forward-queriesConfiguration on gk-west
On the gatekeeper called gk-west, configure all the locally managed prefixes for that gatekeeper:
gk-west(config-gk)# zone local gk-west cisco.comgk-west(config-gk)# zone remote gk-directory cisco.com 172.1.2.3gk-west(config-gk)# zone prefix gk-west 1408.......gk-west(config-gk)# zone prefix gk-west 1415.......gk-west(config-gk)# zone prefix gk-west 1213.......gk-west(config-gk)# zone prefix gk-west 1650.......gk-west(config-gk)# zone prefix gk-directory *Configuration on gk-east
On the gatekeeper called gk-east, configure all the locally managed prefixes for that gatekeeper:
gk-east(config-gk)# zone local gk-east cisco.comgk-east(config-gk)# zone remote gk-directory cisco.com 172.1.2.3gk-east(config-gk)# zone prefix gk-east 1212.......gk-east(config-gk)# zone prefix gk-east 1617.......gk-east(config-gk)# zone prefix gk-directory *Now when an endpoint or gateway in zone gk-west makes a call to 12125551234, gk-west will send an LRQ for that E.164 address to gk-directory, which forwards the LRQ to gk-east. Gatekeeper gk-east responds directly to gk-west.
Related Commands
lrq reject-unknown-prefix
Enables the gatekeeper to reject all Location Requests (LRQs) for zone prefixes that are not configured.
lrq reject-unknown-prefix
To enable the gatekeeper to reject all Location Requests (LRQs) for zone prefixes that are not configured, use the lrq reject-unknown-prefix command in gatekeeper configuration mode. To reenable the gatekeeper to accept and process all incoming LRQs, use the no form of this command.
lrq reject-unknown-prefix
no lrq reject-unknown-prefix
Syntax Description
This command has no arguments or keywords.
Defaults
The gatekeeper accepts and processes all incoming LRQs.
Command Modes
Gatekeeper configuration
Command History
Usage Guidelines
Use the lrq reject-unknown-prefix command to configure the gatekeeper to reject any incoming LRQs for a destination E.164 address that does not match any of the configured zone prefixes.
Whether or not you enable the lrq reject-unknown-prefix command, the following is true when the E.164 address matches a zone prefix:
•
•
If you do not enable the lrq reject-unknown-prefix command, and the target address does not match any known local or remote prefix, the default behavior is to attempt to service the call using one of the local zones. If this default behavior is not suitable for your site, configure the lrq reject-unknown-prefix command on your router to force the gatekeeper to reject such requests.
Examples
Consider the following gatekeeper configuration:
zone local gk408 cisco.comzone local gk415 cisco.comzone prefix gk408 1408.......zone prefix gk415 1415.......lrq reject-unknown-prefixIn this example configuration, the gatekeeper is configured to manage two zones. One zone contains gateways with interfaces in the 408 area code, and the second zone contains gateways in the 415 area code. Then using the zone prefix command, the gatekeeper is configured with the appropriate prefixes so that calls to those area codes hop off in the optimal zone.
Now say some other zone has been erroneously configured to route calls to the 212 area code to this gatekeeper. When the LRQ for a number in the 212 area code arrives at this gatekeeper, the gatekeeper fails to match the area code, and the LRQ is rejected.
If this was your only site that had any gateways in it, and you wanted your other sites to route all calls requiring gateways to this gatekeeper, then you can undo the lrq reject-unknown-prefix command by simply using the no lrq reject-unknown-prefix. Now when the gatekeeper receives an LRQ for the address 12125551234, it will attempt to find an appropriate gateway in either one of the zones gk408 or gk415 to service the call.
Related Commands
lrq forward-queries
Enables a gatekeeper to forward Location Requests (LRQs) that contain E.164 addresses that match zone prefixes controlled by remote gatekeepers.
max-conn
To specify a maximum number of allowed connections for a particular dial peer, use the max-conn command in dial-peer configuration mode. Use the no form of this command to set an unlimited number of connections for this dial peer.
max-conn number
no max-conn number
Syntax Description
number
Specifies the maximum number of connections for this dial peer. Valid values for this field are 1 to 2147483647.
Defaults
The no form of this command is the default, meaning unlimited number of connections.
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)XJ
This command was modified for Store and Forward Fax.
Usage Guidelines
This command applies to both VoIP and POTS dial peers.
Use the max-conn command to define the maximum number of connections used simultaneously on the Cisco AS5300 to send fax-mail.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures the maximum number of connections for VoIP dial peer 10 as 5:
dial-peer voice 10 voipmax-conn 5Related Commands
mta receive maximum-recipients
Specifies the maximum 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. Use the no form of this command to reset to the default value of this command.
max-connection num
no max-connection num
Syntax Description
Defaults
The default is 20 maximum connections.
Command Modes
Settlement configuration
Command History
Examples
The following command sets the maximum number of simultaneous connections to be 10:
settlement 0max-connections 10Related Commands
mdn
To request that a message disposition notice (MDN) be generated when the message is processed ("opened"), use the mdn command in dial-peer configuration mode. Use the no form of this command to restore the default value.
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 the mdn command to request that an e-mail response message be sent to the sender when the e-mail containing 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 notice 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 where MDNs will be sent.
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. Use the no form of this command to restore the default value.
mmoip aaa global-password password
no mmoip aaa global-password password
Syntax Description
password
Character string used to define the CiscoSecure for Windows NT password to be used with Store and Forward Fax. Maximum length is 64 alphanumeric characters.
Defaults
No password defined.
Command Modes
Global configuration
Command History
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.
Examples
The following example defines a password (abercrombie) when CiscoSecure for Windows NT is used with Store and Forward Fax:
configure terminalmmoip aaa global-password abercrombiemmoip aaa method fax accounting
To define the name of the method list to be used for AAA accounting with Store and Forward Fax, use the mmoip aaa method fax accounting command in global configuration mode. Use the no form of this command to restore the default value.
mmoip aaa method fax accounting method-list-name
no mmoip aaa method fax accounting method-list-name
Syntax Description
method-list-name
Character string used to name a list of accounting methods to be used with Store and Forward Fax.
Defaults
No AAA accounting method list 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 global configuration command. Unlike standard AAA (where 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 on the Cisco AS5300.
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.
Examples
The following example defines a AAA accounting method list (called sherman) to be used with Store and Forward Fax:
configure terminalaaa new-modelmmoip aaa method fax accounting shermanRelated Commands
mmoip aaa receive-accounting enable
Enables on-ramp Store and Forward Fax AAA accounting services.
mmoip aaa method fax authentication
To define the name of the method list to be used for AAA authentication with Store and Forward Fax, use the mmoip aaa method fax authentication command in global configuration mode. Use the no form of this command to restore the default value.
mmoip aaa method fax authentication method-list-name
no mmoip aaa method fax authentication method-list-name
Syntax Description
method-list-name
Character string used to name a list of authentication methods to be used with Store and Forward Fax.
Defaults
No AAA authentication method list defined.
Command Modes
Global configuration
Command History
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.
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 defines a AAA authentication method list (called peabody) to be used with Store and Forward Fax:
configure terminalaaa new-modelmmoip aaa method fax authentication peabodyRelated Commands
mmoip aaa receive-authentication enable
Enables on-ramp Store and Forward Fax AAA authentication services.
mmoip aaa receive-accounting enable
To enable on-ramp AAA accounting services, use the mmoip aaa receive-accounting enable command in global configuration mode. Use the no form of this command to restore the default value.
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
Usage Guidelines
This command enables AAA accounting services if a AAA 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 enables a AAA accounting method list (called sherman) to be used with inbound Store and Forward Fax. In this example, Store and Forward Fax is being configured to track start and stop connection accounting records.
configure terminalaaa new-modelmmoip aaa method fax accounting shermanaaa accounting connection sherman stop-only radiusmmoip aaa receive-accounting enableRelated Commands
mmoip aaa method fax accounting
Defines the name of the method list to be used for AAA accounting with Store and Forward Fax.
mmoip aaa receive-authentication enable
To enable on-ramp AAA authentication services, use the mmoip aaa receive-authentication enable command in global configuration mode. Use the no form of this command to restore the default value.
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
Usage Guidelines
This command enables AAA authentication services if an AAA authentication 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 enables a AAA authentication method list (called peabody) to be used with inbound Store and Forward Fax. In this example, RADIUS (and if the RADIUS server fails, then local) authentication is being configured for Store and Forward Fax.
configure terminalaaa new-modelmmoip aaa method fax authentication peabodyaaa authentication login peabody radius localmmoip aaa receive-authentication enableRelated Commands
mmoip aaa method fax authentication
Defines the name of the method list to be used for AAA authentication with Store and Forward Fax.
mmoip aaa receive-id primary
To specify the primary location where AAA retrieves its account identification information for on-ramp faxing, use the mmoip aaa receive-id primary command in global configuration mode. Use the no form of this command to restore the default value, which means that account identification source is undefined.
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—meaning that if the primary identifier is defined and AAA cannot authenticate the primary identifier information, it will 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 of which 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, then the redialer DNIS is used as the authentication identifier. If a user dials in and the redialer DNIS is null, then 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 AAA authentication identifier for Store and Forward Fax:
configure terminalaaa new-modelmmoip aaa receive-id primary redialer-dnisRelated Commands
mmoip aaa receive-id secondary
To specify the secondary location where AAA 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. Use the no form of this command to restore the default value, which means that account identification source is undefined.
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
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 will 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 of which 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, then the redialer DNIS is used as the authentication identifier. If a user dials in and the redialer DNIS is null, then 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:
configure terminalaaa 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 AAA accounting services, use the mmoip aaa send-accounting enable command in global configuration mode. Use the no form of this command to restore the default value.
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
Usage Guidelines
This command enables AAA accounting services if a AAA accounting 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.
Examples
The following example enables a AAA accounting method list (called sherman) to be used with outbound Store and Forward Fax. In this example, Store and Forward Fax is being configured to track start and stop connection accounting records.
configure terminalaaa new-modelmmoip aaa method fax accounting shermanaaa accounting connection sherman stop-only radiusmmoip aaa send-accounting enableRelated Commands
mmoip aaa method fax accounting
Defines the name of the method list to be used for AAA accounting with Store and Forward Fax.
mmoip aaa send-authentication enable
To enable off-ramp AAA authentication services, use the mmoip aaa send-authentication enable command in global configuration mode. Use the no form of this command to restore the default value.
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
Usage Guidelines
This command enables AAA authentication services if a AAA authentication 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 enables a AAA authentication method list (called peabody) to be used with outbound Store and Forward Fax. In this example, RADIUS (and if the RADIUS server fails, then local) authentication is being configured for Store and Forward Fax.
configure terminalaaa new-modelmmoip aaa method fax authentication peabodyaaa authentication login peabody radius localmmoip aaa send-authentication enableRelated Commands
mmoip aaa method fax authentication
Defines the name of the method list to be used for AAA authentication with Store and Forward Fax.
mmoip aaa send-id primary
To specify the primary location where AAA retrieves its account identification information for off-ramp faxing, use the mmoip aaa send-id primary command in global configuration mode. Use the no form of this command to restore the default value, which means that account identification source is undefined.
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
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 will use 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 will check 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 will 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 defines 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:
configure terminalaaa new-modelmmoip aaa send-id primary envelope-toRelated Commands
mmoip aaa send-id secondary
Specifies the secondary location where AAA retrieves its account identification information for off-ramp faxing.
mmoip aaa send-id secondary
To specify the secondary location where AAA retrieves its account identification information for off-ramp faxing, use the mmoip aaa send-id secondary command in global configuration mode. Use the no form of this command to restore the default value, which means that account identification source is undefined.
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
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 secondary 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 will use 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 will check 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 will 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 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 defines 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:
configure terminalaaa new-modelmmoip aaa send-id secondary envelope-toRelated Commands
mmoip aaa send-id primary
Specifies the primary location where AAA retrieves its account identification information for off-ramp faxing.
mode (Voice over ATM)
To set the mode of the T1/E1 controller and enter specific configuration commands for each mode type, use the mode command in controller configuration mode. Use the no form of this command to restore the default mode of the controller.
mode {atm | cas}
no mode {atm | cas}
Syntax Description
Defaults
No mode is configured.
Command Modes
Controller configuration
Command History
Usage Guidelines
This command applies to the Cisco MC3810 with the digital voice module (DVM) installed.
When no mode is selected, channel groups and clear channels (data mode) can be created using the channel group and tdm-group commands, respectively.
On the Cisco MC3810, some DS0s are used exclusively for different signalling modes. The DS0 channels have the following limitations when mixing different applications (such as voice and data) on the same network trunk:
•
•
Examples
The following example configures ATM mode on controller T1 0. This step is required for Voice over ATM.
controller T1 0mode atmThe following example configures CAS mode on controller T1 1:
controller T1 1mode casRelated Commands
mode ccs
To configure the T1/E1 controller to support CCS cross-connect or CCS frame-forwarding, use the mode ccs command in controller 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
Controller configuration mode
Command History
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.
mta receive aliases
To specify a host name accepted as an SMTP alias for off-ramp faxing, use the mta receive aliases command in global configuration mode. Use the no form of this command to disable this alias.
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:
configure terminalmta receive aliases seattle-fax-offramp.example.comThe following example specifies the host name 172.16.0.0 as the alias for the SMTP server:
configure terminalmta receive aliases [172.16.0.0]Related Commands
mta receive generate-mdn
To specify that the off-ramp gateway process a response message delivery notification (MDN) from an SMTP server, use the mta receive generate-mdn command in global configuration mode. Use the no form of this command to disable message delivery notice generation.
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 message delivery notification is enabled on a sending Cisco AS5300, the device inserts a flag in the off-ramp message e-mail header, requesting that the receiving Cisco AS5300 generate the message delivery notification and return that message to the sender when the e-mail message containing the fax image is opened. Use the mta receive generate-mdn command to enable the receiving device—the off-ramp gateway—to process the response message delivery notification.
Depending on the configuration, usage, and features of the mailers used at a site, it might be desirable to enable or disable MDN generation. (DSN generation cannot be disabled.)
Specifications for MDN are described in RFC 2298.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example enables the receiving device to generate message delivery notices:
configure terminalmta receive generate-mdnRelated Commands
mta receive maximum-recipients
To specify the maximum recipients for all SMTP connections, use the mta receive maximum-recipients command in global configuration mode. Use the no form of this command to restore the default value.
mta receive maximum-recipients number
no mta receive maximum-recipients
Syntax Description
number
Specifies the maximum number of recipients for all SMTP connections. Valid entries are from 0 to 1024.
Defaults
The default is 0 recipients, meaning that incoming mail messages will not be accepted, thus no faxes will be sent by the off-ramp gateway.
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to off-ramp Store and Forward Fax functions.
Note
Use the mta receive maximum-recipients command to configure the maximum number of modems 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. This is particularly useful when preparing to shut down the system.
Examples
The following example defines 10 as the maximum number of recipients for all SMTP connections:
configure terminalmta receive maximum-recipients 10Related Commands
mta send mail-from
To specify the mail-from address (also called the RFC 821 envelope-from or the Return-Path address), use the mta send mail-from command in global configuration mode. Use the no form of this command to disable this return path information.
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 the mta send mail-from command to designate the sender of the fax TIFF attachment. This value is equivalent to the return path information in an e-mail message.
The postmaster address, configured with the mta send postmaster command, is used if the mail-from address is blank.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example specifies that the mail-from username information will be derived from the sender's calling number:
configure terminalmta send mail-from username $s$Related Commands
mta send origin-prefix
To add information to the e-mail prefix header, use the mta send origin-prefix command in global configuration mode. Use the no form of this command to disable the defined string.
mta send origin-prefix string
no mta send origin-prefix string
Syntax Description
string
Text string that adds comments to the e-mail prefix header. If this string contains more than one word, the string value should be contained within quotation marks ("x").
Defaults
Null string
Command Modes
Global configuration
Command History
Usage Guidelines
Normally, the Store and Forward Fax feature provides the slot and port number from which this e-mail came in the e-mail prefix header information. Use this command to append the defined text string to the front of the e-mail prefix header information. This test string is a prefix string that is appended with the modem port and slot number and passed in the originator_comment field of the esmtp_client_engine_open() call. Eventually, this 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 will cause 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 provides the user with additional information:
configure terminalmta send origin-prefix Cisco-Powered Fax SystemRelated Commands
mta send postmaster
To define where an e-mail should be delivered (the mail server postmaster account) if it cannot be delivered to the defined destination, use the mta send postmaster command in global configuration mode. Use the no form of this command to disable this defined postmaster.
mta send postmaster e-mail-address
no mta send postmaster e-mail-address
Syntax Description
e-mail-address
Defines where this e-mail should be delivered (the mail server postmaster account) if it cannot be delivered to the defined destination.
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
If you have configured the Cisco AS5300 to generate DSNs and MDNs but you have not configured the sender information (using the mta send mail-from command) or the SMTP server, DSNs and MDNs will be delivered to this e-mail address.
The address defined by this command is used as the mta send mail-from address if the evaluated string is blank. An address, such as fax-administrator@example.com, is recommended (where example.com is replaced with your domain name, and fax-administrator is aliased to the person responsible for the operation of the AS5300's fax functions). At some sites, this may be the same person as the e-mail postmaster, but at most sites this is likely to be a different person and thus should be 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 will be delivered to fax-admin@example.com if the Mail From filed is otherwise blank.
configure terminalmta send postmaster fax-admin@example.comRelated Commands
mta send return-receipt-to
To specify the address where MDNs will be sent, use the mta send return-receipt-to command in global configuration mode. Use the no form of this command to restore the default value.
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 default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
Use the mta send return-receipt-to command to define where you want MDNs to be sent after the fax-mail is opened.
Note
Note
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example configures scoobee as the SMTP mail server to which DSNs will be sent:
configure terminalmta send return-receipt-to hostname server.commta send return-receipt-to username scoobeeRelated Commands
mta send server
To specify a destination mail server or servers, use the mta send server command in global configuration mode. Use the no form of this command to disable the specified destination mail server.
mta send server {host-name | IP-address}
no mta send server {host-name | IP-address}
Syntax Description
host-name
Defines the host name of the destination mail server.
IP-address
Defines the 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 the mta send server 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 the mta send server command. If you configure more than one destination mail server, the Cisco AS5300 attempts to contact the first mail server configured. If that mail server is unavailable, it will contact the next configured destination mail server.
DNS 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 scoobee.example.com and doogie.example.com as the destination mail servers:
configure terminalmta send server scoobee.example.commta send server doogie.example.comRelated Commands
mta send subject
To specify the subject header of the e-mail, use the mta send subject command in global configuration mode. Use the no form of this command to disable this string.
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:
configure terminalmta 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. Use the no form of this command to disable this feature.
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 for the Cisco 3600 series.
12.0(4)T
Support was added for 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 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 for the music played when calls are put on hold to -35:
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 the Cisco 3600 series or Cisco MC3810:
voice-port 1/0/0music-threshold -35Related Commands
network-clock base-rate
To configure the network clock base rate for universal I/O serial ports 0 and 1 on the Cisco MC3810, use the network-clock base-rate command in global configuration mode. Use the no form of this command to disable the current network clock base rate.
network-clock base-rate {56k | 64k}
no network-clock base-rate {56k | 64k}
Syntax Description
56k
Sets the network clock base rate to 56 kilobits per second (kbps).
64k
Sets the network clock base rate to 64 kbps.
Defaults
56 kbps
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to Voice over Frame Relay, Voice over ATM, and Voice over HDLC on the Cisco MC3810.
Examples
The following example sets the network clock base-rate to 64 kbps:
network-clock base-rate 64kRelated Commands
network-clock-select (MC3810)
To use the network clock source to provide timing to the system backplane pulse code modulation (PCM) bus, use the network-clock-select command in global configuration mode. Use the no form of this command to cancel the network clock selection.
network-clock-select priority [serial 0 | system | controller]
no network-clock-select priority [serial 0 | system | controller]
Syntax Description
Defaults
No network clock source is specified.
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to Voice over Frame Relay, Voice over ATM, and Voice over HDLC on the Cisco MC3810.
Examples
The following example sets the priority of four network clock sources. When the clock source with the highest priority (controller T1 0) fails, the Cisco MC3810 switches the clock source to the second highest priority (controller T1 1).
network-clock-select 1 T1 0 network-clock-select 2 T1 1 network-clock-select 3 serial 0 network-clock-select 4 SystemRelated Commands
Configures the switch delay time to the next priority network clock source when the current network clock source fails.
network-clock-switch
To configure the switch delay time to the next priority network clock source when the current network clock source fails, use the network-clock-switch command in global configuration mode. Use the no form of this command to cancel the network clock delay time selection.
network-clock-switch {switch-delay | never} {restore-delay | never}
no network-clock-switch delay
Syntax Description
Defaults
10 seconds
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to Voice over Frame Relay, Voice over ATM, and Voice over HDLC on the Cisco MC3810.
Examples
The following command switches the network clock source after 20 seconds and sets the delay time before the current network clock source recovers to 20 seconds:
network-clock-switch 20 20Related Commands
Uses the network clock source to provide timing to the system backplane PCM bus.
non-linear
To enable nonlinear processing in the echo canceller, use the non-linear command in voice-port configuration mode. Use the no form of this command to disable nonlinear processing.
non-linear
no non-linear
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
Voice-port configuration
Command History
Usage Guidelines
The function enabled by the non-linear command is also generally known as residual echo suppression. This command is associated with the echo canceller operation. The echo-cancel enable command must be enabled for the non-linear command to take effect. Use the non-linear command to shut off any signal if no near-end speech is detected.
Enabling the non-linear command normally improves performance, although some users might perceive truncation of consonants at the end of sentences when this command is enabled.
Examples
The following example enables non-linear call processing on the Cisco 3600 series:
voice-port 1/0/0non-linearThe following example enables non-linear call processing on the Cisco MC3810:
voice-port 1/1non-linearRelated Commands
Enables the cancellation of voice that is sent out the interface and is received on the same interface.
nsap
To specify the network service access point (NSAP) address for a local video dial peer, enter the nsap command in dial-peer configuration mode. Use the no form of the command to remove any configured NSAP address from the dial peer.
nsap nsap-address
no nsap
Syntax Description
Defaults
No video dial peer NSAP address is configured.
Command Modes
Dial-peer configuration
Command History
12.0(5)XK and 12.0(7)T
This command was introduced for ATM video dial-peer configuration on the Cisco MC3810.
Usage Guidelines
The address must be unique on the router.
Examples
On a Cisco MC3810, the following example sets up an NSAP address for the local video dial peer designated as 10:
dial-peer video 10 videocodecnsap 47.0091810000000002F26D4901.333333333332.02Related Commands
num-exp
To define how to expand an extension number into a particular destination pattern, use the num-exp command in global configuration mode. Use the no form of this command to cancel the configured number expansion.
num-exp extension-number expanded-number
no num-exp extension-number expanded-number
Syntax Description
Defaults
No number expansion is defined.
Comm
