Multiservice Applications Commands:
E through P

Syntax Description

8	8 milliseconds
16	16 milliseconds
24	24 milliseconds
32	24 milliseconds

Defaults

16 milliseconds

Command Modes

Voice-port configuration

Command History

Release	Modification
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:0
 echo-cancel enable
 echo-cancel coverage 8

Related Commands

Command	Description
echo-cancel enable	Enables the cancellation of voice that is sent out the interface and is received on the same interface.

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled for all interface types.

Command Modes

Voice-port configuration

Command History

Release	Modification
11.3(1)T	This command was introduced.

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 This command is valid only if the echo-cancel coverage command has been configured. For more information, refer to the echo-cancel coverage command.

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/0
 echo-cancel enable
 echo-cancel coverage 16
 

The 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/1
 echo-cancel enable
 echo-cancel coverage 16

Related Commands

Command	Description
echo-cancel coverage	Adjusts the size of the echo canceler.
non-linear	Enables nonlinear processing in the echo canceler.

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

Interface configuration

Command History

Release	Modification
11.3 MA	This command was introduced.

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 0
 encapsulation atm-ces

Related Commands

Command	Description
ces cell-loss-integration-period	Sets the CES cell-loss integration period on the Cisco MC3810 multiservice concentrator.
ces clockmode synchronous	Configures the ATM CES synchronous clock mode on the Cisco MC3810 multiservice concentrator.
ces connect	Maps the CES service to an ATM PVC on the Cisco MC3810 multiservice concentrator.
ces initial-delay	Configures the size of the receive buffer of a CES circuit on the Cisco MC3810 multiservice concentrator.
ces max-buf-size	Configures the send buffer of a CES circuit on the Cisco MC3810 multiservice concentrator.
ces partial-fill	Configures the number of user octets per cell for the ATM CES on the Cisco MC3810 multiservice concentrator.
ces service	Configures the ATM CES type on the Cisco MC3810 multiservice concentrator.

Syntax Description

des-cbc-sha	Encryption type SSL_RSA_with_DES_CBC_SHA cipher suite.
des40-cbc-sha	Encryption type SSL_RSA_EXPORT_with_DES40_CBC_SHA cipher suite.
dh-des-cbc-sha	Encryption type SSL_DH_RSA_with_DES_CBC_SHA cipher suite.
dh-des40-cbc-sha	Encryption type SSL_DH_RSA_EXPORT_with_DES40_CBC_SHA cipher suite.
null-md5	Encryption type SSL_RSA_with_NULL_MD5 cipher suite.
null-sha	Encryption type SSL_RSA_with_NULL_SHA cipher suite.

Defaults

The default encryption method is all.

Command Modes

Settlement configuration

Command History

Release	Modification
12.0(4)XH1	This command was introduced.

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 0
 encryption des-cbc-sha 

Related Commands

Command	Description
connection-timeout	Configures the time that a connection is maintained after completing a communication exchange.
device-id	Specifies a gateway associated with a settlement provider.
encryption	Sets the encryption method to be negotiated with the provider.
max-connection	Sets the maximum number of simultaneous connections to be used for communication with a settlement provider.
response-timeout	Configures the maximum time to wait for a response from a server.
retry-delay	Sets the time between attempts to connect with the settlement provider.
retry-limit	Sets the maximum number of connection attempts to the provider.
session-timeout	Sets the interval for closing the connection when there is no input or output traffic.
settlement	Enters settlement configuration mode and specifies the attributes specific to a settlement provider.
type	Configures an SAA-RTR operation type.
url	Configures the ISP address.

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

Release	Modification
11.3 NA	This command was introduced.

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 0

Related Commands

Command	Description
delete vfc	Deletes a file from VFC Flash memory.

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

Release	Modification
11.3(1)T	This command was introduced.

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 voip
 expect-factor 0

Syntax Description

1200	Specifies a fax transmission speed of 1200 bits per second (bps).
2400	Specifies a fax transmission speed of 2400 bps.
4800	Specifies a fax transmission speed of 4800 bps.
7200	Specifies a fax transmission speed of 7200 bps.
9600	Specifies a fax transmission speed of 9600 bps.
14400	Specifies a fax transmission speed of 14,400 bps.
disable	Disables fax relay transmission capability.
voice	Specifies the highest possible transmission speed allowed by the voice rate.
bytes	(Optional) Forwards DTMF tones by using the H.245 "signal" User Input Indication method. Valid field entries are 0-9, *, #, and A-D.

Defaults

voice

Command Modes

Dial-peer configuration

Command History

Release	Modification
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 voip
 fax-rate 9600
 

The 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 200

Related Commands

Command	Description
codec (dial-peer)	Specifies the voice coder rate of speech for a dial peer.

Syntax Description

