-
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
resource-pool aaa accounting ppp
resource-pool call treatment discriminator
resource-pool profile customer
resource-pool profile discriminator
pri-group timeslots
To configure Non-Facility Associated Signaling (NFAS) and specify the channels to be controlled by the primary NFAS D channel, use the pri-group timeslots command in controller configuration mode.
pri-group timeslots range nfas_d [primary | backup | none] nfas_int number nfas_group group-id-number
pri-group timeslots range
Syntax Description
Defaults
Disabled
Command Modes
Controller configuration
Command History
Usage Guidelines
NFAS allows a single D channel to control multiple PRI interfaces. Use of a single D channel to control multiple PRI interfaces frees one B channel on each interface to carry other traffic. A backup D channel can also be configured for use when the primary NFAS D channel fails. When a backup D channel is configured, any hard system failure causes a switch over to the backup D channel and currently connected calls remain connected.
NFAS is supported only with a channelized T1 controller and, as a result, must be ISDN PRI capable. Once the channelized T1 controllers are configured for ISDN PRI, only the NFAS primary D channel must be configured; its configuration is distributed to all members of the associated NFAS group. Any configuration changes made to the primary D channel will be propagated to all NFAS group members. The primary D channel interface is the only interface shown after the configuration is written to memory.
The channelized T1 controllers on the router must also be configured for ISDN. The router must connect to either an AT&T 4ESS, Northern Telecom DMS-100 or DMS-250, or National ISDN switch type.
The ISDN switch must be provisioned for NFAS. The primary and backup D channels should be configured on separate T1 controllers. The primary, backup, and B-channel members on the respective controllers should be the same configuration as that configured on the router and ISDN switch. The interface ID assigned to the controllers must match that of the ISDN switch.
You can disable a specified channel or an entire PRI interface, thereby taking it out of service or placing it into one of the other states that is passed in to the switch using the isdn service interface configuration command.
In the event that a controller belonging to an NFAS group is shut down, all active B-channel calls on the controller that is shut down will be cleared (regardless of whether the controller is set to primary, backup, or none), and one of the following events will occur:
•
If the controller that is shut down is configured as the primary and no backup is configured, all active calls on the group are cleared.
•
•
•
Note
Examples
The following example configures T1 controller 1/0 for PRI and for the NFAS primary D channel. This primary D channel controls all the B channels in NFAS group 1.
controller t1 1/0framing esflinecode b8zspri-group timeslots 1-24 nfas_d primary nfas_int 0 nfas_group 1Related Commands
profile incoming
To define a template formed by directives guiding the Call Service Module (CSM) to process the digit sequence for a signaling class, use the profile incoming signaling-class submode command.
Note
profile incoming template
Syntax Description
Defaults
No default behavior or values
Command Modes
Signaling-class submode
Command History
Usage Guidelines
Arrange the directive special characters in the order necessary to process the digit sequence for your signaling class.
Examples
The following example enables the profile incoming command:
service internalsignaling-class cas testprofile incoming S<*a<*d<*nRelated Commands
Activates the signaling-class cas command.
Defines a signalling class with a template formed by directives guiding the CSM to process the digit sequence.
protocol rlm port
To configure the RLM port number, use the protocol rlm port command in RLM configuration mode. To disable this function, use the no form of this command.
protocol rlm port port-number
no protocol rlm port port-number
Syntax Description
port-number
RLM port number. See Table 20 for the port number choices.
Defaults
3000
Command Modes
RLM configuration
Command History
Usage Guidelines
The port number for the basic RLM connection can be reconfigured for the entire RLM group. Table 20 lists the default RLM port numbers.
Related Commands
protocol (VPDN)
To specify the tunneling protocol that a virtual private dialup network (VPDN) subgroup will use, use the protocol command in VPDN subgroup configuration mode. To remove the protocol-specific configurations from a VPDN subgroup, use the no form of this command.
protocol {any | l2f | l2tp | pppoe | pptp}
no protocol
Syntax Description
Defaults
No protocol is specified.
Command Modes
VPDN subgroup
Command History
Usage Guidelines
This command is required for any VPDN subgroup configuration.
L2TP is the only protocol that can be used for dialout subgroup configurations.
Changing the protocol will remove all the commands from the VPDN subgroup configuration, and any protocol-specific commands from the VPDN group configuration.
Note
Examples
The following example configures VPDN group 1 to accept dial-in calls using L2F and to request dial-out calls using L2TP:
vpdn-group 1accept-dialinprotocol l2fvirtual-template 1request-dialoutprotocol l2tppool-member 1local name router1terminate-from hostname router2initiate-to ip 10.3.2.1l2f ignore-mid-sequencel2tp ip udp checksumIf you then use the no protocol command in request-dialout mode, the configuration will be changed to this:
vpdn-group 1accept-dialinprotocol l2fvirtual-template 1request-dialoutlocal name router1terminate-from hostname router2l2f ignore-mid-sequenceRelated Commands
range
To associate a range of modems or other physical resources with a resource group, use the range command in resource group configuration mode. To remove a range of modems or other physical resources, use the no form of this command.
range {limit number | limit slot/port | port slot [slot]}
no range {limit number | limit slot/port | port slot [slot]}
Cisco AS5200 and AS5300 Series Routers
range {limit number | limit slot/port | port slot/port [slot/port]}
no range {limit number | limit slot/port | port slot/port [slot/port]}
Syntax Description
Defaults
No range is configured.
Command Modes
Resource group configuration
Command History
Usage Guidelines
Use the range resource group configuration command to associate a range of modems or other physical resources with a resource group.
Specify the range for port-based resources by using the resource's physical location. Do not identify non-port-based resource ranges by using a location. Rather, specify the size of the resource group with a single integer limit.
Specify noncontiguous ranges by using multiple range port commands within the same resource group. Do not configure the same ports in more than one resource group and do not overlap multiple port ranges.
For resources that are not pooled and have a one-to-one correspondence between DS0s, B channels, and HDLC framers, use the range limit number command. Circuit-switched data calls and V.120 calls use these kinds of resources.
Note
Do not configure "port" and "limit" parameters in the same resource group.Examples
The following example shows the range limit set for 48 simultaneous connections being supported by the resource group:
Cisco AS5300
resource-pool group resource hdlc1range limit 48Cisco AS5400
resource-pool group resource hdlcrange limit 2:255 (where 2 is slot#)Cisco AS5800
resource-pool group resource hdlcrange limit 2/0:255 (where 2 is slot# & 0 is subslot#for the trunk card)The following example shows the ports set for modem 1 ranging from port 0 to port 47:
resource-pool group modem1 range port 1/0 1/47rcapi number
To enable the Cisco 800 series router to distinguish between incoming CAPI calls and incoming non-CAPI calls such as POTS, PPP, and X.25, use the rcapi number command in global configuration mode. To release the specified directory number from the RCAPI interface, use the no form of this command.
rcapi number directory-number[:subaddress]
no rcapi number
Syntax Description
directory-number
ISDN directory number. Default is none.
:subaddress
(Optional) Subaddress of the router preceded by a colon (:).
Defaults
The default is no directory number set for the RCAPI interface.
Command Modes
Global configuration
Command History
12.0(7)XV
The commands rcapi number and no rcapi number were introduced on the Cisco 800 series router.
Usage Guidelines
The rcapi number command allows the Cisco 800 series router to reserve directory numbers exclusively for incoming calls.
The directory-number argument is the number assigned by the ISDN provider for the PC on which RCAPI is configured. The directory number should not be set to any other interfaces such as POTS and DOV. This command works only with the Net3 switch type.
Examples
The following example sets the router to recognize an ISDN number rather than a subaddress:
rcapi number 12345Related Commands
rcapi server
To enable the RCAPI server on the 800 series router or to set the TCP port number, use the rcapi server command in global configuration mode. To disable the RCAPI server on the 800 series router, use the no form of this command.
rcapi server [port number]
no rcapi server
Syntax Description
Defaults
If the router is configured for basic Net3 IDSN switch type, by default RCAPI is enabled, and the port number is set to 2578.
Command Modes
Global configuration
Command History
Usage Guidelines
This command works only with the Net3 switch type. The same port number must be configured on both the router and client PC.
Examples
The following example set the TCP port number to 2000:
rcapi server port 2000Related Commands
reload components
To request that the DSC (or DSCs in a redundant configuration) be reloaded at the same time as a reload on the Router Shelf on the Cisco AS5800, use the reload components command in EXEC mode. To cancel a reload, use the reload components cancel command.
reload components {all | description-line | at hh:mm | in [hhh:]mmm}
reload components cancel
Syntax Description
Defaults
No default behavior or values.
Command Modes
EXEC
Command History
Usage Guidelines
On the Cisco AS5800 only, to request that the DSC (or DSCs in a redundant configuration) be reloaded at the same time as a reload on the Router Shelf, use the reload components all command.
You cannot reload from a virtual terminal if the system is not set up for automatic booting. This prevents the system from dropping to the ROM monitor and thereby taking the system out of remote user control.
If you modify your configuration file, the system prompts you to save the configuration. During a save operation, the system asks you if you want to proceed with the save if the CONFIG_FILE environment variable points to a startup configuration file that no longer exists. If you say "yes" in this situation, the system goes to setup mode upon reload.
When you schedule a reload to occur at a later time, it must take place within approximately 24 days.
The at keyword can only be used if the system clock has be set on the router (either through NTP, the hardware calendar, or manually). The time is relative to the configured time zone on the router. To schedule reloads across several routers to occur simultaneously, the time on each router must be synchronized with NTP.
To display information about a scheduled reload, use the show reload command.
Examples
The following example reloads all components on a Cisco AS5800:
Router# reload components allRelated Commands
request-dialin
To create a request dial-in VPDN subgroup that configures a network access server (NAS) to request the establishment of a dial-in tunnel to a tunnel server, and to enter request dial-in VPDN subgroup configuration mode, use the request-dialin command in VPDN group configuration mode. To remove the request dial-in VPDN subgroup configuration from a virtual private dialup network (VPDN) group, use the no form of this command.
request-dialin
no request-dialin
Syntax Description
This command has no arguments or keywords.
Defaults
No request dial-in VPDN subgroups are configured.
Command Modes
VPDN group configuration
Command History
Usage Guidelines
Use the request-dialin command on a NAS to configure a VPDN group to request the establishment of dial-in VPDN tunnels to a tunnel server.
For a VPDN group to request dial-in calls, you must also configure the following commands:
•
•
•
The NAS can also be configured to accept requests for Layer 2 Tunnel Protocol (L2TP) dial-out VPDN tunnels from the tunnel server using the accept-dialout command. Dial-in and dial-out calls can use the same L2TP tunnel.
Examples
The following example requests an L2TP dial-in tunnel to a remote peer at IP address 172.17.33.125 for a user in the domain named cisco.com:
Router(config)# vpdn-group 1Router(config-vpdn)# request-dialinRouter(config-vpdn-req-in)# protocol l2tpRouter(config-vpdn-req-in)# domain cisco.com!Router(config-vpdn)# initiate-to ip 172.17.33.125Related Commands
request-dialout
To create a request dial-out VPDN subgroup that configures a tunnel server to request the establishment of dial-out Layer 2 Tunnel Protocol (L2TP) tunnels to a network access server (NAS), and to enter request dial-out VPDN subgroup configuration mode, use the request-dialout command in VPDN group configuration mode. To remove the request dial-out VPDN subgroup configuration from a virtual private dialup network (VPDN) group, use the no form of this command.
request-dialout
no request-dialout
Syntax Description
This command has no arguments or keywords.
Defaults
No request dial-out VPDN subgroups are configured.
Command Modes
VPDN group configuration
Command History
Usage Guidelines
Use the request-dialout command on a tunnel server to configure a VPDN group to request the establishment of dial-out VPDN tunnels to a NAS. L2TP is the only tunneling protocol that can be used for dial-out VPDN tunnels.
For a VPDN group to request dial-out calls, you must also configure the following commands:
•
•
•
•
If the dialer pool or dialer rotary group that the VPDN group is in contains physical interfaces, the physical interfaces will be used before the VPDN group configuration.
The tunnel server can also be configured to accept requests to establish dial-in VPDN tunnels from a NAS using the accept-dialin command. Dial-in and dial-out calls can use the same L2TP tunnel.
Examples
The following example configures VPDN group 1 to request an L2TP tunnel to the peer at IP address 10.3.2.1 for tunneling dial-out calls from dialer pool 1:
Router(config)# vpdn-group 1Router(config-vpdn)# request-dialoutRouter(config-vpdn-req-ou)# protocol l2tpRouter(config-vpdn-req-ou)# pool-member 1!Router(config-vpdn)# initiate-to ip 10.3.2.1!Router(config)# interface Dialer2Router(config-if)# ip address 172.16.2.3 255.255.128Router(config-if)# encapsulation pppRouter(config-if)# dialer remote-name reubenRouter(config-if)# dialer string 5551234Router(config-if)# dialer vpdnRouter(config-if)# dialer pool 1Router(config-if)# dialer-group 1Router(config-if)# ppp authentication chapRelated Commands
resource
To assign resources and supported call-types to a customer profile, use the resource command in customer profile configuration mode. To disable this function, use the no form of this command.
resource name {digital | speech | v110 | v120} [service name]
no resource name {digital | speech | v110 | v120} [service name]
Syntax Description
Defaults
No resources are assigned to the customer profile by default.
Command Modes
Customer profile configuration
Command History
Usage Guidelines
Use the resource customer profile configuration command to assign resources and supported call-types to a customer profile. This command specifies a group of physical resources to be used in answering an incoming call of a particular type for a particular customer profile. For example, calls started by analog modems are reciprocated with the speech keyword.
Examples
The following example shows a physical resource group called "modem1". Forty-eight integrated modems are then assigned to modem1, which is linked to the customer profile called "customer1_isp":
resource group resource modem1range port 1/0 1/47exitresource-pool profile customer customer1_ispresource modem1 speechRelated Commands
resource-pool
To enable or disable resource pool management, use the resource-pool command in global configuration mode.
resource-pool {enable | disable}
Syntax Description
Defaults
Resource management is disabled.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the resource-pool global configuration command to enable and disable the resource pool management feature.
Examples
The following example shows how to enable RPM:
resource-pool enableresource-pool aaa accounting ppp
To include enhanced start/stop resource manager records to authorization, authentication, and accounting (AAA) accounting, use the resource-pool aaa accounting ppp command in global configuration mode. To disable this feature, use the no form of this command.
resource-pool aaa accounting ppp
no resource-pool aaa accounting ppp
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled. The default of the resource-pool enable command is to not enable these new accounting records.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the resource-pool aaa accounting ppp global configuration command to include enhanced start/stop resource manager records to AAA accounting. The resource-pool aaa accounting ppp command adds new resource pool management fields to the AAA accounting start/stop records. The new attributes in the start records are also in the stop records—in addition to those new attributes added exclusively for the stop records.
If you have configured your regular AAA accounting, this command directs additional information from the resource manager into your accounting records.
Note
Table 21 shows the new fields that have been added to the start and stop records:
Caution
Note
Examples
The following example shows the new AAA accounting start/stop records inserted into an existing AAA accounting infrastructure:
resource-pool aaa accounting pppRelated Commands
show accounting
Allows display of the active accountable events on the network and helps collect information in the event of a data loss on the accounting server.
resource-pool aaa protocol
To specify which protocol to use for resource management, use the resource-pool aaa protocol command in global configuration mode. To disable this feature and go to local, use the no form of this command.
resource-pool aaa protocol {local | group name}
no resource-pool aaa protocol
Syntax Description
local
Local authorization.
group name
Use an external authorization, authentication, and accounting (AAA) server group. The Resource Pool Management Server (RPMS) is defined in a AAA server group.
Defaults
Default is set to local authorization.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the resource-pool aaa protocol global configuration command to specify which protocol to use for resource management. The AAA server group is most useful when you want to have multiple RPMSs configured as a fall-back mechanism.
Examples
The following example shows how to specify local authorization protocol:
resource-pool aaa protocol localresource-pool call treatment
To set up the signal sent back to the telco switch in response to incoming calls, use the resource-pool call treatment command in global configuration mode. To disable this function, use the no form of this command.
resource-pool call treatment {profile {busy | no-answer} | resource {busy | channel-not-available}}
no resource-pool call treatment {profile {busy | no-answer} | resource {busy | channel-not-available}}
Syntax Description
Defaults
No answer for a customer profile; CNA for a resource.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the resource-pool call treatment global configuration command to set up the signal sent back to the telco switch in response to incoming calls.
Examples
Router(config)# resource-pool call treatment profile ?busy Send busy code when profile authorization failsno-answer Don't answer when profile authorization failsresource-pool call treatment discriminator
To modify the signal (ISDN cause code) sent to the switch when a discriminator rejects a call, enter the resource-pool call treatment discriminator command in global configuration mode. To disable this function, use the no form of this command.
resource-pool call treatment discriminator {busy | no-answer | channel-not-available}
no resource-pool call treatment discriminator {busy | no-answer | channel-not-available}
Syntax Description
Defaults
No answer for a customer profile; CNA for a resource.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the resource-pool call treatment discriminator global configuration command to set up the signal sent back to the telco switch in response to incoming calls.
Examples
Use the following command to answer the call, but send a busy signal to the switch when profile authorization or resource allocation fails:
resource-pool call treatment discriminator busyUse the following command to prevent the call from being answered when profile authorization fails and the discriminator rejects a call:
resource-pool call treatment discriminator no-answerresource-pool group resource
To create a resource group for resource management, use the resource-pool group resource command in global configuration mode. To remove a resource group from the running configuration, use the no form of this command.
resource-pool group resource name
no resource-pool group resource name
Syntax Description
name
Name for the group of physical resources inside the access server. This name can have up to 23 characters.
Defaults
No resource groups are set up.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the resource-pool group resource global configuration command to create a resource group for resource management. When calls come into the access server, they are allocated physical resources as specified within resource groups and customer profiles.
See the range command for more information.
If some physical resources are not included in any resource groups, then these remaining resources are not used and are considered to be part of the default resource group. These resources can be used in certain cases to answer calls before profile allocation occurs, but the resources are not used other than in the connection phase.
Note
When enabling RPM for SS7 signalling, like resources in the network access server (NAS) must be in a single group:
•
•
•
•
All resource group types must have the same number of resources and that number must equal the number of interface channels available from the public network switch. This grouping scheme prevents the CNA signal from being sent to the signalling point. For SS7 signalling, Microcom and MICA technologies modems must be in the same group. If SS7 signalling is not used, Cisco recommends assigning Microcom and MICA modems to separate groups to avoid introducing errors in RPM statistics.
Examples
The following example shows the configuration options within a resource group:
Router(config)# resource-pool group resource modem1?Resource Group Configuration Commands:default Set a command to its defaultsexit Exit from resource-manager configuration modehelp Description of the interactive help systemno Negate a command or set its defaultsrange Configure range for resourceRouter(config-resource)# range ?limit Configure the maximum limitport Configure the resource portsRouter(config-resource)# range limit ?<1-192> Maximum number of connections allowedRouter(config-resource)# range port ?<0-246> First Modem TTY Numberx/y Slot/Port for Internal ModemsRelated Commands
resource-pool profile customer
To create a customer profile and to enter customer profile configuration mode, use the resource-pool profile customer command in global configuration mode. To delete a customer profile from the running configuration, use the no form of this command.
resource-pool profile customer name
no resource-pool profile customer name
Syntax Description
Defaults
No customer profiles are set up.
Command Modes
Global configuration
Command History
12.0(4)XI
This command was introduced.
12.0(5)T
Support for this command was integerated into Cisco IOS Release 12.0(5)T.
Usage Guidelines
Use the resource-pool profile customer command to create a customer profile and enter customer profile configuration mode.
VPDN groups can be associated with a customer profile by issuing the vpdn group command in customer profile configuration mode.
A VPDN profile can be associated with a customer profile by issuing the vpdn profile command in customer profile configuration mode.
VPDN session limits for the VPDN groups associated with a customer profile can be configured in customer profile configuration mode using the limit base-size command.
Examples
The following example shows how to create two VPDN groups, configure the VPDN groups under a VPDN profile named profile1, then associate the VPDN profile with a customer profile named customer12:
Router(config)# vpdn-group 1Router(config-vpdn)#!Router(config)# vpdn-group 2Router(config-vpdn)#!Router(config)# resource-pool profile vpdn profile1Router(config-vpdn-profile)# vpdn group 1Router(config-vpdn-profile)# vpdn group 2!Router(config)# resource-pool profile customer customer12Router(config-vpdn-customer)# vpdn profile profile1Related Commands
resource-pool profile discriminator
To create a call discrimination profile and assign it a name, use the resource-pool profile discriminator command in global configuration mode. To remove a call discrimination profile from the running configuration, use the no form of this command.
resource-pool profile discriminator name
no resource-pool profile discriminator name
Syntax Description
name
Name of the call discrimination profile created. This name can have up to 23 characters. You can add a CLID or DNIS group to the discriminator profile created.
Defaults
No default behavior or values.
Command Modes
Global configuration
Command History
12.0(4)XI
This command was introduced.
12.1(5)T
This command was enhanced to add CLID groups and DNIS groups to a discriminator.
Usage Guidelines
Discriminator profiles enable you to process calls differently based on the call type and DNIS or CLID combination. Use the resource-pool profile discriminator command to create a call discrimination profile, and then use the clid group command to add a CLID group to a discriminator.
To create a call discrimination profile, you must specify both the call type and CLID group. Once a CLID group is associated with a call type in a discriminator, it cannot be used in any other discriminator.
Examples
The following example shows a call discriminator named clidKiller created and configured to block digital calls from the CLID group named zot:
resource-pool profile discriminator clidKillercall-type digitalclid group zotRelated Commands
Configures a CLID group in a discriminator.
Configures a DNIS group in a discriminator.
resource-pool profile service
To set up the service profile configuration, use the resource-pool profile service command in global configuration mode. To disable this function, use the no form of this command.
resource-pool profile service name
no resource-pool profile service name
Syntax Description
Defaults
No service profiles are set up.
Command Modes
Global configuration
Command History
Usage Guidelines
Use the resource-pool profile service global configuration command to set up the service profile configuration.
Examples
The following example shows the creation of a service profile called user1:
resource-pool profile service user1resource-pool profile vpdn
To create a virtual private dialup network (VPDN) profile and to enter VPDN profile configuration mode, use the resource-pool profile vpdn command in global configuration mode. To disable this function, use the no form of this command.
resource-pool profile vpdn name
no resource-pool profile vpdn name
Syntax Description
Defaults
No VPDN profiles are set up.
Command Modes
Global configuration
Command History
12.0(4)XI
This command was introduced.
12.0(5)T
Support for this command was integerated into Cisco IOS Release 12.0(5)T.
Usage Guidelines
Use the resource-pool profile vpdn command to create a VPDN profile and enter VPDN profile configuration mode, or to enter VPDN profile configuration mode for a VPDN profile that already exists.
VPDN groups can be associated with a VPDN profile using the vpdn group command in VPDN profile configuration mode. A VPDN profile will count VPDN sessions across all associated VPDN groups.
VPDN session limits for the VPDN groups associated with a VPDN profile can be configured in VPDN profile configuration mode using the limit base-size command.
Examples
The following example createss the VPDN groups named l2tp and l2f, and associates both VPDN groups with the VPDN profile named profile32:
Router(config)# vpdn-group l2tpRouter(config-vpdn)#!Router(config)# vpdn-group l2fRouter(config-vpdn)#!Router(config)# resource-pool profile vpdn profile32Router(config-vpdn-profile)# vpdn group l2tpRouter(config-vpdn-profile)# vpdn group l2fRelated Commands
retry keepalive
To enable Redundant Link Manager (RLM) keepalive retries, use the retry keepalive command in RLM configuration mode. To disable this function, use the no form of this command.
retry keepalive number-of-times
no retry keepalive number-of-times
Syntax Description
number-of-times
Number of keepalive failures allowed before the link is declared down, from
1 to 100.
Defaults
3
Command Modes
RLM configuration
Command History
Usage Guidelines
RLM allows keepalive failures in consecutive certain amounts of time configured using the command line interface (CLI) before it declares the link is down.
Examples
The following example sets RLM keepalive retries to 88:
retry keepalive 88Related Commands
rotary
To define a group of lines consisting of one or more virtual terminal lines or one auxiliary port line, use the rotary command in line configuration mode. To remove a group of lines from a rotary group, use the no form of this command.
rotary group [queued] [round-robin]
no rotary group [queued] [round-robin]
Syntax Description
Defaults
No group of lines is defined.
Command Modes
Line configuration
Command History
10.0
This command was introduced.
12.1(1)T
The queued keyword was added.
12.1(2)T
The round-robin keyword was added.
Usage Guidelines
Connections to a rotary group can take advantage of the following features:
•
•
•
•
Typically, rotary groups are used on devices with multiple modem connections to allow connection to the next free line in a hunt group. In the event that there are no free asynchronous ports, the queued keyword enables outgoing connection requests to be queued until a free port becomes available. Periodic messages are sent to users to update them on the status of their connection request.
For a nonqueued connection request, the remote host must specify a particular TCP port on the router to connect to a rotary group with connections to an individual line. The available services are the same, but the TCP port numbers are different. Table 22 lists the services and port numbers for both rotary groups and individual lines.
For example, if Telnet protocols are required, the remote host connects to the TCP port numbered 3000 (decimal) plus the rotary group number. If the rotary group identifier is 13, the corresponding TCP port is 3013.
If a raw TCP stream is required, the port is 5000 (decimal) plus the rotary group number. If rotary group 5 includes a raw TCP (printer) line, the user connects to port 5005 and is connected to one of the raw printers in the group.
If Telnet binary mode is required, the port is 7000 (decimal) plus the rotary group number.
The round-robin selection algorithm enabled by the round-robin keyword improves the utilization of tty ports. When looking for the next available port, the default linear hunting algorithm will not roll over to the next port if the first port it finds is bad. This failure to roll over to the next port results in an unequitable utilization of the tty ports on a router. The round-robin hunting algorithm will roll over bad ports instead of retrying them.
Note
Examples
The following example establishes a rotary group consisting of virtual terminal lines 2 through 4 and defines a password on those lines. By using Telnet to connect to TCP port 3001, the user gets the next free line in the rotary group. The user needs not remember the range of line numbers associated with the password.
line vty 2 4rotary 1password letmeinloginThe following example enables asynchronous rotary line queueing using the round-robin algorithm:
line 1 2rotary 1 queued round-robinRelated Commands
rotary-group
To assign a request-dialout virtual private dialup network (VPDN) subgroup to a dialer rotary group, use the rotary-group command in request-dialout configuration mode. To remove the request-dialout VPDN subgroup from the dialer rotary group, use the no form of this command.
rotary-group group-number
no rotary-group [group-number]
Syntax Description
Defaults
Disabled
Command Modes
Request-dialout configuration
Command History
Usage Guidelines
If the dialer pool or dialer rotary group that the VPDN group is in contains physical interfaces, the physical interfaces will be used before the VPDN group.
You must first enable the protocol l2tp command on the request-dialout VPDN subgroup before you can enable the rotary-group command. Removing the protocol l2tp command will remove the rotary-group command from the request-dialout subgroup.
You can only configure one dialer profile pool (using the pool-member command) or dialer rotary group (using the rotary-group command). If you attempt to configure a second dialer resource, you will replace the first dialer resource in the configuration.
Examples
The following example configures VPDN group 1 to request L2TP dialout to IP address 172.16.4.6 using dialer profile pool 1 and identifying itself using the local name harold.
vpdn-group 1request-dialoutprotocol l2tprotary-group 1initiate-to ip 172.16.4.6local name haroldRelated Commands
script activation
To specify that a chat script start on a physical terminal line any time the line is activated, use the script activation command in line configuration mode. To disable this feature, use the no form of this command.
script activation regular-expression
no script activation
Syntax Description
regular-expression
Regular expression that specifies the set of modem scripts that might be executed. The first script name that matches the regular-expression argument will be used.
Defaults
Not assigned to terminal lines
Command Modes
Line configuration
Command History
Usage Guidelines
This command provides an asynchronous handshake to a user or device that activates the line. It can be activated by several events, such as a user issuing a carriage return on a vacant line, by a modem on the line sensing an incoming carrier, or an asynchronous device (such as another router) sending data. Each time an EXEC session is started on a line, the system checks to see if a script activation command is configured on the line. If so, and the regular-expression argument (a regular expression) matches an existing chat script name, the matched script is run on the line. For information about regular expressions, see the appendix "Regular Expressions" in the Cisco IOS Dial Technologies Configuration Guide.
The script activation command can mimic a login handshake of another system. For example, a system that dials into a line on a router and expects an IBM mainframe login handshake can be satisfied with an appropriate activation script.
This command also can send strings to asynchronous devices that are connecting or dialing into a router.
The script activation command functions only on physical terminal (tty) lines. It does not function on virtual terminal lines.
Examples
The following example specifies that the chat script with a name that includes "telebit" will be activated whenever line 4 is activated:
line 4script activation telebitRelated Commands
script arap-callback
To specify that a chat script start on a line any time an AppleTalk Remote Access (ARA) client requests a callback, use the script arap-callback command in line configuration mode. To disable this feature, use the no form of this command.
script arap-callback regular-expression
no script arap-callback
Syntax Description
regular-expression
Regular expression that specifies the set of modem scripts that might be executed. The first script name that matches the regular-expression argument is used.
Defaults
Not assigned to terminal lines
Command Modes
Line configuration
Command History
Usage Guidelines
This command specifies that if an originating ARA client requests callback, the device will be disconnected and the chat script defined by the regular-expression argument will be executed to call back the client. The first available line specified for callback, and for which a chat script has been applied, will be used for the callback.
Create a chat script using the chat script command. The script arap-callback command functions only on physical terminal (tty) lines. It does not function on virtual terminal lines.
Examples
The following example specifies that a chat script with a name that includes usr4 will be activated whenever a client requests a callback on line 4:
line 4script arap-callback usr4Related Commands
script callback
To specify that a chat script start on a line any time a client requests a callback, use the script callback command in line configuration mode. To disable this feature, use the no form of this command.
script callback regular-expression
no script callback
Syntax Description
regular-expression
Regular expression that specifies the set of modem scripts that might be executed. The first script name that matches the regular-expression argument is used.
Defaults
Not assigned to terminal lines
Command Modes
Line configuration
Command History
Usage Guidelines
This command specifies that if an originating client requests callback, the device will be disconnected and the chat script defined by the regular-expression argument will be executed to call back the client. The first available line specified for callback, and for which a chat script has been applied, will be used for the callback. Regular expression characters and strings are described in the appendix "Regular Expressions" at the end of the Cisco IOS Dial Technologies Configuration Guide.
Create a chat script using the chat script command.
The script callback command functions only on physical terminal (tty) lines. It does not function on virtual terminal lines.
Examples
The following example specifies that the chat script with a name that includes supra4 will be activated whenever a client requests a callback on line 4:
line 4script callback supra4Related Commands
script connection
To specify that a chat script will start on a physical terminal line any time a remote network connection is made to a line, use the script connection command in line configuration mode. To disable this feature, use the no form of this command.
script connection regular-expression
no script connection
Syntax Description
regular-expression
Set of modem scripts that can be executed. The first script name that matches the regular-expression argument will be used.
Defaults
Not assigned to terminal lines
Command Modes
Line configuration
Command History
Usage Guidelines
This command provides modem dialing commands and commands for logging onto remote systems. The script connection command functions only on physical terminal (tty) lines. It does not function on virtual terminal lines.
This command can be used to initialize an asynchronous device sitting on a line to which a reverse network connection is made.
For information about regular expressions, see the appendix "Regular Expressions" in the Cisco IOS Dial Technologies Configuration Guide.
Examples
The following example specifies that the chat script with a name that includes inband will be activated whenever a remote connection to line 4 is established. The router can send a login string and password to the UNIX server when a network tunneling connection comes into line 4:
line 4script connection inbandUsing this example and the topology in Figure 4, the access server or router can send a login string and password to the UNIX server when a network tunneling connection comes into line 4.
Figure 4 Network Tunneling Connection on an Asynchronous Line
Related Commands
script dialer
To specify a default modem chat script, use the script dialer command in line configuration mode. To disable this feature, use the no form of this command.
script dialer regular-expression
no script dialer
Syntax Description
regular-expression
Set of modem scripts that can be executed. The first script that matches the regular-expression argument will be used.
Defaults
No chat script is defined.
Command Modes
Line configuration
Command History
Usage Guidelines
This command is used by DDR modules to provide modem dialing commands and commands to log in to remote systems.
The regular-expression argument is used to specify the name of the modem script that is to be executed. The first script that matches the argument in this command and the dialer map command will be used. For information about regular expressions, see the appendix "Regular Expressions" in the Cisco IOS Dial Technologies Configuration Guide.
If you adhere to the naming convention recommended for chat scripts (see the chat-script command), the modem lines (the regular-expression argument in the script dialer command) will be set to one of the following regular expressions to match patterns, depending on the kind of modem you have:
•
•
•
•
In the dialer map command, you can specify the modulation but leave the type of modem unspecified, as in .*-v32bis.
Examples
The following example shows line chat scripts being specified for lines connected to Telebit and US Robotics modems:
! Some lines have telebit modemsline 1 6script dialer telebit.*!! Some lines have US robotics modemsline 7 12script dialer usr.*Related Commands
script reset
To specify that a chat script will start on a physical terminal line any time the specified line is reset, use the script reset command in line configuration mode. To disable this feature, use the no form of this command.
script reset regular-expression
no script reset
Syntax Description
regular-expression
Set of modem scripts that might be executed. The first script name that matches the regular-expression argument will be used.
Defaults
Not assigned to terminal lines.
Command Modes
Line configuration
Command History
Usage Guidelines
Chat scripts provide modem dialing commands and commands for logging onto remote systems. Use this command to reset a modem attached to a line every time a call is dropped.
The script reset command functions only on physical terminal (tty) lines. It does not function on virtual terminal lines.
For information about regular expressions, see the appendix "Regular Expressions" in the Cisco IOS Dial Technologies Configuration Guide.
Examples
The following example specifies that any chat script name with the word linebackup in it will be activated any time line 7 is reset:
line 7script reset linebackupThe following example resets a modem sitting on a line each time a call is dropped:
chat-script drop-line ""+++"" " " ATH OK "ATS0=1" OK "ATS9=21"line 4script reset drop-lineRelated Commands
script startup
To specify that a chat script will start on a physical terminal line any time the router is powered up, use the script startup command in line configuration mode. To disable this feature, use the no form of this command.
script startup regular-expression
no script startup
Syntax Description
regular-expression
Set of modem scripts that might be executed. The first script that matches the regular-expression argument will be used.
Defaults
Not assigned to terminal lines
Command Modes
Line configuration
Command History
Usage Guidelines
Use this command to initialize asynchronous devices connected to a line when the router is started up or reloaded. You can also use it to start up a banner other than the default banner on lines. The script startup command functions only on physical terminal (tty) lines. It does not function on virtual terminal lines.
For information about regular expressions, see the appendix "Regular Expressions" in the Cisco IOS Dial Technologies Configuration Guide.
Examples
The following example specifies that a chat script with the word linestart in its name will be activated whenever line 5 is started up:
line 5script startup linestartRelated Commands
sgbp dial-bids
To allow the stack group to bid for dialout connection, use the sgbp dial-bids command in global configuration mode. To disable this function, use the no form of this command.
sgbp dial-bids
no sgbp dial-bids
Syntax Description
This command has no arguments or keywords.
Defaults
The stack group bid function is disabled by default.
Command Modes
Global configuration
Command History
Examples
The following example shows how to configure a stack group for large-scale dialout:
sgbp group foreversgbp member NAS2 172.21.17.17sgbp dial-bidsRelated Commands
sgbp group
To define a named stack group and make this router a member of that stack group, use the sgbp group command in global configuration mode. To remove the definition, use the no form of this command.
sgbp group name
no sgbp group
Syntax Description
Defaults
Disabled. No stack group name is provided.
Command Modes
Global configuration
Command History
Usage Guidelines
Define the same stack group name across all the stack members.
Examples
The following example makes this system a member of the stack group named stackq:
sgbp group stackqRelated Commands
sgbp member
To specify the host name and IP address of a router or access server that is a peer member of a stack group, use the sgbp member command in global configuration mode. To remove the member association, use the no form of this command.
sgbp member peer-name [peer-ip-address]
no sgbp member peer-name
Syntax Description
Defaults
Disabled. When enabled, names and IP addresses of peer routers or access servers in the stack group are not provided.
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to specify the names of peer hosts (other hosts, not the one being configured) in the specified stack group after you have entered the sgbp dial-bids command.
Examples
The following example configures the current router to recognize the three routers (jimi, janis, and jerry) as peer members of the rockstar stack group:
sgbp group rockstarsgbp member jimi 10.69.5.2sgbp member janis 172.16.6.3sgbp member jerry 192.168.15.4Related Commands
Defines a named stack group and makes this router a member of that stack group.
Sets the bidding level that a stack group member can be used to bid for a bundle.
sgbp ppp-forward
To enable forwarding of PPP calls—in addition to Multilink PPP (MLP) calls—to the winner of the Stack Group Bidding Protocol (SGBP) bid, use the sgbp ppp-forward command in global configuration mode. To return to the default state, use the no form of this command.
sgbp ppp-forward
no sgbp ppp-forward
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Global configuration
Command History
Usage Guidelines
When this command is enabled, both PPP and Multilink PPP calls are projected to the winner of the SGBP bid. By default, only Multilink PPP calls are forwarded.
Examples
The following partial example enables forwarding of PPP calls, as well as MLP calls, to the winner of the SGBP bidding:
sgbp ppp-forwardRelated Commands
sgbp seed-bid
To set the bidding level that a stack group member can bid with for a bundle, use the sgbp seed-bid command in global configuration mode. To return to the default state, use the no form of this command.
sgbp seed-bid {default | offload | forward-only | bid}
no sgbp ppp-forward
Syntax Description
Defaults
The default keyword; no bid-level integer value is set.
Command Modes
Global configuration
Command History
Usage Guidelines
In the case of equivalent stack group members stacked to receive calls in a rotary group across multiple PRIs, use the sgbp seed-bid default command across all stack members. The stack member that receives the first call for a certain user always wins the bid and hosts the master bundle interface. All subsequent calls to the same user received by another stack member will project to this stack member. If the multiple calls come in concurrently over multiple stack members, the SGBP tie-breaking mechanism will break the tie.
To leverage the relative higher power of one stack member over another, you can set the designated stack member (of higher CPU power) as offload server with the sgbp seed-bid offload command. The bid that is sent is the precalibrated per-platform bid approximating the CPU power, minus the bundle load. In this case, the offload server hosts the master bundle. All calls from other stack members get projected to this stack member. One or more offload servers can be defined—if the bids are equal, the SGBP tie-breaking mechanism will break the tie.
The interfaces that received the calls are projected to the master bundle interface and are considered children of the master bundle interface for the call. See the output of the show ppp multilink command for an example of master bundle interface (shown as "Master link") and the children of it.
You can also manually designate bid values with the sgbp seed-bid command. This value overrides the default or offload setting. The bid sent out is the user-configured value minus the bundle load. The bundle load is defined as the number of active bundles on the stack member. In effect, the more current active bundles on a router, the lower its bid for an additional bundle.
If you have assorted or exactly the same platforms and for some reason want to designate one or more as offload servers, you can manually set the bid value to be significantly higher than the rest. For example, you might use the sgbp seed-bid 9999 command. To determine the initial bid value associated with your particular platform, use the show sgbp command. This method allows you to manually designate the bid values when you have assorted platforms and want to designate one or more platforms as offload servers; for example, one Cisco 4700 (given the highest seed-bid), two Cisco 4000s and one Cisco 7000.
To check the bid value currently assigned on the system, use the show sgbp queries command.
Examples
The following example sets the SGBP bidding level to forward-only:
sgbp seed-bid forward-onlyRelated Commands
shelf-id
To change the shelf number assigned to the router shelf or dial shelf on the Cisco AS5800, use the shelf-id command in global configuration mode. To return the shelf numbers to the default value, use the no form of this command.
shelf-id number {router-shelf | dial-shelf}
no shelf-id number
Syntax Description
number
Number to assign to the shelf. Range: 0 to 9999.
router-shelf
Specified number to the router shelf.
dial-shelf
Specified number to the dial shelf.
Defaults
The default shelf number for the router shelf is 0.
The default shelf number for the dial shelf is 1 or one number higher than the specified router shelf number.
Command Modes
Global configuration
Command History
Usage Guidelines
The shelf number is used to distinguish between cards on the router shelf and cards on the dial shelf.
Caution
You can specify the shelf number through the setup facility during initial configuration of the
Cisco AS5800. This is the recommended method to specify shelf numbers.To display the shelf numbers, use the show running-config command. If a shelf number has been changed, the pending change is shown in the output of the show version command (for example, the dial-shelf ID is 87; will change to 2 on reload).
Examples
The following example shows how to assign 456 as the dial shelf number:
shelf-id 456 dial-shelfRelated Commands
show version
Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images.
