Table of Contents
Cisco IOS Commands
Command Reference
accounting method
accounting suppress
accounting template
acct-template
attribute acct-session-id overloaded
attribute h323-remote-id resolved
authentication method
authorization method
call accounting-template voice
call accounting-template voice reload
gw-accounting aaa
method
show call accounting-template voice
suppress
voice class aaa
voice-class aaa
Cisco IOS Commands
Command Reference
This section documents new or modified commands. All other commands used with this feature are documented in the Cisco IOS Release 12.2 command reference publications. All TCL verbs are documented in the TCL IVR API Version 2.0 Programmer's Guide and the VSAs are documented in the RADIUS Vendor-Specific Attributes Voice Implementation Guide.
New Commands:
accounting method
To set an accounting method at login for calls coming into a dial peer, use the accounting method command in voice class AAA configuration mode. To disable the accounting method set at login, use the no form of this command.
- accounting method MethListName [out-bound]
- no accounting method MethListName [out-bound]
Syntax Description
|
MethListName
|
Defines an accounting method list name.
|
|
out-bound
|
Defines the outbound leg.
|
Defaults
When a specific accounting method is not set at login, the system uses aaa accounting connection h323 as the default.
Command Modes
Voice class AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco 5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- This command sets the accounting method for dial peers in voice class AAA configuration mode. To initially define a method list, refer to the AAA Cisco IOS Security Configuration Guide, Release 12.2.
- When the outbound option in the command is specified, the out-bound call leg on the dial peer uses the method list name specified in the command.
- If the method list name is not specified, then by default, the out-bound call leg uses the same method list name as the inbound call leg.
Examples
accounting method dp-out out-bound
Related Commands
accounting suppress
To disable accounting that is generated automatically by a service provider module for a specific dial peer, use the accounting suppress command in voice class AAA configuration mode. To allow accounting to be automatically generated, use the no form of this command.
- accounting suppress [in-bound|out-bound]
- no accounting suppress [in-bound|out-bound]
Syntax Description
|
in-bound
|
Defines call leg for incoming calls.
|
|
out-bound
|
Defines call leg for outbound calls.
|
Defaults
Accounting is automatically generated by the service provider module.
Command Modes
Voice class AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- If a call leg option is not specified in the command, accounting is disabled for both in-bound and outbound calls.
- For accounting to be automatically generated in the service provider module, you must first configure gw-accounting aaa in global configuration mode before configuring dial peer based accounting in voice class AAA mode.
Examples
In the example below, accounting is suppressed for the incoming call leg.
accounting suppress in-bound
Related Commands
| Command |
Description |
|
voice class aaa
|
Enables dial peer based VoIP AAA configurations.
|
|
gw-accounting aaa
|
Enables VoIP gateway accounting.
|
|
suppress
|
Turns off accounting for a call leg on a pots or VoIP dial peer. The command is used in gw-accounting aaa configuration mode.
|
accounting template
To allow each dial peer to choose and send a customized accounting template to the RADIUS server, use the accounting template command in voice class AAA configuration mode. To disable the dial peer from choosing and sending a customized accounting template, use the no form of this command.
- accounting template acctTempName [out-bound]
- no accounting template acctTempName [out-bound]
Syntax Description
|
acctTempName
|
Name of the accounting template.
|
|
out-bound
|
Defines the outbound leg.
|
Defaults
The dial peer does not choose and send a customized accounting template to the RADIUS server.
Command Modes
Voice class AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- This command overrides the acct-template command in gw-accounting aaa mode when using a customized accounting template.
- If you use a TCL script, the TCL verb aaa accounting start [-t acctTempName] takes precedence over the accounting template command in voice class aaa configuration mode.
Examples
accounting template temp-dp out-bound
Related Commands
| Command |
Description |
|
voice class aaa
|
Enables dial peer based VoIP AAA configurations.
|
acct-template
To send a selected group of voice accounting VSAs, use the acct-template command in gateway accounting AAA configuration mode. To disable sending that selected group of voice accounting VSAs, use the no form of this command.
- acct-template {callhistory-detail | acctTempName}
- no acct-template {callhistory-detail | acctTempName}
Syntax Description
|
acctTempName
|
Name of the custom accounting template created by deleting unwanted attributes.
|
|
callhistory-detail
|
Sends all voice attributes for accounting.
|
Defaults
No voice accounting VSAs are sent in gateway accounting AAA configuration mode.
Command Modes
Gateway accounting AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, AS5350, AS5400, AS5800, and AS5850.
|
Usage Guidelines
- If you do not want to create a custom template, use the callhistory-detail command to send all voice VSAs to the accounting server. These are voice VSAs introduced in Cisco IOS releases up to Cisco IOS Release 12.2(11)T. See the RADIUS Vendor Specific Attributes Voice Implementation Guide and the Supplemental RADIUS Vendor Specific Attributes Voice Implementation Guide for the current list of attributes.
- Use the acct-template command to send only those voice VSAs that are defined in the accounting template. The accounting template is a text file that you can create by selecting specific VSAs that are applicable to your billing needs. You must first use the call accounting-template voice command to define your accounting template before using the acct-template command. See the RADIUS Vendor-Specific Attributes Voice Implementation Guide for the latest list of attributes.
- When you send only those VSAs defined in your accounting template, the default call history records that are created by the service provider are automatically suppressed.
Examples
In the example below, the acct-template command is used to create temp-glob, a custom template.
Related Commands
attribute acct-session-id overloaded
To overload the acct-session-id attribute with voice VSAs, use the attribute acct-session-id-overloaded command in gateway accounting AAA configuration mode. To disable overloading the acct-session-id attribute with voice VSAs, use the no form of this command.
- attribute acct-session-id overloaded
- no attribute acct-session-id overloaded
Syntax Description
There are no arguments or keywords for this command.
Defaults
The acct-session-id attribute is not overloaded with voice VSAs.
Command Modes
Gateway accounting AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- acct-session-id is RADIUS attribute 44. For more information on this attribute, see the document, RADIUS attribute 44 (Accounting Session ID) in Access Requests .
- The attribute acct-session-id overloaded command replaces the gw-accounting h323 vsa command.
- Attributes that cannot be mapped to standard RADIUS attributes are packed into the acct-session-id attribute field as ASCII strings separated by the "/" character.
- The Accounting Session ID (acct-session-id) attribute contains the RADIUS account session ID, which is a unique identifier that links accounting records associated with the same login session for a user. This unique identifier makes it easy to match start and stop records in a log file.
- Accounting Session ID numbers restart at 1 each time the router is power-cycled or the software is reloaded.
Examples
attribute acct-session-id overloaded
Related Commands
attribute h323-remote-id resolved
To resolve the h323-remote-id attribute, use the attribute h323-remote-id resolved command in gw-accounting aaa configuration mode. To keep the h323-remote-id attribute unresolved, use the no form of this command.
- attribute h323-remote -id resolved
- no attribute h323-remote -id resolved
Syntax Description
There are no arguments or keywords for this command.
Defaults
The h323-remote-id attribute is not resolved.
Command Modes
gw-accounting aaa configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, AS5350, AS5400, AS5800, and AS5850.
|
Usage Guidelines
Examples
attribute h323-remote-id resolved
Related Commands
authentication method
To set an authentication method at login for calls coming into a dial peer, use the authentication method command in voice class AAA mode. To disable the authentication method set at login, use the no form of this command.
- authentication method MethListName
- no authentication method MethListName
Syntax Description
|
MethListName
|
Defines an authentication method list name.
|
Defaults
When a specific authentication method is not set at login, the system uses aaa authentication login h323 as the default.
Command Modes
voice class AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, AS5350, AS5400, AS5800, and AS5850.
|
Usage Guidelines
- In voice class AAA configuration mode, use this command to direct authentication requests to a RADIUS server based on DNIS or trunk grouping.
- This command is used for directing dial peer based authentication requests. The method list must be defined during initial authentication setup.
Examples
In the example below, dp is the method list name used for authentication. The method list name is defined during initial authentication setup.
Related Commands
| Command |
Description |
|
voice class aaa
|
Enables dial peer based VoIP AAA configurations.
|
|
aaa authentication login
|
Sets AAA authentication at login.
|
authorization method
To set an authorization method at login for calls coming into a dial peer, use the authorization method command in voice class AAA configuration mode. To disable the authorization method set at login, use the no form of this command.
- authorization method MethListName
- no authorization method MethListName
Syntax Description
|
MethListName
|
Defines an authorization method list name.
|
Defaults
When a specific authorization method is not set at login, the system uses aaa authorization exec h323 as the default.
Command Modes
Voice class AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, AS5350, AS5400, AS5800, and AS5850.
|
Usage Guidelines
- In voice class AAA configuration mode, use this command to direct authorization requests to a RADIUS server based on DNIS or trunk grouping.
- This command is used for directing dial peer based authentication requests. The method list must be defined during initial authentication setup.
Examples
Related Commands
| Command |
Description |
|
voice class aaa
|
Enables dial peer based VoIP AAA configurations.
|
|
aaa authorization exec
|
Runs authorization to determine if the user is allowed to run an EXEC shell.
|
call accounting-template voice
To select an accounting template at a specific location, use the call accounting-template voice command in global configuration mode. To remove a specific accounting template, use the no form of this command.
- call accounting-template voice acctTempName url
- no call accounting-template voice acctTempName url
Syntax Description
|
acctTempName
|
Template name
|
|
url
|
Location of the template.
|
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
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 call accounting-template voice command in global configuration mode.
- acctTempName 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 allow you to control your call records based on your accounting needs.
Examples
The example below shows the accounting template cdr1 selected from a specific TFTP address.
call accounting-template voice temp-ivr tftp://kyer/santac/cdr/cdr1.cdr
Related Commands
call accounting-template voice reload
To reload the accounting template, use the call accounting-template voice reload command in privileged EXEC mode.
- call accounting-template voice reload acctTempName
Syntax Description
|
reload
|
Reloads the accounting template from the address (for example, a tftp address) where the template is stored.
|
|
acctTempName
|
The name of the accounting template.
|
Defaults
No default behavior or values
Command Modes
Privileged EXEC
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- Use the call accounting-template voice reload command to reload the template from the url defined in the call accounting-template voice command. After bootup, if the template file fails to load from the TFTP server, the system tries to automatically reload the file at five minute intervals.
Examples
The example below shows how to reload accounting template cdr2.
call accounting-template voice reload cdr2
Related Commands
| Command |
Description |
|
gw-accounting aaa
|
Defines and loads the template file at the location
defined by the url.
|
gw-accounting aaa
To enable VoIP gateway accounting through the AAA system, use the gw-accounting aaa command in global configuration mode. To disable VoIP gateway accounting, use the no form of this command.
- gw-accounting aaa
- no gw-accounting aaa
Syntax Description
There are no arguments or keywords for this command.
Defaults
VoIP gateway accounting is disabled.
Command Modes
Global configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- The gw-accounting aaa command replaces the gw-accounting h323 command.
- Enter the gw-accounting aaa command to configure commands in gateway accounting AAA mode. Commands that are configured in gateway accounting AAA mode are listed in the "Related Commands" section below.
Examples
In the example below, gateway accounting AAA mode is first enabled before configuring the commands method, attribute acct-session-id overloaded, and attribute h323-remote-id resolved.
attribute acct-session-id overloaded
attribute h323-remote-id resolved
Related Commands
| Command |
Description |
|
attribute acct-session-id overloaded
|
Overloads the acct-session-id attribute with voice VSAs.
|
|
attribute h323-remote-id resolved
|
Resolves the h323-remote-id attribute from the h323-remote-address attribute and sends it to the RADIUS server.
|
|
acct-template
|
Sends all accounting voice attributes or only those attributes defined in a specific accounting template file.
|
|
method
|
Specifies the AAA method list name to be used.
|
|
suppress
|
Turns off accounting for a call leg on a POTS or VoIP dial peer.
|
method
To set a specific accounting method list, use the method command in gateway accounting AAA configuration mode.
- method acctMethListName
Syntax Description
|
acctMethListName
|
Defines a specific accounting method list.
|
Defaults
h323 is the default accounting method list.
Command Modes
gw-accounting aaa configuration.
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- For information on setting AAA network security for your network, including setting method lists, refer to the Authentication, Authorization, and Accounting Cisco IOS Security Configuration Guide, Release 12.2.
- The method command sets the accounting method globally (not for a dial peer). To initially define the AAA method list name for accounting, use the aaa accounting command.
- The argument acctMethListName in the method command is the same name used to define the method list name under the aaa accounting command.
In the example below, the method command uses the method list name klz_aaa6 which was previously defined using the AAA commands.
aaa group server radius sg6
server 1.6.30.70 auth-port 1708 acct-port 1709
aaa authentication login klz_aaa6 group sg6
!klz_aaa6 is defined as the method list name
aaa authorization exec klz_aaa6 group sg6
aaa accounting connection klz_aaa6 start-stop group sg6
The same method list name klz_aaa6 is used.
Related Commands
| Command |
Description |
|
gw-accounting aaa
|
Enables VoIP gateway accounting.
|
|
aaa accounting
|
Enables accounting of requested services for billing or security purposes.
|
show call accounting-template voice
To view accounting template activity, use the show call accounting-template voice command in privileged EXEC mode.
- show call accounting-template voice [acctTempName | master | qdump | summary]
Syntax Description
|
acctTempName
|
Defines the name of the accounting template.
|
|
master
|
Displays all VSAs that are filtered by accounting templates.
|
|
qdump
|
Displays template activity in the service and free queues.
|
|
summary
|
Lists names of all the accounting templates and the number of attributes in each template currently being used.
|
Defaults
No default behavior or values
Command Modes
Privileged EXEC
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- show call accounting-template voice displays the status and attributes defined in each template after it is configured.
- show call accounting-template voice acctTempName displays the status of a specific template and the attributes (VSAs) that are defined for that template.
- show call accounting-template voice master displays all the vendor specific attributes (VSAs) that can be filtered by accounting templates.
- show call accounting-template voice qdump displays template activity in the service (svc) and free queues. It displays the template URL, the number of legs on which a template is active, and the state of a template.
-
- After an accounting template is defined, it is put in the svc queue to serve new incoming calls. When a running accounting template is undefined or reloaded during an active call, the template is moved from the svc to the free queue, and can be reused after all the active calls stop referencing it. Templates that are reloaded or undefined while being referenced during an active call are considered to be in a dirty state, and are called dirty templates.
- To ensure that start and stop records correspond on an active call that is referencing a dirty template, it is necessary to keep all dirty templates alive until all active calls referencing that dirty template are released. After all the active calls are released, the reloaded templates are applied to the next call.
- show call accounting-template voice summary displays the current status of all the accounting templates that are configured. It shows if the template was loaded and running successfully.
Examples
show call accounting-template voice
router#
show call accounting-template voice
CDR template cdr1 is running
url: tftp://sanjoe/santa/merwan/Templates/cdr1.cdr
The last load was successful.
attr: h323-call-origin (56)
attr: h323-call-type (57)
attr: out-portgrp-id (81)
CDR template cdr2 is running
url: tftp://sanjoe/santa/merwan/Templates/cdr2.cdr
The last load was successful.
attr: h323-call-origin (56)
attr: h323-call-type (57)
attr: h323-connect-time (59)
attr: h323-disconnect-time (64)
attr: h323-setup-time (76)
attr: h323-voice-quality (78)
show call accounting-template voice acctTempName
In this example, the command displays details about a specific template cdr1.
router#
show call accounting-template voice cdr1
CDR template cdr1 is running
url: tftp://sanjoe/santa/merwan/Templates/cdr1.cdr
The last load was successful.
attr: h323-call-origin (56)
attr: h323-call-type (57)
attr: out-portgrp-id (81)
show call accounting-template voice master
In this example, the show call accounting-template voice master command displays all sixty four attributes that can be filtered by an accounting template.
router#
show call accounting-template voice master
------section of trace removed for viewing purposes----
Totally 64 attributes are filterable.
show call accounting-template voice qdump
In the example shown below, the show call accounting-template voice qdump displays template activity in the service queue. Initially, no templates are in the dirty state.
route#
show call accounting-template voice qdump
name url is_dirty no_of_legs
=========================================================================
cdr1 tftp://sanjoe/santa/johndoe 0
cdr2 tftp://sanjoe/santa/johndoe 0
cdr3 tftp://sanjoe/santa/johndoe 0
After reloading the templates during active calls, the trace below shows cdr1 and cdr2 to be in a dirty state.
cdr1 tftp://sanjoe/santa/johndoe dirty 1
cdr2 tftp://sanjoe/santa/johndoe dirty 1
show call accounting-template voice summary
In the example below, the show call accounting-template voice summary command displays a summary of all configured accounting templates. cdr3 is not in running mode because it has either been rejected or it does not exist at the given URL.
router#
show call accounting-template voice summary
name url last_load is_running
=========================================================================
cdr1 tftp://sanjoe/santa/merwan success is running
cdr2 tftp://sanjoe/santa/merwan success is running
cdr3 tftp://sanjoe/santa/merwan fail is not running
Table Table 3-1 describes the fields shown in the show call accounting-template voice display.
Table 3-1
show call accounting-template voice Field Descriptions
| Field |
Description |
|
name
|
Name of the accounting template.
|
|
url
|
Location of the accounting template.
|
|
last_load
|
Describes if the accounting template was successfully or unsuccessfully loaded from its location.
|
|
is_running
|
Describes if the accounting template has been activated after it is successfully loaded from its location.
|
|
is_dirty
|
Shows that the accounting template was reloaded during an active call.
|
|
no_of_legs
|
Number of call legs.
|
|
attr
|
Vendor specific attributes (VSAs) defined in an accounting template.
|
Related Commands
suppress
To turn off accounting for a specific call leg, use the suppress command in gateway accounting AAA configuration mode. To keep accounting for a specific call leg, use the no form of this command.
- suppress [pots][voip]
- no suppress [pots][voip]
Syntax Description
|
pots
|
Identifies the POTS call leg.
|
|
voip
|
Identifies the VoIP call leg.
|
Defaults
Accounting is kept for the specified call leg. It is not turned off.
Command Modes
Gateway accounting AAA configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, AS5350, AS5400, AS5800, and AS5850.
|
Usage Guidelines
- Use the suppress command to turn off accounting for a specific call leg.
- If both incoming and outgoing call legs of a call are of the same type, no accounting packets are generated.
Examples
The example below suppresses accounting for the POTS call leg.
Related Commands
voice class aaa
To enable dial peer based VoIP AAA configurations, use the voice class aaa command in global configuration mode. To disable dial peer based VoIP AAA configurations, use the no form of this command.
- voice class aaa tag
- no voice class aaa tag
Syntax Description
|
tag
|
Specifies a number to identify voice class authentication, authorization, and accounting (AAA).
|
Defaults
None
Command Modes
Global configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, AS5350, AS5400, AS5800, and AS5850.
|
Usage Guidelines
- The voice class aaa configuration command is a voice service class that allows you to perform dial peer based AAA configurations.
- Commands that are configured in voice class AAA configuration mode are listed in the "Related Commands" section below.
Examples
The example below shows AAA configurations in voice class AAA configuration mode. The number assigned to the tag is 1.
accounting template temp-dp
The example below shows accounting configurations in voice class AAA configuration mode.
accounting method dp-out out-bound
accounting template temp-dp out-bound
Related Commands
| Command |
Description |
|
authentication method
|
Specifies an authentication method for calls coming into the defined dial peer.
|
|
authorization method
|
Specifies an authorization method for calls coming into the defined dial peer.
|
|
method
|
Specifies an accounting method for calls coming into the defined dial peer.
|
|
accounting suppress
|
Disables accounting that is automatically generated by the service provider module for a specific dial peer.
|
|
voice-class aaa
|
Applies properties defined in the voice class to a specific dial peer.
|
voice-class aaa
To apply properties defined in the voice class to a dial peer, use the voice-class aaa command in dial peer configuration mode.
- voice-class aaa tag
Syntax Description
|
tag
|
Specifies a number to identify the voice class.
|
Defaults
None
Command Modes
Dial peer configuration
Command History
| Release |
Modification |
|
12.2(11)T
|
This command was introduced on the Cisco 3660, Cisco AS5300, Cisco AS5350, Cisco AS5400, Cisco AS5800, and Cisco AS5850.
|
Usage Guidelines
- Properties that are configured in voice class aaa configuration mode can be applied to a dial peer by using the voice-class aaa command in dial peer mode.
Examples
The example below shows redirecting AAA requests using DNIS. You define a voice class to specify the AAA methods and then use the voice-class aaa command in dial-peer mode.
incoming called-number 50..
session target ipv4:1.5.31.201
Related Commands
| Command |
Description |
|
voice class aaa
|
Enables dial peer based VoIP AAA configurations.
|