$d$	Wildcard specifies that the information displayed is captured from the configured destination pattern.
string	Specifies the destination telephone number. Valid entries are the plus sign (+), numbers 0 through 9, and the space character. This string can specify an E.164 telephone number; if you choose to configure an E.164 telephone number, you must use the plus sign as the first character.

Defaults

Enabled with a null string.

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 fax received called-subscriber 5551234
 

Syntax Description

$a$	Wildcard that inserts the date in the selected position.
$d$	Wildcard that inserts the destination address in the selected position.
$p$	Wildcard that inserts the page count in the selected position.
$s$	Wildcard that inserts the sender address in the selected position.
$t$	Wildcard that inserts the transmission time in the selected position.
string	Text string that provides personalized information. Valid characters are any text plus wildcards---for example, Time:$t$.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 Because the Cisco AS5300 does not alter fax TIFF attachments, you cannot configure faxed header information for faxes being converted from TIFF files to standard fax transmissions.

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 If the information you have selected for the fax send center-header command exceeds the space allocated for the center fax header, the information is truncated.

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 terminal
 fax send center-header $t$
 

The following example configures the company name Widget and its address as the center fax header information:

configure terminal
 fax send center-header widget $s$

Related Commands

Command	Description
fax send left-header	Specifies the data that will appear on the left in the fax header.
fax send right-header	Specifies the data that will appear on the right in the fax header information.

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

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 fax send coverpage enable
 fax send coverpage comment Acme Fax Services

Related Commands

Command	Description
fax send coverpage e-mail-controllable	Defers to the cover page setting in the e-mail header to generate a standard fax cover sheet.
fax send coverpage enable	Enables the Cisco AS5300 to generate fax cover sheets for faxes that originate from e-mail messages.
fax send coverpage show-detail	Prints all of the e-mail header information as part of the fax cover sheet.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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.

Examples

The following example enables standard generated fax cover sheets:

configure terminal
 fax send coverpage enable
 fax send coverpage e-mail-controllable

Related Commands

Command	Description
fax send coverpage comment	Defines personalized text for the title field of a fax cover sheet.
fax send coverpage enable	Enables the Cisco AS5300 to generate fax cover sheets for faxes that originate from e-mail messages.
fax send coverpage show-detail	Prints all of the e-mail header information as part of the fax cover sheet.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

Usage Guidelines

Note This command is applicable only for faxes originating as e-mail messages. The Cisco AS5300 does not alter fax TIFF attachments. Therefore you cannot use this command to enable the AS5300 to generate fax cover pages for faxes being converted from TIFF files to standard fax transmissions.

This command applies to off-ramp Store and Forward Fax functions.

Examples

The following example enables Cisco AS5300-generated fax cover sheets:

configure terminal
 fax send coverpage enable

Related Commands

Command	Description
fax send coverpage comment	Defines personalized text for the title field of a fax cover sheet.
fax send coverpage e-mail-controllable	Defers to the cover page setting in the e-mail header to generate a standard fax cover sheet.
fax send coverpage show-detail	Prints all of the e-mail header information as part of the fax cover sheet.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

Usage Guidelines

This command applies to off-ramp Store and Forward Fax functions.

Note This command is applicable only for faxes originating as e-mail messages. The Cisco AS5300 does not alter fax TIFF attachments. Therefore, you cannot use this command to enable the AS5300 to display additional fax cover page information for faxes being converted from TIFF files to standard fax transmissions.

Examples

The following example configures an individualized generated fax cover sheet that contains the e-mail header text:

configure terminal
 fax send coverpage enable
 no fax send coverpage e-mail-controllable
 fax send coverpage show-detail

Related Commands

Command	Description
fax send coverpage comment	Defines personalized text for the title field of a fax cover sheet.
fax send coverpage e-mail-controllable	Defers to the cover page setting in the e-mail header to generate a standard fax cover sheet.
fax send coverpage enable	Enables the Cisco AS5300 to generate fax cover sheets for faxes that originate from e-mail messages.

Syntax Description

$a$	Wildcard that inserts the date in the selected position.
$d$	Wildcard that inserts the destination address in the selected position.
$p$	Wildcard that inserts the page count in the selected position.
$s$	Wildcard that inserts the sender's address in the selected position.
$t$	Wildcard that inserts the transmission time in the selected position.
string	Text string that provides personalized information. Valid characters are any combination of ASCII characters and the wildcards listed.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 If the information you select for the fax send left-header command exceeds the space allocated for the left fax header, the information is truncated.

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 terminal
 fax send left-header $t$
 

The following example configures the company name Widget and its address as the left fax header information:

configure terminal
 fax send left-header widget $s$

Related Commands

Command	Description
fax send center-header	Specifies the data that will appear in the center position of the fax header information.
fax send right-header	Specifies the data that will appear on the right in the fax header information.

Syntax Description

