Downloads |
Table Of Contents
call application voice access-method
call application voice accounting enable
call application voice accounting-list
call application voice authentication enable
call application voice accounting-list
call application voice authentication enable
call application voice authen-list
call application voice authen-method
call application voice global-password
call application voice language
call application voice pin-len
call application voice redirect-number
call application voice retry-count
call application voice set-location
call application voice uid-len
call application voice warning-time
fax protocol (dial-peer configuration)
fax send coverpage e-mail-controllable
fax send coverpage show-detail
fax send transmitting-subscriber
mta receive maximum-recipients
Command Reference
This section documents new or modified commands for the T.37/T.38 Fax Gateway feature. All other commands used with this feature are documented in the Cisco IOS Release 12.0(4)XJ Store and Forward Fax feature and in the Cisco IOS Release 12.1 Cisco IOS Multiservice Applications Command Reference.
•
call application voice access-method
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
application
To enable a specific interactive voice response (IVR) application on a dial peer, use the application command in dial-peer configuration mode. To remove the application from the dial peer, use the no form of this command.
application application-name [out-bound]
no application application-name [out-bound]
Syntax Description
Defaults
No default behavior or values.
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use this command when configuring Interactive Voice Response (IVR) or any of the IVR-related features to associate a predefined session application with an incoming POTS dial peer or an outgoing MMOIP dial peer. Calls using this incoming POTS dial peer or this outgoing MMOIP dial peer will be handed to the predefined specified session application.
Examples
This following example shows how to define an application and how to apply it to an incoming POTS dial peer:
call application voice c4 tftp://santa/username/clid_4digits_npw_3.tcldial-peer voice 100 potsapplication c4This following example shows how to define an application and how to apply it to an outbound MMoIP dial peer for the onramp operation:
dial-peer voice 3 mmoipapplication fax_on_vfc_onramp_ap out-bounddestination-pattern 57108..session target mailto:$d$@mail-server.cisco.comRelated Commands
call application voice
Defines the name to be used for an application and indicates the location of the appropriate IVR script to be used with this application.
call application voice access-method
To specify the access method for two-stage dialing for the designated application, use the call application voice access-method command in global configuration mode. To restore default values for this command, use the no form of this command.
call application voice application-name access-method {prompt-user | redialer}
no call application voice application-name access-method
Syntax Description
Defaults
Prompt-user (when DID is not set in the dial peer).
Command Modes
Global configuration mode
Command History
12.1(3)XI
This command was introduced on the Cisco AS5300 access server.
12.1(5)T
This command was introduced in the Cisco IOS T Train.
Usage Guidelines
Use the call application voice access-method command to specify the access method for two-stage dialing when DID is disabled in the POTS dial peer.
Examples
The following example specifies prompt-user as the access method for two-stage dialing for the app_libretto_onramp9 IVR application:
configure terminalcall application voice app_libretto_onramp9 access-method prompt-userRelated Commands
call application voice accounting enable
To enable AAA accounting for a TCL application, use the call application voice accounting enable command in global configuration mode. To disable accounting for a TCL application, use the no form of this command.
call application voice application-name accounting enable
no call application voice application-name accounting enable
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables AAA accounting services if a AAA accounting method list has been defined using both the aaa accounting command and the mmoip aaa method fax accounting command.
This command applies to off-ramp store-and-forward fax functions on AS5300 VFCs.
Examples
The following example enables a AAA accounting to be used with outbound Store and Forward Fax:
configure terminalcall application voice app_libretto_onramp9 accounting enableRelated Commands
mmoip aaa method fax accounting
Defines the name of the method list to be used for AAA accounting with Store and Forward Fax.
call application voice accounting-list
To define the name of the method list to be used for AAA accounting with Store and Forward Fax on a Voice Feature Card (VFC), use the call application voice accounting-list global configuration command. Use the no form of this command to restore the default value.
call application voice application-name accounting-list method-list-name
no call application voice application-name accounting-list method-list-name
Syntax Description
application-name
The name of the application.
method-list-name
Character string used to name a list of accounting methods to be used with Store and Forward Fax.
Defaults
No AAA accounting method list defined.
Command Modes
Global configuration
Command History
Usage Guidelines
This command defines the name of the AAA accounting method list to be used with Store and Forward Fax. The method list itself, which defines the type of accounting services provided for Store and Forward Fax, is defined using the aaa accounting global configuration command. Unlike standard AAA (where each defined method list can be applied to specific interfaces and lines), the AAA accounting method lists used in Store and Forward Fax are applied globally on the Cisco AS5300.
After the accounting method lists have been defined, they are enabled by using the mmoip aaa receive-accounting enable command.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions on AS5300 voice feature cards.
Examples
The following example defines a AAA accounting method list (called sherman) to be used with Store and Forward Fax:
configure terminalaaa new-modelcall application voice app_libretto_onramp9 accounting-list shermanRelated Commands
call application voice accounting enable
Enables on-ramp AAA accounting services.
call application voice authentication enable
To enable AAA authentication services for a TCL application, use the call application voice authentication enable command in global configuration mode. To disable authentication for a TCL application, use the no form of this command.
call application voice application-name authentication enable
no call application voice application-name authentication enable
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables AAA authentication services for a TCL application if a AAA authentication method list has been defined using both the aaa authentication command and the call application voice authen-list command.
Examples
The following example enables a AAA authentication method list (called peabody) to be used with outbound Store and Forward Fax.
configure terminalaaa new-modelcall application voice app_libretto_onramp9 authen-list peabodycall application voice app_libretto_onramp9 authentication enableRelated Commands
call application voice accounting-list
To define the name of the method list to be used for AAA accounting with Store and Forward Fax on a VFC, use the call application voice accounting-list global configuration command. Use the no form of this command to restore the default value.
call application voice application-name accounting-list method-list-name
no call application voice application-name accounting-list method-list-name
Syntax Description
application-name
The name of the application.
method-list-name
Character string used to name a list of accounting methods to be used with store and forward fax.
Defaults
No AAA accounting method list defined.
Command Modes
Global configuration
Command History
Usage Guidelines
This command defines the name of the AAA accounting method list to be used with store and forward fax. The method list itself, which defines the type of accounting services provided for store and forward fax, is defined using the aaa accounting global configuration command. Unlike standard AAA (where each defined method list can be applied to specific interfaces and lines), the AAA accounting method lists used in store and forward fax are applied globally on the Cisco AS5300.
After the accounting method lists have been defined, they are enabled by using the mmoip aaa receive-accounting enable command.
This command applies to both on-ramp and off-ramp store and forward fax functions on AS5300 voice feature cards.
Examples
The following example defines a AAA accounting method list (called sherman) to be used with store and forward fax:
configure terminalaaa new-modelcall application voice app_onramp6 accounting-list shermanRelated Commands
call application voice accounting enable
Enables on-ramp AAA accounting services.
call application voice authentication enable
To enable AAA authentication services for a TCL application, use the call application voice authentication enable command in global configuration mode. To disable authentication for a TCL application, use the no form of this command.
call application voice application-name authentication enable
no call application voice application-name authentication enable
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables AAA authentication services for a TCL application if a AAA authentication method list has been defined using both the aaa authentication command and the call application voice authen-list command.
Examples
The following example enables a AAA authentication method list (called peabody) to be used with outbound store and forward fax.
configure terminalaaa new-modelcall application voice app_onramp6 authen-list peabodycall application voice app_onramp6 authentication enableRelated Commands
call application voice authen-list
To specify the name of an authentication method list for a TCL application, use the call application voice authen-list command in global configuration mode. To disable the authentication method list for a TCL application, use the no form of this command.
call application voice application-name authen-list method-list-name
no call application voice application-name authen-list method-list-name
Syntax Description
application-name
The name of the application.
method-list-name
Character string used to name a list of authentication methods to be used with T.38 fax relay and T.37 Store and Forward Fax.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
This command defines the name of the AAA authentication method list to be used with fax applications on voice feature cards. 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 fax applications are applied globally on the Cisco AS5300.
After the authentication method lists have been defined, they are enabled by using the call application voice authentication enable command.
Examples
The following example defines a AAA authentication method list (called fax) to be used with T.38 fax relay and T.37 Store and Forward Fax:
configure terminalcall application voice app_libretto_onramp9 authen-list faxRelated Commands
call application voice authen-method
To specify a AAA authentication method for a TCL application, use the call application voice authen-method command in global configuration mode. To disable the authentication method for a TCL application, use the no form of this command.
call application voice application-name authen-method {prompt-user | ani | dnis | gateway | redialer-id | redialer-dnis}
no call application voice application-name authen-method {prompt-user |ani | dnis | gateway | redialer-id | redialer-dnis}
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Normally, when AAA is being used for simple user authentication, AAA uses the username information defined in the user profile for authentication. With T.37 Store and Forward Fax and T.38 real-time fax, you can specify that the ANI, DNIS, gateway ID, redialer ID, or redialer DNIS be used to identify the user for authentication, or that the user be prompted for the TCL application .
Examples
The following example shows how to configure the router-specific name derived from the host name and domain name as the TCL application account identifier for the app_libretto_onramp9 TCL application:
configure terminalcall application voice app_libretto_onramp9 authen-method gatewayRelated Commands
call application voice global-password
To define a password to be used with CiscoSecure for Windows NT when using Store and Forward Fax on a voice feature card, use the call application voice global-password global configuration command. Use the no form of this command to restore the default value.
call application voice application-name global-password password
no call application voice application-name global-password password
Syntax Description
Defaults
No password defined.
Command Modes
Global configuration
Command History
Usage Guidelines
CiscoSecure for Windows NT might require a separate password in order to complete authentication, no matter what security protocol you use. This command defines the password to be used with CiscoSecure for Windows NT. All records on the Windows NT server use this defined password.
This command applies to on-ramp Store and Forward Fax functions on AS5300 voice feature cards.
Examples
The following example defines a password (abercrombie) for use by AAA for the app_libretto_onramp9 TCL application:
configure terminalcall application voice app_libretto_onramp9 global-password abercrombiecall application voice language
To define the language of the audio file for the specified application and to pass that information to the specified application, use the call application voice language command in global configuration mode. To remove the associated language of the audio file from the application, use the no form of this command.
call application voice application-name language number language
no call application voice application-name language number language
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when configuring IVR (depending on the TCL script being used) or one of the IVR-related features (such as Debit Card) to define the language of the audio file for the specified application and to pass that information to the specified application.
Table 1 lists TCL script names and the corresponding parameters that are required for each TCL scripts.
Examples
The following example shows how to define English and Spanish as the languages of the audio files associated with the application named prepaid:
configure terminalcall application voice prepaid language 1 encall application voice prepaid language 2 spRelated Commands
call application voice load
To reload the selected TCL script from the URL, use the call application voice load command in privileged EXEC mode.
call application voice load name
Syntax Description
Defaults
No default behavior or values.
Command Modes
Privileged EXEC
Command History
Usage Guidelines
The software checks the signature lock to ensure it is a Cisco-supported TCL script.
Note
00:02:54: %IVR-3-BAD_IVR_SIG: Script signature is invalidExamples
The following example shows how to reload the TCL script called clid_4digits_npw_3.tcl:
Router#call application voice load clid_4digits_npw_3.tcljcall application voice pin-len
To define the number of characters in the Personal Identification Number (PIN) for the designated application, use the call application voice pin-len command in global configuration mode. To restore default values for this command, use the no form of this command.
call application voice application-name pin-len number
no call application voice application-name pin-len number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when configuring IVR (depending on the TCL script being used) to define the number of allowable characters in a PIN for the specified application and to pass that information to the specified application. Table 2 lists TCL script names and required commands (if any) for each script.
Examples
The following example shows how to define a PIN length of 4 characters for the application named prepaid:
configure terminalcall application voice prepaid pin-len 4Related Commands
call application voice redirect-number
To define the telephone number to which a call will be redirected—for example, the operator telephone number of the service provider—for the designated application, use the call application voice redirect-number command in global configuration mode. To cancel this particular parameter, use the no form of this command.
call application voice application-name redirect-number number
no call application voice application-name redirect-number number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when configuring IVR to define the telephone number to which a call is redirected. Table 3 lists TCL script names and required commands (if any) for each script.
Examples
The following example shows how to define a redirect number for the application named prepaid:
configure terminalcall application voice prepaid redirect-number 5551111Related Commands
call application voice retry-count
To define the number of times a caller is permitted to reenter the personal identification number (PIN) for the designated application, use the call application voice retry-count command in global configuration mode. To cancel this particular parameter, use the no form of this command.
call application voice application-name retry-count number
no call application voice application-name retry-count number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when configuring IVR to define how many times a user can reenter a PIN. Table 4 lists TCL script names and the required commands (if any) for each script.
Examples
The following example shows how to define that a user can re-enter a PIN 3 times before being disconnected for the application named prepaid:
configure terminalcall application voice prepaid retry-count 3Related Commands
call application voice set-location
To define the location, language, and category of the audio files for the specified application, use the call application voice set-location command in global configuration mode. To cancel this particular parameter, use the no form of this command.
call application voice application-name set-location language category location
no call application voice application-name set-location language category location
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when configuring IVR to define the location, language, and category of the audio files for the designated application and pass that information to the application. Table 5 lists TCL script names and the required commands (if any) for each script.
Examples
The following example shows how to configure call application voice set-location for the application named prepaid. The defined language is English, the audio file category is Category 0 (meaning all), and the location is the keyer directory on the TFTP server.
configure terminalcall application voice prepaid set-location en 0 tftp://keyer/Related Commands
call application voice uid-len
To define the number of characters in the user identification number (UID) for the designated application, use the call application voice uid-length command in global configuration mode. To restore default values for this command, use the no form of this command.
call application voice application-name uid-len number
no call application voice application-name uid-len number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when configuring IVR to define the number of allowable characters in a UID for the specified application and to pass that information to the specified application. Table 6 lists TCL script names and the required commands (if any) for each script.
Examples
The following example shows how to configure four allowable characters in the UID for the application named prepaid:
configure terminalcall application voice prepaid uid-len 4Related Commands
call application voice warning-time
To define the number of seconds a user is warned before the allowed calling time runs out, use the call application voice warning-time command in global configuration mode. To restore default values for this command, use the no form of this command.
call application voice application-name warning-time number
no call application voice application-name warning-time number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when configuring IVR to define the number of seconds a user is warned before the allowed calling time runs out for the specified application and to pass that information to the specified application. Table 7 lists TCL script names and the required commands (if any) for each script.
Examples
The following example shows how to configure a 30-second warning time for the application named prepaid:
configure terminalcall application voice prepaid warning-time 30Related Commands
dial-peer voice
To enter dial-peer configuration mode, define the type of dial peer, and define the tag number associated with this dial peer, use the dial-peer voice global configuration command. Use the no form of this command to disable this dial peer.
dial-peer voice number {pots | mmoip | voip}
no dial-peer voice number
Syntax Description
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the dial-peer voice global configuration command to switch to dial-peer configuration mode from global configuration mode and to define a particular dial peer. Use the exit command to exit dial-peer configuration mode and return to global configuration mode.
In Store and Forward Fax on the Cisco AS5300, the POTS dial peer defines the inbound faxing line characteristics from the sending fax device to the receiving Cisco AS5300 and the outbound line characteristics from the sending Cisco AS5300 to the receiving fax device. The MMoIP dial peer defines the inbound faxing line characteristics from the Cisco AS5300 to the receiving SMTP mail server.
After you have created a dial peer, that dial peer remains defined and active until you disable that particular dial peer. To disable a dial peer, use the no form of this command.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Note
Examples
The following example accesses dial-peer configuration mode and configures a POTS peer identified as dial peer 10 and an MMoIP dial peer identified as dial peer 20:
configure terminaldial peer voice 10 potsdial peer voice 20 mmoipThe following example disables the MMoIP peer identified as dial peer 20:
configure terminaldial peer no voice 20direct-inward-dial
To enable the Direct Inward Dial (DID) call treatment for the incoming called number, use the direct-inward-dial dial-peer configuration command. Use the no form of this command to disable DID.
direct-inward-dial
no direct-inward-dial
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Dial-peer configuration
Command History
11.3(1)NA
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the direct-inward-dial command to enable the DID call treatment for the incoming called numbers. When this feature is enabled, the incoming call is treated as if the digits are received from the DID trunk. The called number is used to select the outgoing dial peer. No dial tone will be presented to the caller.
Use the no form of this command to disable DID. When disabled, the called number is used to select the outgoing dial peer. The caller will be prompted for a called number via dial tone.
This command is only applicable to POTS dial peers. This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example enables DID call treatment for incoming called numbers:
dial-peer voice 10 potsdirect-inward-dialdsn
To specify that a delivery status notice be delivered to the sender, use the dsn command in the MMoIP dial-peer configuration mode. Use the no form of this command to cancel a specific delay status notice option.
dsn {delay | failure | success}
no dsn {delay | failure | success}
Syntax Description
Note
Defaults
The default is success and failure.
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Delivery Status Notifications (DSNs) are messages or responses that are automatically generated and sent to the sender or originator of an e-mail message by the SMTP server, notifying the sender of the status of the e-mail message. Specifications for DSN are described in RFC 1891, RFC 1892, RFC 1893, and RFC 1894.
The on-ramp DSN request is included as part of the fax-mail message sent by the on-ramp gateway when the matching MMoIP dial peer has been configured. The on-ramp DSN response is generated by the SMTP server when the fax-mail message is accepted. The DSN is sent back to the user defined in using the mta send mail-from command. The off-ramp DSN is requested by the e-mail client. The DSN response is generated by the SMTP server when it receives a request as part of the fax-mail message.
Note
Because the SMTP server generates the DSNs, you need to configure both the mail from: and rcpt to: commands for the DSN feature to be operational. For example:
mail from: <user@mail-server.company.com>rcpt to: <fax=555-1212@company.com> NOTIFY=SUCCESS,FAILURE,DELAYThere are three different states that can be reported back to the sender:
•
•
•
Because these delivery states are not mutually exclusive, you can configure Store and Forward Fax to generate these messages for all or any combination of these events.
DSN messages notify the sender of the status of a particular e-mail message containing a fax TIFF image. Use the dsn command to specify which notification messages will be sent to the user.
The dsn command allows you to select more than one notification option by reissuing the command, specifying a different notification option each time. To discontinue a specific notification option, use the no form of the command for that specific keyword.
If the keyword failure is not included when configuring DSN, the sender will receive absolutely no notification of message delivery failure. As a failure is usually significant, care should be taken to always include failure as part of the dsn command configuration.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example specifies that a DSN message be returned to the sender when the e-mail message containing the fax has been successfully delivered to the recipient or if the message containing the fax has failed, for whatever reason, to be delivered:
dial-peer voice 10 mmoipdsn successdsn failureThe following example specifies that a DSN message be returned to the sender either when the e-mail message containing the fax has been successfully delivered to the recipient or when the message has been delayed:
dial-peer voice 10 mmoipdsn successdsn delayedRelated Commands
fax interface-type vfc
To specify the voice feature card (VFC) to be used for a fax call, use the fax interface-type command in global configuration mode. To return to the default fax protocol, use the no form of this command.
fax interface-type vfc
no fax interface-type vfc
Syntax Description
Defaults
None
Command Modes
Global configuration
Command History
12.1(3)XI
This command was introduced on the Cisco AS5300 access server.
12.1(5)T
This command was integrated into the Cisco IOS Release 12.1(5)T.
Usage Guidelines
When using this command to change the interface type for fax calls, you must reload (reboot or reset) the router.
Note
Examples
The following example specifies the use of a VFC interface for fax calls:
configure terminalfax interface-type vfcfax protocol (voice-service)
To specify the global default fax protocol to be used for all VoIP dial peers, use the fax protocol command in voice-service configuration mode. To return to the default fax protocol, use the no form of this command.
fax protocol {cisco | t38 [ls-redundancy value] [hs-redundancy value]}
no fax protocol
Syntax Description
Defaults
Cisco
Command Modes
Voice-service configuration
Command History
Usage Guidelines
Use the fax protocol t38 command in voice-service configuration mode to configure T.38 fax relay for all VoIP dial peers. The t38 keyword enables the T.38 standard fax relay protocol. The cisco keyword selects the original Cisco proprietary fax protocol. When the system keyword is selected in the dial-peer version of the fax protocol command, it specifies that the global default fax protocol will be used by that dial peer. The optional parameters ls-redundancy and hs-redundancy are used to send redundant T.38 fax packets when using the T.38 fax protocol.
Note
The ls-redundancy parameter refers to data redundancy in the low-speed V.21-based T.30 fax machine protocol. For the ls-redundancy parameter, the value can be from 0 to 5. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
The hs-redundancy parameter refers to data redundancy in the high-speed V.17, V.27, and V.29 T.4 or T.6 fax machine image data. For the hs-redundancy parameter, the value can be from 0 to 2. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
Note
Examples
The following example specifies T.38 fax protocol for all VoIP dial peers and sets low-speed redundancy to a factor of 2 and high-speed redundancy to a factor of 1:
voice service voipfax protocol t38 ls 2 hs 1Related Commands
fax protocol (dial-peer)
Specifies the fax protocol for a specific VoIP dial peer.
fax protocol (dial-peer configuration)
To specify the fax protocol to be used for a specific VoIP dial peer, use the fax protocol command in dial-peer configuration mode. To return to the global default fax protocol, use the fax protocol system command. To disable T.38 fax protocol for a specific dial peer, use the no form of this command.
fax protocol {cisco | t38 [ls-redundancy value] [hs-redundancy value] | system}
no fax protocol
Syntax Description
Defaults
System
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the fax protocol t38 command in dial-peer configuration mode to configure T.38 fax relay for a specific dial peer. The t38 keyword enables the T.38 Fax Relay protocol. The cisco keyword selects the original Cisco proprietary fax protocol. When the system keyword is selected, it specifies that the global default fax protocol will be used by that dial peer. The optional parameters ls-redundancy and hs-redundancy are used to send redundant T.38 fax packets when using the T.38 fax protocol.
Note
The ls-redundancy refers to data redundancy in the low-speed V.21-based T.30 fax machine protocol. For the ls-redundancy, the value can be from 0 to 5. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
The hs-redundancy refers to data redundancy in the high-speed V.17, V.27, and V.29 T.4 or T.6 fax machine image data. For the hs-redundancy, the value can be from 0 to 2. The default is 0 (no redundancy). The parameter value sets the redundancy factor for T.38 fax relay.
Note
Examples
The following example specifies T.38 fax protocol for VoIP dial peer 99:
dial-peer voice 99 voipfax protocol t38Related Commands
fax protocol (voice-service)
Specifies the default fax protocol for all VoIP dial peers.
fax rate
To establish the rate at which a fax is sent to the specified dial peer, use the fax rate command in dial-peer configuration mode. To reset the dial peer for voice calls, use the no form of the command.
fax rate {12000 | 14400 | 2400 | 4800 | 7200 | 9600} [disable | voice] [bytes bytes]
no fax rate
Syntax Description
Defaults
Voice
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use this command to specify the fax transmission rate to the specified dial peer. The values 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 Resource Reservation Protocol (RSVP).
Note
The voice keyword specifies the highest possible transmission speed allowed by the voice rate. For example, if the voice codec is G.711, the fax transmission may occur up to 14400 bps since 14400 bps is less than the 64k voice rate. If the voice codec is G.729 (8k), the fax transmission speed will be 7200 bps.
Note
Examples
The following example shows a fax rate transmission speed of 9600 bps for faxes sent using dial peer 100:
dial-peer voice 100 voipfax rate 9600The following example sets a fax rate transmission speed of 12000 bps and the size of the fax-data frame at 20 bytes for dial peer 100:
dial-peer voice 100 voipfax rate 12000 bytes 20
Related Commands
codec (dial-peer)
Specifies the voice coder rate of speech for a dial peer.
fax protocol (dial-peer)
Specifies the fax protocol for a specific VoIP dial peer.
fax receive called-subscriber
To define the Called Subscriber Identifier (CSI), use the fax receive called-subscriber global configuration command. Use the no form of this command to disable the configured number.
fax called-subscriber {$d$ | string}
no fax called-subscriber {$d$ | string}
Syntax Description
Defaults
Enabled with a null string.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the fax called-subscriber command to define the number displayed in the LCD of the sending fax device when you are sending a fax to a recipient. Typically, with a standard Group 3 fax device, this is the telephone number associated with the receiving fax device. The command defines the CSI.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example configures the number "555-1234" as the called-subscriber number:
configure terminalfax received called-subscriber 5551234fax send center-header
To specify the data that will appear in the center position of the fax header information, use the fax send center-header global configuration command. Use the no form of this command to disable the selected options.
fax send center-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
no fax send center-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the Cisco AS5300's text-to-fax converter. When this conversion is performed, this fax send center-header command is used to indicate what header information should be added to the center top those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers, and the Cisco AS5300's software does not modify TIFF attachments.
Note
This command lets you configure multiple options at once—meaning that you can combine one or more wild cards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example selects the transmission time of the fax as the center fax header information:
configure terminalfax send center-header $t$The following example configures the company name "Widget" and its address as the center fax header information:
configure terminalfax send center-header widget $s$Related Commands
fax send 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.
fax send coverpage comment
To define personalized text for the title field of a fax cover sheet, use the fax send coverpage comment global configuration command. Use the no form of this command to disable the defined comment.
fax send coverpage comment string
no fax send coverpage comment string
Syntax Description
string
Text string that adds personalized text in the title field of the fax cover sheet. Valid characters are any ASCII characters.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
The fax send coverpage comment command can be overridden by the fax send coverpage e-mail controllable command.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures an individualized title comment of "Acme Fax Services" for generated fax cover sheets:
configure terminalfax send coverpage enablefax send coverpage comment Acme Fax ServicesRelated Commands
fax send coverpage e-mail-controllable
To defer to the cover page setting in the e-mail header to generate a standard fax cover sheet, use the fax send coverpage e-mail-controllable global configuration command. Use the no form of this command to disable standard fax sheet generation.
fax send coverpage e-mail-controllable
no fax send coverpage e-mail-controllable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
You can also use the destination address of an e-mail message to control the cover page generation on a per-recipient basis. Use the fax send coverpage e-mail-controllable command to configure the router to defer to the cover page setting in the e-mail header.
In essence, the off-ramp router defers to the setting configured in the e-mail address itself. For example, if the address has a parameter set to cover=no, this parameter will override the setting for the fax send coverpage enable command and the off-ramp gateway will not generate and send a fax cover page. If the address has a parameter set to cover=yes, the off-ramp gateway will defer to this and generate and send a fax cover page.
Table 8 shows examples of what the user would enter in the To: field of the e-mail message.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example enables standard generated fax cover sheets:
configure terminalfax send coverpage enablefax send coverpage e-mail-controllableRelated Commands
fax send coverpage enable
To enable the Cisco AS5300 to generate fax cover sheets for faxes that originate from e-mail messages, use the fax send coverpage enable global configuration command. Use the no form of this command to disable fax cover sheet generation functionality.
fax send coverpage enable
no fax send coverpage enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to off-ramp Store and Forward Fax functions.
Note
Examples
The following example enables Cisco AS5300-generated fax cover sheets:
configure terminalfax send coverpage enableRelated Commands
fax send coverpage show-detail
To print all of the e-mail header information as part of the fax cover sheet, use the fax send coverpage show-detail global configuration command. Use the no form of this command to disable the e-mail header information being displayed.
fax send coverpage show-detail
no fax send coverpage show-detail
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guideliness
This command applies to off-ramp Store and Forward Fax functions.
Note
Examples
The following example configures an individualized generated fax cover sheet that contains the e-mail header text:
configure terminalfax send coverpage enableno fax send coverpage e-mail-controllablefax send coverpage show-detailRelated Commands
fax send left-header
To specify the data that will appear on the left in the fax header, use the fax send left-header global configuration command. Use the no form of this command to disable the selected options.
fax send left-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
no fax send left-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the AS5300's text-to-fax converter. When this conversion is performed, this fax send left-header command is used to indicate what header information should be added to the left top of those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers and the AS5300's software does not modify TIFF attachments.
This command lets you configure multiple options at once—meaning that you can combine one or more wild cards with text string information to personalize your fax header information.
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 terminalfax send left-header $t$The following example configures the company name "Widget" and its address as the left fax header information:
configure terminalfax send left-header widget $s$Related Commands
fax send max-speed
To specify the maximum speed at which an outbound fax will be transmitted, use the fax send max-speed global configuration command. Use the no form of this command to disable the selected speed.
fax send max-speed {12000 | 14400 | 2400 | 4800 | 7200 | 9600}
no fax send max-speed {12000 | 14400 | 2400 | 4800 | 7200 | 9600}
Syntax Description
Defaults
14400
Command Types
Global configuration
Command History
Usage Guidelines
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example sets the outbound fax transmission rate at 2400 bps:
configure terminalfax send max-speed 2400fax send right-header
To specify the data that will appear on the right in the fax header information, use the fax send right-header global configuration command. Use the no form of this command to disable the selected options.
fax send right-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
no fax send right-header {$a$ | $d$ | $p$ | $s$ | $t$ | string}
Syntax Description
Defaults
No connection
Command Modes
Global configuration
Command History
Usage Guidelines
Mail messages that contain only text or contain text attachments (MIME media type of text) can be converted by the off-ramp AS5300 into a format understood by fax machines using the AS5300's text-to-fax converter. When this conversion is performed, this fax send right-header command is used to indicate what header information should be added to right top of those pages.
Mail messages with TIFF attachments (MIME media type of image and subtype of TIFF) are expected to include their own per-page headers and the AS5300's software does not modify TIFF attachments.
This command lets you configure multiple options at once—meaning that you can combine one or more wildcards with text string information to personalize your fax header information.
Note
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example selects the date of the fax as the right fax header information:
configure terminalfax send right-header $a$The following example configures the company name "Widget" and its address as the right fax header information:
configure terminalfax send right-header widget $s$Related Commands
fax send center-header
Specifies the data that will appear in the center in the fax header.
fax send left-header
Specifies the data that will appear on the left in the fax header.
fax send transmitting-subscriber
To define the transmitting subscriber identifier (TSI), use the fax send transmitting-subscriber global configuration command. Use the no form of this command to disable the configured value.
fax send transmitting-subscriber {$s$ | string}
no fax send transmitting-subscriber {$s$ | string}
Syntax Description
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
The transmitting subscriber number is the number displayed in the LCD of the receiving fax device. Typically, with a standard Group 3 fax device, this is the telephone number associated with the transmitting or sending fax device. This command defines the TSI.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures the company's name (as captured by the on-ramp from the sending fax machine as +18005551234) as the TSI:
configure terminalfax send transmitting-subscriber +14085551234image encoding
To select a specific encoding method for fax images associated with an MMoIP dial peer, use the image encoding dial-peer configuration command. Use the no form of this command to restore the default value.
image encoding{mh | mr | mmr | passthrough}
no image encoding{mh | mr | mmr | passthrough}
Syntax Description
Defaults
Passthrough
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the image encoding command to specify an encoding method for e-mail fax TIFF images for a specific MMoIP dial peer. This command applies primarily to the on-ramp MMoIP dial peer. Although you can optionally create an off-ramp dial peer and configure a particular image encoding value for that off-ramp call leg, Store and Forward Fax ignores the off-ramp MMoIP setting and transmits the file using Modified Huffman encoding.
There are four available encoding methods:
•
•
•
•
The IETF standard for transmitting 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 transmitting fax TIFF images. For most images, MR is more efficient than MH and MMR is more efficient than MR. If you know the recipient is capable of receiving more efficient encodings than just MH, Store and Forward Fax allows you to send the most efficient encoding the recipient can process. For end-to-end closed networks, you can choose any encoding scheme because the off-ramp gateway can process MH, MR, and MMR.
Another factor to take into account is the viewing software. Many viewing applications (for example, those that come with Windows `95 or Windows NT) are able to display MH, MR, and MMR. Therefore you should decide, based on the viewing application and the available bandwidth, which encoding scheme is right for your network.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example selects Modified Modified Read as the encoding method for fax TIFF images sent by MMoIP dial peer 10:
dial-peer voice 10 mmoipimage encoding mmrRelated Commands
image-resolution
Specifies a particular fax image resolution for a specific MMoIP dial peer.
image resolution
To specify a particular fax image resolution for a specific MMoIP dial peer, use the image resolution dial-peer configuration command. Use the no form of this command to restore the default value.
image resolution {fine | standard | superfine | passthrough}
no connection {fine | standard | superfine | passthrough}
Syntax Description
Defaults
Passthrough
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Use the image resolution command to specify a resolution in pixels per inch for e-mail fax TIFF images. This command applies primarily to the on-ramp MMoIP dial peer. Although off-ramp dial peer can be optionally created and a particular image resolution value configured, Store and Forward Fax ignores the off-ramp MMoIP setting and transmits the file using fine resolution.
This command enables the increase or decrease of the fax TIFF image resolution and changes the size of the fax TIFF file also. The IETF standard for transmitting 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 resolution fine (204-by-196 pixels per inch) for TIFF images associated with MMoIP dial peer 10:
dial-peer voice 10 mmoipimage encoding mhimage resolution fineincoming called-number
To specify an incoming called number of an MMoIP or POTS dial peer, use the incoming called-number dial-peer configuration command. Use the no form of this command to reset the default value for this command.
incoming called-number string
no incoming called-number string
Syntax Description
string
Specifies the incoming called telephone number. Valid entries are any series of digits that specify the E.164 telephone number.
Defaults
No incoming called number is defined.
Command Types
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
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 on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example configures the number (310)555-9261 as the incoming called number for MMoIP dial peer 10:
dial-peer voice 10 mmoipincoming 3105559261information-type
To select a particular information type for an MMoIP dial peer, use the information-type dial-peer configuration command. Use the no form of this command to reset the default value for this command.
information type {fax | voice}
no information type {fax | voice}
Syntax Description
fax
Indicates that the information type has been set to Store and Forward Fax.
voice
Indicates that the information type has been set to voice.
Defaults
Voice
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example sets the information type for MMoIP dial peer 10 to fax:
dial-peer voice 10 mmoipinformation-type faxmax-conn
To specify a maximum number of connections for a particular MMoIP or POTS dial peer, use the max-conn dial-peer configuration command. Use the no form of this command to set an unlimited number of connections for this dial peer.
max-conn number
no max-conn number
Syntax Description
number
Specifies the maximum number of connections for this dial peer. Valid values for this field are 1 to 2147483647.
Defaults
The no form of this command is the default, meaning unlimited number of connections.
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the max-conn command to define the maximum number of connections used simultaneously on the Cisco AS5300 to transmit fax-mail.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example configures the maximum number of connections for MMoIP dial peer 10 as 5:
dial-peer voice 10 mmoipmax-conn 5Related Commands
mta receive maximum-recipients
Specifies the maximum number of recipients for all SMTP connections.
mdn
To request that a message disposition notice be generated when the message is processed ("opened"), use the mdn command. Use the no form of this command to restore the default value.
mdn
no mdn
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Message disposition notification is an e-mail message that is generated and sent to the sender when the message is opened by the receiver. Use the mdn command to request that an e-mail response message be sent to the sender when the e-mail containing the fax TIFF image has been opened.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example requests that a message disposition notice be generated by the recipient:
dial-peer voice 10 mmoipmdnRelated Commands
mta receive aliases
To specify a host name accepted as an SMTP alias for off-ramp faxing, use the mta receive aliases global configuration command. Use the no form of this command to disable this alias.
mta receive aliases string
no mta receive aliases string
Syntax Description
string
Specifies the host name or IP address that is the alias for the SMTP server. If specifying an IP address, enclose it in brackets as follows: {xxx.xxx.xxx.xxx].
Defaults
Enabled with an empty string.
Command Modes
Global configuration
Command History
Usage Guidelines
This command creates an accept or reject an alias list. The first alias is used by the mailer to identify itself in SMTP banners and when generating its own RFC 822 Received: header. This command applies to on-ramp Store and Forward Fax functions.
Note
Examples
The following example specifies the host name seattle-fax-offramp.example.com as the alias for the SMTP server:
configure terminalmta receive aliases seattle-fax-offramp.example.comThe following example specifies the host name 172.16.0.0 as the alias for the SMTP server:
configure terminalmta receive aliases [172.16.0.0]Related Commands
mta receive generate-mdn
To specify that the off-ramp gateway process a response message delivery notification (MDN) from an SMTP server, use the mta receive generate-mdn global configuration command. Use the no form of this command to disable message delivery notice generation.
mta receive generate-mdn
no mta receive generate-mdn
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
When message delivery notification is enabled on a sending Cisco AS5300, the device inserts a flag in the off-ramp message e-mail header, requesting that the receiving Cisco AS5300 generate the message delivery notification and return that message to the sender when the e-mail message containing the fax image is opened. Use the mta receive generate-mdn command to enable the receiving device—the off-ramp gateway—to process the response message delivery notification.
Depending on the configuration, usage, and features of the mailers used at a site, it might be desirable to enable or disable MDN generation. (DSN generation cannot be disabled.)
Specifications for MDN are described in RFC 2298.
This command applies to off-ramp Store and Forward Fax functions.
Examples
The following enables the receiving device to generate message delivery notices:
configure terminalmta receive generate-mdnRelated Commands
mta receive maximum-recipients
To specify the maximum recipients for all SMTP connections, use the mta receive maximum-recipients global configuration command. Use the no form of this command to restore the default value.
mta receive maximum-recipients number
no mta receive maximum-recipients
Syntax Description
number
Specifies the maximum number of recipients for all SMTP connections. Valid entries are from 0 to 1024.
Defaults
The default is zero (0) recipients. This means that incoming mail messages are not accepted, and no faxes are transmitted by the off-ramp gateway.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the mta receive maximum-recipients command to configure the maximum number of resources that you want to allocate for fax usage at any one time. You can use this command to limit the resource usage on the gateway. When the value for the number argument is set to 0, no new connections can be established. This is particularly useful when preparing to shut down the system.
This command applies to off-ramp Store and Forward Fax functions.
Note
Examples
The following example defines 10 as the maximum number of recipients for all SMTP connections:
configure terminalmta receive maximum-recipients 10Related Commands
mta send mail-from
To specify the mail-from address (also called the RFC 821 envelope-from or the Return-Path address), use the mta send mail-from global configuration command. Use the no form of this command to disable this return path information.
mta send mail-from {hostname string | {username string | username $s$}}
no mta send mail-from {hostname string | {username string | username $s$}}
Syntax Description
Defaults
None
Command Modes
Global configuration
Command History
Usage Guidelines
Use the mta send mail-from command to designate the sender of the fax TIFF attachment, which is equivalent to the return path in an e-mail message. If the mail-from address is blank, use the postmaster address. This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example specifies that the mail-from username information will be derived from the sender's calling number:
configure terminalmta send mail-from username $s$Related Commands
mta send origin-prefix
To add additional information to the e-mail prefix header, use the mta send origin-prefix global configuration command. Use the no form of this command to disable the defined string.
mta send origin-prefix string
no mta send origin-prefix string
Syntax Description
string
Text string that adds comments to the e-mail prefix header. If this string contains more than one word, the string value should be contained within quotation marks ("x").
Defaults
Null string
Command Modes
Global configuration
Command History
Usage Guidelines
Store and Forward Fax provides the slot and port number of the sending e-mail in the e-mail prefix header information. It is passed in the originator_comment field of the esmtp_client_engine_open() call. Use this command to append the defined text string to the front of the e-mail prefix header information. Eventually, this ends up in the received header field of the fax-mail message. For example:
Received (test onramp Santa Cruz slot1 port15) by router-5300.cisco.com for <test-test@cisco.com> (with Cisco NetWorks); Fri, 25 Dec 1998 001500 -0800In other words, using mta send origin-prefix dog causes the received header to contain the following information:
Received (dog, slot 3 vfc 8) by as5300-sj.example.com .....This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example provides the user with additional information:
configure terminalmta send origin-prefix Cisco-Powered Fax SystemRelated Commands
mta send postmaster
To define the destination of an e-mail (the mail server postmaster account), if it cannot be delivered to the defined destination, use the mta send postmaster global configuration command. Use the no form of this command to disable this defined postmaster.
mta send postmaster e-mail-address
no mta send postmaster e-mail-address
Syntax Description
Defaults
Undefined
Command Modes
Global configuration
Command History
Usage Guidelines
If the Cisco AS5300 generates DSNs and MDNs, but not the sender information (using the mta send mail-from command) or the SMTP server, DSNs and MDNs are delivered to the postmaster.
It is recommended that an address, such as fax-administrator@example.com, be used. In this case, fax-administrator is aliased to the responsible person. At some sites, this could be the same person as the e-mail postmaster, but most likely is a different person with a different e-mail address.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example configures the e-mail address:
configure terminalmta send postmaster fax-admin@example.comRelated Commands
mta send return-receipt-to
To specify the address where MDNs will be sent, use the mta send return-receipt-to global configuration command. Use the no form of this command to restore the default value.
mta send return-receipt-to {hostname string | {username string | $s$}}
no mta send return-receipt-to {hostname string | {username string | $s$}}
Syntax Description
Defaults
None defined.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the mta send return-receipt-to command to define the destination of the MDNs after the fax-mail is opened. Store and Forward Fax supports Eudora's proprietary format (generated header of the Store and Forward Fax is RFC 2298 [MDN] compliant).
Note
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example configures scoobee as the SMTP mail server to which DSNs will be sent:
configure terminalmta send return-receipt-to hostname server.commta send return-receipt-to username scoobeeRelated Commands
mta send server
To specify a destination mail server or servers, use the mta send server global configuration command. Use the no form of this command to disable the specified destination mail server.
mta send server {host-name | IP-address}
no mta send server {host-name | IP-address}
Syntax Description
host-name
Defines the host name of the destination mail server.
IP-address
Defines the IP address of the destination mail server.
Defaults
IP address defined as 0.0.0.0.
Command Modes
Global configuration
Command History
Usage Guidelines
Mta send server provides a backup destination server when the first configured mail server is unavailable. This command is not intended to be used for load distribution. Ten different destination mail servers can be configured using the mta send server command. DNS MX records are not used to look up hostnames provided to this command.
Note
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example defines the mail servers scoobee.example.com and doogie.example.com as the destination mail servers:
configure terminalmta send server scoobee.example.commta send server doogie.example.comRelated Commands
mta send subject
To specify the subject header of the e-mail, use the mta send subject global configuration command. Use the no form of this command to disable this string.
mta send subject string
no mta send subject string
Syntax Description
DefaultsDefaults
Null string
Command Modes
Global configuration
Command History
Usage Guidelines
This command applies to on-ramp Store and Forward Fax functions.
Note
Examples
The following example defines the subject header of an e-mail message as "fax attachment":
configure terminalmta send subject fax attachmentRelated Commands
prefix
To specify the prefix of the dialed digits for this dial peer, use the prefix dial-peer configuration command. Use the no form of this command to disable this feature.
prefix string
no prefix
Syntax Description
Defaults
Null string
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the prefix command to specify a prefix for a specific dial peer. When an outgoing call is initiated to this dial peer, the prefix string value is sent to the telephony interface first, before the telephone number associated with the dial peer. If there are different prefixes to configure on the same interface, configure different dial peers.
This command is applicable only to POTS dial peers. This command applies to off-ramp Store and Forward Fax functions.
Examples
The following example specifies a prefix of 9 and then a pause:
dial-peer voice 10 potsprefix 9,session protocol
To establish a session protocol for calls between the local and remote routers via the packet network, use the session protocol dial-peer configuration command. Use the no form of this command to reset the default value for this command.
session protocol {smtp}
no session protocol
Syntax Description
Defaults
SMTP
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
For this release, SMTP is the only available session protocol.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example selects SMTP as the session protocol:
dial-peer voice 10 mmoipsession protocol smtpsession target
To specify a network-specific address for a specified dial peer, use the session target dial peer configuration command. Use the no form of this command to restore the default value.
session target {mailto:{name | $d$}@domain-name | ipv4:destination-address | dns:[$s$. | $d$. | $u$. | $e$.] host-name | loopback:rtp | loopback:compressed | loopback:uncompressed}
no session target
Syntax Description
Defaults
The default for this command is enabled with no IP address or domain name defined.
Command Modes
Dial peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use session target to specify a network-specific address or domain name for a dial peer. Whether you select a network-specific address or a domain name depends on the session protocol you select. The syntax of this command complies with the simple syntax of mailto as described in RFC 1738.
Use session target mailto to deliver fax-mail to multiple recipients by specifying an email alias as the name argument and have that alias expanded by the mailer.
Session target loopback tests the voice transmission path of a call. The loopback point depends on the call origination and the loopback type selected.
Session target dns can be used with or without the specified wildcards. Using the optional wildcards can reduce the number of VoIP dial peer session targets you need to configure if you have groups of numbers associated with a particular router.
This command applies to on-ramp Store and Forward Fax functions.
Examples
The following example configures a session target using dns for a host, "voice_router," in the domain "cisco.com":
dial-peer voice 10 voipsession target dns:voice_router.cisco.comThe following example configures a session target using DNS, with the optional $u$. wildcard. In this example, the destination pattern has been configured to allow for any four-digit extension, beginning with the numbers 1310222. The optional wildcard $u$. indicates that the router will use the unmatched portion of the dialed number—in this case, the four-digit extension, to identify the dial peer. As in the previous example, the domain is "cisco.com."
dial-peer voice 10 voipdestination-pattern 1310222....session target dns:$u$.cisco.comThe following example configures a session target using DNS, with the optional $d$. wildcard. In this example, the destination pattern has been configured for 13105551111. The optional wildcard $d$. indicates that the router will use the destination pattern to identify the dial peer in the "cisco.com" domain.
dial-peer voice 10 voipdestination-pattern 13105551111session target dns:$d$.cisco.comThe following example delivers fax-mail to multiple recipients:
dial-peer voice 10 mmoipsession target marketing-information@mailer.example.comAssuming that mailer.example.com is running sendmail, you can put the following information into its /etc/aliases file:
marketing-information:john@example.com,fax=+14085551212@sj-offramp.example.comshow call active
To show active call information for a fax transmission in progress, use the show call active fax privileged EXEC command. Use the no form of this command to cancel.
show call active {voice | fax}
no show call active {voice | fax}
Syntax Description
voice
Displays voice call information in the active call table.
fax
Displays fax call information in the active call table.
Command Modes
Privileged EXEC
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
Use the show call active privileged EXEC command to display the contents of the active call table. If you use the voice keyword, the active call table displays information about all of the voice calls currently connected through the router or access server. If you use the fax keyword, the active call table shows all of the fax calls currently connected through the router.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following is sample output from the show call active voice command:
router# show call active voiceGENERIC:SetupTime=179388054 msIndex=1PeerAddress=+5....PeerSubAddress=PeerId=5PeerIfIndex=32LogicalIfIndex=29ConnectTime=179389793 msCallState=4CallOrigin=2ChargedUnits=0InfoType=2TransmitPackets=532TransmitBytes=10640ReceivePackets=147ReceiveBytes=2940TELE:ConnectionId=[0xE3EA3FF8 0xFF6D0105 0x0 0x6AEC71E4]TxDuration=23230 msVoiceTxDuration=2940 msFaxTxDuration=0 msCoderTypeRate=g729r8NoiseLevel=-84ACOMLevel=20OutSignalLevel=-66InSignalLevel=-66InfoActivity=2ERLLevel=20SessionTarget=GENERIC:SetupTime=179388237 msIndex=1PeerAddress=+3622PeerSubAddress=PeerId=3PeerIfIndex=31LogicalIfIndex=0ConnectTime=179389793 msCallState=4CallOrigin=1ChargedUnits=0InfoType=2TransmitPackets=143TransmitBytes=2860ReceivePackets=580ReceiveBytes=11600VOIP:ConnectionId[0xE3EA3FF8 0xFF6D0105 0x0 0x6AEC71E4]RemoteIPAddress=172.24.96.200RemoteUDPPort=16422RoundTripDelay=37 msSelectedQoS=best-effortSessionProtocol=ciscoSessionTarget=ipv4:172.24.96.200OnTimeRvPlayout=9920GapFillWithSilence=0 msGapFillWithPrediction=0 msGapFillWithInterpolation=0 msGapFillWithRedundancy=0 msHiWaterPlayoutDelay=70 msLoWaterPlayoutDelay=30 msReceiveDelay=30 msVAD = enabledCoderTypeRate=g729r8The following is sample output from the show call active fax brief command:
router# show call active fax brief<ID>: <start>hs.<index> +<connect> pid:<peer_id> <dir> <addr> <state> \tx:<packets>/<bytes> rx:<packets>/<bytes> <state>IP <ip>:<udp> rtt:<time>ms pl:<play>/<gap>ms lost:<lost>/<early>/<late>delay:<last>/<min>/<max>ms <codec>FR <protocol> [int dlci cid] vad:<y/n> dtmf:<y/n> seq:<y/n>sig:<on/off> <codec> (payload size)Tele <int>: tx:<tot>/<v>/<fax>ms <codec> noise:<l> acom:<l> i/o:<l>/<l> dBm1 : 22021hs.1 +2263 pid:0 Answer wook song activetx:0/0 rx:0/41190IP 0.0.0.0 AcceptedMime:2 DiscardedMime:11 : 23193hs.1 +1091 pid:3469 Originate 527.... activetx:10/13838 rx:0/0Tele : tx:31200/10910/20290ms noise:-1 acom:-1 i/0:0/0 dBmThe following is sample output from the show call active fax command:
router# show call active faxGENERIC:SetupTime=22021 msIndex=1PeerAddress=wook songPeerSubAddress=PeerId=0PeerIfIndex=0LogicalIfIndex=0ConnectTime=24284CallState=4CallOrigin=2ChargedUnits=0InfoType=10TransmitPackets=0TransmitBytes=0ReceivePackets=0ReceiveBytes=41190MMOIP:ConnectionId[0x37EC7F41 0xB0110001 0x0 0x35C34]RemoteIPAddress=0.0.0.0SessionProtocol=SMTPSessionTarget=MessageId=AccountId=ImgEncodingType=MHImgResolution=fineAcceptedMimeTypes=2DiscardedMimeTypes=1Notification=NoneGENERIC:SetupTime=23193 msIndex=1PeerAddress=527....PeerSubAddress=PeerId=3469PeerIfIndex=157LogicalIfIndex=30ConnectTime=24284CallState=4CallOrigin=1ChargedUnits=0InfoType=10TransmitPackets=5TransmitBytes=6513ReceivePackets=0ReceiveBytes=0TELE:ConnectionId=[0x37EC7F41 0xB0110001 0x0 0x35C34]TxDuration=24010 msFaxTxDuration=10910 msFaxRate=14400NoiseLevel=-1ACOMLevel=-1OutSignalLevel=0InSignalLevel=0InfoActivity=0ERLLevel=-1SessionTarget=ImgPages=0Table 9 provides an alphabetical listing of the show call active fields and a description of each field.
Related Commands
show call history
To display the fax call history table for a fax transmission, use the show call history fax privileged EXEC command. Use the no form of this command to cancel.
show call history {voice | fax} [last number | brief]
no show call history {voice | fax} [last number | brief]
Syntax Description
Command Modes
Privileged EXEC
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
The fax call history table contains a listing of all fax calls connected through this router in descending time order since Store and Forward Fax was enabled. You can display subsets of the fax call history table by using specific keywords. To display the last calls connected through this router, use the keyword last, and define the number of calls to be displayed with the argument number. To display a truncated version of the call history table, use the brief keyword.
This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following is sample output from the show call history voice command:
router# show call history voice brief<ID>: <start>hs.<index> +<connect> +<disc> pid:<peer_id> <direction> <addr>tx:<packets>/<bytes> rx:<packets>/<bytes> <disc-cause>(<text>)IP <ip>:<udp> rtt:<time>ms pl:<play>/<gap>ms delay:<last>/<min>/<max>ms <codec>Telephony <int>: tx:<tot>/<voice>/<fax>ms <codec> noise:<lvl>dBm acom:<lvl>dBm234 : 158305740hs.1280 +241 +9199 pid:0 Answer +3...tx:3804/76080 rx:1358/27160 10 (normal call clearing.)IP 172.24.96.200:16468 rtt:33ms pl:25990/0ms delay:30/30/70ms g729r8234 : 158305745hs.1281 +236 +9195 pid:6 Originate +68888tx:1358/27160 rx:3804/76080 10 (normal call clearing.)Telephony 0:D:22: tx:91850/76080/0ms g729r8 noise:-84dBm acom:20dBm235 : 158344850hs.1282 +230 +28773 pid:0 Answer +3...tx:11063/221260 rx:4604/92080 10 (normal call clearing.)IP 172.24.96.200:16474 rtt:41ms pl:88260/290ms delay:40/30/130ms g729r8235 : 158344856hs.1283 +224 +28769 pid:6 Originate +68888tx:4604/92080 rx:11063/221260 10 (normal call clearing.)Telephony 0:D:22: tx:287590/221280/0ms g729r8 noise:-75dBm acom:20dBmThe following is sample output from the show call history fax brief command:
router# show call history fax brief<ID>: <start>hs.<index> +<connect> +<disc> pid:<peer_id> <direction> <addr>tx:<packets>/<bytes> rx:<packets>/<bytes> <disc-cause>(<text>)IP <ip>:<udp> rtt:<time>ms pl:<play>/<gap>ms lost:<lost>/<early>/<late>delay:<last>/<min>/<max>ms <codec>Telephony <int>: tx:<tot>/<voice>/<fax>ms <codec> noise:<lvl>dBm acom:<lvl>dBm2 : 5996450hs.25 +-1 +3802 pid:100 Answer 408tx:0/0 rx:0/0 1F (T30 T1 EOM timeout)Telephony : tx:38020/38020/0ms g729r8 noise:0dBm acom:0dBm2 : 5996752hs.26 +-1 +3500 pid:110 Originate uut1@linux2.allegro.comtx:0/0 rx:0/0 3F (The e-mail was not sent correctly. Remote SMTP server said: 354 )IP 14.0.0.1 AcceptedMime:0 DiscardedMime:03 : 6447851hs.27 +1111 +3616 pid:310 Originate 576341.tx:11/14419 rx:0/0 10 (Normal connection)Telephony : tx:36160/11110/25050ms g729r8 noise:115dBm acom:-14dBm3 : 6447780hs.28 +1182 +4516 pid:0 Answertx:0/0 rx:0/0 10 (normal call clearing.)IP 0.0.0.0 AcceptedMime:0 DiscardedMime:04 : 6464816hs.29 +1050 +3555 pid:310 Originate 576341.tx:11/14413 rx:0/0 10 (Normal connection)Telephony : tx:35550/10500/25050ms g729r8 noise:115dBm acom:-14dBm4 : 6464748hs.30 +1118 +4517 pid:0 Answertx:0/0 rx:0/0 10 (normal call clearing.)IP 0.0.0.0 AcceptedMime:0 DiscardedMime:05 : 6507900hs.31 +1158 +2392 pid:100 Answer 4085763413tx:0/0 rx:3/3224 10 (Normal connection)Telephony : tx:23920/11580/12340ms g729r8 noise:0dBm acom:0dBm5 : 6508152hs.32 +1727 +2140 pid:110 Originate uut1@linux2.allegro.comtx:0/2754 rx:0/0 3F (service or option not available, unspecified)IP 14.0.0.4 AcceptedMime:0 DiscardedMime:06 : 6517176hs.33 +1079 +3571 pid:310 Originate 576341.tx:11/14447 rx:0/0 10 (Normal connection)Telephony : tx:35710/10790/24920ms g729r8 noise:115dBm acom:-14dBm6 : 6517106hs.34 +1149 +4517 pid:0 Answertx:0/0 rx:0/0 10 (normal call clearing.)IP 0.0.0.0 AcceptedMime:0 DiscardedMime:07 : 6567382hs.35 +1054 +3550 pid:310 Originate 576341.tx:11/14411 rx:0/0 10 (Normal connection)Telephony : tx:35500/10540/24960ms g729r8 noise:115dBm acom:-14dBm7 : 6567308hs.36 +1128 +4517 pid:0 Answertx:0/0 rx:0/0 10 (normal call clearing.)IP 0.0.0.0 AcceptedMime:0 DiscardedMime:0The following is output from the show call history command.
router# show call history fax l 2GENERIC:SetupTime=23193 msIndex=1PeerAddress=527....PeerSubAddress=PeerId=3469PeerIfIndex=157LogicalIfIndex=30DisconnectCause=10DisconnectText=normal call clearing.: Normal connectionConnectTime=24284DisconectTime=31288CallOrigin=1ChargedUnits=0InfoType=faxTransmitPackets=62TransmitBytes=88047ReceivePackets=0ReceiveBytes=0TELE:ConnectionId=[0x37EC7F41 0xB0110001 0x0 0x35C34]TxDuration=80950 msFaxTxDuration=10910 msFaxRate=14400NoiseLevel=-1ACOMLevel=-1SessionTarget=ImgPages=3GENERIC:SetupTime=22021 msIndex=2PeerAddress=wook songPeerSubAddress=PeerId=0PeerIfIndex=0LogicalIfIndex=0DisconnectCause=10DisconnectText=normal call clearing.ConnectTime=24284DisconectTime=31545CallOrigin=2ChargedUnits=0InfoType=faxTransmitPackets=0TransmitBytes=0ReceivePackets=0ReceiveBytes=41190MMOIP:ConnectionId[0x37EC7F41 0xB0110001 0x0 0x35C34]RemoteIPAddress=0.0.0.0SessionProtocol=SMTPSessionTarget=MessageId=AccountId=ImgEncodingType=MHImgResolution=fineAcceptedMimeTypes=2DiscardedMimeTypes=1Notification=None
Table 10 provides an alphabetical listing of the fields for the show call history command and a description of each field.
Related Commands
show call active fax
Shows active call information for a fax transmission in progress.
shutdown (dial peer)
To shut down the dial peer, use the shutdown command in privileged EXEC command. Use the no form of this command to restore the default value.
shutdown
no shutdown
Syntax Description
This command has no keywords or arguments.
Command Modes
Dial-peer configuration
Command History
11.3(1)T
This command was introduced.
12.0(4)T
This command was modified for Store and Forward Fax.
Usage Guidelines
When a dial peer is shut down, you cannot initiate calls to that peer. This command applies to both on-ramp and off-ramp Store and Forward Fax functions.
Examples
The following example changes the administrative state of MMoIP dial peer 10 to down:
dial-peer voice 10shutdownThe following example changes the administrative state of MMoIP dial peer 10 to up:
dial-peer voice 10no shutdownRelated Commands
dial-peer voice
Enters the dial-peer configuration mode, define the type of dial peer, and define the dial-peer tag number.
voice hunt user-busy
To configure fax roll-over from T.38 (fax relay) to T.37 (Store and Forward Fax), use the voice hunt user-busy command in global configuration mode. To return to the default settings, use the no form of this command.
voice hunt user-busy
no voice hunt user-busy
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables a roll over of fax call to the T.37 gateway, if the T.38 fax relay connection is busy. It acts as a switch, enabling or disabling the roll-over functionality. To use this command, ensure that there are specific values configured for the T.38 VoIP dial peer (to set the preference) and the T.37 on-ramp MMoIP dial peer. For example, if the preference for the T.38 VoIP dial peer is configured as two, the preference of the on-ramp MMoIP dial peer must be three or greater.
Examples
The following example shows how to configure T.38 to T.37 roll over capabilities:
configure terminalvoice hunt user-busyvoice service
To enter the voice-service configuration mode and specify the fax protocol to be used for fax applications, use the voice service command. Use the exit command to return to global configuration mode.
voice service voip
Syntax Description
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
Use the voice service command to switch to the voice-service configuration mode from the global configuration mode and to specify a voice encapsulation type. Use the exit command to exit the voice-service configuration mode and return to the global configuration mode.
Examples
The following example shows how to access the voice-service configuration mode and specify VoIP parameters, beginning in global configuration mode:
configure terminalvoice service voipRelated Commands
modem passthrough
Configures modem passthrough over VoIP.
fax protocol
Specifies the global default fax protocol for all the VoIP dial peers.
Debug Commands
This section documents new or modified debug commands for the Store and Forward Fax application using Cisco AS5300 VFCs. All other commands used with this feature are documented in the Store and Forward Fax with ESMTP document and in the Cisco IOS Release 12.0 command references.
debug dmsp doc-to-fax
To display debug messages for the doc Media Service Provider TIFF or text2Fax engine, use the debug dmsp doc-to-fax EXEC command. To disable the debug messages, use the no form of this command.
debug dmsp doc-to-fax [text-to-fax | tiff-reader]
no debug dmsp doc-to-fax [text-to-fax | tiff-reader]
Syntax Description
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug dmsp doc-to-fax command.
router# debug dmsp doc-to-faxJan 1 04:58:39.898: docmsp_call_setup_request: callid=18Jan 1 04:58:39.902: docmsp_call_setup_request(): ramp data dir=OFFRAMP, conf dir=SRCJan 1 04:58:39.902: docmsp_caps_ind: call id=18, src=17Jan 1 04:58:39.902: docmsp_bridge cfid=5, srccid=18, dstcid=17Jan 1 04:58:39.902: docmsp_bridge(): ramp data dir=OFFRAMP, conf dir=SRC, encode out=2Jan 1 04:58:39.902: docmsp_rcv_msp_ev: call id =18, evID = 42Jan 1 04:58:39.902: docmsp_bridge cfid=6, srccid=18, dstcid=15Jan 1 04:58:39.902: docmsp_bridge(): ramp data dir=OFFRAMP, conf dir=DEST, encode out=2Jan 1 04:58:39.902: docmsp_process_rcv_data: call id src=0, dst=18Jan 1 04:58:39.902: docmsp_generate_page:Jan 1 04:58:39.902: docmsp_generate_page: new context for Call 18Jan 1 04:58:39.922: docmsp_get_msp_event_buffer:Jan 1 04:58:42.082: docmsp_xmit: call id src=15, dst=18Jan 1 04:58:42.082: docmsp_process_rcv_data: call id src=15, dst=18Jan 1 04:58:42.082: offramp_data_process:Jan 1 04:58:42.102: docmsp_xmit: call id src=15, dst=18Jan 1 04:58:42.106: docmsp_process_rcv_data: call id src=15, dst=18Jan 1 04:58:42.106: offramp_data_process:Jan 1 04:58:42.122: docmsp_xmit: call id src=15, dst=18Jan 1 04:58:42.126: docmsp_process_rcv_data: call id src=15, dst=18Jan 1 04:58:42.126: offramp_data_process:Jan 1 04:58:42.142: docmsp_xmit: call id src=15, dst=18Jan 1 04:58:42.146: docmsp_xmit: call id src=15, dst=18Related Commands
debug dmsp fax-to-doc
Displays debug messages for the doc Media Service Provider fax-to-doc TIFF engine.
debug dmsp fax-to-doc
To display debug messages for doc MSP fax-to-doc, use the debug dmsp fax-to-doc EXEC command. To disable the debug messages, use the no form of this command.
debug dmsp fax-to-doc [tiff-writer]
no debug dmsp fax-to-doc [tiff-writer]
Syntax Description
tiff-writer
Displays debug messages that occur while the DocMSP Component is receiving T4 fax data and producing TIFF packets.
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug dmsp fax-to-doc command.
router# debug dmsp fax-to-doc*Oct 16 08:29:54.487: docmsp_call_setup_request: callid=22*Oct 16 08:29:54.487: docmsp_call_setup_request(): ramp data dir=OFFRAMP, conf dir=SRC*Oct 16 08:29:54.487: docmsp_caps_ind: call id=22, src=21*Oct 16 08:29:54.487: docmsp_bridge cfid=15, srccid=22, dstcid=21*Oct 16 08:29:54.487: docmsp_bridge(): ramp data dir=OFFRAMP, conf dir=SRC, encode out=2*Oct 16 08:29:54.487: docmsp_bridge cfid=16, srccid=22, dstcid=17*Oct 16 08:29:54.487: docmsp_bridge(): ramp data dir=OFFRAMP, conf dir=DEST, encode out=2*Oct 16 08:29:54.487: docmsp_xmit: call id src=17, dst=22*Oct 16 08:29:54.487: docmsp_process_rcv_data: call id src=17, dst=22*Oct 16 08:29:54.487: offramp_data_process:*Oct 16 08:29:54.515: docmsp_get_msp_event_buffer:*Oct 16 08:29:56.115: docmsp_call_setup_request: callid=24*Oct 16 08:29:56.115: docmsp_call_setup_request(): ramp data dir=ONRAMP, conf dir=DEST*Oct 16 08:29:56.115: docmsp_caps_ind: call id=24, src=20*Oct 16 08:29:56.115: docmsp_bridge cfid=17, srccid=24, dstcid=20Related Commands
debug dmsp doc-to-fax
Displays debug messages for the doc Media Service Provider TIFF or text2Fax engine.
debug fmsp receive
To display debug messages for FMSP receive, use the debug fmsp receive EXEC command. To disable the debug messages, use the no form of this command.
debug fmsp receive [t30 | t38]
no debug fmsp receive [t30 | t38]
Syntax Description
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug fmsp receive command.
router# debug fmsp receive*Oct 16 08:31:33.243: faxmsp_call_setup_request: call id=28*Oct 16 08:31:33.243: faxmsp_call_setup_request: ramp data dir=ONRAMP, conf dir=DEST*Oct 16 08:31:33.243: faxmsp_bridge(): cfid=19, srccid=28, dstcid=27*Oct 16 08:31:33.243: faxmsp_bridge(): ramp data dir=ONRAMP, conf dir=DEST*Oct 16 08:31:33.243: faxmsp_bridge(): Explicit caps ind. done; will wait for registry caps ind*Oct 16 08:31:33.243: faxmsp_caps_ind: call id=28, src=27*Oct 16 08:31:33.243: faxmsp_caps_ack: call id src=27*Oct 16 08:31:33.279: faxmsp_call_setup_request: call id=29*Oct 16 08:31:33.279: faxmsp_call_setup_request: ramp data dir=OFFRAMP, conf dir=SRC*Oct 16 08:31:33.283: faxmsp_bridge(): cfid=20, srccid=29, dstcid=26*Oct 16 08:31:33.283: faxmsp_bridge(): ramp data dir=OFFRAMP, conf dir=SRC*Oct 16 08:31:33.283: faxmsp_bridge(): Explicit caps ind. done; will wait for registry caps ind*Oct 16 08:31:33.283: faxmsp_caps_ind: call id=29, src=26*Oct 16 08:31:33.283: faxmsp_caps_ack: call id src=26*Oct 16 08:31:33.635: faxmsp_codec_download_done: call id=29*Oct 16 08:31:33.635: faxmsp_codec_download_done: call id=28*Oct 16 08:31:33.643: faxmsp_xmit: callid src=26, dst=29*Oct 16 08:31:33.643: faxmsp_xmit: callid src=27, dst=28*Oct 16 08:31:33.643: faxmsp_process_rcv_data: call id src=26, dst=29Related Commands
debug fmsp send
To display debug messages for FMSP send, use the debug fmsp send EXEC command. To disable the debug messages, use the no form of this command.
debug fmsp send [t30 | t38]
no debug fmsp send [t30 | t38]
Syntax Description
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug fmsp send command.
router# debug fmsp sendJan 1 05:02:56.782: faxmsp_call_setup_request: call id=21Jan 1 05:02:56.782: faxmsp_call_setup_request: ramp data dir=OFFRAMP, conf dir=SRCJan 1 05:02:56.782: faxmsp_bridge(): cfid=7, srccid=21, dstcid=20Jan 1 05:02:56.782: faxmsp_bridge(): ramp data dir=OFFRAMP, conf dir=SRCJan 1 05:02:56.782: faxmsp_bridge(): Explicit caps ind. done; will wait for registry caps indJan 1 05:02:56.782: faxmsp_caps_ind: call id=21, src=20Jan 1 05:02:56.782: faxmsp_caps_ack: call id src=20Jan 1 05:02:57.174: faxmsp_codec_download_done: call id=21Jan 1 05:02:57.174: faxMsp_tx_buffer callID=21Jan 1 05:02:57.178: faxMsp_tx_buffer callID=21Jan 1 05:02:57.178: faxMsp_tx_buffer callID=21Jan 1 05:02:57.178: faxMsp_tx_buffer callID=21Jan 1 05:02:57.182: faxmsp_xmit: callid src=20, dst=21Jan 1 05:02:57.182: faxmsp_process_rcv_data: call id src=20, dst=21Jan 1 05:03:01.814: faxmsp_xmit: callid src=20, dst=21Jan 1 05:03:01.814: faxmsp_process_rcv_data: call id src=20, dst=21Jan 1 05:03:01.814: faxMsp_tx_buffer callID=21Jan 1 05:03:02.802: faxmsp_xmit: callid src=20, dst=21Jan 1 05:03:02.802: faxmsp_process_rcv_data: call id src=20, dst=21Jan 1 05:03:02.822: faxmsp_xmit: callid src=20, dst=21Jan 1 05:03:02.822: faxmsp_process_rcv_data: call id src=20, dst=21Jan 1 05:03:02.854: faxmsp_xmit: callid src=20, dst=21Jan 1 05:03:02.854: faxmsp_process_rcv_data: call id src=20, dst=21Related Commands
debug foip off-ramp
To display debug messages for off-ramp faxmail, use the debug foip off-ramp EXEC command. To disable the debug messages, use the no form of this command.
debug foip off-ramp
no debug foip off-ramp
Syntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug foip off-ramp command.
router# debug foip off-rampJan 1 02:31:17.539: lapp off: CC_EV_CALL_HANDOFF, cid(0xB)Jan 1 02:31:17.539: loffHandoff: called number=5271714, callid=0xBJan 1 02:31:17.543: loffSetupPeer: cid1(0xB)Jan 1 02:31:17.543: destPat(5271714),matched(1),pref(5),tag(20),encap(1)Jan 1 02:31:22.867: lapp off: CC_EV_CALL_CONNECTED, cid(0xC)Jan 1 02:31:22.867: st=CALL_SETTING cid(0xB,0x0,0x0,0xC),cfid(0x0,0x0,0x0)Jan 1 02:31:22.867: loffConnectedJan 1 02:31:22.867: loffFlushPeerTagQueue cid(11) peer list: (empty)Jan 1 02:31:22.867: lapp off: CC_EV_CONF_CREATE_DONE, cid(0xC), cid2(0xD), cfid(0x1)Jan 1 02:31:22.867: st=CONFERENCING3 cid(0xB,0x0,0xD,0xC),cfid(0x0,0x0,0x1)Jan 1 02:31:22.867: loffConfDone3Jan 1 02:31:30.931: lapp off: CC_EV_FROM_FMSP_ON_CALL_DETAIL, cid(0xD)Jan 1 02:31:30.931: st=WAIT_SESS_INFO cid(0xB,0x0,0xD,0xC),cfid(0x0,0x0,0x1)Jan 1 02:31:30.931: loffSessionInfoJan 1 02:31:30.931: encd=2, resl=2, spd=26, min_scan_len=0, csid= 4085271714Jan 1 02:31:30.931: lapp off: CC_EV_CONF_CREATE_DONE, cid(0xD), cid2(0xE), cfid(0x2)Jan 1 02:31:30.931: st=CONFERENCING2 cid(0xB,0xE,0xD,0xC),cfid(0x0,0x2,0x1)Jan 1 02:31:30.931: loffConfDone2Related Commands
debug foip on-ramp
To display debug messages for on-ramp faxmail, use the debug foip on-ramp EXEC command. To disable the debug messages, use the no form of this command.
debug foip on-ramp
no debug foip on-ramp
Syntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug foip on-ramp command.
router# debug foip on-ramp*Oct 16 08:07:01.947: lapp_on_application: Incoming Event: (15 = CC_EV_CALL_HANDOFF), CID(11), DISP(0)*Oct 16 08:07:01.947: lapp_on_call_handoff: Authentication enabled = FALSE*Oct 16 08:07:01.947: lapp_on_call_handoff: Authentication ID = 0*Oct 16 08:07:01.947: lapp_on_call_handoff: Authentication ID source = IVR or unknown*Oct 16 08:07:01.947: lapp_on_call_handoff: Authentication status = SUCCESS*Oct 16 08:07:01.947: lapp_on_call_handoff: Accounting enabled = FALSE*Oct 16 08:07:01.947: lapp_on_call_handoff: Accounting method list = fax*Oct 16 08:07:01.947: lapp_on_conference_vtsp_fmsp: Begin conferencing VTSP and FMSP...*Oct 16 08:07:01.951: lapp_on_change_state: old state(0) new state(1)*Oct 16 08:07:01.951: lapp_on_application: Incoming Event: (29 = CC_EV_CONF_CREATE_DONE), CID(11), DISP(0)*Oct 16 08:07:01.951: lapp_on_application: Current call state = 1*Oct 16 08:07:01.951: lapp_on_conference_created: The VTSP and the FMSP are conferenced*Oct 16 08:07:01.951: lapp_on_conference_created: Wait for FMSP call detail eventRelated Commands
debug mmoip aaa
Use the debug mmoip aaa EXEC command to display output relating to AAA services with Store and Forward Fax. Use the no form of this command to disable debugging output.
debug mmoip aaa
[no] debug mmoip aaa
Usage Guidelines
This command has no arguments or keywords.
Defaults
Disabled
Command History
Examples
The following output shows how the debug mmoip aaa command provides information about AAA on-ramp or off-ramp authentication:
router# debug mmoip aaa5d10h:fax_aaa_begin_authentication:User-Name = mmoip-b.cisco.com5d10h:fax_aaa_begin_authentication:fax_account_id_origin = GATEWAY_ID5d10h:fax_aaa_end_authentication_callback:Authentication successfulThe following output shows how the debug mmoip aaa command provides information about AAA off-ramp accounting:
router# debug mmoip aaa5d10h:fax_aaa_start_accounting:User-Name = mmoip-b.cisco.com5d10h:fax_aaa_start_accounting:Calling-Station-Id = gmercuri@mail-server.cisco.com5d10h:fax_aaa_start_accounting:Called-Station-Id = fax=571-0839@mmoip-b.cisco.com5d10h:fax_aaa_start_accounting:fax_account_id_origin = GATEWAY_IDmmoip-b#ax_aaa_start_accounting:fax_msg_id = <37117AF3.3D98300E@mail-server.cisco.com>5d10h:fax_aaa_start_accounting:fax_pages = 25d10h:fax_aaa_start_accounting:fax_coverpage_flag = TRUE5d10h:fax_aaa_start_accounting:fax_connect_speed = 14400bps5d10h:fax_aaa_start_accounting:fax_recipient_count = 15d10h:fax_aaa_start_accounting:fax_auth_status = USER SUCCESS5d10h:fax_aaa_start_accounting:gateway_id = mmoip-b.cisco.com5d10h:fax_aaa_start_accounting:call_type = Fax Send5d10h:fax_aaa_start_accounting:port_used = slot:0 vfc port:05d10h:fax_aaa_do_offramp_accounting tty(6), Stopping accounting5d10h:fax_aaa_stop_accounting:ftdb->cact->generic.callActiveTransmitBytes = 180385d10h:fax_aaa_stop_accounting:ftdb->cact->generic.callActiveTransmitPackets = 14The following output shows how the debug mmoip aaa command provides information about AAA on-ramp accounting:
router# debug mmoip aaa5d10h:fax_aaa_start_accounting:User-Name = mmoip-b.cisco.com5d10h:fax_aaa_start_accounting:Calling-Station-Id = FAX=408@mail-from-hostname.com5d10h:fax_aaa_start_accounting:Called-Station-Id = FAX=5710839@mail-server.cisco.com5d10h:fax_aaa_start_accounting:fax_account_id_origin = GATEWAY_ID5d10h:fax_aaa_start_accounting:fax_msg_id = 00391997233216263@mmoip-b.cisco.com5d10h:fax_aaa_start_accounting:fax_pages = 25d10h:fax_aaa_start_accounting:fax_connect_speed = 14400bps5d10h:fax_aaa_start_accounting:fax_auth_status = USER SUCCESS5d10h:fax_aaa_start_accounting:email_server_address = 1.14.116.15d10h:fax_aaa_start_accounting:email_server_ack_flag = TRUE5d10h:fax_aaa_start_accounting:gateway_id = mmoip-b.cisco.com5d10h:fax_aaa_start_accounting:call_type = Fax Receive5d10h:fax_aaa_start_accounting:port_used = Cisco Powered Fax System slot:1 port:45d10h:fax_aaa_do_onramp_accounting tty(5), Stopping accounting5d10h:fax_aaa_stop_accounting:endb->cact->generic.callActiveTransmitBytes = 266875d10h:fax_aaa_stop_accounting:ftdb->cact->generic.callActiveReceiveBytes = 185585d10h:fax_aaa_stop_accounting:ftdb->cact->generic.callActiveReceivePackets = 14debug mspi receive
To display debug messages for mail Service Provider Interface receive, use the debug mspi receive EXEC command. To disable the debug messages, use the no form of this command.
debug mspi receive
no debug mspi receive
Syntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug mspi receive command.
router# debug mspi receiveJan 1 05:09:33.890: mspi_tel_num_trans: from: Radhika,ph#in: fax=5271714 ph#dial: 5271714Jan 1 05:09:33.890: incoming destPat(5271714), matched(7), tag(22)Jan 1 05:09:33.890: out destPat(5......), tag(20), dgt strip enabledJan 1 05:09:33.890: mspi_off_new_rcpt: envlp_to [fax=5271714@rpadmana.cisco.com], 30Jan 1 05:09:33.890: tel_numb_dial: 5271714, subaddr:[], cover pageJan 1 05:09:39.122: mspi_offramp_rfc822_header: msgType=0Jan 1 05:09:39.122: envlp_from: [Radhika], 8Jan 1 05:09:39.122: mspi_off_put_buff: ignore mime type=1, st=CONNECTING, len=0Jan 1 05:09:39.122: moff_save_buffer: cid=0x1F, mime=9, len=4Jan 1 05:09:39.122: offramp disabled receiving!Dec 31 21:09:44.078: %ISDN-6-CONNECT: Interface Serial0:22 is now connected to 5271714Jan 1 05:09:52.154: mspi_bridge: cid=0x1F, dst cid=0x22, data dir=OFFRAMP, conf dir=DESTJan 1 05:09:52.154: mspi_offramp_send_buffer: cid=0x1F, mime=9Jan 1 05:09:52.154: buffer with only CR/LF - set buff_len=0Jan 1 05:09:52.154: mspi_offramp_send_buffer: cid=0x1F, mime=9 rx BUFF_END_OF_PART, offramp rcpt enabledJan 1 05:09:54.126: mspi_offramp_send_buffer: cid=0x1F, mime=11Jan 1 05:09:54.134: mspi_offramp_send_buffer: cid=0x1F, mime=11Related Commands
debug mspi send
To display debug messages for mail Service Provider Interface send, use the debug mspi send EXEC command. To disable the debug messages, use the no form of this command.
debug mspi send
no debug mspi send
Syntax Description
There are no arguments or keywords for this command.
Defaults
No default behavior or values.
Command History
Examples
The following example displays output from the debug mspi send command.
router# debug mspi send*Oct 16 08:40:27.515: mspi_bridge: cid=0x21, dst cid=0x26, data dir=OFFRAMP, conf dir=DEST*Oct 16 08:40:29.143: mspi_setup_req: for cid=0x27*Oct 16 08:40:29.147: envelope_from=5??????@fax.cisco.com*Oct 16 08:40:29.147: envelope_to=ilyau@cisco.com*Oct 16 08:40:30.147: mspi_chk_connect: cid=0x27, cnt=0,*Oct 16 08:40:30.147: SMTP connected to the server !*Oct 16 08:40:30.147: mspi_bridge: cid=0x27, dst cid=0x28, data dir=ONRAMP, conf dir=SRC*Oct 16 08:40:38.995: mspi_xmit: cid=0x27, st=CONFERENCED, src_cid=0x28, buf cnt=0Related Commands
debug mta receive all
Use the debug mta receive all EXEC command to show output relating to the activity on the SMTP server. Use the no form of this command to disable debugging output.
debug mta receive all
[no] debug mta receive all
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command History
Examples
The following example shows the messages exchanged (for example, the handshake) between the e-mail server and the off-ramp gateway.
router# debug mta receive allJan 1 05:07:41.314: esmtp_server_work: calling heloJan 1 05:07:43.354: esmtp_server_work: calling mailJan 1 05:07:45.386: esmtp_server_work: calling rcptJan 1 05:07:47.426: esmtp_server_work: calling dataJan 1 05:07:49.514: (S)R: 'Content-Type: multipart/mixed; boundary="------------11F7CD9D2EB3E8B8D5627C62"'Jan 1 05:07:49.514: (S)R: ''Jan 1 05:07:49.514: esmtp_server_engine_new_part:Jan 1 05:07:49.514: (S)R: 'Content-Type: text/plain; charset=us-ascii'Jan 1 05:07:49.514: (S)R: 'Content-Transfer-Encoding: 7bit'Jan 1 05:07:49.514: (S)R: ''Jan 1 05:07:49.514: esmtp_server_engine_new_part:Jan 1 05:07:49.514: esmtp_server_work: freeing temp headerJan 1 05:07:49.514: (S)R: 'Content-Type: image/tiff; name="DevTest.8.1610.tif"'Jan 1 05:07:49.514: (S)R: 'Content-Transfer-Encoding: base64'Jan 1 05:07:49.514: (S)R: 'Content-Disposition: inline; filename="DevTest.8.1610.tif"'Jan 1 05:07:49.514: (S)R: ''Jan 1 05:07:49.514: esmtp_server_engine_update_recipient_status: status=6Jan 1 05:07:49.514: esmtp_server_engine_new_part:Jan 1 05:07:49.518: esmtp_server_work: freeing temp headerJan 1 05:08:03.014: esmtp_server_engine_update_recipient_status: status=7Jan 1 05:08:04.822: esmtp_server_engine_update_recipient_status: status=6Jan 1 05:08:33.042: esmtp_server_engine_update_recipient_status: status=7Jan 1 05:08:34.906: esmtp_server_engine_getline: Unexpected end of file on socket 1Jan 1 05:08:34.906: esmtp_server_work: error occured with ctx=0x61FFF710, socket=1Related Commands
debug mta send all
Use the debug mta send all EXEC command to display output for all of the on-ramp client connections. Use the no form of this command to disable debugging output.
debug mta send all
[no] debug mta send all
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command History
Examples
This display shows the messages exchanged (for example, the handshake) between the e-mail server and the on-ramp gateway.
router# debug mta send all*Oct 16 09:04:13.055: esmtp_client_engine_open: from=5??????@fax.cisco.com,
