Feedback
cac master through call application stats
- cable-detect
- cable-detect-poll-timer
- cac master
- cac_off
- cache (neighbor BE)
- cache reload time (global application configuration mode)
- cadence
- cadence-list
- cadence-max-off-time
- cadence-min-on-time
- cadence-variation
- call accounting-template
- call accounting-template voice
- call accounting-template voice reload
- call-agent
- call application alternate
- call application cache reload time
- call application dump event-log
- call application event-log
- call application event-log dump ftp
- call application event-log error-only
- call application event-log max-buffer-size
- call application global
- call application history session event-log save-exception-only
- call application history session max-records
- call application history session retain-timer
- call application interface dump event-log
- call application interface event-log
- call application interface event-log dump ftp
- call application interface event-log error-only
- call application interface event-log max-buffer-size
- call application interface max-server-records
- call application interface stats
- call application session start (global)
- call application session start (privileged EXEC)
- call application session stop
- call application stats
cable-detect
To enable cable polling on an analog Foreign Exchange Office (FXO) voice port, use the cable-detect command in voice port configuration mode. To disable cable polling, use the no form of this command.
Command History
Release
Modification
15.1(1)T
This command was introduced.
15.2(4)M
This command was modified. Cable polling was extended to analog Foreign Exchange Office End Ground Start (FXOGS), Foreign Exchange Office End Loop Start (FXOLS), Foreign Exchange Station End Ground Start (FXSGS), and Foreign Exchange Station End Loop Start (FXSLS) voice ports.
Usage Guidelines
The FXOLS voice port is in the busyout state if the Digital Signal Processor (DSP) detects that no cable is connected between the analog FXSLS and FXOLS ports. If you have configured the no cable-detect command and the analog FXOLS voice port is in busyout state because no cable is connected, the Cisco software stops polling the cable connection. The analog FXOLS voice port remains in the busyout state until you use the shutdown and no shutdown commands to switch the analog FXOLS voice port to the idle state. The cable-detect command supports loop start and Central Automatic Message Accounting (CAMA) signaling.
Unlike FXOLS, for analog FXOGS, FXSLS, and FXSGS voice ports, the voice port state does not change when the cable status changes from connected to disconnected or disconnected to connected; only a syslog message is printed to indicate the new cable status. The cable-detect command will not show up under the voice port if the analog voice interface does not support cable polling.
For analog FXOGS, the cable-detect command can be configured on all FXO voice interface cards.
This command can be configured on the following analog FXOLS voice interface cards (VICs):
For analog FXSLS and FXSGS, this command can be configured on the following FXS voice interface cards:
cable-detect-poll-timer
To configure the cable polling timer value for background polling processes on an analog voice port, use the cable-detect-poll-timer command in voice service configuration mode. To disable the polling timer, use the no form of this command.
Usage Guidelines
Use the cable-detect-poll-timer command to configure the cable polling timer value on analog Foreign Exchange Office End Ground Start (FXOGS), Foreign Exchange Office End Loop Start (FXOLS), Foreign Exchange Station End Ground Start (FXSGS), and Foreign Exchange Station End Loop Start (FXSLS) voice ports.
cac master
To configure the call admission control (CAC) operation as master, enter the cacmaster command in voice-service configuration mode. To restore CAC operation to slave, use the no form of this command.
Usage Guidelines
You should configure the router at opposite ends of an ATM adaptation layer 2 (AAL2) trunk for the opposite CAC operation--master at one end and slave at the other end.
A router configured as a master always performs CAC during fax and modem upspeed. A router configured as a slave sends a request for CAC to the CAC master.
cac_off
To disable connection admission control (CAC), use the cac_offcommand in interface-ATM-VC configuration mode. To enable CAC, use the no form of this command.
Usage Guidelines
Connection admission control (CAC) is a set of actions taken by each ATM switch during connection setup to determine whether the requested quality of service (QoS) will violate the QoS guarantees for established connections. CAC reserves bandwidth for voice calls, however, the bandwidth required when the lossless compression codec (LLCC) is used is dynamic and usually less than what is generally reserved by CAC. Disabling CAC can help in better utilization of bandwidth when LLCC is used.
cache (neighbor BE)
To configure the local border element (BE) to cache the descriptors received from its neighbors, use the cache command in neighbor BE configuration mode. To disable caching, use the no form of this command.
Command History
Release
Modification
12.2(2)XA
This command was introduced.
12.2(4)T
This command was integrated into Cisco IOS Release 12.2(4)T. Support for the Cisco AS5300 universal access server, Cisco AS5350, Cisco AS5400 is not included in this release.
12.2(2)XB1
This command was implemented on the Cisco AS5850.
12.2(11)T
This command was integrated into Cisco IOS Release 12.2(11)T.
Usage Guidelines
Use this command to configure the local BE to cache the descriptors received from its neighbor. If caching is enabled, the neighbors are queried at the specified interval for their descriptors.
cache reload time (global application configuration mode)
To configure the router to reload scripts from cache on a regular interval, use the cachereloadtime command in global application configuration mode. To set the value to the default, use the no form of this command.
Syntax Description
Examples
The following example displays the cachereloadtime command configured to specify 15 minutes before a background process is awakened:
Enter application configuration mode to configure applications and services:
applicationEnter global application configuration mode:
globalConfigure the cache reload time:
cache reload time 15cadence
To define the tone-on and tone-off durations for a call-progress tone, use the cadence command in call-progress dualtone configuration mode. To restore the default cadence, use the no form of this command.
{ cadence cycle-1-on-time cycle-1-off-time [ cycle-2-on-time cycle-2-off-time ] [ cycle-3-on-time cycle-3-off-time ] [ cycle-4-on-time cycle-4-off-time ] | continuous }
no cadence
Syntax Description
cycle-1-on-time
Tone-on duration for the first cycle of the cadence pattern, in milliseconds (ms). Range is from 0 to 1000. The default is 0.
cycle-1-off-time
Tone-off duration for the first cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
cycle-2-on-time
(Optional) Tone-on duration for the second cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
cycle-2-off-time
(Optional) Tone-off duration for the second cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
cycle-3-on-time
(Optional) Tone-on duration for the third cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
cycle-3-off-time
(Optional) Tone-off duration for the third cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
cycle-4-on-time
(Optional) Tone-on duration for the fourth cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
cycle-4-off-time
(Optional) Tone-off duration for the fourth cycle of the cadence pattern, in milliseconds. Range is from 0 to 1000. The default is 0.
continuous
Continuous call-progress tone is detected.
Usage Guidelines
This command specifies the cadence for a class of custom call-progress tones.
You must define each cadence that you want a voice port to detect. Reenter the command for each additional cadence to be detected.
You must associate the class of custom call-progress tones with a voice port for this command to affect tone detection.
Examples
The following example defines a cadence for a busy tone in the custom-cptone voice class with the name "country-x." This example defines 500 ms tone on and 500 ms tone off.
voice class custom-cptone country-x dualtone busy cadence 500 500The following example configures detection of the default frequency and cadence values for the busy tone in the custom-cptone voice class with the name "country-x". The default frequency is a 300 Hz tone, and the default cadence is continuous.
voice class custom-cptone country-x dualtone busy no cadence no frequencyRelated Commands
Command
Description
supervisory custom-cptone
Associates a class of custom call-progress tones with a voice port.
voice class custom-cptone
Creates a voice class for defining custom call-progress tones.
voice class dualtone-detect-params
Modifies the boundaries and limits for custom call-progress tones defined by the voiceclasscustom-cptonecommand.
cadence-list
To specify a tone cadence pattern to be detected, use the cadence-listcommand in voice-class configuration mode. To delete a cadence pattern, use the no form of this command.
cadence-list cadence-id cycle-1-on-time cycle-1-off-time [ cycle-2-on-time cycle-2-off-time ] [ cycle-3-on-time cycle-3-off-time ] [ cycle-4-on-time cycle-4-off-time ]
no cadence-list cadence-id
Syntax Description
cadence-id
A tag to identify this cadence list. The range is from 1 to 10.
cycle-1-on-time
The tone duration for the first cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
cycle-1-off-time
The silence duration for the first cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
cycle-2-on-time
(Optional) The tone duration for the second cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
cycle-2-off-time
(Optional) The silence duration for the second cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
cycle-3-on-time
(Optional) The tone duration for the third cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
cycle-3-off-time
(Optional) The silence duration for the third cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
cycle-4-on-time
(Optional) The tone duration for the fourth cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
cycle-4-off-time
(Optional) The silence duration for the fourth cycle of the cadence pattern. Range is from 0 to 1000 (0 milliseconds to 100 seconds). The default is 0.
Usage Guidelines
A cadence list enables the router to match a complex tone pattern from a PBX or public switched telephone network (PSTN). A tone is detected if it matches any configured cadence list. You can create up to ten cadence lists, enabling the router to detect up to ten different tone patterns. If the tone to be detected consists of only one on-off cycle, you can configure this in either of two ways:
- Create a cadence list using only the cycle-1-on-timeand cycle-1-off-timevariables.
- Use the cadence-max-off-time and cadence-min-on-time commands.
You must also configure the times of the cadence-max-off-time and cadence-min-on-timecommands to be compatible with the on and off times specified by the cadence-list command. The time of the cadence-max-off-time must be equal to or greater than the longest off-time in the cadence list; the cadence-min-on-time must be equal to or less than the shortest on-time in the cadence list.
cadence-max-off-time
To specify the maximum time that a tone can be off and still detected as part of a cadence, use the cadence-max-off-time command in voice-class configuration mode. To restore the default, use the no form of this command.
Usage Guidelines
Specify a time value greater than the off time of the tone to be detected, and use a time value greater than 0 to enable detection of a cadenced tone. With the default (0), the router detects only a continuous tone.
cadence-min-on-time
To specify the minimum time that a tone can be on and still detected as part of a cadence, use the cadence-min-on-time command in voice-class configuration mode. To restore the default, use the no form of this command.
Usage Guidelines
Specify a time value shorter than the on time of the tone to be detected. With the default (0), a tone of any length is detected.
cadence-variation
To specify the cadence variation time allowed for detection of a tone, use the cadence-variation command in voice-class configuration mode. To restore the default cadence variation time, use the no form of this command.
Command History
Release
Modification
12.1(3)T
This command was introduced on the Cisco 2600 series, Cisco 3600 series, and the Cisco MC3810.
12.1(5)XM
This command was implemented on the Cisco 2600 series, Cisco 3600 series, and the Cisco MC3810.
12.2(2)T
This command was integrated into Cisco IOS Release 12.2(2)T and implemented on the Cisco 1750 router.
Usage Guidelines
Specify a time value greater than the cadence variation of the tone to be detected. With the default of 0, only those tones that match the configured cadence are detected.
This command creates a detection limit for one parameter within a voice class. You can apply the detection limit to any voice port.
Examples
The following example specifies a cadence variation time of 30 milliseconds for voice class 100:
voice class dualtone 100 cadence-variation 3The following example specifies 80 ms (eight 10-ms time intervals) as the maximum allowable cadence variation in voice class 70:
voice class dualtone-detect-params 70 cadence-variation 8Related Commands
Command
Description
cadence-max-off-time
Specifies the maximum off duration for detection of a tone.
cadence-min-on-time
Specifies the minimum on duration for detection of a tone.
supervisory answer dualtone
Enables answer supervision on a voice port.
supervisory dualtone-detect-params
Assigns the boundary and detection tolerance parameters defined by thevoiceclassdualtone-detect-paramscommand to a voice port.
call accounting-template
To select an accounting template at a specific location, use the callaccounting-templatecommand in global configuration or application configuration mode. To deselect a specific accounting template, use the no form of this command.
Command History
Release
Modification
12.2(11)T
This command was introduced on the following platforms: Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
12.3(14)T
This command was added to the application configuration mode to replace the callapplicationvoiceaccounting-templatecommand.
Usage Guidelines
For call detail records, the template name must have a .cdr extension. To select call records based on your accounting needs and to specify the location of an accounting template that defines the applicable vendor-specific attributes (VSAs) for generating those selected call records, use the callaccounting-templatecommand in global configuration mode.
TheacctTempName argument refers to a specific accounting template file that you want to send to the RADIUS server. This template file defines only specific VSAs selected by you to control your call records based on your accounting needs.
call accounting-template voice
To select an accounting template at a specific location, use the callaccounting-templatevoice command in global configuration mode. To remove a specific accounting template, use the no form of this command.
Command History
Release
Modification
12.2(11)T
This command was introduced on the following platforms: Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
12.3(14)T
The callaccounting-templatevoicecommand is replaced by the callaccounting-templatecommand in application configuration mode. See the callaccounting-templatecommand for more information.
Usage Guidelines
The template name must have a .cdr extension.
To select call records based on your accounting needs and to specify the location of an accounting template that defines the applicable vendor-specific attributes (VSAs) for generating those selected call records, use the callaccounting-templatevoice command in global configuration mode.
TheacctTempName argument refers to a specific accounting template file that you want to send to the RADIUS server. This template file defines only specific VSAs selected by you to control your call records based on your accounting needs.
call accounting-template voice reload
To reload the accounting template, use the callaccounting-templatevoicereload command in privileged EXEC mode.
Usage Guidelines
Use the callaccounting-templatevoicereload command to reload the template from the URL defined in the callaccounting-templatevoice command. After bootup, if the template file fails to load from the TFTP server, the system tries to automatically reload the file at 5-minute intervals.
Examples
The example below shows how to reload accounting template cdr2:
call accounting-template voice reload cdr2call-agent
To define the call agent for a Media Gateway Control Protocol (MGCP) profile, use the call-agent command in MGCP profile configuration mode. To return to the default values, use the no form of this command.
call-agent { dns-name | ip-address } [port] [ service-type type ] [ version protocol-version ]
no call-agent
Syntax Description
Command Default
The default call-agent UDP port is 2727 for MGCP 1.0, Network-based Call Signaling (NCS) 1.0, and Trunking Gateway Control Protocol (TGCP) 1.0. The default call-agent UDP port is 2427 for MGCP 0.1 and Simple Gateway Control Protocol (SGCP). The default service type and version are MGCP 0.1.
Usage Guidelines
This command is used when values for a MGCP profile are configured.
Call-agent configuration for an MGCP profile (with this command) and global call-agent configuration (with the mgcpcall-agent command) are mutually exclusive; the first to be configured on an endpoint blocks configuration of the other on the same endpoint.
Identifying call agents by Domain Name System (DNS) name rather than by IP address in the call-agent command provides call-agent redundancy, because a DNS name can have more than one IP address associated with it. If a call agent is identified by a DNS name and a message from the gateway fails to reach the call agent, the max1lookup and max2lookup commands enable a search from the DNS lookup table for a backup call agent at a different IP address.
The port argument configures the call agent port number (the UDP port over which the gateway sends messages to the call agent). The reverse, or the gateway port number (the UDP port over which the gateway receives messages from the call agent), is configured by specifying a port number in the mgcp command.
The service type mgcp supports the Restart In Progress (RSIP) error messages sent by the gateway if the mgcpsgcprestartnotify command is enabled. The service type sgcp ignores the RSIP messages.
Examples
The following example defines a call agent for the MGCP profile named "tgcp_trunk":
Router(config)# mgcp profile tgcp_trunk Router(config-mgcp-profile)# call-agent 10.13.93.3 2500 service-type tgcp version 1.0Related Commands
Command
Description
max1 lookup
Enables DNS lookup of the MGCP call agent address when the suspicion threshold value is reached.
max2 lookup
Enables DNS lookup of the MGCP call agent address when the disconnect threshold value is reached.
mgcp
Starts and allocates resources for the MGCP daemon.
mgcp call-agent
Configures the address of the call agent (media gateway controller).
mgcp profile
Initiates MGCP profile mode to create and configure a named MGCP profile associated with one or more endpoints or to configure the default profile.
call application alternate
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationalternatecommand is replaced by the servicecommand in global application configuration mode. See the servicecommand for more information.
To specify an alternate application to use if the application that is configured in the dial peer fails, use the callapplicationalternate command in global configuration mode. To return to the default behavior, use the no form of this command.
Usage Guidelines
If this command is not configured, calls are rejected when the dial peer that matches the call does not specify a valid voice application.
In releases before Cisco IOS Release 12.2(11)T, the default application (DEFAULT) was automatically triggered if no application was configured in the dial peer or if the configured application failed. The default application is no longer automatically executed unless the callapplicationalternate command is configured.
The application named DEFAULT is a simple application that outputs dial tone, collects digits, and places a call to the dialed number. This application is included in Cisco IOS software; you do not have to download it or configure it by using the callapplicationvoice command.
The callapplicationalternate command specifies that if the application that is configured in the dial peer fails, the default voice application is executed. If the name of a specific application is entered, that application is triggered if the application configured in the dial peer fails. If the alternate application also fails, the call is rejected.
If an application name is entered, that application must first be configured on the gateway by using the callapplicationvoice command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application alternate Warning: This command has been deprecated. Please use the following: serviceThe following example configures the DEFAULT application as the alternate:
call application alternateThe following example configures the application session as the alternate:
call application alternate sessionRelated Commands
Command
Description
application
Enables a voice application on a dial peer.
call application voice
Defines the name of a voice application and specifies the location of the Tcl or VoiceXML document to load for this application.
service
Loads and configures a specific, standalone application on a dial peer.
show call application voice
Displays information about voice applications.
call application cache reload time
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationcachereloadtime command is replaced by the cachereloadtime command in application configuration global mode. See the cachereloadtime command for more information.
To configure the router to reload the Media Gateway Control Protocol (MGCP) scripts from cache on a regular interval, use the callapplicationcachereloadtime command in global configuration mode. To set the value to the default, use the no form of this command.
Syntax Description
Command History
Release
Modification
12.1(3)T
This command was introduced on the Cisco AS5300.
12.3(14)T
This command was replaced by the cachereloadtime command in application configuration global mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application cache reload 20 Warning: This command has been deprecated. Please use the following: cache reload timeThe following example displays the callapplicationcachereloadtime command configured to specify 30 minutes before a background process is awakened:
call application cache reload time 30call application dump event-log
To flush the event log buffer for application instances to an external file, use the callapplicationdumpevent-logcommand in privileged EXEC mode.
Usage Guidelines
This command immediately writes the event log buffer to the external file whose location is defined with the callapplicationevent-logdumpftp command in global configuration mode.
NoteThecallapplicationdumpevent-log command and the callapplicationevent-logdumpftp command are two different commands.
Examples
The following example flushes the application event log buffer:
Router# call application dump event-logRelated Commands
Command
Description
call application event-log
Enables event logging for voice application instances.
call application event-log dump ftp
Enables the gateway to write the contents of the application event log buffer to an external file.
call application event-log max-buffer-size
Sets the maximum size of the event log buffer for each application instance.
show call application session-level
Displays event logs and statistics for voice application instances.
call application event-log
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationevent-log command is replaced by the event-logcommand in application configuration monitor mode. See the event-log command for more information.
To enable event logging for all voice application instances, use the callapplicationevent-logcommand in global configuration mode. To reset to the default, use the no form of this command.
Usage Guidelines
This command enables event logging globally for all voice application instances. To enable or disable event logging for a specific application, use the callapplicationvoiceevent-log command.
NoteTo prevent event logging from adversely impacting system resources for production traffic, the gateway uses a throttling mechanism. When free processor memory drops below 20%, the gateway automatically disables all event logging. It resumes event logging when free memory rises above 30%. While throttling is occurring, the gateway does not capture any new event logs even if event logging is enabled. You should monitor free memory and enable event logging only when necessary for isolating faults.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application event-log Warning: This command has been deprecated. Please use the following: event-logThe following example enables event logging for all application instances:
call application event-logRelated Commands
Command
Description
call application event-log error-only
Restricts event logging to error events only for application instances.
call application event-log max-buffer-size
Sets the maximum size of the event log buffer for each application instance.
call application interface event-log
Enables event logging for external interfaces used by voice applications.
call application stats
Enables statistics collection for voice applications.
call application voice event-log
Enables event logging for a specific voice application.
call leg event-log
Enables event logging for voice, fax, and modem call legs.
event-log
Enables event logging for applications.
monitor call application event-log
Displays the event log for an active application instance in real-time.
show call application session-level
Displays event logs and statistics for voice application instances.
call application event-log dump ftp
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationevent-logdumpftpcommand is replaced by the event-logdumpftpcommand in application configuration monitor mode. See the event-logdumpftpcommand for more information.
To enable the gateway to write the contents of the application event log buffer to an external file, use the callapplicationevent-logdumpftpcommand in global configuration mode. To reset to the default, use the no form of this command.
call application event-log dump ftp server [ :port ] /file username username password [ [encryption-type] ] password
no call application event-log dump ftp
Syntax Description
server
Name or IP address of FTP server where file is located.
: port
(Optional) Specific port number on server.
/ file
Name and path of file.
username
Username required to access file.
encryption-type
(Optional) The Cisco proprietary algorithm used to encrypt the password. Values are 0 or 7. To disable encryption enter 0; to enable encryption enter 7. If you specify 7, you must enter an encrypted password (a password already encrypted by a Cisco router).
password
Password required to access file.
Usage Guidelines
This command enables the gateway to automatically write the event log buffer to the named file either after an active application instance terminates or when the event log buffer becomes full. The default buffer size is 4 KB. To modify the size of the buffer, use the callapplicationevent-logmax-buffer-size command. To manually flush the event log buffer, use the callapplicationdumpevent-log command in privileged EXEC mode.
NoteThecallapplicationdumpevent-log command and the callapplicationevent-logdumpftp command are two different commands.
Enabling the gateway to write event logs to FTP could adversely impact gateway memory resources in some scenarios, for example, when:
- The gateway is consuming high processor resources and FTP does not have enough processor resources to flush the logged buffers to the FTP server.
- The designated FTP server is not powerful enough to perform FTP transfers quickly
- Bandwidth on the link between the gateway and the FTP server is not large enough
- The gateway is receiving a high volume of short-duration calls or calls that are failing
You should enable FTP dumping only when necessary and not enable it in situations where it might adversely impact system performance.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application event-log dump ftp Warning: This command has been deprecated. Please use the following: event-log dump ftpThe following example enables the gateway to write application event logs to an external file named app_elogs.log on a server named ftp-server:
call application event-log dump ftp ftp-server/:elogs/app-elogs.log username myname password 0 mypassThe following example specifies that application event logs are written to an external file named app_elogs.log on a server with the IP address of 10.10.10.101:
call application event-log dump ftp 10.10.10.101/:elogs/app-elogs.log username myname password 0 mypassRelated Commands
Command
Description
call application dump event-log
Flushes the event log buffer for application instances to an external file.
call application event-log
Enables event logging for voice application instances.
call application event-log max-buffer-size
Sets the maximum size of the event log buffer for each application instance.
event-log dump ftp
Enables the gateway to write the contents of the application event log buffer to an external file.
show call application session-level
Displays event logs and statistics for voice application instances.
call application event-log error-only
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationevent-logerror-onlycommand is replaced by the event-logerror-onlycommand in application configuration monitor mode. See the event-logerror-onlycommand for more information.
To restrict event logging to error events only for application instances, use the callapplicationevent-logerror-only command in global configuration mode. To reset to the default, use the no form of this command.
Usage Guidelines
This command limits new event logging to error events only; it does not enable logging. You must use this command with either the callapplicationevent-log command, which enables event logging for all voice applications, or with the callapplicationvoiceevent-log command, which enables event logging for a specific application. Any events logged before this command is issued are not affected.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application event-log error-only Warning: This command has been deprecated. Please use the following: event-log error-onlyThe following example enables event logging for error events only:
call application event-log call application event-log error-onlyRelated Commands
Command
Description
call application event-log
Enables event logging for voice application instances.
call application history session event-log save-exception-only
Saves in history only the event logs for application instances that have at least one error.
call application voice event-log
Enables event logging for a specific voice application.
event-log error-only
Restricts event logging to error events only for application instances.
show call application app-level
Displays application-level statistics for voice applications.
show call application session-level
Displays event logs and statistics for voice application instances.
call application event-log max-buffer-size
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationevent-logmax-buffer-sizecommand is replaced by the event-logmax-buffer-sizecommand in application configuration monitor mode. See the event-logmax-buffer-sizecommand for more information.
To set the maximum size of the event log buffer for each application instance, use the callapplicationevent-logmax-buffer-sizecommand in global configuration mode. To reset to the default, use the no form of this command.
Usage Guidelines
If the event log buffer reaches the limit set by this command, the gateway allocates a second buffer of equal size. The contents of both buffers is displayed when you use the showcallapplicationsession-level command. When the first event log buffer becomes full, the gateway automatically appends its contents to an external FTP location if the callapplicationevent-logdumpftp command is used.
A maximum of two buffers are allocated for an event log. If both buffers are filled, the first buffer is deleted and another buffer is allocated for new events (buffer wraps around). If the callapplicationevent-logdumpftp command is configured and the second buffer becomes full before the first buffer is dumped, event messages are dropped and are not recorded in the buffer.
Do not set the maximum buffer size to more than you need for a typical application session. After an active session terminates, the amount of memory used by the buffer is allocated to the history table and is maintained for the length of time set by the callapplicationhistorysessionretain-timer command. Also consider that most fatal errors are captured at the end of an event log.
To conserve memory resources, write the event log buffer to FTP by using the callapplicationevent-logdumpftp command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application event-log max-buffer-size Warning: This command has been deprecated. Please use the following: event-log max-buffer-sizeThe following example sets the application event log buffer to 8 kilobytes:
call application event-log call application event-log max-buffer-size 8Related Commands
Command
Description
call application dump event-log
Flushes the event log buffer for application instances to an external file.
call application event-log
Enables event logging for voice application instances.
call application event-log dump ftp
Enables the gateway to write the contents of the application event log buffer to an external file.
event-log max-buffer-size
Sets the maximum size of the event log buffer for each application instance.
show call application session-level
Displays event logs and statistics for voice application instances.
call application global
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationglobalcommand is replaced by the globalcommand in application configuration mode. See the globalcommand for more information.
To configure an application to use for incoming calls whose incoming dial peer does not have an explicit application configured, use the callapplicationglobal command in global configuration mode. To remove the application, use theno form of this command.
Command History
Release
Modification
12.2(15)ZJ
This command was introduced.
12.3(4)T
This command was integrated into Cisco IOS Release 12.3(4)T.
12.3(14)T
This command was replaced by the globalcommand in application configuration mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Usage Guidelines
The application defined in the dial peer always takes precedence over the global application configured with the callapplicationglobal command. The application configured with this command executes only when a dial peer has no application configured.
The application you configure with this command can be an application other than the default session application, but it must be included with the Cisco IOS software or be loaded onto the gateway with the callapplicationvoice command before using this command. If the application does not exist in Cisco IOS software or has not been loaded onto the gateway, this command will have no effect.
NoteIn Cisco IOS Release 12.3(4)T and later releases, the application-name default refers to the application that supports Open Settlement Protocol (OSP), call transfer, and call forwarding. The default session application in Cisco IOS Release 12.2(13)T and earlier releases has been renamed default.old.c and can still be configured for specific dial peers through the application command or globally configured for all inbound dial peers through the callapplicationglobal command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application global Warning: This command has been deprecated. Please use the following: globalIn the following example, the clid_authen_collect application is configured as the global application for all inbound dial peers that do not have a specific application configured:
call application global clid_authen_collectcall application history session event-log save-exception-only
NoteEffective with Cisco IOS Release 12.3(14)T, thecallapplicationhistorysessionevent-logsave-exception-only command is replaced by the historysessionevent-logsave-exception-onlycommand in application configuration monitor mode. See the historysessionevent-logsave-exception-onlycommand for more information.
To save in history only the event logs for application sessions that have at least one error, use the callapplicationhistorysessionevent-logsave-exception-only command in global configuration mode. To reset to the default, use the no form of this command.
call application history session event-log save-exception-only
no call application history session event-log save-exception-only
Command History
Release
Modification
12.3(8)T
This command was introduced.
12.3(14)T
This command was replaced by the historysessionevent-logsave-exception-onlycommand in application configuration monitor mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Usage Guidelines
Application event logs move from active to history after an instance terminates. If you use this command, the voice gateway saves event logs only for instances that had one or more errors. Event logs for normal instances that do not contain any errors are not saved to history.
NoteThis command does not affect records saved to an FTP server by using the callapplicationdumpevent-log command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application history session event-log save-exception-only Warning: This command has been deprecated. Please use the following: history session event-log save-exception-onlyThe following example saves an event log in history only if the instance had an error:
call application history session event-log save-exception-onlyRelated Commands
Command
Description
call application event-log
Enables event logging for voice application instances.
call application event-log error-only
Restricts event logging to error events only for application instances.
call application event-log max-buffer-size
Sets the maximum size of the event log buffer for each application instance.
call application history session max-records
Sets the maximum number of application instance records saved in history.
call application history session retain-timer
Sets the maximum number of minutes for which application instance records are saved in history.
history session event-log save-exception-only
Saves in history only the event logs for application sessions that have at least one error.
call application history session max-records
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationhistorysessionmax-recordscommand is replaced by the historysessionmax-recordscommand in application configuration monitor mode. See the historysessionmax-records command for more information.
To set the maximum number of application instance records saved in history, use the callapplicationhistorysessionmax-recordscommand in global configuration mode. To reset to the default, use the no form of this command.
Usage Guidelines
This command affects the number of records that display when you use the showcallapplicationhistorysession-level command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application history session max-records Warning: This command has been deprecated. Please use the following: history session max-recordsThe following example sets the maximum record limit to 500:
call application history session max-records 500Related Commands
Command
Description
call application event-log
Enables event logging for voice application instances.
call application history session event-log save-exception-only
Saves in history only the event logs for application instances that have at least one error.
call application history session retain-timer
Sets the maximum number of minutes that application instance records are saved in history.
history session max-records
Sets the maximum number of application instance records saved in history.
show call application session-level
Displays event logs and statistics for voice application instances.
call application history session retain-timer
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationhistorysessionretain-timercommand is replaced by the historysessionretain-timer command in application configuration monitor mode. See the historysessionretain-timercommand for more information.
To set the maximum number of minutes for which application instance records are saved in history, use the callapplicationhistorysessionretain-timercommand in global configuration mode. To reset to the default, use the no form of this command.
call application history session retain-timer minutes
no call application history session retain-timer
Command History
Release
Modification
12.3(8)T
This command was introduced.
12.3(14)T
This command was replaced by the historysessionretain-timer command in application configuration monitor mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Usage Guidelines
This command affects the number of records that display when you use the showcallapplicationhistorysession-level command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application history session retain-timer Warning: This command has been deprecated. Please use the following: history session retain-timerThe following example sets the maximum time to save history records to 1 hour:
call application history session retain-timer 60Related Commands
Command
Description
call application event-log
Enables event logging for voice application instances.
call application history session event-log save-exception-only
Saves in history only the event logs for application instances that have at least one error.
call application history session max-records
Sets the maximum number of application instance records saved in history.
history session retain-timer
Sets the maximum number of minutes for which application instance records are saved in history.
show call application session-level
Displays event logs and statistics for voice application instances.
call application interface dump event-log
To flush the event log buffer for application interfaces to an external file, use the callapplicationinterfacedumpevent-logcommand in privileged EXEC mode.
Usage Guidelines
This command immediately writes the event log buffer to the external file whose location is defined with the callapplicationinterfaceevent-logdumpftp command in global configuration mode.
NoteThe callapplicationinterfacedumpevent-log command and the callapplicationinterfaceevent-logdumpftp command are two different commands.
Examples
The following example writes the event log buffer to the external file named int_elogs:
Router(config)# call application interface event-log dump ftp ftp-server/int_elogs.log username myname password 0 mypass Router(config)# exit Router# call application interface dump event-logRelated Commands
Command
Description
call application interface event-log
Enables event logging for external interfaces used by voice applications.
call application interface event-log dump ftp
Enables the voice gateway to write the contents of the interface event log buffer to an external file.
call application interface event-log max-buffer-size
Sets the maximum size of the event log buffer for each application interface.
show call application interface
Displays event logs and statistics for application interfaces.
call application interface event-log
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationinterfaceevent-log command is replaced by the interfaceevent-log command in application configuration monitor mode. See the interfaceevent-log command for more information.
To enable event logging for interfaces that provide services to voice applications, use the callapplicationinterfaceevent-logcommand in global configuration mode. To reset to the default, use the no form of this command.
call application interface event-log [ { aaa | asr | flash | http | ram | rtsp | smtp | tftp | tts } [ server server ] [disable] ]
no call application interface event-log [ { aaa | asr | flash | http | ram | rtsp | smtp | tftp | tts } [ server server ] [disable] ]
Syntax Description
aaa
Authentication, authorization, and accounting (AAA) interface type.
asr
Automatic speech recognition (ASR) interface type.
flash
Flash memory of the Cisco gateway.
http
Hypertext Transfer Protocol (HTTP) interface type.
ram
Memory of the Cisco gateway.
rtsp
Real Time Streaming Protocol (RTSP) interface type.
smtp
Simple Mail Transfer Protocol (SMTP) interface type.
tftp
Trivial File Transfer Protocol (TFTP) interface type.
tts
Text-to-speech (TTS) interface type.
server server
(Optional) Server name or IP address.
disable
(Optional) Disables event logging for the specified interface type or server.
Usage Guidelines
This command enables event logging globally for all interface types and servers unless you select a specific interface type or server. Specifying an interface type takes precedence over the global command for a specific interface type. Specifying an individual server takes precedence over the interface type.
NoteTo prevent event logging from adversely impacting system resources for production traffic, the gateway uses a throttling mechanism. When free processor memory drops below 20%, the gateway automatically disables all event logging. It resumes event logging when free memory rises above 30%. While throttling is occurring, the gateway does not capture any new event logs even if event logging is enabled. You should monitor free memory and enable event logging only when necessary for isolating faults.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application interface event-log Warning: This command has been deprecated. Please use the following: interface event-logThe following example enables event logging for all interfaces:
call application interface event-logThe following example enables event logging for HTTP interfaces only:
call application interface event-log httpThe following example enables event logging for all interfaces except HTTP:
call application interface event-log call application interface event-log http disableThe following example enables event logging for all HTTP servers except the server with the IP address of 10.10.1.1:
call application interface event-log http call application interface event-log http server http://10.10.1.1 disableRelated Commands
Command
Description
call application interface event-log dump ftp
Enables the gateway to write the contents of the interface event log buffer to an external file.
call application interface event-log error-only
Restricts event logging to error events only for application interfaces.
call application interface event-log max-buffer-size
Sets the maximum size of the event log buffer for each application interface.
call application interface max-server-records
Sets the maximum number of application interface records that are saved.
call application interface stats
Enables statistics collection for application interfaces.
interface event-log
Enables event logging for interfaces providing services to voice applications.
show call application interface
Displays event logs and statistics for application interfaces.
call application interface event-log dump ftp
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationinterfaceevent-logdumpftp command is replaced by the interfaceevent-logdumpftp command in application configuration monitor mode. See the interfaceevent-logdumpftp command for more information.
To enable the gateway to write the contents of the interface event log buffer to an external file, use the callapplicationinterfaceevent-logdumpftpcommand in global configuration mode. To reset to the default, use the no form of this command.
call application interface event-log dump ftp server [ :port ] /file username username password [ [encryption-type] ] password
no call application interface event-log dump ftp
Syntax Description
server
Name or IP address of FTP server where the file is located.
: port
(Optional) Specific port number on server.
/ file
Name and path of file.
username username
Username required to access file.
encryption-type
(Optional) Cisco proprietary algorithm used to encrypt the password. Values are 0 or 7. To disable encryption enter 0; to enable encryption enter 7. If you specify 7, you must enter an encrypted password (a password already encrypted by a Cisco router).
password password
Password required to access file.
Usage Guidelines
This command enables the gateway to automatically write the interface event log buffer to the named file when the buffer becomes full. The default buffer size is 4 KB. To modify the size of the buffer, use the callapplicationinterfaceevent-logmax-buffer-size command. To manually flush the event log buffer, use the callapplicationinterfacedumpevent-log command in privileged EXEC mode.
NoteThe callapplicationinterfacedumpevent-log command and the callapplicationinterfaceevent-logdumpftp command are two different commands.
- The gateway is consuming high processor resources and FTP does not have enough processor resources to flush the logged buffers to the FTP server.
- The designated FTP server is not powerful enough to perform FTP transfers quickly
- Bandwidth on the link between the gateway and the FTP server is not large enough
- The gateway is receiving a high volume of short-duration calls or calls that are failing
You should enable FTP dumping only when necessary and not enable it in situations where it might adversely impact system performance.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application interface event-log dump ftp Warning: This command has been deprecated. Please use the following: interface event-log dump ftpThe following example specifies that interface event log are written to an external file named int_elogs.log on a server named ftp-server:
call application interface event-log dump ftp ftp-server/elogs/int_elogs.log username myname password 0 mypassThe following example specifies that application event logs are written to an external file named int_elogs.log on a server with the IP address of 10.10.10.101:
call application interface event-log dump ftp 10.10.10.101/elogs/int_elogs.log username myname password 0 mypassRelated Commands
Command
Description
call application interface dump event-log
Flushes the event log buffer for application interfaces to an external file.
call application interface event-log
Enables event logging for external interfaces used by voice applications.
call application interface event-log max-buffer-size
Sets the maximum size of the event log buffer for each application interface.
call application interface max-server-records
Sets the maximum number of application interface records that are saved.
interface event-log dump ftp
Enables the gateway to write the contents of the interface event log buffer to an external file.
show call application interface
Displays event logs and statistics for application interfaces.
call application interface event-log error-only
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationinterfaceevent-logerror-only command is replaced by theinterfaceevent-logerroronlycommandinapplication configuration monitor mode. See the interfaceevent-logerroronly command for more information.
To restrict event logging to error events only for application interfaces, use the callapplicationinterfaceevent-logerror-only command in global configuration mode. To reset to the default, use the no form of this command.
Command History
Release
Modification
12.3(8)T
This command was introduced.
12.3(14)T
This command was replaced by theinterfaceevent-logerroronly command in application configuration monitor mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Usage Guidelines
This command limits the severity level of the events that are logged; it does not enable logging. You must use this command with the callapplicationinterfaceevent-log command, which enables event logging for all application interfaces.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application interface event-log error-only Warning: This command has been deprecated. Please use the following: interface event-log error onlyThe following example enables event logging for error events only:
call application interface event-log error-onlyRelated Commands
Command
Description
call application interface event-log
Enables event logging for external interfaces used by voice applications.
call application interface event-log max-buffer-size
Sets the maximum size of the event log buffer for each application interface.
call application interface max-server-records
Sets the maximum number of application interface records that are saved.
interface event-log error-only
Restricts event logging to error events only for application interfaces.
show call application interface
Displays event logs and statistics for application interfaces.
call application interface event-log max-buffer-size
NoteEffective with Cisco IOS Release 12.3(14)T, thecallapplicationinterfaceevent-logmax-buffer-sizecommand is replaced by the interfaceevent-logmax-buffer-size command in application configuration monitor mode. See the interfaceevent-logmax-buffer-size command for more information.
To set the maximum size of the event log buffer for each application interface, use the callapplicationinterfaceevent-logmax-buffer-sizecommand in global configuration mode. To reset to the default, use the no form of this command.
call application interface event-log max-buffer-size kilobytes
no call application interface event-log max-buffer-size
Command History
Release
Modification
12.3(8)T
This command was introduced.
12.3(14)T
This command was replaced by the interfaceevent-logmax-buffer-size command in application configuration monitor mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Usage Guidelines
If the event log buffer reaches the limit set by this command, the gateway allocates a second buffer of equal size. The contents of both buffers is displayed when you use the showcallapplicationinterface command. When the first event log buffer becomes full, the gateway automatically appends its contents to an external FTP location if the callapplicationinterfaceevent-logdumpftp command is used.
A maximum of two buffers are allocated for an event log. If both buffers are filled, the first buffer is deleted and another buffer is allocated for new events (buffer wraps around). If the callapplicationinterfaceevent-logdumpftp command is configured and the second buffer becomes full before the first buffer is dumped, event messages are dropped and are not recorded in the buffer.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application interface event-log max-buffer-size Warning: This command has been deprecated. Please use the following: interface event-log max-buffer-sizeThe following example sets the maximum buffer size to 8 kilobytes:
call application interface event-log max-buffer-size 8Related Commands
Command
Description
call application interface dump event-log
Flushes the event log buffer for application interfaces to an external file.
call application interface event-log dump ftp
Enables the gateway to write the contents of the interface event log buffer to an external file.
call application interface max-server-records
Sets the maximum number of application interface records that are saved.
interface event-log max-buffer-size
Sets the maximum size of the event log buffer for each application interface.
show call application interface
Displays event logs and statistics for application interfaces.
call application interface max-server-records
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationinterfacemax-server-records command is replaced by theinterfacemax-server-records command in application configuration monitor mode. See the interfacemax-server-recordscommand for more information.
To set the maximum number of application interface records that are saved, use the callapplicationinterfacemax-server-recordscommand in global configuration mode. To reset to the default, use the no form of this command.
call application interface max-server-records number
no call application interface max-server-records
Command History
Release
Modification
12.3(8)T
This command was introduced.
12.3(14)T
This command was replaced by theinterfacemax-server-records command in application configuration monitor mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Usage Guidelines
Only the specified number of records from the most recently accessed servers are kept.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application interface max-server-records Warning: This command has been deprecated. Please use the following: interface max-server-recordsThe following example sets the maximum saved records to 50:
call application interface max-server-records 50Related Commands
Command
Description
call application interface event-log
Enables event logging for external interfaces used by voice applications.
call application interface event-log max-buffer-size
Sets the maximum size of the event log buffer for each application interface.
interface max-server-records
Sets the maximum number of application interface records that are saved.
show call application interface
Displays event logs and statistics for application interfaces.
call application interface stats
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationinterfacestats command is replaced by the interfacestats command in application configuration monitor mode. See the interfacestats command for more information.
To enable statistics collection for application interfaces, use the callapplicationinterfacestats command in global configuration mode. To reset to the default, use the no form of this command.
Usage Guidelines
To display the interface statistics enabled by this command, use the showcallapplicationinterface command. To reset the interface counters to zero, use the clearcallapplicationinterface command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application interface stats Warning: This command has been deprecated. Please use the following: interface statsThe following example enables statistics collection for application interfaces:
call application interface statsRelated Commands
Command
Description
call application interface event-log
Enables event logging for external interfaces used by voice applications.
clear call application interface
Clears application interface statistics or event logs.
interface stats
Enables statistics collection for application interfaces.
show call application interface
Displays event logs and statistics for application interfaces.
stats
Enables statistics collection for voice applications.
call application session start (global)
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationsessionstart(global) command is replaced by the the sessionstartcommand in application configuration mode. See the sessionstartcommand for more information.
To start a new instance (session) of a Tcl IVR 2.0 application, use the callapplicationsessionstartcommand in global configuration mode. To stop the session and remove the configuration, use the no form of this command.
call application session start instance-name application-name
no call application session start instance-name
Command History
Release
Modification
12.3(4)T
This command was introduced.
12.3(14)T
The callapplicationsessionstart (global configuration) command was replaced by the sessionstartcommand in application configuration mode.
12.4(24)T
This command was modified. The automatic conversion to the new CLI is replaced with an explicit error message.
Usage Guidelines
This command starts a new session, or instance, of a Tcl IVR 2.0 application. It cannot start a session for a VoiceXML application because Cisco IOS software cannot start a VoiceXML application without an active call leg.
You can start an application instance only after the Tcl application is loaded onto the gateway with the callapplicationvoice command.
If this command is used, the session restarts if the gateway reboots.
The nocallapplicationsessionstart command stops the Tcl session and removes the configuration from the gateway. You can stop an application session without removing the configuration by using thecallapplicationsessionstop command.
VoiceXML sessions cannot be stopped with the nocallapplicationsessionstart command because VoiceXML sessions cannot be started with Cisco IOS commands.
If the application session stops running, it does not restart unless the gateway reboots. A Tcl script might intentionally stop running by executing a "call close" command for example, or it might fail because of a script error.
You can start multiple instances of the same application by using different instance names.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application session start Warning: This command has been deprecated. Please use the following: session startThe following example starts a session named my_instance for the application named demo:
call application session start my_instance demoThe following example starts another session for the application named demo:
call application session start my_instance2 demoRelated Commands
Command
Description
call application session start (privileged EXEC)
Starts a new instance (session) of a Tcl application from privileged EXEC mode.
call application session stop
Stops a voice application session that is running.
debug voip ivr
Displays debug messages for VoIP IVR interactions.
session start
Starts a new instance (session) of a Tcl IVR 2.0 application.
show call application services registry
Displays a one-line summary of all registered services.
show call application sessions
Displays summary or detailed information about voice application sessions.
call application session start (privileged EXEC)
To start a new instance (session) of a Tcl IVR 2.0 application, use the callapplicationsessionstart command in privileged EXEC mode.
Syntax Description
Usage Guidelines
This command starts a new session, or instance, of a Tcl IVR 2.0 application. It cannot start a session for a VoiceXML application because Cisco IOS software cannot start a VoiceXML application without an active call leg.
You can start an application instance only after the Tcl application is loaded onto the gateway with the callapplicationvoice command.
Using this command does not restart the session if the gateway reboots. To automatically restart the session if the gateway reboots, use the callapplicationsessionstart command in global configuration mode.
To stop an application session once it starts running, use the callapplicationsessionstop command.
If the application session stops running, it does not restart unless the gateway reboots and the callapplicationsessionstart command is used in global configuration mode. A Tcl script might intentionally stop running by executing a "call close" command for example, or it might fail due to a script error.
You can start multiple instances of the same application by using different instance names.
Examples
The following example restarts an application session called my_instance:
call application session start my_instanceRelated Commands
Command
Description
call application session start (global configuration)
Starts a new instance (session) of a Tcl application in global configuration mode.
call application session stop
Stops a voice application session that is running.
show call application services registry
Displays a one-line summary of all registered services.
show call application sessions
Displays summary or detailed information about voice application sessions.
call application session stop
To stop a voice application session that is running, use the callapplicationsessionstop command in privileged EXEC mode.
call application session stop { callid call-id | handle handle | id session-id | name instance-name }
Syntax Description
callid call-id
Call-leg ID that can be displayed in the output from the debugvoipivrscript command if the Tcl script uses puts commands.
handle handle
Handle of a session from the Tcl mod_handle infotag.
id session-id
Session ID that can be displayed with the showcallapplicationsessions command.
name instance-name
Instance name that was configured with the callapplicationsessionstartcommand.
Usage Guidelines
This command stops a Tcl IVR 2.0 or VoiceXML application session that is identified by one of four different methods: call ID, handle, session ID, or instance name. To see a list of currently running applications, use the showcallapplicationsessions command.
A Tcl session that is stopped with this command receives a session terminate event. The session is expected to close all call legs and stop. If a session does not close itself after a 10-second timer, it is forcibly stopped and all call legs that it controls disconnect.
Using this command to stop a VoiceXML session immediately stops the document interpretation and disconnects the call leg. No VoiceXML events are thrown.
If you stop a Tcl session that is configured to start with the callapplicationsessionstart command in global configuration mode, you must remove the session by using the nocallapplicationsessionstart command before you can restart it.
To see a list of stopped sessions, use the showcallapplicationsessions command. Only stopped sessions that are configured to start with the callapplicationsessionstart command in global configuration mode are displayed. If a session was started with the callapplicationsessionstart command in privileged EXEC mode, it is not tracked by the system and it is not shown as stopped in the output of the showcallapplicationsessions command.
Examples
The following example stops an application session called my_instance:
call application session stop name my_instanceRelated Commands
Command
Description
call application session start (global configuration)
Starts a new instance (session) of a Tcl application from global configuration mode.
show call application services registry
Displays a one-line summary of all registered services.
show call application sessions
Displays summary or detailed information about voice application sessions.
call application stats
NoteEffective with Cisco IOS Release 12.3(14)T, the callapplicationstatscommand is replaced by the stats command in application configuration monitor mode. See the stats command for more information.
To enable statistics collection for voice applications, use thecallapplicationstats command in global configuration mode. To reset to the default, use the no form of this command.
Usage Guidelines
To display the application statistics, use the showcallapplicationsession-level, showcallapplicationapp-level, or showcallapplicationgateway-levelcommand. To reset the application counters in history to zero, use the clearcallapplicationstats command.
Examples
Effective with Cisco IOS Release 12.4(24)T, the following warning message is displayed to direct users to the replacement command options:
Router(config)# call application stats Warning: This command has been deprecated. Please use the following: statsThe following example enables statistics collection for voice applications:
call application statsRelated Commands
Command
Description
call application event-log
Enables event logging for voice application instances.
call application interface stats
Enables statistics collection for application interfaces.
clear call application stats
Clears application-level statistics in history and subtracts the statistics from the gateway-level statistics.
show call application app-level
Displays application-level statistics for voice applications.
show call application gateway-level
Displays gateway-level statistics for voice application instances.
show call application session-level
Displays event logs and statistics for voice application instances.
stats
Enables statistics collection for voice applications.