12000	Indicates a transmission speed of 12000 bits per second (bps).
14400	Indicates a transmission speed of 14400 bps.
2400	Indicates a transmission speed of 2400 bps.
4800	Indicates a transmission speed of 4800 bps.
7200	Indicates a transmission speed of 7200 bps.
9600	Indicates a transmission speed of 9600 bps.

Defaults

14400

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 fax send max-speed 2400
 

Syntax Description

$a$	Wildcard that inserts the date in the selected position.
$d$	Wildcard that inserts the destination address in the selected position.
$p$	Wildcard that inserts the page count in the selected position.
$s$	Wildcard that inserts the sender's address in the selected position.
$t$	Wildcard that inserts the transmission time in the selected position.
string	Text string that provides personalized information. Valid characters are any combination of ASCII characters and the wildcards listed.

Defaults

No connection

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 If the information you select for the fax send right-header command exceeds the space allocated for the right fax header, the information is truncated.

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 terminal
 fax send right-header $a$
 

The following example configures the company name Widget and its address as the right fax header information:

configure terminal
 fax send right-header widget $s$

Related Commands

Command	Description
fax send center-header	Specifies the data that will appear in the center position of the fax header information.
fax send left-header	Specifies the data that will appear on the left in the fax header.

Syntax Description

$s$	Wildcard that inserts the sender name from the RFC 822 header (captured by the on-ramp from the sending fax machine) in the selected position.
string	Specifies the destination telephone number. Valid entries are the plus sign (+), numbers 0 through 9, and the space character. This string can specify an E.164 telephone number; if you choose to configure an E.164 telephone number, you must use the plus sign as the first character.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 fax send transmitting-subscriber +14085551234

Syntax Description

num-digit	The number of digits to be forwarded. If the number of digits is longer than the length of a destination phone number, the length of the destination number is used. The valid range is 0 to 32. Setting the value to 0 is equivalent to entering no forward digits (the default).
all	Forward all digits. If "all" is used, the full length of the destination pattern will be used.
implicit	Exactly matched digits are not forwarded. Only digits matched by the wildcard pattern are forwarded.

Defaults

No digits are forwarded.

Command Modes

Dial-peer configuration

Command History

Release	Modification
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 all

Related Commands

Command	Description
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.

Syntax Description

bps_reserved	The bandwidth in bps reserved for voice traffic for the specified map class. The range is from 8000 to 45000000 bits per second; the default is 0, which disables voice calls.
queue depth	(Optional) The queue reserved strictly for voice packets.The depth value represents the depth of the queue reserved strictly for voice packets. The default is 100, and the valid range is 30 to 1000.

Defaults

Disabled (zero)

Command Modes

Map-class configuration

Command History

Release	Modification
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 Cisco strongly recommends that you set voice bandwidth to a value less than the committed information rate (CIR) if Frame Relay traffic shaping is configured. Cisco also strongly recommends that you set the minimum CIR (using the frame-relay mincir command) to be at least equal to or greater than the voice bandwidth.

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)

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/1
 frame-relay interface-dlci 100
  class vofr
  exit
map-class frame-relay vofr
 frame-relay voice bandwidth 64000

Related Commands

Command	Description
codec (dial-peer)	Specifies the voice coder rate of speech for a Voice over Frame Relay dial peer.
frame-relay fair-queue	Enables weighted fair queueing for one or more Frame Relay PVCs.
frame-relay fragment	Enables fragmentation for a Frame Relay map class.
frame-relay interface-dlci	Assigns a DLCI to a specified Frame Relay subinterface on the router or access server.
map-class frame-relay	Specifies a map class to define QoS values for an SVC.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
11.3(2)NA and 12.0(3)T	This command was introduced.

Usage Guidelines

Press Ctrl-Z or use the exit command to exit gatekeeper configuration mode.

Examples

The following example brings the gatekeeper online:

configure terminal
gatekeeper
no shutdown

Syntax Description

This command has no keywords or arguments.

Defaults

The gateway is unregistered.

Command Modes

Global configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced.

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 terminal
gateway

Syntax Description

h323	Enables standard H.323 accounting using Internet Engineering task Force (IETF) RADIUS attributes.
syslog	Enables the system logging facility to output accounting information in the form of a system log message.
vsa	Enables H.323 accounting using RADIUS vendor specific attributes (VSAs).

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
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:

Examples

The following example configures the basic H.323 accounting using IETF RADIUS attributes:

gw-accounting h323
 

The following example configures H.323 accounting using the VSA RADIUS attributes:

gw-accounting vsa

Syntax Description

