-
Cisco IOS Dial Technologies Command Reference, Release 12.2
-
Using Cisco IOS Software
-
Commands A through CAS
-
Commands CHA through CPP
-
Commands D
-
Commands EN through IP
-
Commands IS through L2
-
Commands LCP through MOD
-
Commands MU through PPP
-
Commands PRI through SHE
-
Commands SHOW A through SHOW DI
-
Commands SHOW DS through SHOW LI
-
Commands SHOW M through SHOW N
-
Commands SHOW P through SHOW R
-
Commands SHOW S through SHOW V
-
Commands SHU through X
-
Index
-
Feedback
Table Of Contents
aaa authorization configuration default
calltracker history retain-mins
Dial Technologies Commands
This chapter presents the commands to configure and maintain Cisco IOS dial and access applications. The commands are presented in alphabetical order. Some commands required for configuring dial and access solutions may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.
aaa authorization configuration default
To download static route configuration information from the authorization, authentication, and accounting (AAA) server using TACACS+ or RADIUS, use the aaa authorization configuration default command in global configuration mode. To remove static route configuration information, use the no form of this command.
aaa authorization configuration default {radius | tacacs+}
no aaa authorization configuration default
Syntax Description
Defaults
No configuration authorization is defined.
Command Modes
Global configuration
Command History
Examples
The following example downloads static route information using a TACACS+ server:
aaa authorization configuration default tacacs+Related Commands
aaa route download
To enable the download static route feature and set the amount of time between downloads, use the aaa route download command in global configuration mode. To disable this function, use the no form of this command.
aaa route download [time]
no aaa route download
Syntax Description
Defaults
The default period between downloads (updates) is 720 minutes.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is used to download static route details from the authorization, authentication, and accounting (AAA) server if the name of the router is hostname. The name passed to the AAA server for static routes is hostname-1, hostname-2... hostname-n—the router downloads static routes until it fails an index and no more routes can be downloaded.
Examples
The following example sets the AAA route update period to 100 minutes:
aaa route download 100Related Commands
accept-dialin
To create an accept dial-in VPDN subgroup that configures a tunnel server to accept requests from a network access server (NAS) to tunnel dial-in calls, and to enter accept dial-in VPDN subgroup configuration mode, use the accept-dialin command in VPDN group configuration mode. To remove the accept dial-in VPDN subgroup configuration from a virtual private dialup network (VPDN) group, use the no form of this command.
accept-dialin
no accept-dialin
Syntax Description
This command has no arguments or keywords.
Defaults
No accept dial-in VPDN subgroups are configured.
Command Modes
VPDN group configuration
Command History
Usage Guidelines
Use the accept-dialin command on a tunnel server to configure a VPDN group to accept requests to establish dial-in VPDN tunnels from a NAS. Once the tunnel server accepts the request from a NAS, it uses the specified virtual template to clone new virtual access interfaces.
To configure a VPDN group to accept dial-in calls, you must also configure the following commands:
•
The protocol command from accept dial-in VPDN subgroup configuration mode
•
•
Note
Typically, you need one VPDN group for each NAS that will be tunneling to the tunnel server. For a tunnel server that services many NASs, the configuration can become cumbersome. If all the NASs will share the same tunnel attributes, you can simplify the configuration by using the default VPDN group configuration, or by creating a VPDN default group template using the vpdn-template command.
The tunnel server can also be configured to request the establishment of Layer 2 Tunnel Protocol (L2TP) dial-out VPDN tunnels to a NAS using the request-dialout command. Dial-in and dial-out calls can use the same L2TP tunnel.
Examples
The following example enables the tunnel server to accept Layer 2 Forwarding (L2F) tunnels from a NAS named router23. A virtual-access interface will be cloned from virtual-template 1.
Router(config)# vpdn-group 1Router(config-vpdn)# accept-dialinRouter(config-vpdn-acc-in)# protocol l2fRouter(config-vpdn-acc-in)# virtual-template 1!Router(config-vpdn)# terminate-from hostname router23The following example configures the router so that tunnels requested by the NAS named router16 are created with the tunnel attributes specified by VPDN group 1, while any other incoming L2TP tunnel request will use the settings configured in the default VPDN group, VPDN group 2:
Router(config)# vpdn-group 1Router(config-vpdn)# accept-dialinRouter(config-vpdn-acc-in)# protocol l2tpRouter(config-vpdn-acc-in)# virtual-template 2!Router(config-vpdn)# terminate-from hostname router16Router(config)# vpdn-group 2! Default L2TP VPDN groupRouter(config-vpdn)# accept-dialinRouter(config-vpdn-acc-in)# protocol l2tpRouter(config-vpdn-acc-in)# virtual-template 3Related Commands
accept-dialout
To create an accept dial-out VPDN subgroup that configures a network access server (NAS) to accept requests from a tunnel server to tunnel Layer 2 Tunneling Protocol (L2TP) dial-out calls, and to enter accept dial-out VPDN subgroup configuration mode, use the accept-dialout command in VPDN group configuration mode. To remove the accept dial-out VPDN subgroup configuration from the virtual private dialup network (VPDN) group, use the no form of this command.
accept-dialout
no accept-dialout
Syntax Description
This command has no arguments or keywords.
Defaults
No accept dial-out VPDN subgroups are configured.
Command Modes
VPDN group configuration
Command History
Usage Guidelines
Use the accept-dialout command on a NAS to configure a VPDN group to accept requests for dial-out VPDN tunnels from a tunnel server. L2TP is the only tunneling protocol that can be used for dial-out VPDN tunnels.
For a VPDN group to accept dial-out calls, you must also configure the following commands:
•
•
•
•
The NAS can also be configured to request the establishment of dial-in VPDN tunnels to a tunnel server using the request-dialin command. Dial-in and dial-out calls can use the same L2TP tunnel.
Examples
The following example configures a VPDN group on the NAS to accept L2TP tunnels for dial-out calls from the tunnel server TS23 using dialer 2 as its dialing resource:
Router(config)# vpdn-group 1Router(config-vpdn)# accept-dialoutRouter(config-vpdn-acc-ou)# protocol l2tpRouter(config-vpdn-acc-ou)# dialer 2!Router(config-vpdn)# terminate-from hostname TS23!Router(config)# interface Dialer2Router(config-if)# ip unnumbered Ethernet0Router(config-if)# encapsulation pppRouter(config-if)# dialer in-bandRouter(config-if)# dialer aaaRouter(config-if)# dialer-group 1Router(config-if)# ppp authentication chapRelated Commands
arap callback
To enable an AppleTalk Remote Access (ARA) client to request a callback, use the arap callback command in global configuration mode. To disable callback requests, use the no form of this command.
arap callback
no arap callback
Syntax Description
This command has no arguments or keywords.
Defaults
Callback requests are not accepted on lines configured for ARA.
Command Modes
Global configuration
Command History
Usage Guidelines
This command enables the router to accept callback requests from ARA clients. You first have to enable AppleTalk routing on the router and then enable automatic ARA startup on the line. You can use this command with either local username authentication or TACACS+ authentication.
Examples
The following example accepts a callback request from an ARA client:
arap callbackRelated Commands
async default routing
To enable the router to pass routing updates to other routers over the AUX port configured as an asynchronous interface, use the async default routing command in interface configuration mode. To disable dynamic addressing, use the no form of this command.
async default routing
no async default routing
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
Use the async default routing command to define the default behavior for router-to-router communication over connections to the AUX port configured as an asynchronous interface. This command is commonly used to enable two routers to communicate over an async dial backup link.
To require a remote user to manually configure routing over connections to the AUX port configured as an asynchronous interface, use the async dynamic routing command.
Examples
The following example enables routing over asynchronous interface 0:
interface async 0async default routingRelated Commands
async dynamic address
To specify dynamic asynchronous addressing, use the async dynamic address command in interface configuration mode. To disable dynamic addressing, use the no form of this command.
async dynamic address
no async dynamic address
Syntax Description
This command has no arguments or keywords.
Defaults
Dynamic addressing is disabled.
Command Modes
Interface configuration
Command History
Usage Guidelines
You can control whether addressing is dynamic (the user specifies the address at the EXEC level when making the connection) or whether default addressing is used (the address is forced by the system). If you specify dynamic addressing, the router must be in interactive mode and the user will enter the address at the EXEC level.
It is common to configure an asynchronous interface to have a default address and to allow dynamic addressing. With this configuration, the choice between the default address or dynamic addressing is made by users when they enter the slip or ppp EXEC command. If the user enters an address, it is used, and if the user enters the default keyword, the default address is used.
Examples
The following example shows dynamic addressing assigned to asynchronous interface six.
interface ethernet 0ip address 10.0.0.1 255.0.0.0interface async 6async dynamic addressRelated Commands
async dynamic routing
To enable manually configured routing on an asynchronous interface, use the async dynamic routing command in interface configuration mode. To disable routing protocols, use the no form of this command; static routing is still used.
async dynamic routing
no async dynamic routing
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
The async dynamic routing command is commonly used to manually bring up PPP from an EXEC session.
Examples
The following example shows how to enable manually configured routing on asynchronous interface 1. The ip tcp header-compression passive command enables Van Jacobson TCP header compression and prevents transmission of compressed packets until a compressed packet arrives from the asynchronous link.
interface async 1async dynamic routing async dynamic addresspeer default IP address 10.1.1.2 ip tcp header-compression passiveA remote user who establishes a PPP or SLIP connection to this asynchronous interface can enable routing by using the /routing switch or the ppp/routing command. However, if you want to establish routing by default on connections to an asynchronous interface, use the async default routing command when you configure the interface.
Related Commands
async mode dedicated
To place a line into dedicated asynchronous mode using Serial Line Internet Protocol (SLIP) or PPP encapsulation, use the async mode dedicated command in interface configuration mode. To return the line to interactive mode, use the no form of this command.
async mode dedicated
no async mode dedicated
Syntax Description
This command has no arguments or keywords.
Defaults
Asynchronous mode is disabled.
Command Modes
Interface configuration
Command History
Usage Guidelines
With dedicated asynchronous network mode, the interface will use either SLIP or PPP encapsulation, depending on which encapsulation method is configured for the interface. An EXEC prompt does not appear, and the router is not available for normal interactive use.
If you configure a line for dedicated mode, you will not be able to use the async dynamic address command because there is no user prompt.
Examples
The following example assigns an IP address to an asynchronous line and places the line into network mode. Setting the stop bits to 1 enhances performance.
interface async 4peer default IP address 172.31.7.51async mode dedicatedencapsulation slipline 20location Joe's computerstopbits 1speed 115200Related Commands
Returns a line that has been placed into dedicated asynchronous network mode to interactive mode, thereby enabling the slip and ppp EXEC commands.
async mode interactive
To return a line that has been placed into dedicated asynchronous network mode to interactive mode, thereby enabling the slip and ppp EXEC commands, use the async mode interactive command in interface configuration mode. To prevent users from implementing Serial Line Internet Protocol (SLIP) and PPP at the EXEC level, use the no form of this command.
async mode interactive
no async mode interactive
Syntax Description
This command has no arguments or keywords.
Defaults
Asynchronous mode is disabled.
Command Modes
Interface configuration
Command History
Usage Guidelines
Interactive mode enables the slip and ppp EXEC commands. In dedicated mode, there is no user EXEC level. The user does not enter any commands, and a connection is automatically established when the user logs in, according to the configuration.
Examples
The following example places asynchronous interface 6 into interactive asynchronous mode:
interface async 6peer default IP address 172.31.7.51async mode interactiveip unnumbered ethernet 0Related Commands
authen-before-forward
To configure a network access server (NAS) to request authentication of a complete username before making a forwarding decision for dial-in Layer 2 Tunnel Protocol (L2TP) or Layer 2 Forwarding (L2F) tunnels belonging to a virtual private dialup network (VPDN) group, use the authen-before-forward command in VPDN group configuration mode. To disable this configuration, use the no form of this command.
authen-before-forward
no authen-before-forward
Syntax Description
This command has no arguments or keywords.
Command Default
L2TP or L2F tunnels are forwarded to the tunnel server without first requesting authentication of the complete username.
Command Modes
VPDN group configuration
Command History
Usage Guidelines
To configure the NAS to perform authentication of dial-in L2TP or L2F sessions belonging to a specific VPDN group before the sessions are forwarded to the tunnel server, use the authen-before-forward command in VPDN group configuration mode.
To configure the NAS to perform authentication of all dial-in L2TP or L2F sessions before the sessions are forwarded to the tunnel server, configure the vpdn authen-before-forward command in global configuration mode.
You must configure a request dial-in VPDN subgroup by issuing the request-dialin command before you can configure the authen-before-forward command. Removing the request-dialin configuration will remove the authen-before-forward command configuration from the VPDN group.
Enabling the authen-before-forward command instructs the NAS to authenticate the complete username before making a forwarding decision based on the domain portion of the username. A user may be forwarded or terminated locally depending on the information contained in the users RADIUS profile. Users with forwarding information in their RADIUS profile are forwarded based on that information. Users without forwarding information in their RADIUS profile are either forwarded or terminated locally based on the Service-Type in their RADIUS profile. The relationship between forwarding decisions and the information contained in the users RADIUS profile is summarized in Table 3.
Examples
The following example configures an L2F request dial-in VPDN subgroup that sends the entire username to the authentication, authorization, and accounting (AAA) server when a user dials in with a username that includes the domain cisco.com:
vpdn-group 1request-dialinprotocol l2fdomain cisco.cominitiate-to ip 10.0.0.1local name router32authen-before-forwardRelated Commands
autocommand
To configure the Cisco IOS software to automatically execute a command when a user connects to a particular line, use the autocommand command in line configuration mode. To disable the automatic execution, use the no form of this command.
autocommand command
no autocommand command
Syntax Description
command
Any appropriate EXEC command, including the host name and any switches that occur with the EXEC command.
Defaults
No commands are configured to execute automatically.
Command Modes
Line configuration
Command History
Usage Guidelines
This command enables you to automatically execute an EXEC command when a user connects to a line.
Examples
The following example forces an automatic connection to a host named host21 (which could be an IP address):
line vty 4 autocommand connect host21autodetect encapsulation
To enable automatic detection of the encapsulation types operating over a point-to-point link to a specified serial or ISDN interface, use the autodetect encapsulation command in interface configuration mode. To disable automatic dynamic detection of the encapsulation types on a link, use the no form of this command.
autodetect encapsulation {lapb-ta | ppp | v120}
no autodetect encapsulation {lapb-ta | ppp | v120}
Syntax Description
lapb-ta
Link Access Procedure, Balanced (LAPB) for an ISDN terminal adapter.
ppp
PPP encapsulation on the interface.
v120
V.120 encapsulation on B channels.
Defaults
No default behavior or values.
Command Modes
Interface configuration
Command History
Usage Guidelines
At least one encapsulation type is required in the command, but you can specify additional encapsulation types.
Use this command to enable the specified serial or ISDN interface to accept calls and dynamically change the encapsulation in effect on the interface when the remote device does not signal the call type. For example, if an ISDN call does not identify the call type in the Lower Layer Compatibility fields and is using an encapsulation that is different from the one configured on the interface, the interface can change its encapsulation type dynamically.
This command enables interoperation with ISDN terminal adapters that use V.120 encapsulation but do not signal V.120 in the call setup message. An ISDN interface that by default answers a call as synchronous serial with PPP encapsulation can change its encapsulation and answer such calls.
Autodetection of LAPB traffic on an ISDN terminal adapter is now possible, by adding the keyword lapb-ta to the command line. This allows recognition of incoming LAPB-TA calls.
Automatic detection is attempted for the first 10 seconds after the link is established or the first five packets exchanged over the link, whichever is first.
Examples
The following example configures BRI 0 to call and receive calls from two sites, use Point-to-Point Protocol (PPP) encapsulation on outgoing calls, and use Challenge Handshake Authentication Protocol (CHAP) authentication on incoming calls. This example also enables BRI 0 to configure itself dynamically to answer calls that use V.120 but that do not signal V.120.
interface bri 0encapsulation pppautodetect encapsulation v120no keepalivedialer map ip 172.17.36.10 name EB1 234dialer map ip 172.17.36.9 name EB2 456dialer-group 1isdn spid1 0146334600isdn spid2 0146334610isdn T200 1000ppp authentication chapThe following example enables the LAPB-TA and V.120 protocols for autodetection on the serial interface after you have configured the virtual terminals to handle asynchronous traffic:
vty-asyncinterface serial0:23autodetect encapsulation lapb-ta v120Related Commands
autohangup
To configure automatic line disconnect, use the autohangup command in line configuration mode. To disable automatic line disconnect, use the no form of this command.
autohangup
no autohangup
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Line configuration
Command History
Usage Guidelines
This command causes the EXEC to issue the exit command when the last connection closes. The autohangup command is useful for the UNIX-to-UNIX Copy Program (UUCP) applications that automatically disconnect lines because UUCP scripts cannot issue the exit command to hang up the telephone.
Examples
The following example enables automatic line disconnect on lines 5 through 10:
line 5 10autohangupautoselect
To configure a line to start an Appletalk Remote Access (ARA), PPP, or Serial Line Internet Protocol (SLIP) session, use the autoselect command in line configuration mode. To disable this function on a line, use the no form of this command.
autoselect {arap | ppp | slip | during-login | timeout seconds}
no autoselect [timeout]
Syntax Description
Defaults
ARA session
No timeout default
Command Modes
Line configuration
Command History
10.3
This command was introduced.
11.3
The following keywords were added:
•
•
•
Usage Guidelines
This command eliminates the need for users to enter an EXEC command to start an ARA, PPP, or SLIP session.
Note
The autoselect command configures the Cisco IOS software to identify the type of connection being requested. For example, when a user on a Macintosh running ARA selects the Connect button, the Cisco IOS software automatically starts an ARAP session. If, on the other hand, the user is running SLIP or PPP and uses the autoselect ppp or autoselect slip command, the Cisco IOS software automatically starts a PPP or SLIP session, respectively. This command is used on lines making different types of connections.
A line that does not have autoselect configured views an attempt to open a connection as noise. The router does not respond and the user client times out.
When a timeout period is configured and the initial sample byte is not received before that timeout period, a default EXEC process (if configured) is initiated.
Note
Examples
The following example enables ARA on a line:
line 3arap enableautoselect arapThe following example enables a timeout of 30 seconds on a PPP-enabled line:
line 7autoselect pppautoselect timeout 30The following example enables ARA on a line and allows logins from users with a modified CCL script and an unmodified script to log in:
line 3arap enableautoselect arapautoselect during-loginarap noguest if-neededRelated Commands
backup
To configure an IP backup endpoint address, enter the backup command in VPDN group configuration mode. To remove this function, use the no form of this command.
backup ip ip-address [limit number [priority number]]
no backup ip ip-address [limit number [priority number]]
Syntax Description
Defaults
No default behavior or values. This function is used only if it is configured.
Command Modes
VPDN group configuration
Command History
12.0(4)XI
This command was introduced on the following platforms only: Cisco AS5200 and Cisco AS5300.
Usage Guidelines
Use the backup VPDN group configuration command to configure an IP backup endpoint address.
Examples
The following examples show that the backup command is not available in the command line interface until you enter the request-dialin command:
Router(config)# vpdn-group customer1-vpdngroupRouter(config-vpdn)# ?VPDN group configuration commands:accept-dialin VPDN accept-dialin group configurationaccept-dialout VPDN accept-dialout group configurationdefault Set a command to its defaultsdescription Description for this VPDN groupexit Exit from VPDN group configuration modeip IP settings for tunnelno Negate a command or set its defaultsrequest-dialin VPDN request-dialin group configurationrequest-dialout VPDN request-dialout group configurationsource-ip Set source IP address for this vpdn-groupRouter(config-vpdn)# request-dialin l2tp ip 10.2.2.2 domain customerxRouter(config-vpdn)#?VPDN group configuration commands:backup Add backup addressdefault Set a command to its defaultsdnis Accept a DNIS tunneldomain Accept a domain tunnelexit Exit from VPDN group configuration modeforce-local-chap Force a CHAP challenge to be instigated locallyl2tp L2TP specific commandslcp LCP specific commandsloadsharing Add loadsharing addresslocal local information, like namemultilink Configure limits for Multilinkno Negate a command or set its defaultsrequest Request to open a tunnelThe following example shows an IP backup endpoint address of 10.1.1.1 configured with a backup session limit of 5:
Router(config-vpdn)# backup ip 10.1.1.1 limit 5Related Commands
backup delay
To define how much time should elapse before a secondary line status changes after a primary line status has changed, use the backup delay command in interface configuration mode. To return to the default so that as soon as the primary fails, the secondary is immediately brought up without delay, use the no form of this command.
backup delay {enable-delay-period | never} {disable-delay-period | never}
no backup delay {enable-delay-period | never} {disable-delay-period | never}
Syntax Description
Defaults
0 seconds
Command Modes
Interface configuration
Command History
Usage Guidelines
For environments in which spurious signal disruptions appear as intermittent lost carrier signals, we recommend that you enable some delay before activating and deactivating a secondary line.
Examples
The following example sets a 10-second delay on deactivating the secondary line (serial interface 0); however, the line is activated immediately.
interface serial 0backup delay 0 10backup interface
To configure an interface as a secondary or dial backup, use the backup interface command in interface configuration mode. To disable this feature, use the no form of this command.
Cisco 7200 Series and Cisco 7500 Series Routers Only
backup interface slot/port-adapter/port
no backup interface slot/port-adapter/port
Other Cisco Routers
backup interface interface-type interface-number
no backup interface interface-type interface-number
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
The interface you define with this command can back up only one other interface.
Examples
The following example sets serial 1 as the backup line to serial 0:
interface serial 0backup interface serial 1backup interface dialer
To configure a dialer interface as a secondary or dial backup, use the backup interface dialer command in interface configuration mode. To disable this feature, use the no form of this command.
backup interface dialer number
no backup interface dialer number
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
Multiple dialer interfaces can use the same dialer pool, which might have a single ISDN interface as a member. Thus, that ISDN interface can back up different serial interfaces and can make calls to different sites.
Examples
The following example shows the configuration of a site that backs up two leased lines using one BRI. Two dialer interfaces are defined. Each serial (leased line) interface is configured to use one of the dialer interfaces as a backup. Both of the dialer interfaces use dialer pool 1, which has BRI 0 as a member. Thus, BRI 0 can back up two different serial interfaces and can make calls to two different sites.
interface dialer0ip unnumbered loopback0encapsulation pppdialer remote-name Remote0dialer pool 1dialer string 5551212dialer-group 1interface dialer1ip unnumbered loopback0encapsulation pppdialer remote-name Remote1dialer pool 1dialer string 5551234dialer-group 1interface bri 0encapsulation PPPdialer pool-member 1ppp authentication chapinterface serial 0ip unnumbered loopback0backup interface dialer 0backup delay 5 10interface serial 1ip unnumbered loopback0backup interface dialer 1backup delay 5 10backup load
To set a traffic load threshold for dial backup service, use the backup load command in interface configuration mode. To return to the default value, use the no form of this command.
backup load {enable-threshold | never} {disable-load | never}
no backup load {enable-threshold | never} {disable-load | never}
Syntax Description
Defaults
No threshold is defined.
Command Modes
Interface configuration
Command History
Usage Guidelines
When the transmitted or received load on the primary line is greater than the value assigned to the enable-threshold argument, the secondary line is enabled.
The secondary line is disabled when one of the following conditions occurs:
•
•
If the never keyword is used instead of an enable-threshold argument, the secondary line is never activated because of traffic load. If the never keyword is used instead of a disable-load argument, the secondary line is never activated because of traffic load.
Examples
The following example sets the traffic load threshold to 60 percent of the primary line serial 0. When that load is exceeded, the secondary line is activated and will not be deactivated until the combined load is less than 5 percent of the primary bandwidth.
interface serial 0backup load 60 5backup interface serial 1busyout
To inform a central-office switch that a channel is out-of-service, and to busyout an entire card on a dial shelf and remove it from dial services, use the busyout command in privileged EXEC mode. To cancel busyout, use the no form of this command.
busyout shelf/slot/port
no busyout shelf/slot/port
Syntax Description
shelf/slot/port
Shelf number, slot number, and port number. You must type in the forward slashes (/).
Defaults
Busyout is disabled.
Command Modes
Privileged EXEC
Command History
11.3(2)AA
This command was introduced and supported T1 and T3 only.
12.0
This command was enhanced to support E1 and DMM HMM (Double Modem Module [12] Hex Modem Module [6]).
Usage Guidelines
This command does not terminate an existing call; instead, after you hang up or end a call, a new call cannot be established on a channel that has received a busyout command instruction.
Use the busyout command before you remove a card from a shelf. The maintenance LED on the card goes ON after all the channels (or calls) have been terminated. The ON LED indicates that it is safe to remove the card from the shelf.
Use this command to busyout digital signal level 0s (DS0s) on a trunk card or all modems on a modem card.
To busyout an individual DS0, use the ds0 busyout controller configuration command.
To display the busyout information, use the show busyout privileged EXEC command.
Restrictions
If the trunk card is using ISDN signalling, there is a limit on the amount of traffic that the exchange can accept on the signalling channel. The restrictions are as follows:
•
•
Examples
The following example enables busyout on the card in dial shelf 5, slot 4:
busyout 5/4Related Commands
busyout (port)
To disable a port by waiting for the active services on the specified port to terminate, use the busyout command in port configuration mode. To re-enable the ports, use the no form of this command.
busyout
no busyout
Syntax Description
This command has no arguments or keywords.
Defaults
Busyout is not enabled.
Command Modes
Port configuration
Command History
12.1(1)XD
This command was introduced on the Cisco AS5400.
12.1(3)T
This command was implemented on the Cisco AS5800.
Usage Guidelines
The busyout command disables a port by waiting for the active services on the specified port to terminate. Use the no form of this command to re-enable the ports.
Examples
The following example shows how to configure the busyout command on a Cisco AS5400 with NextPort DFC. This example busies out ports 1 to 10 on slot 1:
port 1/1 1/10busyoutRelated Commands
Resets the NextPort port and clears any active call.
Reboots all specified SPEs.
Disables a port.
Displays SPE status.
busyout (spe)
To disable active calls on the specified Service Processing Elements (SPEs), use the busyout command in SPE configuration mode. To re-enable the SPEs, use the no form of this command.
busyout
no busyout
Syntax Description
This command has no arguments or keywords.
Defaults
Busyout is not enabled.
Command Modes
SPE configuration
Command History
12.1(1)XD
This command was introduced on the Cisco AS5400.
12.1(3)T
This command was implemented on the Cisco AS5800.
Usage Guidelines
You can perform auto-diagnostic tests and firmware upgrades when you put the SPEs in the Busiedout state. Active ports on the specified SPE will change the state of the specified range of SPEs to the BusyoutPending state. The state changes from BusyoutPending to Busiedout when all calls end. Use the show spe command to see the state of the range of SPEs. Use the shutdown command to override the busyout command. Use the no busyout command to re-enable the SPEs.
Examples
The following example shows output from the busyout command on the Cisco AS5400 with NextPort DFC. This example busies out all active ports in slot 1, SPE 1 to 10:
spe 1/1 1/10busyoutRelated Commands
Resets the NextPort port and clears any active call.
Reboots all specified SPEs.
Disables a port.
Displays SPE status.
call progress tone country
To specify the country code for retrieving the call progress tone parameters from the call progress tone database, use the call progress tone country command in global configuration mode. To cancel the previous setting and to generate the call progress tones according to modem settings, use the no version of this command.
call progress tone country country-name
no call progress tone country country-name
Syntax Description
Defaults
Default modem settings. (The country-name keyword northamerica was the default in Cisco IOS Releases earlier than release 12.0(3)XG; usa is the default country keyword for Cisco IOS Release 12.0(3)XG and later releases.)
Command Modes
Global configuration
Command History
12.0(3)XG
This command was introduced.
12.0(4)XI
This command was enhanced with additional country keywords.
Usage Guidelines
Use the call progress tone country configuration to specify the country for call progress tone generation. While in many cases the country is chosen automatically on the basis of the modem setting, automatic selection does not work for all users because many modems do not support all countries and many users choose the "us" or "default-t1" or "default-e1" setting on their modem.
This command affects the tones generated at the local interface and does not affect any information passed to the remote end of a connection or any tones generated at the remote end of a connection.
For dial platforms (AS5200, AS5300, and AS5800), call progress tones are used only for the resource pool management application. Resource pool management assumes that the call progress tone selection is global. Select only one call progress tone set, and it will globally override country settings on all ports.
Examples
The following example shows the call progress tone set for Japan tone parameters:
call progress tone country japanRelated Commands
callback forced-wait
To force the Cisco IOS software to wait before initiating a callback to a requesting client, use the callback forced-wait command in global configuration mode. To disable the forced waiting period, use the no form of this command.
callback forced-wait
no callback forced-wait
Syntax Description
This command has no arguments or keywords.
Defaults
The forced waiting period is not set.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command when the router is calling back a modem that initiated a call, then dropped the connection, but requires a rest period before subsequent input is accepted.
Examples
The following example sets a waiting period during which a callback chat script is delayed from being sent on an outgoing target line:
callback forced-waitRelated Commands
callback nodsr-wait
To set the time period for which an asynchronous callback waits to see the DSR signal go low after the router signals a hang-up request on the incoming call, use the callback nodsr-wait command in line configuration mode. To negate or change the line setting, use the no form of this command.
callback nodsr-wait milliseconds
no callback nodsr-wait
Syntax Description
milliseconds
The timeout value in a range from 5000 to 30,000 milliseconds (ms). Default is 5000 ms.
Defaults
5000 ms
Command Modes
Line configuration
Command History
Usage Guidelines
Use the callback nodsr-wait command when the dial-out modem takes longer than 5000 ms to drop a carrier after the router signals a hang-up on the incoming call.
Increase the duration of the callback if the debug callback command displays the following failed callback attempt message:
callback process fail - timeout with DSR up
Examples
The following example sets the callback duration to 10 seconds for lines 1/0 to 1/107:
line 1/0 1/107callback nodsr-wait 10000Related Commands
called-number (modem pool)
To assign a called party number to a pool of modems, use the called-number command in modem pool configuration mode. To remove a number from a modem pool, use the no form of this command.
called-number number [max-conn number]
no called-number number [max-conn number]
Syntax Description
number
Called number for a modem pool.
max-conn number
(Optional) Maximum number of simultaneous connections allowed for the called party number.
Defaults
Disabled
Command Modes
Modem pool configuration
Command History
Usage Guidelines
A called party number is a telephone number that is used to reach a remote destination. For example, a mobile laptop dials a called party number to reach the POP of an ISP. Some ISPs set up several called party numbers to enable remote clients to dial in, but to the end user, it appears and functions as one unified service.
Cisco's implementation of a called party number is based on the dialed number identification service (DNIS). You can configure multiple DNIS numbers in a single modem pool. However, the same DNIS number cannot be used in multiple modem pools. Each modem pool must be assigned different DNIS numbers.
Use the max-conn option to provide overflow protection, which specifies a maximum number of simultaneous connections that a called party number can consume. For example, if you create one modem pool to serve two or more services or customers, this option guarantees how many modems each service or customer can have access to at any given time.
The Cisco IOS software also includes a feature that simplifies the called number configuration. By using an x variable as the last digit in a called telephone number (for example, issuing the called-number 408555121x command), clients dialing different called numbers such as 4085551214 or 4085551215 will automatically be sent to the same modem pool. The x variable is a floating place holder for digits 1 through 9.
Note
Examples
In the following example, the modem pool called v90service is virtually partitioned between two customers using different DNIS numbers. The pool-range command assigns modems 1 to 110 to the shared modem pool. The called-number 5551212 max-conn 55 command assigns the DNIS number 5551212 to the v90service modem pool. The total number of simultaneous connections is limited to 55. The called-number 4441212 max-conn 55 command assigns the DNIS number 4441212, which is for a different customer, to the same v90service modem pool. The total number of simultaneous connections is also set to 55.
modem-pool v90servicepool-range 1-110called-number 5551212 max-conn 55called-number 4441212 max-conn 55The following configuration rejects the pool-range 30 command because modem TTY line 30 is already a member of the modem pool v90service, which was configured in the previous example. Each modem in the access server is automatically assigned to a unique TTY line. TTY line numbers are assigned according to your shelf, slot, or port hardware configuration.
modem-pool v34service# pool-range 30Related Commands
calltracker call-record
To enable call record SYSLOG generation for the purpose of debugging, monitoring, or externally saving detailed call record information, use the calltracker call-record command in global configuration mode. To disable call record SYSLOG generation, use the no form of this command.
calltracker call-record {terse | verbose} [quiet]
no calltracker call-record {terse | verbose} [quiet]
Syntax Description
Defaults
Call Tracker call record logging is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
SYSLOG call records will be generated in the order of ten seconds of call termination. A small delay is needed to ensure that all subsystems finish reporting all appropriate information on call termination. Furthermore, the process of logging is considered a very low priority with respect to normal call processing and data routing. As such, logging all call records can be guaranteed if Call Tracker is properly configured. However, the delay from the time a call actually terminated can vary if the CPU is busy handling higher-priority processes.
Call Tracker records must be found within the History table for at least one minute after call termination for this capability to work. As such, one must ensure that Call Tracker history collection is not disabled with the calltracker history configuration options.
Because the call rates possible on a high-capacity access server can be rather large and the information provided by the call records is substantial, simply enabling normal SYSLOG call records can make the use of the console difficult. As such, by using the quiet option and having a SYSLOG server configured to capture the call records, the console can be freed from displaying any call records, yet still have the call records captured by a SYSLOG server.
The following informational logs are available:
•
•
•
•
•
Examples
The following example reports the Verbose Call Records for a normal modem call termination:
*Nov 16 18:30:26.097: %CALLTRKR-3-CALL_RECORD: ct_hndl=5, service=PPP, origin=Answer, category=Modem, DS0 slot/cntr/chan=0/0/22, called=71071, calling=6669999, resource slot/port=1/0, userid=maverick5200, ip=192.9.1.2, mask=255.255.255.0, account id=5, setup=10/16/1999 18:29:20, conn=0.10, phys=17.12, srvc=23.16, auth=23.16, init-rx/tx b-rate=31200/33600, rx/tx chars=246/161, time=53.50, disc subsys=ModemDrvr, disc code=0xA220, disc text= Rx (line to host) data flushing - not OK/EC condition - locally detected/received DISC frame -- normal LAPM termination*Nov 16 18:30:26.097: %CALLTRKR-3-MODEM_CALL_REC: ct_hndl=5, prot: last=LAP-M, attempt=LAP-M, comp: last=V.42bis-Both, supp= V.42bis-RX V.42bis-TX, std: last=V.34+, attempt=V.34+, init=V.34+, snr=38, sq=3, rx/tx: chars=246/161, ec: rx/tx=22/12, rx bad=46, rx/tx b-rate: last=33600/33600, low=31200/33600, high=33600/33600, desired-client=33600/33600, desired-host=33600/33600, retr: local=0, remote=0, fail=0, speedshift: local up/down=1/0, remote up/down=0/0, fail=0, v90: stat=No Attempt, client=(n/a), fail=None, time(sec)=52, disc reason=0xA220*Nov 16 18:30:26.101: %CALLTRKR-3-MODEM_LINE_CALL_REC: ct_hndl=5, rx/tx levl=-17/-16, phase-jit: freq=0, levl=0, far-end echo-levl=-71, freq offst=0, phase-roll=-98, round-trip=1, d-pad=None, d-pad comp=0, rbs=0, const=16, rx/tx: sym-rate=3429/3429, carr-freq=1959/1959, trel-code=0/0, preemph-index=6/0, rx/tx: const-shape=Off/On, nonlin-encode=Off/On, precode=Off/On, xmit levl-reduct=2/3, shape=0x1920212120202120202020202020202020202020201F1D191100*Nov 16 18:30:26.101: %CALLTRKR-3-MODEM_INFO_CALL_REC: ct_hndl=5, general info=0x0, rx/tx link-layer=264/182, NAKs=0/0, rx/tx ppp-slip=5/7, bad ppp-slip=0, proj max rx b-rate: client=19200, host=24000, rx/tx: max neg I frame=128/128, neg window=15/15, T401 timeouts=1, tx window closures=0, rx overruns=0, retrans frames=0, v110: rx good=0, rx bad=0, tx=0, sync-lost=0, ss7/cot=0x00, v42bis size: dict=1024, test err=0, reset=0, v0 synch-loss=0, mail lost: host=0, sp=0, diag=0x00000000000000000000000000000000*Nov 16 18:30:26.101: %CALLTRKR-3-MODEM_NEG_CALL_REC: ct_hndl=5, v8bis cap=0x00000000000000000000000000000000000000000000, v8bis mod-sl=0x00000000000000000000000000000000000000000000, v8 jnt-menu=0x01E0C14513942A000000000000000000000000000000, v8 call-menu=0x01C14513942A00000000000000000000000000000000, v90 train=0x00000000, v90 sgn-ptrn=0x00000000, state trnsn=0x000102030410204042430451FF00000000000000000000000000000000000000, phase2=0x010000F4EF221FF37E0001E4EFA21FF2E30001A4EF980101B7CF98003C0000000034EF40000502160 AE0301FFFFE1C07A707A70D650D6500Related Commands
calltracker enable
To enable Call Tracker on the access server, use the calltracker enable command in global configuration mode. To restore the default condition, use the no form of this command.
calltracker enable
no calltracker enable
Syntax Description
This command has no arguments or keywords.
Defaults
Call Tracker is not enabled.
Command Modes
Global configuration
Command History
Usage Guidelines
To enable real-time call statistics from the MICA technologies modem to Call Tracker, you must configure the modem link-info poll time command.
Examples
The following shows how to enable the Call Tracker feature:
calltracker enablecalltracker history max-size numbercalltracker history retain-mins minutescalltracker call-record tersesnmp-server packetsize byte-countsnmp-server queue-length lengthsnmp-server enable traps calltrackersnmp-server host host community-string calltrackerRelated Commands
calltracker history max-size
To set the maximum number of call entries stored in the Call Tracker history table, use the calltracker history max-size command in global configuration mode. To restore the default value, use the no form of this command.
calltracker history max-size number
no calltracker history max-size number
Syntax Description
Defaults
The default maximum is dynamically calculated to be 1 times the maximum DS0 supported on a platform.
Command Modes
Global configuration
Command History
Usage Guidelines
Be careful when extending the maximum number of call entries stored in the Call Tracker history table, as this activity causes Call Tracker to use more memory resources to store the additional call data. Network access server memory consumption must be considered when increasing this parameter. The active call table is not affected by this command.
Examples
The following example sets the history table size to 50 calls:
calltracker history max-size 50Related Commands
calltracker history retain-mins
To set the number of minutes for which call entries are stored in the Call Tracker history table, use the calltracker history retain-mins command in global configuration mode. To restore the default value, use the no form of this command.
calltracker history retain-mins minutes
no calltracker history retain-mins minutes
Syntax Description
minutes
The length of time to store calls in the Call Tracker history table. The valid range is from 0 through 26,000 minutes. A value of 0 prevents any history from being saved.
Defaults
The default number of minutes is 5000.
Command Modes
Global configuration
Command History
Usage Guidelines
Active calls are not affected by this command. Entries in the active table are retained as long as the calls are connected.
Examples
The following example sets the retention time for the history table to 5000 minutes:
calltracker history retain-mins 5000Related Commands
calltracker timestamp
To display the millisecond value of the call setup time in the Call Record (CDR) on the access server, use the calltracker timestamp command in global configuration mode. To restore the default value, use the no form of this command.
calltracker timestamp msec
no calltracker timestamp msec
Syntax Description
This command has no arguments or keywords.
Defaults
The default value of the call setup time does not contain milliseconds. It is in the hh:mm:ss form.
Command Modes
Global configuration
Command History
Usage Guidelines
This AS5400 command is used to add a milliseconds timestamp (hh:mm:ss.ms) to call detail records. These call records of originating and terminating calls are written to flat files on the subscriber server. These files may be passed periodically from the subscriber to the publisher server. Third party applications such as billing and accounting use CDR data.
All calltracker commands (including calltracker timestamp) are only supported for dial services and not for voice.
Examples
The following configuration example shows calltracker options and a display of calltracker active including timestamp.
u5400#configure tEnter configuration commands, one per line. End with CNTL/Z.u5400(config)#calltracker ?call-record Generate a SYSLOG Call Record at end of callenable start calltrackerhistory Aspects of the CT History Tabletimestamp CDR timestamp configu5400(config)#calltracker timestamp ?msec Shows millisecond value in timestampu5400(config)#calltracker timestamp msec ?<cr>u5400#show call calltracker active-------------------------- call handle = 206 -------------------------------status-Active, service=PPP, origin=Anser, category-ModemDSO slot/port/dsl/chan=7/0/0/19, called=40852 68222,calling=(n/a)userid=myusername, ip=10.1.1.2, mask=10.1.1.2setup=08/05/2003 19.04.41.645, conn=0.01,phys=23.73,service=16.33,authen=26.33init rx/tx b-rate=28800/28800,rx/tx chars=0/0resource slot/port=4/97, mp bundle=0,charged units=0,accontid=198ibd handle=0x0,tty handle=0x63B4F010,tcb handle=0x0Related Commands
call-type
To reject particular types of calls, use the call-type command in call discriminator profile configuration mode. To disable this feature, use the no form of this command.
call-type {all | digital | speech | v110 | v120}
no call-type {all | digital | speech | v110 | v120}
Syntax Description
Defaults
All calls are accepted by the network access server.
Command Modes
Call discriminator profile configuration
Command History
Usage Guidelines
Use the call-type call discriminator command to reject particular types of calls. Call type "all" is mutually exclusive for all other call types. If call type "all" is set in the discriminator, no other call types are allowed. Also, once a DNIS is associated with a call type in a discriminator, it cannot be used in any other discriminator.
Examples
The following example shows the call discriminator being configured to reject speech calls for the call discriminator profile named userd3:
resource-pool profile discriminator userd3call-type speechcall-type cas
To statically set the call-type override for incoming channel-associated signalling (CAS) calls, use the call-type cas command in DNIS group configuration mode. To disable this service, use the no form of this command.
call-type cas {digital | speech}
no call-type cas {digital | speech}
Syntax Description
Defaults
No default behavior or values.
Command Modes
DNIS group configuration
Command History
Usage Guidelines
Use the call-type cas DNIS group configuration command to set the call-type override. From the resource pooling call-type perspective, use CT1 (CAS) to support either analog calls (speech) or digital calls (switched 56K).
Switched 56K calls are digital calls that connect to High-Level Data Link Control (HDLC) framers. Unlike ISDN, it is impossible to communicate the call type in CT1. Therefore, switched 56K services in CT1 can be differentiated by the DNIS numbers. This command identifies that the call arriving with the DNIS in the DNIS group is assigned to the call type specified in the command.
Examples
The following example shows the DNIS group configuration mode being accessed to use the call-type cas command to set the call type override for CAS to speech:
dialer dnis group modem-group1call-type cas speechcas-custom
To customize signalling parameters for a particular E1 or T1 channel group on a channelized line, use the cas-custom command in controller configuration mode. To disable the signalling customization, use the no form of this command.
cas-custom channel
no cas-custom channel
Syntax Description
Defaults
No customized signalling parameters are set. If you do not specify a country name using the country name command, which is described in Table 4, ITU is the selected default signal.
Command Modes
Controller configuration
Command History
Usage Guidelines
The customization parameters set by the cas-custom channel command are applied to the same channel group number used in the cas-group channel timeslots range type signal command. These channel group numbers must match. Otherwise, the customized features specified by the cas-custom command will not be applied to the cas-group command's configuration. The signalling customization will not take effect. See Example 3 (E1).
However, you will not need to configure or set more than one channel group number per E1 line in most cases. Though rarely used, it is possible to split a single E1 (time slots 1 to 31) into two groups (for example, 1 to 15 on group 1 and time slots 17 to 31 in group 2).
Cisco strongly recommends that you use the optional use-defaults keyword when specifying a particular country type; see the country name command in Table 4. This additional keyword ensures that all the local country settings are correctly enabled. For example, issue the country greece use-defaults command. If the use-defaults option is not specified, generic ITU will be the default setting for all countries. See Example 4 (Localized E1 R2).
You can configure the system to deviate from a country's default settings as defined by Cisco. To do this, choose from the following list of commands described in Table 4: ani-digits min number max number, answer-signal {group-a | group-b} number, caller-digits number, category number, dnis-digits min number max number, invert-abcd, ka number, kd number, metering, nc-congestion, and unused-abcd value. To return a country back to its country specific default settings, issue the country name use-defaults command. To return a country back to the ITU standard, issue the default country name use-defaults command. See Example 4 (Localized E1 R2) and Example 6 (E1 R2 Country Defaults).
Note
Table 4 shows a list of command options in cas-custom mode, which is used to customize R2 signalling settings.
Examples
Example 1 (T1)
The following example enables this feature on channel 1:
Router(config)# controller T1 1/0/1Router(config-controller)# cas-custom 1Example 2 (E1 on AS5800)
The following example displays the available signaling parameters after you enter cas-custom mode. Notice that the same channel group 1 is specified in the ds0-group command and the cas-custom command.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/ZRouter(config)# controller e1 1/0/1Router(config-controller)# ds0-group 1 timeslots 1-31 type r2-digital r2-compelledRouter(config-controller)# cas-custom 1Router(config-ctrl-cas)# ?CAS custom commands:ani-digits Expected number of ANI digitsanswer-signal Answer signal to be usedcaller-digits Digits to be collected before requesting CallerIDcategory Category signalcountry Country Namedefault Set a command to its defaultsdnis-digits Expected number of DNIS digitsexit Exit from cas custom modeinvert-abcd invert the ABCD bits before tx and after rxka KA Signalkd KD Signalmetering R2 network is sending metering signalnc-congestion Non Compelled Congestion signalno Negate a command or set its defaultsunused-abcd Unused ABCD bit valuesExample 3 (E1)
The following example displays the available signalling parameters after you enter cas-custom mode. Notice that the same channel group 1 is specified in the cas-group command and the cas-custom command.
Router(config)# controller e1 1Router(config-controller)# cas-group 1 timeslots 1-31 type r2-digital r2-compelledRouter(config-controller)# cas-custom 1Router(config-ctrl-cas)# ?CAS custom commands:ani-digits Expected number of ANI digitsanswer-signal Answer signal to be usedcaller-digits Digits to be collected before requesting CallerIDcategory Category signalcountry Country Namedefault Set a command to its defaultsdnis-digits Expected number of DNIS digitsexit Exit from cas custom modeinvert-abcd invert the ABCD bits before tx and after rxka KA Signalkd KD Signalmetering R2 network is sending metering signalnc-congestion Non Compelled Congestion signalno Negate a command or set its defaultsunused-abcd Unused ABCD bit valuesExample 4 (Localized E1 R2)
You can localize your R2 configuration for a specific country. Do not forget to include the use-defaults option as described in Table 4. For example, use the country argentina use-defaults command for a R2 scenario in Argentina.
Router(config-ctrl-cas)# country ?argentina Argentinaaustralia Australiabolivia Boliviabrazil Brazilbulgaria Bulgariachina Chinacolombia Colombiacostarica Costa Ricacroatia Croatiaeasteurope East Europeecuador-itu Ecuador ITUecuador-lme Ecuador LMEgreece Greeceguatemala Guatemalahongkong-china Hong Kong (China variant)india Indiaindonesia Indonesiaisrael Israelitu ITUkorea Korealaos LAOS Network (Thailand Variant)malaysia Malaysiamalta Maltanewzealand New Zealandparaguay Paraguayperu Peruphilippines Philippinessaudiarabia Saudi Arabiasingapore Singaporesouthafrica-panaftel South Africa Panafteltelmex Telmextelnor Telnorthailand Thailanduruguay Uruguayvenezuela Venezuelavietnam VietnamRouter(config-ctrl-cas)# country argentina ?use-defaults Use Country defaults<cr>Router(config-ctrl-cas)# country argentina use-defaultsExample 5 (Collect ANI Digits)
The following example customizes the signalling for channel group 1. The configuration collects three digits before it requests ANI information for analog calls received on a Cisco AS5800 in Argentina.
Router(config)# cas-custom 1Router(config-ctrl-cas)# country argentina use-defaultsRouter(config-ctrl-cas)# caller-digits 3Router(config-ctrl-cas)# ^zExample 6 (E1 R2 Country Defaults)
Because cas-custom mode gives you the flexibility to customize R2 parameters, the margin for user error increases. Therefore, the Cisco IOS software enables you to return a country back to its default R2 settings using the use-defaults option. The following configuration brings up the Argentina default settings, changes a few customization parameters, then returns the Argentina R2 setting back to its original state.
Router(config-ctrl-cas)# country argentina use-defaultsRouter(config-ctrl-cas)# caller-digits 3Router(config-ctrl-cas)# unused-abcd 1Router(config-ctrl-cas)# meteringRouter(config-ctrl-cas)# country argentina use-defaultsRelated Commands
cas-group (E1 controller)
To configure channel-associated signalling (CAS) on an E1 controller, use the cas-group command in controller configuration mode. To disable CAS for one or more time slots, use the no form of this command.
cas-group channel timeslots range type signal
no cas-group channel timeslots range type signal
Syntax Description
Defaults
No CAS is configured on the controller. All R2 signalling types have DNIS turned on by default.
Command Modes
Controller configuration
Command History
11.2 P
This command was introduced.
12.0(1)T
This command was implemented on the Cisco 3600 series.
Usage Guidelines
Use this command to configure support for incoming and outgoing call signals (such as on-hook and off-hook) on each E1 controller.
If you specify the time slot range 1-31, the system software automatically uses the 16th time slot to transmit the channel associated signalling.
The signalling you configure on the access server must match the signalling used by the central office. For example if the central office switch is forwarding R2 analog signalling to a Cisco AS5800, then the access server's E1 controller must also be configured for R2 analog signalling (r2-analog).
All R2 signalling options have DNIS support turned on by default. If you enable the ani option, the collection of DNIS information is still performed. Specifying the ani option does not disable DNIS. DNIS is the number being called. ANI is the caller's number. For example, if you are configuring router A to call router B, then the DNIS number is router B, the ANI number is router A. ANI is very similar to Caller ID.
To customize the R2 signalling parameters, refer to the cas-custom controller configuration command. When you enable the cas-group command, the cas-custom command is automatically setup to be polled for configuration information. However, unless you enable or turn on specific features with the cas-custom command, the cas-custom feature has an empty set of signalling parameters.
Note
DNIS is automatically collected for modem pools and R2 tone signalling. You do not need to specify the collection of DNIS information with the cas-group command. However, if you are using non-R2 tone signalling, the system must be manually configured to collect DNIS information. For non-R2 cas signalling, DNIS collection is done only for E&M-fgb.
Examples
In most cases, you will configure the same channel-associated signalling on each E1 controller. The following examples configure signalling and customized parameters on controller E1 2 using the cas-group and cas-custom controller configuration commands.
The following example configures the E1 controller on a Cisco 5800 series access server.
To configure a Cisco 3600 series access server, replace the command:controller e1 2/1/0
with the command:
controller e1 2
Note
Router(config-controller)# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config-controller)# controller e1 2/1/0Router(config-controller)# cas-group 1 timeslots 1-31 type r2-digital r2-compelled ani%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 1 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 2 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 3 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 4 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 5 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 6 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 7 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 8 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 9 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 10 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 11 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 12 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 13 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 14 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 15 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 17 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 18 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 19 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 20 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 21 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 22 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 23 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 24 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 25 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 26 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 27 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 28 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 29 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 30 is up%DSX0-5-RBSLINEUP: RBS of controller 0 timeslot 31 is upThe following example shows all the supported E1 signalling types on a Cisco AS5800:
Router(config-controller)# cas-group 1 timeslots 1-31 type ?e&m-fgb E & M Type II FGBe&m-fgd E & M Type II FGDe&m-immediate-start E & M Immediate Startfxs-ground-start FXS Ground Startfxs-loop-start FXS Loop Startp7 P7 Switchr2-analog R2 ITU Q411r2-digital R2 ITU Q421r2-pulse R2 ITU Supplement 7sas-ground-start SAS Ground Startsas-loop-start SAS Loop StartRouter(config-controller)# cas-group 1 timeslots 1-31 type r2-analog ?dtmf DTMF tone signalingr2-compelled R2 Compelled Register signalingr2-non-compelled R2 Non Compelled Register signalingr2-semi-compelled R2 Semi Compelled Register signaling<cr>R2 signalling parameters can be customized with the cas-custom controller configuration command:
Router(config-controller)# cas-custom 1?CAS custom commands:caller-digits Digits to be collected before requesting CallerIDcategory Category signalcountry Country Namedefault Set a command to its defaultsexit Exit from cas custom modeinvert-abcd invert the ABCD bits before tx and after rxmetering R2 network is sending metering signalnc-congestion Non Compelled Congestion signalno Negate a command or set its defaultscas-group (T1 controller)
To configure channelized T1 time slots with robbed-bit signalling, and R1 channel-associated signalling, use the cas-group command in controller configuration mode. To disable signalling for one or more time slots, use the no form of this command.
Cisco AS5200, Cisco AS5300, and Cisco AS5800 Series Access Servers
cas-group channel timeslots range type signal
no cas-group channel timeslots range type signal
R1 Channel-Associated Signalling
cas-group channel timeslots range type r1-modified {ani-dnis | dnis}
no cas-group channel timeslots range type r1-modified {ani-dnis | dnis}
Syntax Description
Defaults
For ISDN PRI, the cas-group command is disabled.
If the channelized T1 is not configured as a PRI, the default value for line signalling is e&m-fgb and the default value for tone signalling is DTMF.
The R1 signalling default value is ani-dnis.
Command Modes
Controller configuration
Command History
11.2
This command was introduced.
11.3 T
The following signalling keywords were added:
•
•
•
The R1 keyword was added.
Usage Guidelines
Use the cas-group command to configure T1 controllers with different types of robbed-bit signalling, such as on-hook and off-hook for E&M feature group B (e&m-fgb).
If you want to collect DNIS information on a T1 controller, you must manually configure it on the access server. DNIS collection is performed only for E&M-fgb. To collect DTMF DNIS for E&M-fgb under a controller T1 configuration, enter the cas-group 0 timeslots 1-24 type e&m-fgb dtmf dnis command. To collect MF DNIS for E&M-fgb, enter the cas-group 0 timeslots 1-24 type e&m-fgb mf dnis command.
Examples
The following example configures all 24 channels with ear and mouth robbed-bit signalling with feature group B support:
Router(config-controller)# controller T1 0Router(config-controller)# cas-group 1 timeslots 1-24 type e&m-fgb%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 1 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 2 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 3 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 4 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 5 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 6 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 7 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 8 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 9 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 10 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 11 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 12 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 13 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 14 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 15 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 16 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 17 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 18 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 19 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 20 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 21 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 22 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 23 is up%DSX0-5-RBSLINEUP: RBS of controller 1 timeslot 24 is upThe following example configures the required signalling to support modem pooling and the digital number identification service (DNIS) over channelized T1 lines on a Cisco AS5300. The only supported signalling and tone types for modem pooling over CT1 RBS are E&M feature group B, DTMF tones, and MF tones. By configuring DNIS as part of the cas-group command, the system can collect DNIS digits for incoming calls, which can be redirected to specific modem pools setup for different customers or services. Additionally, you must be running MICA modems in the system and have at least 10% of your total modems in the default modem pool. Free modems are needed in the default pool to detect the incoming called number or DNIS before handing the call off to the appropriate modem pool. Therefore, two modems are actually needed to handle each incoming call.
Note
controller t1 0cas-group 0 timeslots 1-24 type e&m-fgb dtmf dnisexitmodem-pool accounts1pool-range 30-50called-number 2000 max-conn 21exitThe next example configures a Cisco AS5200 to accept switched 56K digital calls on both of its T1 controllers:
copy running-config startup-configThe next example configures switched 56K digital services and analog modem services on one controller. Each service is assigned its own range of timeslots. Switched 56K calls are assigned to timeslots 1 through 15. Analog modem calls are assigned to timeslots 16 through 24. However, you must use different channel group numbers in each cas-group command entry.
controller T1 0cas-group 0 timeslots 1-15 type e&m-fgb service datacas-group 1 timeslots 16-24 type e&m-fgb service voiceframing esfclock source line secondarylinecode b8zsexitThe following example configures R1 signalling on a Cisco AS5200 (T1 interface) and specifies the collection of both ANI and DNIS information:
cas-group 1 timeslots 1-24 type r1-modified ani-dnisThe following example configures R1 modified signalling on a Cisco AS5800 (T1 interface) and specifies the collection of both ANI and DNIS information:
Router(config-controller)# cas-group 1 timeslots 1-24 type r1-modified ani-dnisRouter(config-controller)# ^ZRouter(config-controller)# debug csmCall Switching Module debugging is on1d16h:%CONTROLLER-5-UPDOWN:Controller E1 1/1/0, changed state to up*Dec 17 11:27:47.946:allocate slot 4 and port 2 is allocated*Dec 17 11:27:47.946:CSM v(4/2) c(E1 1/1/0:0):CSM_PROC_IDLE: ev_DSX0_CALL.*Dec 17 11:27:47.961:CSM v(4/2) c(E1 1/1/0:0):CSM_PROC_IC1_RING: ev_MODEM_OFFHOOK.*Dec 17 11:27:49.413:CSM v(4/2) c(E1 1/1/0:0):CSM_PROC_IC2_COLLECT_ADDR_INFO: ev_IC_DNIS_INFO_COLLECTED.*Dec 17 11:27:50.265:CSM v(4/2) c(E1 1/1/0:0):CSM_PROC_IC2_COLLECT_ADDR_INFO: ev_IC_ADDR_INFO_COLLECTED.*Dec 17 11:27:50.265:CSM v(4/2) c(E1 1/1/0:0):CSM_PROC_IC4_WAIT_FOR_CARRIER: ev_DSX0_CONNECTED.Router(config-controller)# show modem csm 1/4/2VDEV_INFO:slot 4, port 2vdev_status(0x00000001):VDEV_STATUS_ACTIVE_CALL.csm_state(0x00000205)=CSM_IC5_CONNECTED, csm_event_proc=0x60665CB0, current call thru Channelize lineinvalid_event_count=0, wdt_timeout_count=0watchdog timer is not activatedwait_for_dialing:False, wait_for_bchan:pri_chnl=(E1 1/1/0:0), vdev_chnl=(s4, c2)start_chan_p=0, chan_p=61994BC4, time_slot=0The calling party phone number =The called party phone number = 6789ring_no_answer=0, ic_failure=0, ic_complete=1dial_failure=0, oc_failure=0, oc_complete=0oc_busy=0, oc_no_dial_tone=0, oc_dial_timeout=0remote_link_disc=0, busyout=0, modem_reset=0call_duration_started=1d16h, call_duration_ended=00:00:00, total_call_duration=00:00:00Router(config-controller)# debug mica msmMICA modems state machine debugging is onDA-Slot4#1d16h:Msm2:MSM_IN_SERVICE:n_ring_ind:cc0x200 si5 dc3 ms0 cr56000,751d16h:Msm2:MSM_PREPARE:m_state_trans:newst MODEM_STATE_SETUP1d16h:Msm2:MSM_SETUP:m_dig_det:di=0x23(#)1d16h:Msm2:MSM_COLLECTING_DNIS:m_dig_det:di=0x41(A)1d16h:Msm2:MSM_COLLECTING_DNIS:m_dig_det:di=0x36(6)1d16h:Msm2:MSM_COLLECTING_DNIS:m_dig_det:di=0x37(7)1d16h:Msm2:MSM_COLLECTING_DNIS:m_dig_det:di=0x38(8)1d16h:Msm2:MSM_COLLECTING_DNIS:m_dig_det:di=0x39(9)1d16h:Msm2:MSM_COLLECTING_DNIS:m_dig_det:di=0x42(B)1d16h:Msm2:MSM_COLLECTING_ANI_PREFIX:m_dig_det:di=0x23(#)1d16h:Msm2:MSM_COLLECTING_ANI:m_dig_det:di=0x41(A)1d16h:Msm2:MSM_COLLECTING_ANI:m_dig_det:di=0x42(B)1d16h:Msm2:MSM_COLLECTING_ANI_SUFFIX:t_timeout:1d16h:Msm2:MSM_CALL_VERIFICATION:n_call_acc:1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_CONNECT1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_LINK1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_TRAINUP1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_EC_NEGOTIATING1d16h:Msm2:MSM_TRAING_NEGNG:m_state_trans:newst MODEM_STATE_STEADY_STATE