type-prefix	A technology prefix is recognized and is stripped before checking for the zone prefix. It is strongly recommended that you select technology prefixes that do not lead to ambiguity with zone prefixes. Do this by using the # character to terminate technology prefixes, for example, 3#.
hopoff gkid	(Optional) Specifies the gatekeeper or zone where the call is to hop off, regardless of the zone prefix in the destination address. The gkid argument refers to a zone previously configured using the zone local or zone remote comment.
default-technology	(Optional) Gateways registering with this prefix option are used as the default for routing any addresses that are otherwise unresolved.
gw ipaddr ipaddr [port]	(Optional) Indicates that the gateway is incapable of registering technology prefixes. When it registers, it adds the gateway to the group for this type-prefix, just as if it had sent the technology prefix in its registration. This parameter can be repeated to associate more than one gateway with a technology prefix.

Defaults

No technology prefix is defined.

Command Modes

Gatekeeper configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced.

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-technology

Related Commands

Command	Description
zone prefix	Configures the gatekeeper with knowledge of its own prefix and the prefix of any remote zone.

Syntax Description

There are no arguments or keywords for this command.

Defaults

ASR is disabled.

Command Modes

Interface configuration

Command History

Release	Modification
11.3(2)NA	This command was introduced.

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 If you specify no h323 asr bandwidth max-bandwidth, this removes the bandwidth setting but ASR is still enabled. You must enter no h323 asr to disable ASR.

Examples

The following example enables ASR:

h323 asr

Syntax Description

bandwidth max-bandwidth

(Optional) Maximum bandwidth on the interface. Value ranges from 1 to 10,000,000 kbps. If you do not specify the max-bandwidth, this value defaults to the bandwidth on the interface. If you specify max-bandwidth as a value greater than the interface bandwidth, the bandwidth will default to the interface bandwidth.

Defaults

ASR is disabled.

Command Modes

Interface configuration

Command History

Release	Modification
11.3(2)NA and 12.0(3)T	This command was introduced.

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 If you specify no h323 asr bandwidth max-bandwidth, this removes the bandwidth setting and ASR is still enabled. You must enter no h323 asr to disable ASR.

Examples

The following example enables ASR and specifies a maximum bandwidth of 10,000 kbps:

h323 asr bandwidth 10000

Syntax Description

id gatekeeper-id	(Optional) The gatekeeper-id argument specifies the gatekeeper name. Typically, this is a DNS name, but it can also be a raw IP address in dotted form. If this parameter is specified, gatekeepers that have either the default or explicit flags set for the proxy's subnet will respond. If this parameter is not specified, only those gatekeepers with the default subnet flag will respond.
ipaddr ipaddr [port]	If this parameter is specified, the gatekeeper discovery message will be unicast to this address and, optionally, the port specified.
multicast	If this parameter is specified, the gatekeeper discovery message will be multicast to the well-known RAS multicast address and port.

Defaults

No gatekeeper is configured for the proxy.

Command Modes

Interface configuration

Command History

Release	Modification
11.3(2)NA	This command was introduced.

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.2
 

The following example sets up a multicast discovery for a gatekeeper of a particular name:

h323 gatekeeper id gk.zone5.com multicast

Related Commands

Command	Description
h323 interface	Registers an H.323 proxy alias with a gatekeeper.
h323 interface	Specifies the interface from which the proxy will take its IP address.

Syntax Description

interface-id

H.323 name (ID) used by this gateway when this gateway communicates with its associated gatekeeper. Usually, this ID is the name of the gateway with the gatekeeper domain name appended to the end: name@domain-name.

Defaults

No gateway identification is defined.

Command Modes

Interface configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced.

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/0
 ip address 172.9.53.13 255.255.255.0
 h323-gateway voip interface
 h323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719
 h323-gateway voip h323-id GW13@cisco.com
 h323-gateway voip tech-prefix 13#

Related Commands

Command	Description
h323-gateway voip id	Defines the name and location of the gatekeeper for this gateway.
h323-gateway voip interface	Configures this interface as an H.323 interface.
h323-gateway voip tech-prefix	Defines the technology prefix that the gateway will register with the gatekeeper.

Syntax Description

gatekeeper-id	Indicates the H.323 identification of the gatekeeper. This value must exactly match the gatekeeper ID in the gatekeeper configuration. The recommended format is name.doman-name.
ipaddr	Indicates that the gateway will use an IP address to locate the gatekeeper
ip-address	Defines the IP address used to identify the gatekeeper.
multicast	Indicates that the gateway will use multicast to locate the gatekeeper.
port-number	(Optional) Defines the port number used.

Defaults

No gatekeeper identification is defined.

Command Modes

Interface configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced.

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 GW15.cisco.com and its IP address is 172.9.53.15 (using port 1719).

interface Ethernet0/0
 ip address 172.9.53.15 255.255.255.0
 h323-gateway voip interface
 h323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719
 h323-gateway voip h323-id GW15@cisco.com
 h323-gateway voip tech-prefix 13#

Related Commands

Command	Description
h323-gateway voip h323-id	Configures the H.323 name of the gateway identifying this gateway to its associated gatekeeper.
h323-gateway voip interface	Configures this interface as an H.323 interface.
h323-gateway voip tech-prefix	Defines the technology prefix that the gateway will register with the gatekeeper.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled.

Command Modes

Interface configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced.

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/0
 ip address 172.9.53.15 255.255.255.0
 h323-gateway voip interface
 h323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719
 h323-gateway voip h323-id GW15@cisco.com
 h323-gateway voip tech-prefix 13#

Related Commands

Command	Description
h323-gateway voip h323-id	Configures the H.323 name of the gateway identifying this gateway to its associated gatekeeper.
h323-gateway voip id	Defines the name and location of the gatekeeper for this gateway.
h323-gateway voip tech-prefix	Defines the technology prefix that the gateway will register with the gatekeeper.

Syntax Description

prefix

Defines the numbers used as the technology prefixes. Each technology prefix can contain up to 11 characters. Although not strictly necessary, a pound (#) symbol is frequently used as the last digit in a technology prefix. Valid characters are 0 though 9, the pound (#) symbol, and the asterisk (*).

Defaults

Disabled

Command Modes

Interface configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced.

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 Cisco gatekeepers use the asterisk (*) as a reserved character. If you are using Cisco gatekeepers, do not use the asterisk as part of the technology prefix.

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/0
 ip address 172.9.53.15 255.255.255.0
 h323-gateway voip interface
 h323-gateway voip id GK15.cisco.com ipaddr 172.9.53.15 1719
 h323-gateway voip h323-id GW15@cisco.com
 h323-gateway voip tech-prefix 13#

Related Commands

Command	Description
h323-gateway voip id	Defines the name and location of the gatekeeper for this gateway.
h323-gateway voip interface	Configures this interface as an H.323 interface.
h323-gateway voip h323-id	Configures the H.323 name of the gateway identifying this gateway to its associated gatekeeper.

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

Release	Modification
11.3(2)NA and 12.0(3)T	This command was introduced.

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 You must enter the h323 interface command before using this command. The h323 h323-id command must be entered on the same interface as the h323 gatekeeper command. The proxy will not go online without this command.

Examples

The following example registers an H.323 proxy alias called proxy1@zone5.com with a gatekeeper:

h323 h323-id proxy1@zone5.com

Related Commands

Command	Description
h323 gatekeeper	Specifies the gatekeeper associated with a proxy and controls how the gatekeeper is discovered.
h323 interface	Specifies the interface from which the proxy will take its IP address.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Interface configuration

Command History

Release	Modification
11.3(2)NA and 12.0(3)T	This command was introduced.

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 Loopback0
 ip address 173.0.0.1 255.0.0.0
 h323 interface

Related Commands

Command	Description
h323 qos	Enables QoS on the proxy.

Syntax Description

ip-precedence value	Specifies that RTP streams should set their IP precedence bits to the specified value.
rsvp controlled-load	Specifies controlled load class of service.
rsvp guaranteed-qos	Specifies guaranteed QoS class of service.

Defaults

No QoS is configured.

Command Modes

Interface configuration

Command History

Release	Modification
11.3(2)NA	This command was introduced.

Usage Guidelines

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Dial-peer configuration

Command History

Release	Modification
12.0(5)T	This command was introduced on the Cisco MC3810.

Usage Guidelines

Once you enter this command, no further hunting is allowed if a call fails on the specified dial peer.

Note This command can be used with all types of dial peers.

Examples

The following example shows how to disable dial-peer hunting on a specific dial peer:

dial peer voice 100 vofr
 huntstop
 

The following example shows how to reenable dial-peer hunting on a specific dial peer:

dial peer voice 100 vofr
 no huntstop

Related Commands

Command	Description
dial-peer voice	Enters dial-peer configuration mode and specifies the method of voice-related encapsulation.

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

Release	Modification
11.3(1)T	This command was introduced.

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 voip
 icpif 0

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-bit

E&M MEL CAS:

no ignore rx-b-bit, rx-c-bit, rx-d-bit

Command Modes

Voice-port configuration

Command History

Release	Modification
11.3 MA	This command was introduced.

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/1
 ignore rx-b-bit
 ignore rx-c-bit
 ignore rx-d-bit

Related Commands

Command	Description
condition	Manipulates the signalling format bit-pattern for all voice signalling types on the Cisco MC3810 multiservice concentrator.
define	Defines the send and receive bits for E&M and E&M MEL CAS voice signalling on the Cisco MC3810 multiservice concentrator.

Syntax Description

mh	Specifies Modified Huffman image encoding. This is the IETF standard.
mr	Specifies Modified Read image encoding.
mmr	Specifies Modified Modified Read image encoding.
passthrough	Specifies that the image will not be modified by an encoding method.

Defaults

Passthrough

Command Modes

Dial-peer configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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:

• Modified Huffman (MH)---One-dimensional data compression scheme that compresses data in only one direction (horizontal). Modified Huffman compression does not allow the transmission of redundant data. This encoding method produces the largest image file size.

• Modified Read (MR)---Two-dimensional data compression scheme (used by fax devices) that handles the data compression of the vertical line and that concentrates on the space between lines and within given characters.

• Modified Modified Read (MMR)---Data compression scheme used by newer Group 3 fax devices. This encoding method produces the smallest possible image file size and is slightly more efficient than Modified Read.

• Passthrough---No encoding method will be applied to the image---meaning that the image will be encoded by whatever encoding method is used by the fax device.

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 mmoip
 image encoding mmr

Related Commands

Command	Description
image-resolution	Specifies a particular fax image resolution for a specific MMoIP dial peer.

Syntax Description

fine	Configures the fax TIFF image resolution to be 204-by-196 pixels per inch.
standard	Configures the fax TIFF image resolution to be 204-by-98 pixels per inch.
super-fine	Configures the fax TIFF image resolution to be 204-by-391 pixels per inch.
passthrough	Indicates that the resolution of the fax TIFF image will not be altered.

Defaults

Passthrough

Command Modes

Dial-peer configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 mmoip
 image encoding mh
 image resolution fine

Related Commands

Command	Description
image encoding	Selects a specific encoding method for fax images associated with an MMoIP dial peer.

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

Release	Modification
11.3(1)T	This command was introduced.

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/0
 impedance 600r
 

The following example configures an E&M voice port on the Cisco MC3810 for a terminating impedance of 900 ohms (complex):

voice-port 1/1
 impedance 900c

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

Release	Modification
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 pots
 incoming called-number 3799262
 

The following example configures the number (310)555-9261 as the incoming called number for MMoIP dial peer 10:

dial-peer voice 10 mmoip
 incoming 3105559261

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

Release	Modification
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 mmoip
 information-type fax

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

Release	Modification
11.3(1)T	This command was introduced.

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/0
 input gain 3
 

The following example configures a 3-decibel gain to be inserted at the receiver side of the interface in the Cisco MC3810:

port 1/1
 input gain 3

Related Commands

Command	Description
output attenuation	Configures a specific output attenuation value for a voice port.

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

Release	Modification
11.3 NA	This command was introduced.

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 voip
 ip precedence 5

Syntax Description

This command has no arguments or keywords.

Defaults

disabled

Command Modes

Dial-peer configuration

Command History

Release	Modification
11.3(1)T	This command was introduced.

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 voip
 ip udp checksum

Related Commands

Command	Description
loop-detect	Enables loop detection for T1 for Voice over ATM, Voice over Frame Relay, and Voice over HDLC.

Syntax Description

url	Indicates that a URL is used to locate the index file that contains a list of all available audio files.
location	Specifies the URL of the index file. Example of index file on TFTP: tftp://keyer/index Example of index file on Flash: flash:index

Defaults

No URL is defined.

Command Modes

Global configuration

Command History

Release	Modification
12.0(7)T	This command was introduced.

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.

• Check if any prompt is being actively used (IVR is actively playing some prompts). If there are active prompts, the command fails with following error (.au files are also referred to as prompts):

  command is not allowed when prompts are active
  

• Check if there is already a back-ground process in progress. If there a process, command fails with following error:

  previous autoload command is still in progress
  

• Check if there is already a earlier ivr autoload command. If there is already an ivr autoload command configured, the user sees the following response when the command is issued:

  previous command is being replaced
  

• When the no ivr autoload command is issued, if there was already an ivr autoload command in progress, it will be aborted.

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/index4
 

The index file for this example index4 is shown as:

Router# more index4
tftp://jurai/mgindi/tclware/au/en/en_one.au 
#tftp://jurai/mgindi/tclware/au/ch/ch_one.au 
tftp://jurai/mgindi/tclware/au/ch/ch_one.au

Related Commands

Command	Description
ivr prompt memory	Configures the maximum amount of memory you wish to allow the dynamic audio files (prompts) to occupy in memory.

Syntax Description

number

Indicates a number from 1 to 5. The default value is 3.

Defaults

ivr autoload retry 3

Command Modes

Global configuration

Command History

Release	Modification
12.0(7)T	This command was introduced.

Examples

The following example configures the system to try three times to load audio files:

ivr autoload retry 3

Related Commands

Command	Description
ivr prompt memory	Configures the maximum amount of memory you wish to allow the dynamic audio files (prompts) to occupy in memory.

Syntax Description

verbose	Displays the file transfer activity to the console. This mode is recommended for use while debugging.
silent	Performs the file transfer in silent mode, meaning that no file transfer activity is displayed to the console.
retry	(Optional) Specifies the number of times the system will try to transfer a file when there are errors. This parameter applies to each file transfer.
number	(Optional) Indicates a number from 1 to 5. The default value is 3.
url	Indicates that a URL is used to locate the index file that contains a list of all available audio files.
location	Specifies the URL of the index file. Example of index file on TFTP: tftp://keyer/index Example of index file on Flash: flash:index

Defaults

ivr autoload silent

Command Modes

Global configuration

Command History

Release	Modification
12.0(7)T	This command was introduced.

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.

• Check if any prompt is being actively used (IVR is actively playing some prompts). If there are active prompts, the command fails with following error (.au files are also referred to as prompts):

  command is not allowed when prompts are active
  

• Check if there is already a back-ground process in progress. If there is a process, command fails with following error:

  previous autoload command is still in progress
  

• Check if there is already a earlier ivr autoload command. If there is already an ivr autoload command configured, the user sees the following response when the command is issued:

  previous command is being replaced
  

• When the no ivr autoload command is issued, if there was already an ivr autoload command in progress, it will be aborted.

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/index4
 

The index file for this example index4 is shown as:

Router# more index4
tftp://jurai/mgindi/tclware/au/en/en_one.au 
#tftp://jurai/mgindi/tclware/au/ch/ch_one.au 
tftp://jurai/mgindi/tclware/au/ch/ch_one.au

Related Commands

Command	Description
ivr prompt memory	Configures the maximum amount of memory you wish to allow the dynamic audio files (prompts) to occupy in memory.

Syntax Description

size	Specifies the maximum memory to be used by the free dynamic prompts in kilobytes. Valid entries are from 128 to 16384.
files number	Specifies the number of files that can stay in memory. Valid entries for the number argument is 50 to 1000.

Command Modes

Global configuration

Command History

Release	Modification
12.0(7)T	This command was introduced.

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 500 

Related Commands

Command	Description
ivr autoload	Loads files from TFTP to memory.
show call prompt-mem-usage	Displays the memory site use by prompts.

Syntax Description

diagnostic	Loops the outgoing transmit signal back to the receive signal
line	Places the interface into external loopback mode at the line.
local	Places the interface into local loopback mode.
payload	Places the interface into external loopback mode at the payload level.
remote	Keeps the local end of the connection in remote loopback mode.
iboc	Sends an in-band bit-oriented code to the far end to cause it to go into line loopback.
esf	Specifies extended super frame as the T1 or E1 frame type.

Defaults

No loopback is configured.

Command Modes

Controller configuration

Command History

Release	Modification
11.3 MA	This command was introduced as a controller configuration command for the Cisco MC3810.
12.0(5)T and 12.0(5)XK	The command was introduced as an ATM interface configuration command for the Cisco 2600 and 3600 series.
12.0(5)XE	The command was introduced as an ATM interface configuration command for the Cisco 7200 and 7500 series.
12.0(5)XK and 12.0(7)T	The command was introduced as a controller configuration command for the Cisco 2600 and 3600 series.

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/0
loopback diagnostic

Syntax Description

This command has no arguments or keywords.

Defaults

Loop detection is disabled.

Command Modes

Controller configuration

Command History

Release	Modification
11.3 MA	This command was introduced.

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 0
 loop-detect

Related Commands

Command	Description
loopback (interface)	Diagnoses equipment malfunctions between an interface and a device.

Syntax Description

plan1	FXO: A-D gain = 0 db, D-A gain = 0 db FXS: A-D gain = -3 db, D-A gain = -3 db
plan2	FXO: A-D gain = 3 db, D-A gain = 0 db FXS: A-D gain = 0 db, D-A gain =-3 db
plan5	FXO: Not applicable FXS: A-D gain = -3 db, D-A gain = -10 db
plan6	FXO: Not applicable FXS: A-D gain = 0 db, D-A gain = -7 db
plan7	FXO: A-D gain = 7 db, D-A gain = 0 db FXS: A-D gain = 0 db, D-A gain = -6 db

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

Release	Modification
11.3(1)MA	This command was introduced on the Cisco MC3810.

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/6
 loss-plan plan3
 

The 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/1
 loss-plan plan6

Related Commands

Command	Description
impedance	Specifies the terminating impedance (amount of wire resistance and reactivity to current) of a voice port interface. The setting must match the physical wiring.
input gain	Configures a specific input gain value for a voice port.
output attenuation	Configures a specific output attenuation value for a voice port.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Gatekeeper configuration

Command History

Release	Modification
12.0(3)T	This command was introduced.

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

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.1
gk-directory(config-gk)# zone remote gk-east cisco.com 172.0.2.1
 
gk-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-queries

Configuration 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.com
gk-west(config-gk)# zone remote gk-directory cisco.com 172.1.2.3
 
gk-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.com
gk-east(config-gk)# zone remote gk-directory cisco.com 172.1.2.3
 
gk-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

Command	Description
lrq reject-unknown-prefix	Enables the gatekeeper to reject all Location Requests (LRQs) for zone prefixes that are not configured.

Syntax Description

This command has no arguments or keywords.

Defaults

The gatekeeper accepts and processes all incoming LRQs.

Command Modes

Gatekeeper configuration

Command History

Release	Modification
11.3(6)NA2	This command was introduced.

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 the matching zone prefix is local (that is, controlled by this gatekeeper), the LRQ is serviced.

• If the matching zone prefix is remote (that is, controlled by some other gatekeeper), the LRQ is rejected.

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.com
zone local gk415 cisco.com
zone prefix gk408 1408.......
zone prefix gk415 1415.......
lrq reject-unknown-prefix
 

In 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

Command	Description
lrq forward-queries	Enables a gatekeeper to forward Location Requests (LRQs) that contain E.164 addresses that match zone prefixes controlled by remote gatekeepers.

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

Release	Modification
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 voip
 max-conn 5

Related Commands

Command	Description
mta receive maximum-recipients	Specifies the maximum recipients for all SMTP connections.

Syntax Description

num	Specifies the maximum number of HTTP connections to a settlement provider.

Defaults

The default is 20 maximum connections.

Command Modes

Settlement configuration

Command History

Release	Modification
12.0(4)XH1	This command was introduced.

Examples

The following command sets the maximum number of simultaneous connections to be 10:

settlement 0
 max-connections 10

Related Commands

Command	Description
connection-timeout	Configures the time that a connection is maintained after completing a communication exchange.
device-id	Specifies a gateway associated with a settlement provider.
encryption	Sets the encryption method to be negotiated with the provider.
response-timeout	Configures the maximum time to wait for a response from a server.
retry-delay	Sets the time between attempts to connect with the settlement provider.
retry-limit	Sets the maximum number of connection attempts to the provider.
session-timeout	Sets the interval for closing the connection when there is no input or output traffic.
settlement	Enters settlement configuration mode and specifies the attributes specific to a settlement provider.
type	Configures an SAA-RTR operation type.
url	Configures the ISP address.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Dial-peer configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 mmoip
 mdn

Related Commands

Command	Description
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.

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

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 mmoip aaa global-password abercrombie

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

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 aaa new-model
 mmoip aaa method fax accounting sherman

Related Commands

Command	Description
mmoip aaa receive-accounting enable	Enables on-ramp Store and Forward Fax AAA accounting services.

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

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 aaa new-model
 mmoip aaa method fax authentication peabody

Related Commands

Command	Description
mmoip aaa receive-authentication enable	Enables on-ramp Store and Forward Fax AAA authentication services.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 aaa new-model
 mmoip aaa method fax accounting sherman
 aaa accounting connection sherman stop-only radius
 mmoip aaa receive-accounting enable

Related Commands

Command	Description
mmoip aaa method fax accounting	Defines the name of the method list to be used for AAA accounting with Store and Forward Fax.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 aaa new-model
 mmoip aaa method fax authentication peabody
 aaa authentication login peabody radius local
 mmoip aaa receive-authentication enable

Related Commands

Command	Description
mmoip aaa method fax authentication	Defines the name of the method list to be used for AAA authentication with Store and Forward Fax.

Syntax Description

ani	Indicates that AAA uses the calling party telephone number (automatic number identification or ANI) as the AAA account identifier.
dnis	Indicates that AAA uses the called party telephone number (dialed number identification service or DNIS) as the AAA account identifier.
gateway	Indicates that AAA uses the router-specific name derived from the host name and domain name as the AAA account identifier, displayed in the following format: router-name.domain-name.
redialer-id	Indicates that AAA uses the account string returned by the external redialer device as the AAA account identifier. In this case, the redialer ID is either the redialer serial number or the redialer account number.
redialer-dnis	Indicates that AAA uses the called party telephone number (dialed number identification service or DNIS) as the AAA account identifier captured by the redialer if a redialer device is present.

Defaults

No account identification source is defined.

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 aaa new-model
 mmoip aaa receive-id secondary redialer-dnis

Related Commands

Command	Description
mmoip aaa receive-id primary	Specifies the primary location where AAA retrieves its account identification information for on-ramp faxing.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

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 terminal
 aaa new-model
 mmoip aaa method fax accounting sherman
 aaa accounting connection sherman stop-only radius
 mmoip aaa send-accounting enable

Related Commands

Command	Description
mmoip aaa method fax accounting	Defines the name of the method list to be used for AAA accounting with Store and Forward Fax.

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release	Modification
12.0(4)XJ	This command was introduced.

Usage Guidelines